1 /*
2 * Copyright (c) 1995, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package java.awt;
27
28 import java.awt.datatransfer.Clipboard;
29 import java.awt.dnd.DragGestureListener;
30 import java.awt.dnd.DragGestureRecognizer;
31 import java.awt.dnd.DragSource;
32 import java.awt.event.*;
33 import java.awt.im.InputMethodHighlight;
34 import java.awt.image.ColorModel;
35 import java.awt.image.ImageObserver;
36 import java.awt.image.ImageProducer;
37 import java.beans.PropertyChangeEvent;
38 import java.beans.PropertyChangeListener;
39 import java.beans.PropertyChangeSupport;
40 import java.io.File;
41 import java.io.FileInputStream;
42 import java.net.URL;
43 import java.util.ArrayList;
44 import java.util.EventListener;
45 import java.util.HashMap;
46 import java.util.Map;
47 import java.util.MissingResourceException;
48 import java.util.Properties;
49 import java.util.ResourceBundle;
50 import java.util.StringTokenizer;
51 import java.util.WeakHashMap;
52
53 import sun.awt.AWTAccessor;
54 import sun.awt.AWTPermissions;
55 import sun.awt.AppContext;
56 import sun.awt.HeadlessToolkit;
57 import sun.awt.PeerEvent;
58 import sun.awt.SunToolkit;
59
60 import java.security.AccessController;
61 import java.security.PrivilegedAction;
62 import java.util.Arrays;
63 import java.util.ServiceLoader;
64 import java.util.Set;
65 import java.util.stream.Collectors;
66 import javax.accessibility.AccessibilityProvider;
67
68 /**
69 * This class is the abstract superclass of all actual
70 * implementations of the Abstract Window Toolkit. Subclasses of
71 * the {@code Toolkit} class are used to bind the various components
72 * to particular native toolkit implementations.
73 * <p>
74 * Many GUI events may be delivered to user
75 * asynchronously, if the opposite is not specified explicitly.
76 * As well as
77 * many GUI operations may be performed asynchronously.
78 * This fact means that if the state of a component is set, and then
79 * the state immediately queried, the returned value may not yet
80 * reflect the requested change. This behavior includes, but is not
81 * limited to:
82 * <ul>
83 * <li>Scrolling to a specified position.
84 * <br>For example, calling {@code ScrollPane.setScrollPosition}
85 * and then {@code getScrollPosition} may return an incorrect
86 * value if the original request has not yet been processed.
87 *
88 * <li>Moving the focus from one component to another.
89 * <br>For more information, see
90 * <a href="http://docs.oracle.com/javase/tutorial/uiswing/misc/focus.html#transferTiming">Timing
91 * Focus Transfers</a>, a section in
92 * <a href="http://docs.oracle.com/javase/tutorial/uiswing/">The Swing
93 * Tutorial</a>.
94 *
95 * <li>Making a top-level container visible.
96 * <br>Calling {@code setVisible(true)} on a {@code Window},
97 * {@code Frame} or {@code Dialog} may occur
98 * asynchronously.
99 *
100 * <li>Setting the size or location of a top-level container.
101 * <br>Calls to {@code setSize}, {@code setBounds} or
102 * {@code setLocation} on a {@code Window},
103 * {@code Frame} or {@code Dialog} are forwarded
104 * to the underlying window management system and may be
105 * ignored or modified. See {@link java.awt.Window} for
106 * more information.
107 * </ul>
108 * <p>
109 * Most applications should not call any of the methods in this
110 * class directly. The methods defined by {@code Toolkit} are
111 * the "glue" that joins the platform-independent classes in the
112 * {@code java.awt} package with their counterparts in
113 * {@code java.awt.peer}. Some methods defined by
114 * {@code Toolkit} query the native operating system directly.
115 *
116 * @author Sami Shaio
117 * @author Arthur van Hoff
118 * @author Fred Ecks
119 * @since 1.0
120 */
121 public abstract class Toolkit {
122
123 // The following method is called by the private method
124 // <code>updateSystemColors</code> in <code>SystemColor</code>.
125
126 /**
127 * Fills in the integer array that is supplied as an argument
128 * with the current system color values.
129 *
130 * @param systemColors an integer array.
131 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
132 * returns true
133 * @see java.awt.GraphicsEnvironment#isHeadless
134 * @since 1.1
135 */
136 protected void loadSystemColors(int[] systemColors)
137 throws HeadlessException {
138 GraphicsEnvironment.checkHeadless();
139 }
140
141 /**
142 * Controls whether the layout of Containers is validated dynamically
143 * during resizing, or statically, after resizing is complete.
144 * Use {@code isDynamicLayoutActive()} to detect if this feature enabled
145 * in this program and is supported by this operating system
146 * and/or window manager.
147 * Note that this feature is supported not on all platforms, and
148 * conversely, that this feature cannot be turned off on some platforms.
149 * On these platforms where dynamic layout during resizing is not supported
150 * (or is always supported), setting this property has no effect.
151 * Note that this feature can be set or unset as a property of the
152 * operating system or window manager on some platforms. On such
153 * platforms, the dynamic resize property must be set at the operating
154 * system or window manager level before this method can take effect.
155 * This method does not change support or settings of the underlying
156 * operating system or
157 * window manager. The OS/WM support can be
158 * queried using getDesktopProperty("awt.dynamicLayoutSupported") method.
159 *
160 * @param dynamic If true, Containers should re-layout their
161 * components as the Container is being resized. If false,
162 * the layout will be validated after resizing is completed.
163 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
164 * returns true
165 * @see #isDynamicLayoutSet()
166 * @see #isDynamicLayoutActive()
167 * @see #getDesktopProperty(String propertyName)
168 * @see java.awt.GraphicsEnvironment#isHeadless
169 * @since 1.4
170 */
171 public void setDynamicLayout(final boolean dynamic)
172 throws HeadlessException {
173 GraphicsEnvironment.checkHeadless();
174 if (this != getDefaultToolkit()) {
175 getDefaultToolkit().setDynamicLayout(dynamic);
176 }
177 }
178
179 /**
180 * Returns whether the layout of Containers is validated dynamically
181 * during resizing, or statically, after resizing is complete.
182 * Note: this method returns the value that was set programmatically;
183 * it does not reflect support at the level of the operating system
184 * or window manager for dynamic layout on resizing, or the current
185 * operating system or window manager settings. The OS/WM support can
186 * be queried using getDesktopProperty("awt.dynamicLayoutSupported").
187 *
188 * @return true if validation of Containers is done dynamically,
189 * false if validation is done after resizing is finished.
190 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
191 * returns true
192 * @see #setDynamicLayout(boolean dynamic)
193 * @see #isDynamicLayoutActive()
194 * @see #getDesktopProperty(String propertyName)
195 * @see java.awt.GraphicsEnvironment#isHeadless
196 * @since 1.4
197 */
198 protected boolean isDynamicLayoutSet()
199 throws HeadlessException {
200 GraphicsEnvironment.checkHeadless();
201
202 if (this != Toolkit.getDefaultToolkit()) {
203 return Toolkit.getDefaultToolkit().isDynamicLayoutSet();
204 } else {
205 return false;
206 }
207 }
208
209 /**
210 * Returns whether dynamic layout of Containers on resize is currently
211 * enabled on the underlying operating system and/or window manager. If the
212 * platform supports it, {@code setDynamicLayout(boolean)} may be used to
213 * programmatically enable or disable platform dynamic layout. Regardless of
214 * whether that toggling is supported, or whether {@code true} or {@code
215 * false} is specified as an argument, or has never been called at all, this
216 * method will return the active current platform behavior and which will be
217 * followed by the JDK in determining layout policy during resizing.
218 * <p>
219 * If dynamic layout is currently inactive then Containers re-layout their
220 * components when resizing is completed. As a result the
221 * {@code Component.validate()} method will be invoked only once per resize.
222 * If dynamic layout is currently active then Containers re-layout their
223 * components on every native resize event and the {@code validate()} method
224 * will be invoked each time. The OS/WM support can be queried using the
225 * getDesktopProperty("awt.dynamicLayoutSupported") method. This property
226 * will reflect the platform capability but is not sufficient to tell if it
227 * is presently enabled.
228 *
229 * @return true if dynamic layout of Containers on resize is currently
230 * active, false otherwise.
231 * @throws HeadlessException if the GraphicsEnvironment.isHeadless() method
232 * returns true
233 * @see #setDynamicLayout(boolean dynamic)
234 * @see #isDynamicLayoutSet()
235 * @see #getDesktopProperty(String propertyName)
236 * @see java.awt.GraphicsEnvironment#isHeadless
237 * @since 1.4
238 */
239 public boolean isDynamicLayoutActive()
240 throws HeadlessException {
241 GraphicsEnvironment.checkHeadless();
242
243 if (this != Toolkit.getDefaultToolkit()) {
244 return Toolkit.getDefaultToolkit().isDynamicLayoutActive();
245 } else {
246 return false;
247 }
248 }
249
250 /**
251 * Gets the size of the screen. On systems with multiple displays, the
252 * primary display is used. Multi-screen aware display dimensions are
253 * available from {@code GraphicsConfiguration} and
254 * {@code GraphicsDevice}.
255 * @return the size of this toolkit's screen, in pixels.
256 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
257 * returns true
258 * @see java.awt.GraphicsConfiguration#getBounds
259 * @see java.awt.GraphicsDevice#getDisplayMode
260 * @see java.awt.GraphicsEnvironment#isHeadless
261 */
262 public abstract Dimension getScreenSize()
263 throws HeadlessException;
264
265 /**
266 * Returns the screen resolution in dots-per-inch.
267 * @return this toolkit's screen resolution, in dots-per-inch.
268 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
269 * returns true
270 * @see java.awt.GraphicsEnvironment#isHeadless
271 */
272 public abstract int getScreenResolution()
273 throws HeadlessException;
274
275 /**
276 * Gets the insets of the screen.
277 * @param gc a {@code GraphicsConfiguration}
278 * @return the insets of this toolkit's screen, in pixels.
279 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
280 * returns true
281 * @see java.awt.GraphicsEnvironment#isHeadless
282 * @since 1.4
283 */
284 public Insets getScreenInsets(GraphicsConfiguration gc)
285 throws HeadlessException {
286 GraphicsEnvironment.checkHeadless();
287 if (this != Toolkit.getDefaultToolkit()) {
288 return Toolkit.getDefaultToolkit().getScreenInsets(gc);
289 } else {
290 return new Insets(0, 0, 0, 0);
291 }
292 }
293
294 /**
295 * Determines the color model of this toolkit's screen.
296 * <p>
297 * {@code ColorModel} is an abstract class that
298 * encapsulates the ability to translate between the
299 * pixel values of an image and its red, green, blue,
300 * and alpha components.
301 * <p>
302 * This toolkit method is called by the
303 * {@code getColorModel} method
304 * of the {@code Component} class.
305 * @return the color model of this toolkit's screen.
306 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
307 * returns true
308 * @see java.awt.GraphicsEnvironment#isHeadless
309 * @see java.awt.image.ColorModel
310 * @see java.awt.Component#getColorModel
311 */
312 public abstract ColorModel getColorModel()
313 throws HeadlessException;
314
315 /**
316 * Returns the names of the available fonts in this toolkit.<p>
317 * For 1.1, the following font names are deprecated (the replacement
318 * name follows):
319 * <ul>
320 * <li>TimesRoman (use Serif)
321 * <li>Helvetica (use SansSerif)
322 * <li>Courier (use Monospaced)
323 * </ul><p>
324 * The ZapfDingbats fontname is also deprecated in 1.1 but the characters
325 * are defined in Unicode starting at 0x2700, and as of 1.1 Java supports
326 * those characters.
327 * @return the names of the available fonts in this toolkit.
328 * @deprecated see {@link java.awt.GraphicsEnvironment#getAvailableFontFamilyNames()}
329 * @see java.awt.GraphicsEnvironment#getAvailableFontFamilyNames()
330 */
331 @Deprecated
332 public abstract String[] getFontList();
333
334 /**
335 * Gets the screen device metrics for rendering of the font.
336 * @param font a font
337 * @return the screen metrics of the specified font in this toolkit
338 * @deprecated As of JDK version 1.2, replaced by the {@code Font}
339 * method {@code getLineMetrics}.
340 * @see java.awt.font.LineMetrics
341 * @see java.awt.Font#getLineMetrics
342 * @see java.awt.GraphicsEnvironment#getScreenDevices
343 */
344 @Deprecated
345 public abstract FontMetrics getFontMetrics(Font font);
346
347 /**
348 * Synchronizes this toolkit's graphics state. Some window systems
349 * may do buffering of graphics events.
350 * <p>
351 * This method ensures that the display is up-to-date. It is useful
352 * for animation.
353 */
354 public abstract void sync();
355
356 /**
357 * The default toolkit.
358 */
359 private static Toolkit toolkit;
360
361 /**
362 * Used internally by the assistive technologies functions; set at
363 * init time and used at load time
364 */
365 private static String atNames;
366
367 /**
368 * Initializes properties related to assistive technologies.
369 * These properties are used both in the loadAssistiveProperties()
370 * function below, as well as other classes in the jdk that depend
371 * on the properties (such as the use of the screen_magnifier_present
372 * property in Java2D hardware acceleration initialization). The
373 * initialization of the properties must be done before the platform-
374 * specific Toolkit class is instantiated so that all necessary
375 * properties are set up properly before any classes dependent upon them
376 * are initialized.
377 */
378 private static void initAssistiveTechnologies() {
379
380 // Get accessibility properties
381 final String sep = File.separator;
382 final Properties properties = new Properties();
383
384
385 atNames = java.security.AccessController.doPrivileged(
386 new java.security.PrivilegedAction<String>() {
387 public String run() {
388
389 // Try loading the per-user accessibility properties file.
390 try {
391 File propsFile = new File(
392 System.getProperty("user.home") +
393 sep + ".accessibility.properties");
394 FileInputStream in =
395 new FileInputStream(propsFile);
396
397 // Inputstream has been buffered in Properties class
398 properties.load(in);
399 in.close();
400 } catch (Exception e) {
401 // Per-user accessibility properties file does not exist
402 }
403
404 // Try loading the system-wide accessibility properties
405 // file only if a per-user accessibility properties
406 // file does not exist or is empty.
407 if (properties.size() == 0) {
408 try {
409 File propsFile = new File(
410 System.getProperty("java.home") + sep + "conf" +
411 sep + "accessibility.properties");
412 FileInputStream in =
413 new FileInputStream(propsFile);
414
415 // Inputstream has been buffered in Properties class
416 properties.load(in);
417 in.close();
418 } catch (Exception e) {
419 // System-wide accessibility properties file does
420 // not exist;
421 }
422 }
423
424 // Get whether a screen magnifier is present. First check
425 // the system property and then check the properties file.
426 String magPresent = System.getProperty("javax.accessibility.screen_magnifier_present");
427 if (magPresent == null) {
428 magPresent = properties.getProperty("screen_magnifier_present", null);
429 if (magPresent != null) {
430 System.setProperty("javax.accessibility.screen_magnifier_present", magPresent);
431 }
432 }
433
434 // Get the names of any assistive technologies to load. First
435 // check the system property and then check the properties
436 // file.
437 String classNames = System.getProperty("javax.accessibility.assistive_technologies");
438 if (classNames == null) {
439 classNames = properties.getProperty("assistive_technologies", null);
440 if (classNames != null) {
441 System.setProperty("javax.accessibility.assistive_technologies", classNames);
442 }
443 }
444 return classNames;
445 }
446 });
447 }
448
449 /**
450 * Rethrow the AWTError but include the cause.
451 *
452 * @param s the error message
453 * @param e the original exception
454 * @throws AWTError the new AWTError including the cause (the original exception)
455 */
456 private static void newAWTError(Throwable e, String s) {
457 AWTError newAWTError = new AWTError(s);
458 newAWTError.initCause(e);
459 throw newAWTError;
460 }
461
462 /**
463 * When a service provider for Assistive Technology is not found look for a
464 * supporting class on the class path and instantiate it.
465 *
466 * @param atName the name of the class to be loaded
467 */
468 private static void fallbackToLoadClassForAT(String atName) {
469 try {
470 Class<?> c = Class.forName(atName, false, ClassLoader.getSystemClassLoader());
471 c.getConstructor().newInstance();
472 } catch (ClassNotFoundException e) {
473 newAWTError(e, "Assistive Technology not found: " + atName);
474 } catch (InstantiationException e) {
475 newAWTError(e, "Could not instantiate Assistive Technology: " + atName);
476 } catch (IllegalAccessException e) {
477 newAWTError(e, "Could not access Assistive Technology: " + atName);
478 } catch (Exception e) {
479 newAWTError(e, "Error trying to install Assistive Technology: " + atName);
480 }
481 }
482
483 /**
484 * Loads accessibility support using the property assistive_technologies.
485 * The form is assistive_technologies= followed by a comma-separated list of
486 * assistive technology providers to load. The order in which providers are
487 * loaded is determined by the order in which the ServiceLoader discovers
488 * implementations of the AccessibilityProvider interface, not by the order
489 * of provider names in the property list. When a provider is found its
490 * accessibility implementation will be started by calling the provider's
491 * activate method. All errors are handled via an AWTError exception.
492 */
493 private static void loadAssistiveTechnologies() {
494 // Load any assistive technologies
495 if (atNames != null) {
496 ClassLoader cl = ClassLoader.getSystemClassLoader();
497 Set<String> names = Arrays.stream(atNames.split(","))
498 .map(String::trim)
499 .collect(Collectors.toSet());
500 final Map<String, AccessibilityProvider> providers = new HashMap<>();
501 AccessController.doPrivileged((PrivilegedAction<Void>) () -> {
502 try {
503 for (AccessibilityProvider p : ServiceLoader.load(AccessibilityProvider.class, cl)) {
504 String name = p.getName();
505 if (names.contains(name) && !providers.containsKey(name)) {
506 p.activate();
507 providers.put(name, p);
508 }
509 }
510 } catch (java.util.ServiceConfigurationError | Exception e) {
511 newAWTError(e, "Could not load or activate service provider");
512 }
513 return null;
514 });
515 names.stream()
516 .filter(n -> !providers.containsKey(n))
517 .forEach(Toolkit::fallbackToLoadClassForAT);
518 }
519 }
520
521 /**
522 * Gets the default toolkit.
523 * <p>
524 * If a system property named {@code "java.awt.headless"} is set
525 * to {@code true} then the headless implementation
526 * of {@code Toolkit} is used,
527 * otherwise the default platform-specific implementation of
528 * {@code Toolkit} is used.
529 * <p>
530 * If this Toolkit is not a headless implementation and if they exist, service
531 * providers of {@link javax.accessibility.AccessibilityProvider} will be loaded
532 * if specified by the system property
533 * {@code javax.accessibility.assistive_technologies}.
534 * <p>
535 * An example of setting this property is to invoke Java with
536 * {@code -Djavax.accessibility.assistive_technologies=MyServiceProvider}.
537 * In addition to MyServiceProvider other service providers can be specified
538 * using a comma separated list. Service providers are loaded after the AWT
539 * toolkit is created. All errors are handled via an AWTError exception.
540 * <p>
541 * The names specified in the assistive_technologies property are used to query
542 * each service provider implementation. If the requested name matches the
543 * {@linkplain AccessibilityProvider#getName name} of the service provider, the
544 * {@link AccessibilityProvider#activate} method will be invoked to activate the
545 * matching service provider.
546 *
547 * @implSpec
548 * If assistive technology service providers are not specified with a system
549 * property this implementation will look in a properties file located as follows:
550 * <ul>
551 * <li> {@code ${user.home}/.accessibility.properties}
552 * <li> {@code ${java.home}/conf/accessibility.properties}
553 * </ul>
554 * Only the first of these files to be located will be consulted. The requested
555 * service providers are specified by setting the {@code assistive_technologies=}
556 * property. A single provider or a comma separated list of providers can be
557 * specified.
558 *
559 * @return the default toolkit.
560 * @exception AWTError if a toolkit could not be found, or
561 * if one could not be accessed or instantiated.
562 * @see java.util.ServiceLoader
563 * @see javax.accessibility.AccessibilityProvider
564 */
565 public static synchronized Toolkit getDefaultToolkit() {
566 if (toolkit == null) {
567 java.security.AccessController.doPrivileged(
568 new java.security.PrivilegedAction<Void>() {
569 public Void run() {
570 Class<?> cls = null;
571 String nm = System.getProperty("awt.toolkit");
572 try {
573 cls = Class.forName(nm);
574 } catch (ClassNotFoundException e) {
575 ClassLoader cl = ClassLoader.getSystemClassLoader();
576 if (cl != null) {
577 try {
578 cls = cl.loadClass(nm);
579 } catch (final ClassNotFoundException ignored) {
580 throw new AWTError("Toolkit not found: " + nm);
581 }
582 }
583 }
584 try {
585 if (cls != null) {
586 toolkit = (Toolkit)cls.getConstructor().newInstance();
587 if (GraphicsEnvironment.isHeadless()) {
588 toolkit = new HeadlessToolkit(toolkit);
589 }
590 }
591 } catch (final ReflectiveOperationException ignored) {
592 throw new AWTError("Could not create Toolkit: " + nm);
593 }
594 return null;
595 }
596 });
597 if (!GraphicsEnvironment.isHeadless()) {
598 loadAssistiveTechnologies();
599 }
600 }
601 return toolkit;
602 }
603
604 /**
605 * Returns an image which gets pixel data from the specified file,
606 * whose format can be either GIF, JPEG or PNG.
607 * The underlying toolkit attempts to resolve multiple requests
608 * with the same filename to the same returned Image.
609 * <p>
610 * Since the mechanism required to facilitate this sharing of
611 * {@code Image} objects may continue to hold onto images
612 * that are no longer in use for an indefinite period of time,
613 * developers are encouraged to implement their own caching of
614 * images by using the {@link #createImage(java.lang.String) createImage}
615 * variant wherever available.
616 * If the image data contained in the specified file changes,
617 * the {@code Image} object returned from this method may
618 * still contain stale information which was loaded from the
619 * file after a prior call.
620 * Previously loaded image data can be manually discarded by
621 * calling the {@link Image#flush flush} method on the
622 * returned {@code Image}.
623 * <p>
624 * This method first checks if there is a security manager installed.
625 * If so, the method calls the security manager's
626 * {@code checkRead} method with the file specified to ensure
627 * that the access to the image is allowed.
628 * @param filename the name of a file containing pixel data
629 * in a recognized file format.
630 * @return an image which gets its pixel data from
631 * the specified file.
632 * @throws SecurityException if a security manager exists and its
633 * checkRead method doesn't allow the operation.
634 * @see #createImage(java.lang.String)
635 */
636 public abstract Image getImage(String filename);
637
638 /**
639 * Returns an image which gets pixel data from the specified URL.
640 * The pixel data referenced by the specified URL must be in one
641 * of the following formats: GIF, JPEG or PNG.
642 * The underlying toolkit attempts to resolve multiple requests
643 * with the same URL to the same returned Image.
644 * <p>
645 * Since the mechanism required to facilitate this sharing of
646 * {@code Image} objects may continue to hold onto images
647 * that are no longer in use for an indefinite period of time,
648 * developers are encouraged to implement their own caching of
649 * images by using the {@link #createImage(java.net.URL) createImage}
650 * variant wherever available.
651 * If the image data stored at the specified URL changes,
652 * the {@code Image} object returned from this method may
653 * still contain stale information which was fetched from the
654 * URL after a prior call.
655 * Previously loaded image data can be manually discarded by
656 * calling the {@link Image#flush flush} method on the
657 * returned {@code Image}.
658 * <p>
659 * This method first checks if there is a security manager installed.
660 * If so, the method calls the security manager's
661 * {@code checkPermission} method with the corresponding
662 * permission to ensure that the access to the image is allowed.
663 * If the connection to the specified URL requires
664 * either {@code URLPermission} or {@code SocketPermission},
665 * then {@code URLPermission} is used for security checks.
666 * For compatibility with pre-1.2 security managers, if the access
667 * is denied with {@code FilePermission} or {@code SocketPermission},
668 * the method throws the {@code SecurityException}
669 * if the corresponding 1.1-style SecurityManager.checkXXX method
670 * also denies permission.
671 * @param url the URL to use in fetching the pixel data.
672 * @return an image which gets its pixel data from
673 * the specified URL.
674 * @throws SecurityException if a security manager exists and its
675 * checkPermission method doesn't allow
676 * the operation.
677 * @see #createImage(java.net.URL)
678 */
679 public abstract Image getImage(URL url);
680
681 /**
682 * Returns an image which gets pixel data from the specified file.
683 * The returned Image is a new object which will not be shared
684 * with any other caller of this method or its getImage variant.
685 * <p>
686 * This method first checks if there is a security manager installed.
687 * If so, the method calls the security manager's
688 * {@code checkRead} method with the specified file to ensure
689 * that the image creation is allowed.
690 * @param filename the name of a file containing pixel data
691 * in a recognized file format.
692 * @return an image which gets its pixel data from
693 * the specified file.
694 * @throws SecurityException if a security manager exists and its
695 * checkRead method doesn't allow the operation.
696 * @see #getImage(java.lang.String)
697 */
698 public abstract Image createImage(String filename);
699
700 /**
701 * Returns an image which gets pixel data from the specified URL.
702 * The returned Image is a new object which will not be shared
703 * with any other caller of this method or its getImage variant.
704 * <p>
705 * This method first checks if there is a security manager installed.
706 * If so, the method calls the security manager's
707 * {@code checkPermission} method with the corresponding
708 * permission to ensure that the image creation is allowed.
709 * If the connection to the specified URL requires
710 * either {@code URLPermission} or {@code SocketPermission},
711 * then {@code URLPermission} is used for security checks.
712 * For compatibility with pre-1.2 security managers, if the access
713 * is denied with {@code FilePermission} or {@code SocketPermission},
714 * the method throws {@code SecurityException}
715 * if the corresponding 1.1-style SecurityManager.checkXXX method
716 * also denies permission.
717 * @param url the URL to use in fetching the pixel data.
718 * @return an image which gets its pixel data from
719 * the specified URL.
720 * @throws SecurityException if a security manager exists and its
721 * checkPermission method doesn't allow
722 * the operation.
723 * @see #getImage(java.net.URL)
724 */
725 public abstract Image createImage(URL url);
726
727 /**
728 * Prepares an image for rendering.
729 * <p>
730 * If the values of the width and height arguments are both
731 * {@code -1}, this method prepares the image for rendering
732 * on the default screen; otherwise, this method prepares an image
733 * for rendering on the default screen at the specified width and height.
734 * <p>
735 * The image data is downloaded asynchronously in another thread,
736 * and an appropriately scaled screen representation of the image is
737 * generated.
738 * <p>
739 * This method is called by components {@code prepareImage}
740 * methods.
741 * <p>
742 * Information on the flags returned by this method can be found
743 * with the definition of the {@code ImageObserver} interface.
744
745 * @param image the image for which to prepare a
746 * screen representation.
747 * @param width the width of the desired screen
748 * representation, or {@code -1}.
749 * @param height the height of the desired screen
750 * representation, or {@code -1}.
751 * @param observer the {@code ImageObserver}
752 * object to be notified as the
753 * image is being prepared.
754 * @return {@code true} if the image has already been
755 * fully prepared; {@code false} otherwise.
756 * @see java.awt.Component#prepareImage(java.awt.Image,
757 * java.awt.image.ImageObserver)
758 * @see java.awt.Component#prepareImage(java.awt.Image,
759 * int, int, java.awt.image.ImageObserver)
760 * @see java.awt.image.ImageObserver
761 */
762 public abstract boolean prepareImage(Image image, int width, int height,
763 ImageObserver observer);
764
765 /**
766 * Indicates the construction status of a specified image that is
767 * being prepared for display.
768 * <p>
769 * If the values of the width and height arguments are both
770 * {@code -1}, this method returns the construction status of
771 * a screen representation of the specified image in this toolkit.
772 * Otherwise, this method returns the construction status of a
773 * scaled representation of the image at the specified width
774 * and height.
775 * <p>
776 * This method does not cause the image to begin loading.
777 * An application must call {@code prepareImage} to force
778 * the loading of an image.
779 * <p>
780 * This method is called by the component's {@code checkImage}
781 * methods.
782 * <p>
783 * Information on the flags returned by this method can be found
784 * with the definition of the {@code ImageObserver} interface.
785 * @param image the image whose status is being checked.
786 * @param width the width of the scaled version whose status is
787 * being checked, or {@code -1}.
788 * @param height the height of the scaled version whose status
789 * is being checked, or {@code -1}.
790 * @param observer the {@code ImageObserver} object to be
791 * notified as the image is being prepared.
792 * @return the bitwise inclusive <strong>OR</strong> of the
793 * {@code ImageObserver} flags for the
794 * image data that is currently available.
795 * @see java.awt.Toolkit#prepareImage(java.awt.Image,
796 * int, int, java.awt.image.ImageObserver)
797 * @see java.awt.Component#checkImage(java.awt.Image,
798 * java.awt.image.ImageObserver)
799 * @see java.awt.Component#checkImage(java.awt.Image,
800 * int, int, java.awt.image.ImageObserver)
801 * @see java.awt.image.ImageObserver
802 */
803 public abstract int checkImage(Image image, int width, int height,
804 ImageObserver observer);
805
806 /**
807 * Creates an image with the specified image producer.
808 * @param producer the image producer to be used.
809 * @return an image with the specified image producer.
810 * @see java.awt.Image
811 * @see java.awt.image.ImageProducer
812 * @see java.awt.Component#createImage(java.awt.image.ImageProducer)
813 */
814 public abstract Image createImage(ImageProducer producer);
815
816 /**
817 * Creates an image which decodes the image stored in the specified
818 * byte array.
819 * <p>
820 * The data must be in some image format, such as GIF or JPEG,
821 * that is supported by this toolkit.
822 * @param imagedata an array of bytes, representing
823 * image data in a supported image format.
824 * @return an image.
825 * @since 1.1
826 */
827 public Image createImage(byte[] imagedata) {
828 return createImage(imagedata, 0, imagedata.length);
829 }
830
831 /**
832 * Creates an image which decodes the image stored in the specified
833 * byte array, and at the specified offset and length.
834 * The data must be in some image format, such as GIF or JPEG,
835 * that is supported by this toolkit.
836 * @param imagedata an array of bytes, representing
837 * image data in a supported image format.
838 * @param imageoffset the offset of the beginning
839 * of the data in the array.
840 * @param imagelength the length of the data in the array.
841 * @return an image.
842 * @since 1.1
843 */
844 public abstract Image createImage(byte[] imagedata,
845 int imageoffset,
846 int imagelength);
847
848 /**
849 * Gets a {@code PrintJob} object which is the result of initiating
850 * a print operation on the toolkit's platform.
851 * <p>
852 * Each actual implementation of this method should first check if there
853 * is a security manager installed. If there is, the method should call
854 * the security manager's {@code checkPrintJobAccess} method to
855 * ensure initiation of a print operation is allowed. If the default
856 * implementation of {@code checkPrintJobAccess} is used (that is,
857 * that method is not overriden), then this results in a call to the
858 * security manager's {@code checkPermission} method with a
859 * {@code RuntimePermission("queuePrintJob")} permission.
860 *
861 * @param frame the parent of the print dialog. May not be null.
862 * @param jobtitle the title of the PrintJob. A null title is equivalent
863 * to "".
864 * @param props a Properties object containing zero or more properties.
865 * Properties are not standardized and are not consistent across
866 * implementations. Because of this, PrintJobs which require job
867 * and page control should use the version of this function which
868 * takes JobAttributes and PageAttributes objects. This object
869 * may be updated to reflect the user's job choices on exit. May
870 * be null.
871 * @return a {@code PrintJob} object, or {@code null} if the
872 * user cancelled the print job.
873 * @throws NullPointerException if frame is null
874 * @throws SecurityException if this thread is not allowed to initiate a
875 * print job request
876 * @see java.awt.GraphicsEnvironment#isHeadless
877 * @see java.awt.PrintJob
878 * @see java.lang.RuntimePermission
879 * @since 1.1
880 */
881 public abstract PrintJob getPrintJob(Frame frame, String jobtitle,
882 Properties props);
883
884 /**
885 * Gets a {@code PrintJob} object which is the result of initiating
886 * a print operation on the toolkit's platform.
887 * <p>
888 * Each actual implementation of this method should first check if there
889 * is a security manager installed. If there is, the method should call
890 * the security manager's {@code checkPrintJobAccess} method to
891 * ensure initiation of a print operation is allowed. If the default
892 * implementation of {@code checkPrintJobAccess} is used (that is,
893 * that method is not overriden), then this results in a call to the
894 * security manager's {@code checkPermission} method with a
895 * {@code RuntimePermission("queuePrintJob")} permission.
896 *
897 * @param frame the parent of the print dialog. May not be null.
898 * @param jobtitle the title of the PrintJob. A null title is equivalent
899 * to "".
900 * @param jobAttributes a set of job attributes which will control the
901 * PrintJob. The attributes will be updated to reflect the user's
902 * choices as outlined in the JobAttributes documentation. May be
903 * null.
904 * @param pageAttributes a set of page attributes which will control the
905 * PrintJob. The attributes will be applied to every page in the
906 * job. The attributes will be updated to reflect the user's
907 * choices as outlined in the PageAttributes documentation. May be
908 * null.
909 * @return a {@code PrintJob} object, or {@code null} if the
910 * user cancelled the print job.
911 * @throws NullPointerException if frame is null
912 * @throws IllegalArgumentException if pageAttributes specifies differing
913 * cross feed and feed resolutions. Also if this thread has
914 * access to the file system and jobAttributes specifies
915 * print to file, and the specified destination file exists but
916 * is a directory rather than a regular file, does not exist but
917 * cannot be created, or cannot be opened for any other reason.
918 * However in the case of print to file, if a dialog is also
919 * requested to be displayed then the user will be given an
920 * opportunity to select a file and proceed with printing.
921 * The dialog will ensure that the selected output file
922 * is valid before returning from this method.
923 * @throws SecurityException if this thread is not allowed to initiate a
924 * print job request, or if jobAttributes specifies print to file,
925 * and this thread is not allowed to access the file system
926 * @see java.awt.PrintJob
927 * @see java.awt.GraphicsEnvironment#isHeadless
928 * @see java.lang.RuntimePermission
929 * @see java.awt.JobAttributes
930 * @see java.awt.PageAttributes
931 * @since 1.3
932 */
933 public PrintJob getPrintJob(Frame frame, String jobtitle,
934 JobAttributes jobAttributes,
935 PageAttributes pageAttributes) {
936 // Override to add printing support with new job/page control classes
937
938 if (this != Toolkit.getDefaultToolkit()) {
939 return Toolkit.getDefaultToolkit().getPrintJob(frame, jobtitle,
940 jobAttributes,
941 pageAttributes);
942 } else {
943 return getPrintJob(frame, jobtitle, null);
944 }
945 }
946
947 /**
948 * Emits an audio beep depending on native system settings and hardware
949 * capabilities.
950 * @since 1.1
951 */
952 public abstract void beep();
953
954 /**
955 * Gets the singleton instance of the system Clipboard which interfaces
956 * with clipboard facilities provided by the native platform. This
957 * clipboard enables data transfer between Java programs and native
958 * applications which use native clipboard facilities.
959 * <p>
960 * In addition to any and all default formats text returned by the system
961 * Clipboard's {@code getTransferData()} method is available in the
962 * following flavors:
963 * <ul>
964 * <li>DataFlavor.stringFlavor</li>
965 * <li>DataFlavor.plainTextFlavor (<b>deprecated</b>)</li>
966 * </ul>
967 * As with {@code java.awt.datatransfer.StringSelection}, if the
968 * requested flavor is {@code DataFlavor.plainTextFlavor}, or an
969 * equivalent flavor, a Reader is returned. <b>Note:</b> The behavior of
970 * the system Clipboard's {@code getTransferData()} method for
971 * {@code DataFlavor.plainTextFlavor}, and equivalent DataFlavors, is
972 * inconsistent with the definition of {@code DataFlavor.plainTextFlavor}.
973 * Because of this, support for
974 * {@code DataFlavor.plainTextFlavor}, and equivalent flavors, is
975 * <b>deprecated</b>.
976 * <p>
977 * Each actual implementation of this method should first check if there
978 * is a security manager installed. If there is, the method should call
979 * the security manager's {@link SecurityManager#checkPermission
980 * checkPermission} method to check {@code AWTPermission("accessClipboard")}.
981 *
982 * @return the system Clipboard
983 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
984 * returns true
985 * @see java.awt.GraphicsEnvironment#isHeadless
986 * @see java.awt.datatransfer.Clipboard
987 * @see java.awt.datatransfer.StringSelection
988 * @see java.awt.datatransfer.DataFlavor#stringFlavor
989 * @see java.awt.datatransfer.DataFlavor#plainTextFlavor
990 * @see java.io.Reader
991 * @see java.awt.AWTPermission
992 * @since 1.1
993 */
994 public abstract Clipboard getSystemClipboard()
995 throws HeadlessException;
996
997 /**
998 * Gets the singleton instance of the system selection as a
999 * {@code Clipboard} object. This allows an application to read and
1000 * modify the current, system-wide selection.
1001 * <p>
1002 * An application is responsible for updating the system selection whenever
1003 * the user selects text, using either the mouse or the keyboard.
1004 * Typically, this is implemented by installing a
1005 * {@code FocusListener} on all {@code Component}s which support
1006 * text selection, and, between {@code FOCUS_GAINED} and
1007 * {@code FOCUS_LOST} events delivered to that {@code Component},
1008 * updating the system selection {@code Clipboard} when the selection
1009 * changes inside the {@code Component}. Properly updating the system
1010 * selection ensures that a Java application will interact correctly with
1011 * native applications and other Java applications running simultaneously
1012 * on the system. Note that {@code java.awt.TextComponent} and
1013 * {@code javax.swing.text.JTextComponent} already adhere to this
1014 * policy. When using these classes, and their subclasses, developers need
1015 * not write any additional code.
1016 * <p>
1017 * Some platforms do not support a system selection {@code Clipboard}.
1018 * On those platforms, this method will return {@code null}. In such a
1019 * case, an application is absolved from its responsibility to update the
1020 * system selection {@code Clipboard} as described above.
1021 * <p>
1022 * Each actual implementation of this method should first check if there
1023 * is a security manager installed. If there is, the method should call
1024 * the security manager's {@link SecurityManager#checkPermission
1025 * checkPermission} method to check {@code AWTPermission("accessClipboard")}.
1026 *
1027 * @return the system selection as a {@code Clipboard}, or
1028 * {@code null} if the native platform does not support a
1029 * system selection {@code Clipboard}
1030 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
1031 * returns true
1032 *
1033 * @see java.awt.datatransfer.Clipboard
1034 * @see java.awt.event.FocusListener
1035 * @see java.awt.event.FocusEvent#FOCUS_GAINED
1036 * @see java.awt.event.FocusEvent#FOCUS_LOST
1037 * @see TextComponent
1038 * @see javax.swing.text.JTextComponent
1039 * @see AWTPermission
1040 * @see GraphicsEnvironment#isHeadless
1041 * @since 1.4
1042 */
1043 public Clipboard getSystemSelection() throws HeadlessException {
1044 GraphicsEnvironment.checkHeadless();
1045
1046 if (this != Toolkit.getDefaultToolkit()) {
1047 return Toolkit.getDefaultToolkit().getSystemSelection();
1048 } else {
1049 GraphicsEnvironment.checkHeadless();
1050 return null;
1051 }
1052 }
1053
1054 /**
1055 * Determines which modifier key is the appropriate accelerator
1056 * key for menu shortcuts.
1057 * <p>
1058 * Menu shortcuts, which are embodied in the
1059 * {@code MenuShortcut} class, are handled by the
1060 * {@code MenuBar} class.
1061 * <p>
1062 * By default, this method returns {@code Event.CTRL_MASK}.
1063 * Toolkit implementations should override this method if the
1064 * <b>Control</b> key isn't the correct key for accelerators.
1065 * @return the modifier mask on the {@code Event} class
1066 * that is used for menu shortcuts on this toolkit.
1067 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
1068 * returns true
1069 * @see java.awt.GraphicsEnvironment#isHeadless
1070 * @see java.awt.MenuBar
1071 * @see java.awt.MenuShortcut
1072 * @since 1.1
1073 */
1074 @SuppressWarnings("deprecation")
1075 public int getMenuShortcutKeyMask() throws HeadlessException {
1076 GraphicsEnvironment.checkHeadless();
1077
1078 return Event.CTRL_MASK;
1079 }
1080
1081 /**
1082 * Returns whether the given locking key on the keyboard is currently in
1083 * its "on" state.
1084 * Valid key codes are
1085 * {@link java.awt.event.KeyEvent#VK_CAPS_LOCK VK_CAPS_LOCK},
1086 * {@link java.awt.event.KeyEvent#VK_NUM_LOCK VK_NUM_LOCK},
1087 * {@link java.awt.event.KeyEvent#VK_SCROLL_LOCK VK_SCROLL_LOCK}, and
1088 * {@link java.awt.event.KeyEvent#VK_KANA_LOCK VK_KANA_LOCK}.
1089 *
1090 * @param keyCode the key code
1091 * @return {@code true} if the given key is currently in its "on" state;
1092 * otherwise {@code false}
1093 * @exception java.lang.IllegalArgumentException if {@code keyCode}
1094 * is not one of the valid key codes
1095 * @exception java.lang.UnsupportedOperationException if the host system doesn't
1096 * allow getting the state of this key programmatically, or if the keyboard
1097 * doesn't have this key
1098 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
1099 * returns true
1100 * @see java.awt.GraphicsEnvironment#isHeadless
1101 * @since 1.3
1102 */
1103 public boolean getLockingKeyState(int keyCode)
1104 throws UnsupportedOperationException
1105 {
1106 GraphicsEnvironment.checkHeadless();
1107
1108 if (! (keyCode == KeyEvent.VK_CAPS_LOCK || keyCode == KeyEvent.VK_NUM_LOCK ||
1109 keyCode == KeyEvent.VK_SCROLL_LOCK || keyCode == KeyEvent.VK_KANA_LOCK)) {
1110 throw new IllegalArgumentException("invalid key for Toolkit.getLockingKeyState");
1111 }
1112 throw new UnsupportedOperationException("Toolkit.getLockingKeyState");
1113 }
1114
1115 /**
1116 * Sets the state of the given locking key on the keyboard.
1117 * Valid key codes are
1118 * {@link java.awt.event.KeyEvent#VK_CAPS_LOCK VK_CAPS_LOCK},
1119 * {@link java.awt.event.KeyEvent#VK_NUM_LOCK VK_NUM_LOCK},
1120 * {@link java.awt.event.KeyEvent#VK_SCROLL_LOCK VK_SCROLL_LOCK}, and
1121 * {@link java.awt.event.KeyEvent#VK_KANA_LOCK VK_KANA_LOCK}.
1122 * <p>
1123 * Depending on the platform, setting the state of a locking key may
1124 * involve event processing and therefore may not be immediately
1125 * observable through getLockingKeyState.
1126 *
1127 * @param keyCode the key code
1128 * @param on the state of the key
1129 * @exception java.lang.IllegalArgumentException if {@code keyCode}
1130 * is not one of the valid key codes
1131 * @exception java.lang.UnsupportedOperationException if the host system doesn't
1132 * allow setting the state of this key programmatically, or if the keyboard
1133 * doesn't have this key
1134 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
1135 * returns true
1136 * @see java.awt.GraphicsEnvironment#isHeadless
1137 * @since 1.3
1138 */
1139 public void setLockingKeyState(int keyCode, boolean on)
1140 throws UnsupportedOperationException
1141 {
1142 GraphicsEnvironment.checkHeadless();
1143
1144 if (! (keyCode == KeyEvent.VK_CAPS_LOCK || keyCode == KeyEvent.VK_NUM_LOCK ||
1145 keyCode == KeyEvent.VK_SCROLL_LOCK || keyCode == KeyEvent.VK_KANA_LOCK)) {
1146 throw new IllegalArgumentException("invalid key for Toolkit.setLockingKeyState");
1147 }
1148 throw new UnsupportedOperationException("Toolkit.setLockingKeyState");
1149 }
1150
1151 /**
1152 * Give native peers the ability to query the native container
1153 * given a native component (eg the direct parent may be lightweight).
1154 *
1155 * @param c the component to fetch the container for
1156 * @return the native container object for the component
1157 */
1158 protected static Container getNativeContainer(Component c) {
1159 return c.getNativeContainer();
1160 }
1161
1162 /**
1163 * Creates a new custom cursor object.
1164 * If the image to display is invalid, the cursor will be hidden (made
1165 * completely transparent), and the hotspot will be set to (0, 0).
1166 *
1167 * <p>Note that multi-frame images are invalid and may cause this
1168 * method to hang.
1169 *
1170 * @param cursor the image to display when the cursor is activated
1171 * @param hotSpot the X and Y of the large cursor's hot spot; the
1172 * hotSpot values must be less than the Dimension returned by
1173 * {@code getBestCursorSize}
1174 * @param name a localized description of the cursor, for Java Accessibility use
1175 * @exception IndexOutOfBoundsException if the hotSpot values are outside
1176 * the bounds of the cursor
1177 * @return the cursor created
1178 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
1179 * returns true
1180 * @see java.awt.GraphicsEnvironment#isHeadless
1181 * @since 1.2
1182 */
1183 public Cursor createCustomCursor(Image cursor, Point hotSpot, String name)
1184 throws IndexOutOfBoundsException, HeadlessException
1185 {
1186 // Override to implement custom cursor support.
1187 if (this != Toolkit.getDefaultToolkit()) {
1188 return Toolkit.getDefaultToolkit().
1189 createCustomCursor(cursor, hotSpot, name);
1190 } else {
1191 return new Cursor(Cursor.DEFAULT_CURSOR);
1192 }
1193 }
1194
1195 /**
1196 * Returns the supported cursor dimension which is closest to the desired
1197 * sizes. Systems which only support a single cursor size will return that
1198 * size regardless of the desired sizes. Systems which don't support custom
1199 * cursors will return a dimension of 0, 0. <p>
1200 * Note: if an image is used whose dimensions don't match a supported size
1201 * (as returned by this method), the Toolkit implementation will attempt to
1202 * resize the image to a supported size.
1203 * Since converting low-resolution images is difficult,
1204 * no guarantees are made as to the quality of a cursor image which isn't a
1205 * supported size. It is therefore recommended that this method
1206 * be called and an appropriate image used so no image conversion is made.
1207 *
1208 * @param preferredWidth the preferred cursor width the component would like
1209 * to use.
1210 * @param preferredHeight the preferred cursor height the component would like
1211 * to use.
1212 * @return the closest matching supported cursor size, or a dimension of 0,0 if
1213 * the Toolkit implementation doesn't support custom cursors.
1214 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
1215 * returns true
1216 * @see java.awt.GraphicsEnvironment#isHeadless
1217 * @since 1.2
1218 */
1219 public Dimension getBestCursorSize(int preferredWidth,
1220 int preferredHeight) throws HeadlessException {
1221 GraphicsEnvironment.checkHeadless();
1222
1223 // Override to implement custom cursor support.
1224 if (this != Toolkit.getDefaultToolkit()) {
1225 return Toolkit.getDefaultToolkit().
1226 getBestCursorSize(preferredWidth, preferredHeight);
1227 } else {
1228 return new Dimension(0, 0);
1229 }
1230 }
1231
1232 /**
1233 * Returns the maximum number of colors the Toolkit supports in a custom cursor
1234 * palette.<p>
1235 * Note: if an image is used which has more colors in its palette than
1236 * the supported maximum, the Toolkit implementation will attempt to flatten the
1237 * palette to the maximum. Since converting low-resolution images is difficult,
1238 * no guarantees are made as to the quality of a cursor image which has more
1239 * colors than the system supports. It is therefore recommended that this method
1240 * be called and an appropriate image used so no image conversion is made.
1241 *
1242 * @return the maximum number of colors, or zero if custom cursors are not
1243 * supported by this Toolkit implementation.
1244 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
1245 * returns true
1246 * @see java.awt.GraphicsEnvironment#isHeadless
1247 * @since 1.2
1248 */
1249 public int getMaximumCursorColors() throws HeadlessException {
1250 GraphicsEnvironment.checkHeadless();
1251
1252 // Override to implement custom cursor support.
1253 if (this != Toolkit.getDefaultToolkit()) {
1254 return Toolkit.getDefaultToolkit().getMaximumCursorColors();
1255 } else {
1256 return 0;
1257 }
1258 }
1259
1260 /**
1261 * Returns whether Toolkit supports this state for
1262 * {@code Frame}s. This method tells whether the <em>UI
1263 * concept</em> of, say, maximization or iconification is
1264 * supported. It will always return false for "compound" states
1265 * like {@code Frame.ICONIFIED|Frame.MAXIMIZED_VERT}.
1266 * In other words, the rule of thumb is that only queries with a
1267 * single frame state constant as an argument are meaningful.
1268 * <p>Note that supporting a given concept is a platform-
1269 * dependent feature. Due to native limitations the Toolkit
1270 * object may report a particular state as supported, however at
1271 * the same time the Toolkit object will be unable to apply the
1272 * state to a given frame. This circumstance has two following
1273 * consequences:
1274 * <ul>
1275 * <li>Only the return value of {@code false} for the present
1276 * method actually indicates that the given state is not
1277 * supported. If the method returns {@code true} the given state
1278 * may still be unsupported and/or unavailable for a particular
1279 * frame.
1280 * <li>The developer should consider examining the value of the
1281 * {@link java.awt.event.WindowEvent#getNewState} method of the
1282 * {@code WindowEvent} received through the {@link
1283 * java.awt.event.WindowStateListener}, rather than assuming
1284 * that the state given to the {@code setExtendedState()} method
1285 * will be definitely applied. For more information see the
1286 * documentation for the {@link Frame#setExtendedState} method.
1287 * </ul>
1288 *
1289 * @param state one of named frame state constants.
1290 * @return {@code true} is this frame state is supported by
1291 * this Toolkit implementation, {@code false} otherwise.
1292 * @exception HeadlessException
1293 * if {@code GraphicsEnvironment.isHeadless()}
1294 * returns {@code true}.
1295 * @see java.awt.Window#addWindowStateListener
1296 * @since 1.4
1297 */
1298 public boolean isFrameStateSupported(int state)
1299 throws HeadlessException
1300 {
1301 GraphicsEnvironment.checkHeadless();
1302
1303 if (this != Toolkit.getDefaultToolkit()) {
1304 return Toolkit.getDefaultToolkit().
1305 isFrameStateSupported(state);
1306 } else {
1307 return (state == Frame.NORMAL); // others are not guaranteed
1308 }
1309 }
1310
1311 /**
1312 * Support for I18N: any visible strings should be stored in
1313 * sun.awt.resources.awt.properties. The ResourceBundle is stored
1314 * here, so that only one copy is maintained.
1315 */
1316 private static ResourceBundle resources;
1317 private static ResourceBundle platformResources;
1318
1319 // called by platform toolkit
1320 private static void setPlatformResources(ResourceBundle bundle) {
1321 platformResources = bundle;
1322 }
1323
1324 /**
1325 * Initialize JNI field and method ids
1326 */
1327 private static native void initIDs();
1328
1329 /**
1330 * WARNING: This is a temporary workaround for a problem in the
1331 * way the AWT loads native libraries. A number of classes in the
1332 * AWT package have a native method, initIDs(), which initializes
1333 * the JNI field and method ids used in the native portion of
1334 * their implementation.
1335 *
1336 * Since the use and storage of these ids is done by the
1337 * implementation libraries, the implementation of these method is
1338 * provided by the particular AWT implementations (for example,
1339 * "Toolkit"s/Peer), such as Motif, Microsoft Windows, or Tiny. The
1340 * problem is that this means that the native libraries must be
1341 * loaded by the java.* classes, which do not necessarily know the
1342 * names of the libraries to load. A better way of doing this
1343 * would be to provide a separate library which defines java.awt.*
1344 * initIDs, and exports the relevant symbols out to the
1345 * implementation libraries.
1346 *
1347 * For now, we know it's done by the implementation, and we assume
1348 * that the name of the library is "awt". -br.
1349 *
1350 * If you change loadLibraries(), please add the change to
1351 * java.awt.image.ColorModel.loadLibraries(). Unfortunately,
1352 * classes can be loaded in java.awt.image that depend on
1353 * libawt and there is no way to call Toolkit.loadLibraries()
1354 * directly. -hung
1355 */
1356 private static boolean loaded = false;
1357 static void loadLibraries() {
1358 if (!loaded) {
1359 java.security.AccessController.doPrivileged(
1360 new java.security.PrivilegedAction<Void>() {
1361 public Void run() {
1362 System.loadLibrary("awt");
1363 return null;
1364 }
1365 });
1366 loaded = true;
1367 }
1368 }
1369
1370 static {
1371 AWTAccessor.setToolkitAccessor(
1372 new AWTAccessor.ToolkitAccessor() {
1373 @Override
1374 public void setPlatformResources(ResourceBundle bundle) {
1375 Toolkit.setPlatformResources(bundle);
1376 }
1377 });
1378
1379 java.security.AccessController.doPrivileged(
1380 new java.security.PrivilegedAction<Void>() {
1381 public Void run() {
1382 try {
1383 resources = ResourceBundle.getBundle("sun.awt.resources.awt");
1384 } catch (MissingResourceException e) {
1385 // No resource file; defaults will be used.
1386 }
1387 return null;
1388 }
1389 });
1390
1391 // ensure that the proper libraries are loaded
1392 loadLibraries();
1393 initAssistiveTechnologies();
1394 initIDs();
1395 }
1396
1397 /**
1398 * Gets a property with the specified key and default.
1399 * This method returns defaultValue if the property is not found.
1400 *
1401 * @param key the key
1402 * @param defaultValue the default value
1403 * @return the value of the property or the default value
1404 * if the property was not found
1405 */
1406 public static String getProperty(String key, String defaultValue) {
1407 // first try platform specific bundle
1408 if (platformResources != null) {
1409 try {
1410 return platformResources.getString(key);
1411 }
1412 catch (MissingResourceException e) {}
1413 }
1414
1415 // then shared one
1416 if (resources != null) {
1417 try {
1418 return resources.getString(key);
1419 }
1420 catch (MissingResourceException e) {}
1421 }
1422
1423 return defaultValue;
1424 }
1425
1426 /**
1427 * Get the application's or applet's EventQueue instance.
1428 * Depending on the Toolkit implementation, different EventQueues
1429 * may be returned for different applets. Applets should
1430 * therefore not assume that the EventQueue instance returned
1431 * by this method will be shared by other applets or the system.
1432 *
1433 * <p> If there is a security manager then its
1434 * {@link SecurityManager#checkPermission checkPermission} method
1435 * is called to check {@code AWTPermission("accessEventQueue")}.
1436 *
1437 * @return the {@code EventQueue} object
1438 * @throws SecurityException
1439 * if a security manager is set and it denies access to
1440 * the {@code EventQueue}
1441 * @see java.awt.AWTPermission
1442 */
1443 public final EventQueue getSystemEventQueue() {
1444 SecurityManager security = System.getSecurityManager();
1445 if (security != null) {
1446 security.checkPermission(AWTPermissions.CHECK_AWT_EVENTQUEUE_PERMISSION);
1447 }
1448 return getSystemEventQueueImpl();
1449 }
1450
1451 /**
1452 * Gets the application's or applet's {@code EventQueue}
1453 * instance, without checking access. For security reasons,
1454 * this can only be called from a {@code Toolkit} subclass.
1455 * @return the {@code EventQueue} object
1456 */
1457 protected abstract EventQueue getSystemEventQueueImpl();
1458
1459 /* Accessor method for use by AWT package routines. */
1460 static EventQueue getEventQueue() {
1461 return getDefaultToolkit().getSystemEventQueueImpl();
1462 }
1463
1464 /**
1465 * Creates a concrete, platform dependent, subclass of the abstract
1466 * DragGestureRecognizer class requested, and associates it with the
1467 * DragSource, Component and DragGestureListener specified.
1468 *
1469 * subclasses should override this to provide their own implementation
1470 *
1471 * @param <T> the type of DragGestureRecognizer to create
1472 * @param abstractRecognizerClass The abstract class of the required recognizer
1473 * @param ds The DragSource
1474 * @param c The Component target for the DragGestureRecognizer
1475 * @param srcActions The actions permitted for the gesture
1476 * @param dgl The DragGestureListener
1477 *
1478 * @return the new object or null. Always returns null if
1479 * GraphicsEnvironment.isHeadless() returns true.
1480 * @see java.awt.GraphicsEnvironment#isHeadless
1481 */
1482 public <T extends DragGestureRecognizer> T
1483 createDragGestureRecognizer(Class<T> abstractRecognizerClass,
1484 DragSource ds, Component c, int srcActions,
1485 DragGestureListener dgl)
1486 {
1487 return null;
1488 }
1489
1490 /**
1491 * Obtains a value for the specified desktop property.
1492 *
1493 * A desktop property is a uniquely named value for a resource that
1494 * is Toolkit global in nature. Usually it also is an abstract
1495 * representation for an underlying platform dependent desktop setting.
1496 * For more information on desktop properties supported by the AWT see
1497 * <a href="doc-files/DesktopProperties.html">AWT Desktop Properties</a>.
1498 *
1499 * @param propertyName the property name
1500 * @return the value for the specified desktop property
1501 */
1502 public final synchronized Object getDesktopProperty(String propertyName) {
1503 // This is a workaround for headless toolkits. It would be
1504 // better to override this method but it is declared final.
1505 // "this instanceof" syntax defeats polymorphism.
1506 // --mm, 03/03/00
1507 if (this instanceof HeadlessToolkit) {
1508 return ((HeadlessToolkit)this).getUnderlyingToolkit()
1509 .getDesktopProperty(propertyName);
1510 }
1511
1512 if (desktopProperties.isEmpty()) {
1513 initializeDesktopProperties();
1514 }
1515
1516 Object value;
1517
1518 // This property should never be cached
1519 if (propertyName.equals("awt.dynamicLayoutSupported")) {
1520 return getDefaultToolkit().lazilyLoadDesktopProperty(propertyName);
1521 }
1522
1523 value = desktopProperties.get(propertyName);
1524
1525 if (value == null) {
1526 value = lazilyLoadDesktopProperty(propertyName);
1527
1528 if (value != null) {
1529 setDesktopProperty(propertyName, value);
1530 }
1531 }
1532
1533 /* for property "awt.font.desktophints" */
1534 if (value instanceof RenderingHints) {
1535 value = ((RenderingHints)value).clone();
1536 }
1537
1538 return value;
1539 }
1540
1541 /**
1542 * Sets the named desktop property to the specified value and fires a
1543 * property change event to notify any listeners that the value has changed.
1544 *
1545 * @param name the property name
1546 * @param newValue the new property value
1547 */
1548 protected final void setDesktopProperty(String name, Object newValue) {
1549 // This is a workaround for headless toolkits. It would be
1550 // better to override this method but it is declared final.
1551 // "this instanceof" syntax defeats polymorphism.
1552 // --mm, 03/03/00
1553 if (this instanceof HeadlessToolkit) {
1554 ((HeadlessToolkit)this).getUnderlyingToolkit()
1555 .setDesktopProperty(name, newValue);
1556 return;
1557 }
1558 Object oldValue;
1559
1560 synchronized (this) {
1561 oldValue = desktopProperties.get(name);
1562 desktopProperties.put(name, newValue);
1563 }
1564
1565 // Don't fire change event if old and new values are null.
1566 // It helps to avoid recursive resending of WM_THEMECHANGED
1567 if (oldValue != null || newValue != null) {
1568 desktopPropsSupport.firePropertyChange(name, oldValue, newValue);
1569 }
1570 }
1571
1572 /**
1573 * An opportunity to lazily evaluate desktop property values.
1574 * @return the desktop property or null
1575 * @param name the name
1576 */
1577 protected Object lazilyLoadDesktopProperty(String name) {
1578 return null;
1579 }
1580
1581 /**
1582 * initializeDesktopProperties
1583 */
1584 protected void initializeDesktopProperties() {
1585 }
1586
1587 /**
1588 * Adds the specified property change listener for the named desktop
1589 * property. When a {@link java.beans.PropertyChangeListenerProxy} object is added,
1590 * its property name is ignored, and the wrapped listener is added.
1591 * If {@code name} is {@code null} or {@code pcl} is {@code null},
1592 * no exception is thrown and no action is performed.
1593 *
1594 * @param name The name of the property to listen for
1595 * @param pcl The property change listener
1596 * @see PropertyChangeSupport#addPropertyChangeListener(String,
1597 PropertyChangeListener)
1598 * @since 1.2
1599 */
1600 public void addPropertyChangeListener(String name, PropertyChangeListener pcl) {
1601 desktopPropsSupport.addPropertyChangeListener(name, pcl);
1602 }
1603
1604 /**
1605 * Removes the specified property change listener for the named
1606 * desktop property. When a {@link java.beans.PropertyChangeListenerProxy} object
1607 * is removed, its property name is ignored, and
1608 * the wrapped listener is removed.
1609 * If {@code name} is {@code null} or {@code pcl} is {@code null},
1610 * no exception is thrown and no action is performed.
1611 *
1612 * @param name The name of the property to remove
1613 * @param pcl The property change listener
1614 * @see PropertyChangeSupport#removePropertyChangeListener(String,
1615 PropertyChangeListener)
1616 * @since 1.2
1617 */
1618 public void removePropertyChangeListener(String name, PropertyChangeListener pcl) {
1619 desktopPropsSupport.removePropertyChangeListener(name, pcl);
1620 }
1621
1622 /**
1623 * Returns an array of all the property change listeners
1624 * registered on this toolkit. The returned array
1625 * contains {@link java.beans.PropertyChangeListenerProxy} objects
1626 * that associate listeners with the names of desktop properties.
1627 *
1628 * @return all of this toolkit's {@link PropertyChangeListener}
1629 * objects wrapped in {@code java.beans.PropertyChangeListenerProxy} objects
1630 * or an empty array if no listeners are added
1631 *
1632 * @see PropertyChangeSupport#getPropertyChangeListeners()
1633 * @since 1.4
1634 */
1635 public PropertyChangeListener[] getPropertyChangeListeners() {
1636 return desktopPropsSupport.getPropertyChangeListeners();
1637 }
1638
1639 /**
1640 * Returns an array of all property change listeners
1641 * associated with the specified name of a desktop property.
1642 *
1643 * @param propertyName the named property
1644 * @return all of the {@code PropertyChangeListener} objects
1645 * associated with the specified name of a desktop property
1646 * or an empty array if no such listeners are added
1647 *
1648 * @see PropertyChangeSupport#getPropertyChangeListeners(String)
1649 * @since 1.4
1650 */
1651 public PropertyChangeListener[] getPropertyChangeListeners(String propertyName) {
1652 return desktopPropsSupport.getPropertyChangeListeners(propertyName);
1653 }
1654
1655 /**
1656 * The desktop properties.
1657 */
1658 protected final Map<String,Object> desktopProperties =
1659 new HashMap<String,Object>();
1660 /**
1661 * The desktop properties change support.
1662 */
1663 protected final PropertyChangeSupport desktopPropsSupport =
1664 Toolkit.createPropertyChangeSupport(this);
1665
1666 /**
1667 * Returns whether the always-on-top mode is supported by this toolkit.
1668 * To detect whether the always-on-top mode is supported for a
1669 * particular Window, use {@link Window#isAlwaysOnTopSupported}.
1670 * @return {@code true}, if current toolkit supports the always-on-top mode,
1671 * otherwise returns {@code false}
1672 * @see Window#isAlwaysOnTopSupported
1673 * @see Window#setAlwaysOnTop(boolean)
1674 * @since 1.6
1675 */
1676 public boolean isAlwaysOnTopSupported() {
1677 return true;
1678 }
1679
1680 /**
1681 * Returns whether the given modality type is supported by this toolkit. If
1682 * a dialog with unsupported modality type is created, then
1683 * {@code Dialog.ModalityType.MODELESS} is used instead.
1684 *
1685 * @param modalityType modality type to be checked for support by this toolkit
1686 *
1687 * @return {@code true}, if current toolkit supports given modality
1688 * type, {@code false} otherwise
1689 *
1690 * @see java.awt.Dialog.ModalityType
1691 * @see java.awt.Dialog#getModalityType
1692 * @see java.awt.Dialog#setModalityType
1693 *
1694 * @since 1.6
1695 */
1696 public abstract boolean isModalityTypeSupported(Dialog.ModalityType modalityType);
1697
1698 /**
1699 * Returns whether the given modal exclusion type is supported by this
1700 * toolkit. If an unsupported modal exclusion type property is set on a window,
1701 * then {@code Dialog.ModalExclusionType.NO_EXCLUDE} is used instead.
1702 *
1703 * @param modalExclusionType modal exclusion type to be checked for support by this toolkit
1704 *
1705 * @return {@code true}, if current toolkit supports given modal exclusion
1706 * type, {@code false} otherwise
1707 *
1708 * @see java.awt.Dialog.ModalExclusionType
1709 * @see java.awt.Window#getModalExclusionType
1710 * @see java.awt.Window#setModalExclusionType
1711 *
1712 * @since 1.6
1713 */
1714 public abstract boolean isModalExclusionTypeSupported(Dialog.ModalExclusionType modalExclusionType);
1715
1716 // 8014718: logging has been removed from SunToolkit
1717
1718 private static final int LONG_BITS = 64;
1719 private int[] calls = new int[LONG_BITS];
1720 private static volatile long enabledOnToolkitMask;
1721 private AWTEventListener eventListener = null;
1722 private WeakHashMap<AWTEventListener, SelectiveAWTEventListener> listener2SelectiveListener = new WeakHashMap<>();
1723
1724 /*
1725 * Extracts a "pure" AWTEventListener from a AWTEventListenerProxy,
1726 * if the listener is proxied.
1727 */
1728 private static AWTEventListener deProxyAWTEventListener(AWTEventListener l)
1729 {
1730 AWTEventListener localL = l;
1731
1732 if (localL == null) {
1733 return null;
1734 }
1735 // if user passed in a AWTEventListenerProxy object, extract
1736 // the listener
1737 if (l instanceof AWTEventListenerProxy) {
1738 localL = ((AWTEventListenerProxy)l).getListener();
1739 }
1740 return localL;
1741 }
1742
1743 /**
1744 * Adds an AWTEventListener to receive all AWTEvents dispatched
1745 * system-wide that conform to the given {@code eventMask}.
1746 * <p>
1747 * First, if there is a security manager, its {@code checkPermission}
1748 * method is called with an
1749 * {@code AWTPermission("listenToAllAWTEvents")} permission.
1750 * This may result in a SecurityException.
1751 * <p>
1752 * {@code eventMask} is a bitmask of event types to receive.
1753 * It is constructed by bitwise OR-ing together the event masks
1754 * defined in {@code AWTEvent}.
1755 * <p>
1756 * Note: event listener use is not recommended for normal
1757 * application use, but are intended solely to support special
1758 * purpose facilities including support for accessibility,
1759 * event record/playback, and diagnostic tracing.
1760 *
1761 * If listener is null, no exception is thrown and no action is performed.
1762 *
1763 * @param listener the event listener.
1764 * @param eventMask the bitmask of event types to receive
1765 * @throws SecurityException
1766 * if a security manager exists and its
1767 * {@code checkPermission} method doesn't allow the operation.
1768 * @see #removeAWTEventListener
1769 * @see #getAWTEventListeners
1770 * @see SecurityManager#checkPermission
1771 * @see java.awt.AWTEvent
1772 * @see java.awt.AWTPermission
1773 * @see java.awt.event.AWTEventListener
1774 * @see java.awt.event.AWTEventListenerProxy
1775 * @since 1.2
1776 */
1777 public void addAWTEventListener(AWTEventListener listener, long eventMask) {
1778 AWTEventListener localL = deProxyAWTEventListener(listener);
1779
1780 if (localL == null) {
1781 return;
1782 }
1783 SecurityManager security = System.getSecurityManager();
1784 if (security != null) {
1785 security.checkPermission(AWTPermissions.ALL_AWT_EVENTS_PERMISSION);
1786 }
1787 synchronized (this) {
1788 SelectiveAWTEventListener selectiveListener =
1789 listener2SelectiveListener.get(localL);
1790
1791 if (selectiveListener == null) {
1792 // Create a new selectiveListener.
1793 selectiveListener = new SelectiveAWTEventListener(localL,
1794 eventMask);
1795 listener2SelectiveListener.put(localL, selectiveListener);
1796 eventListener = ToolkitEventMulticaster.add(eventListener,
1797 selectiveListener);
1798 }
1799 // OR the eventMask into the selectiveListener's event mask.
1800 selectiveListener.orEventMasks(eventMask);
1801
1802 enabledOnToolkitMask |= eventMask;
1803
1804 long mask = eventMask;
1805 for (int i=0; i<LONG_BITS; i++) {
1806 // If no bits are set, break out of loop.
1807 if (mask == 0) {
1808 break;
1809 }
1810 if ((mask & 1L) != 0) { // Always test bit 0.
1811 calls[i]++;
1812 }
1813 mask >>>= 1; // Right shift, fill with zeros on left.
1814 }
1815 }
1816 }
1817
1818 /**
1819 * Removes an AWTEventListener from receiving dispatched AWTEvents.
1820 * <p>
1821 * First, if there is a security manager, its {@code checkPermission}
1822 * method is called with an
1823 * {@code AWTPermission("listenToAllAWTEvents")} permission.
1824 * This may result in a SecurityException.
1825 * <p>
1826 * Note: event listener use is not recommended for normal
1827 * application use, but are intended solely to support special
1828 * purpose facilities including support for accessibility,
1829 * event record/playback, and diagnostic tracing.
1830 *
1831 * If listener is null, no exception is thrown and no action is performed.
1832 *
1833 * @param listener the event listener.
1834 * @throws SecurityException
1835 * if a security manager exists and its
1836 * {@code checkPermission} method doesn't allow the operation.
1837 * @see #addAWTEventListener
1838 * @see #getAWTEventListeners
1839 * @see SecurityManager#checkPermission
1840 * @see java.awt.AWTEvent
1841 * @see java.awt.AWTPermission
1842 * @see java.awt.event.AWTEventListener
1843 * @see java.awt.event.AWTEventListenerProxy
1844 * @since 1.2
1845 */
1846 public void removeAWTEventListener(AWTEventListener listener) {
1847 AWTEventListener localL = deProxyAWTEventListener(listener);
1848
1849 if (listener == null) {
1850 return;
1851 }
1852 SecurityManager security = System.getSecurityManager();
1853 if (security != null) {
1854 security.checkPermission(AWTPermissions.ALL_AWT_EVENTS_PERMISSION);
1855 }
1856
1857 synchronized (this) {
1858 SelectiveAWTEventListener selectiveListener =
1859 listener2SelectiveListener.get(localL);
1860
1861 if (selectiveListener != null) {
1862 listener2SelectiveListener.remove(localL);
1863 int[] listenerCalls = selectiveListener.getCalls();
1864 for (int i=0; i<LONG_BITS; i++) {
1865 calls[i] -= listenerCalls[i];
1866 assert calls[i] >= 0: "Negative Listeners count";
1867
1868 if (calls[i] == 0) {
1869 enabledOnToolkitMask &= ~(1L<<i);
1870 }
1871 }
1872 }
1873 eventListener = ToolkitEventMulticaster.remove(eventListener,
1874 (selectiveListener == null) ? localL : selectiveListener);
1875 }
1876 }
1877
1878 static boolean enabledOnToolkit(long eventMask) {
1879 return (enabledOnToolkitMask & eventMask) != 0;
1880 }
1881
1882 synchronized int countAWTEventListeners(long eventMask) {
1883 int ci = 0;
1884 for (; eventMask != 0; eventMask >>>= 1, ci++) {
1885 }
1886 ci--;
1887 return calls[ci];
1888 }
1889 /**
1890 * Returns an array of all the {@code AWTEventListener}s
1891 * registered on this toolkit.
1892 * If there is a security manager, its {@code checkPermission}
1893 * method is called with an
1894 * {@code AWTPermission("listenToAllAWTEvents")} permission.
1895 * This may result in a SecurityException.
1896 * Listeners can be returned
1897 * within {@code AWTEventListenerProxy} objects, which also contain
1898 * the event mask for the given listener.
1899 * Note that listener objects
1900 * added multiple times appear only once in the returned array.
1901 *
1902 * @return all of the {@code AWTEventListener}s or an empty
1903 * array if no listeners are currently registered
1904 * @throws SecurityException
1905 * if a security manager exists and its
1906 * {@code checkPermission} method doesn't allow the operation.
1907 * @see #addAWTEventListener
1908 * @see #removeAWTEventListener
1909 * @see SecurityManager#checkPermission
1910 * @see java.awt.AWTEvent
1911 * @see java.awt.AWTPermission
1912 * @see java.awt.event.AWTEventListener
1913 * @see java.awt.event.AWTEventListenerProxy
1914 * @since 1.4
1915 */
1916 public AWTEventListener[] getAWTEventListeners() {
1917 SecurityManager security = System.getSecurityManager();
1918 if (security != null) {
1919 security.checkPermission(AWTPermissions.ALL_AWT_EVENTS_PERMISSION);
1920 }
1921 synchronized (this) {
1922 EventListener[] la = ToolkitEventMulticaster.getListeners(eventListener,AWTEventListener.class);
1923
1924 AWTEventListener[] ret = new AWTEventListener[la.length];
1925 for (int i = 0; i < la.length; i++) {
1926 SelectiveAWTEventListener sael = (SelectiveAWTEventListener)la[i];
1927 AWTEventListener tempL = sael.getListener();
1928 //assert tempL is not an AWTEventListenerProxy - we should
1929 // have weeded them all out
1930 // don't want to wrap a proxy inside a proxy
1931 ret[i] = new AWTEventListenerProxy(sael.getEventMask(), tempL);
1932 }
1933 return ret;
1934 }
1935 }
1936
1937 /**
1938 * Returns an array of all the {@code AWTEventListener}s
1939 * registered on this toolkit which listen to all of the event
1940 * types specified in the {@code eventMask} argument.
1941 * If there is a security manager, its {@code checkPermission}
1942 * method is called with an
1943 * {@code AWTPermission("listenToAllAWTEvents")} permission.
1944 * This may result in a SecurityException.
1945 * Listeners can be returned
1946 * within {@code AWTEventListenerProxy} objects, which also contain
1947 * the event mask for the given listener.
1948 * Note that listener objects
1949 * added multiple times appear only once in the returned array.
1950 *
1951 * @param eventMask the bitmask of event types to listen for
1952 * @return all of the {@code AWTEventListener}s registered
1953 * on this toolkit for the specified
1954 * event types, or an empty array if no such listeners
1955 * are currently registered
1956 * @throws SecurityException
1957 * if a security manager exists and its
1958 * {@code checkPermission} method doesn't allow the operation.
1959 * @see #addAWTEventListener
1960 * @see #removeAWTEventListener
1961 * @see SecurityManager#checkPermission
1962 * @see java.awt.AWTEvent
1963 * @see java.awt.AWTPermission
1964 * @see java.awt.event.AWTEventListener
1965 * @see java.awt.event.AWTEventListenerProxy
1966 * @since 1.4
1967 */
1968 public AWTEventListener[] getAWTEventListeners(long eventMask) {
1969 SecurityManager security = System.getSecurityManager();
1970 if (security != null) {
1971 security.checkPermission(AWTPermissions.ALL_AWT_EVENTS_PERMISSION);
1972 }
1973 synchronized (this) {
1974 EventListener[] la = ToolkitEventMulticaster.getListeners(eventListener,AWTEventListener.class);
1975
1976 java.util.List<AWTEventListenerProxy> list = new ArrayList<>(la.length);
1977
1978 for (int i = 0; i < la.length; i++) {
1979 SelectiveAWTEventListener sael = (SelectiveAWTEventListener)la[i];
1980 if ((sael.getEventMask() & eventMask) == eventMask) {
1981 //AWTEventListener tempL = sael.getListener();
1982 list.add(new AWTEventListenerProxy(sael.getEventMask(),
1983 sael.getListener()));
1984 }
1985 }
1986 return list.toArray(new AWTEventListener[0]);
1987 }
1988 }
1989
1990 /*
1991 * This method notifies any AWTEventListeners that an event
1992 * is about to be dispatched.
1993 *
1994 * @param theEvent the event which will be dispatched.
1995 */
1996 void notifyAWTEventListeners(AWTEvent theEvent) {
1997 // This is a workaround for headless toolkits. It would be
1998 // better to override this method but it is declared package private.
1999 // "this instanceof" syntax defeats polymorphism.
2000 // --mm, 03/03/00
2001 if (this instanceof HeadlessToolkit) {
2002 ((HeadlessToolkit)this).getUnderlyingToolkit()
2003 .notifyAWTEventListeners(theEvent);
2004 return;
2005 }
2006
2007 AWTEventListener eventListener = this.eventListener;
2008 if (eventListener != null) {
2009 eventListener.eventDispatched(theEvent);
2010 }
2011 }
2012
2013 private static class ToolkitEventMulticaster extends AWTEventMulticaster
2014 implements AWTEventListener {
2015 // Implementation cloned from AWTEventMulticaster.
2016
2017 ToolkitEventMulticaster(AWTEventListener a, AWTEventListener b) {
2018 super(a, b);
2019 }
2020
2021 @SuppressWarnings("overloads")
2022 static AWTEventListener add(AWTEventListener a,
2023 AWTEventListener b) {
2024 if (a == null) return b;
2025 if (b == null) return a;
2026 return new ToolkitEventMulticaster(a, b);
2027 }
2028
2029 @SuppressWarnings("overloads")
2030 static AWTEventListener remove(AWTEventListener l,
2031 AWTEventListener oldl) {
2032 return (AWTEventListener) removeInternal(l, oldl);
2033 }
2034
2035 // #4178589: must overload remove(EventListener) to call our add()
2036 // instead of the static addInternal() so we allocate a
2037 // ToolkitEventMulticaster instead of an AWTEventMulticaster.
2038 // Note: this method is called by AWTEventListener.removeInternal(),
2039 // so its method signature must match AWTEventListener.remove().
2040 protected EventListener remove(EventListener oldl) {
2041 if (oldl == a) return b;
2042 if (oldl == b) return a;
2043 AWTEventListener a2 = (AWTEventListener)removeInternal(a, oldl);
2044 AWTEventListener b2 = (AWTEventListener)removeInternal(b, oldl);
2045 if (a2 == a && b2 == b) {
2046 return this; // it's not here
2047 }
2048 return add(a2, b2);
2049 }
2050
2051 public void eventDispatched(AWTEvent event) {
2052 ((AWTEventListener)a).eventDispatched(event);
2053 ((AWTEventListener)b).eventDispatched(event);
2054 }
2055 }
2056
2057 private class SelectiveAWTEventListener implements AWTEventListener {
2058 AWTEventListener listener;
2059 private long eventMask;
2060 // This array contains the number of times to call the eventlistener
2061 // for each event type.
2062 int[] calls = new int[Toolkit.LONG_BITS];
2063
2064 public AWTEventListener getListener() {return listener;}
2065 public long getEventMask() {return eventMask;}
2066 public int[] getCalls() {return calls;}
2067
2068 public void orEventMasks(long mask) {
2069 eventMask |= mask;
2070 // For each event bit set in mask, increment its call count.
2071 for (int i=0; i<Toolkit.LONG_BITS; i++) {
2072 // If no bits are set, break out of loop.
2073 if (mask == 0) {
2074 break;
2075 }
2076 if ((mask & 1L) != 0) { // Always test bit 0.
2077 calls[i]++;
2078 }
2079 mask >>>= 1; // Right shift, fill with zeros on left.
2080 }
2081 }
2082
2083 SelectiveAWTEventListener(AWTEventListener l, long mask) {
2084 listener = l;
2085 eventMask = mask;
2086 }
2087
2088 public void eventDispatched(AWTEvent event) {
2089 long eventBit = 0; // Used to save the bit of the event type.
2090 if (((eventBit = eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 &&
2091 event.id >= ComponentEvent.COMPONENT_FIRST &&
2092 event.id <= ComponentEvent.COMPONENT_LAST)
2093 || ((eventBit = eventMask & AWTEvent.CONTAINER_EVENT_MASK) != 0 &&
2094 event.id >= ContainerEvent.CONTAINER_FIRST &&
2095 event.id <= ContainerEvent.CONTAINER_LAST)
2096 || ((eventBit = eventMask & AWTEvent.FOCUS_EVENT_MASK) != 0 &&
2097 event.id >= FocusEvent.FOCUS_FIRST &&
2098 event.id <= FocusEvent.FOCUS_LAST)
2099 || ((eventBit = eventMask & AWTEvent.KEY_EVENT_MASK) != 0 &&
2100 event.id >= KeyEvent.KEY_FIRST &&
2101 event.id <= KeyEvent.KEY_LAST)
2102 || ((eventBit = eventMask & AWTEvent.MOUSE_WHEEL_EVENT_MASK) != 0 &&
2103 event.id == MouseEvent.MOUSE_WHEEL)
2104 || ((eventBit = eventMask & AWTEvent.MOUSE_MOTION_EVENT_MASK) != 0 &&
2105 (event.id == MouseEvent.MOUSE_MOVED ||
2106 event.id == MouseEvent.MOUSE_DRAGGED))
2107 || ((eventBit = eventMask & AWTEvent.MOUSE_EVENT_MASK) != 0 &&
2108 event.id != MouseEvent.MOUSE_MOVED &&
2109 event.id != MouseEvent.MOUSE_DRAGGED &&
2110 event.id != MouseEvent.MOUSE_WHEEL &&
2111 event.id >= MouseEvent.MOUSE_FIRST &&
2112 event.id <= MouseEvent.MOUSE_LAST)
2113 || ((eventBit = eventMask & AWTEvent.WINDOW_EVENT_MASK) != 0 &&
2114 (event.id >= WindowEvent.WINDOW_FIRST &&
2115 event.id <= WindowEvent.WINDOW_LAST))
2116 || ((eventBit = eventMask & AWTEvent.ACTION_EVENT_MASK) != 0 &&
2117 event.id >= ActionEvent.ACTION_FIRST &&
2118 event.id <= ActionEvent.ACTION_LAST)
2119 || ((eventBit = eventMask & AWTEvent.ADJUSTMENT_EVENT_MASK) != 0 &&
2120 event.id >= AdjustmentEvent.ADJUSTMENT_FIRST &&
2121 event.id <= AdjustmentEvent.ADJUSTMENT_LAST)
2122 || ((eventBit = eventMask & AWTEvent.ITEM_EVENT_MASK) != 0 &&
2123 event.id >= ItemEvent.ITEM_FIRST &&
2124 event.id <= ItemEvent.ITEM_LAST)
2125 || ((eventBit = eventMask & AWTEvent.TEXT_EVENT_MASK) != 0 &&
2126 event.id >= TextEvent.TEXT_FIRST &&
2127 event.id <= TextEvent.TEXT_LAST)
2128 || ((eventBit = eventMask & AWTEvent.INPUT_METHOD_EVENT_MASK) != 0 &&
2129 event.id >= InputMethodEvent.INPUT_METHOD_FIRST &&
2130 event.id <= InputMethodEvent.INPUT_METHOD_LAST)
2131 || ((eventBit = eventMask & AWTEvent.PAINT_EVENT_MASK) != 0 &&
2132 event.id >= PaintEvent.PAINT_FIRST &&
2133 event.id <= PaintEvent.PAINT_LAST)
2134 || ((eventBit = eventMask & AWTEvent.INVOCATION_EVENT_MASK) != 0 &&
2135 event.id >= InvocationEvent.INVOCATION_FIRST &&
2136 event.id <= InvocationEvent.INVOCATION_LAST)
2137 || ((eventBit = eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 &&
2138 event.id == HierarchyEvent.HIERARCHY_CHANGED)
2139 || ((eventBit = eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 &&
2140 (event.id == HierarchyEvent.ANCESTOR_MOVED ||
2141 event.id == HierarchyEvent.ANCESTOR_RESIZED))
2142 || ((eventBit = eventMask & AWTEvent.WINDOW_STATE_EVENT_MASK) != 0 &&
2143 event.id == WindowEvent.WINDOW_STATE_CHANGED)
2144 || ((eventBit = eventMask & AWTEvent.WINDOW_FOCUS_EVENT_MASK) != 0 &&
2145 (event.id == WindowEvent.WINDOW_GAINED_FOCUS ||
2146 event.id == WindowEvent.WINDOW_LOST_FOCUS))
2147 || ((eventBit = eventMask & sun.awt.SunToolkit.GRAB_EVENT_MASK) != 0 &&
2148 (event instanceof sun.awt.UngrabEvent))) {
2149 // Get the index of the call count for this event type.
2150 // Instead of using Math.log(...) we will calculate it with
2151 // bit shifts. That's what previous implementation looked like:
2152 //
2153 // int ci = (int) (Math.log(eventBit)/Math.log(2));
2154 int ci = 0;
2155 for (long eMask = eventBit; eMask != 0; eMask >>>= 1, ci++) {
2156 }
2157 ci--;
2158 // Call the listener as many times as it was added for this
2159 // event type.
2160 for (int i=0; i<calls[ci]; i++) {
2161 listener.eventDispatched(event);
2162 }
2163 }
2164 }
2165 }
2166
2167 /**
2168 * Returns a map of visual attributes for the abstract level description
2169 * of the given input method highlight, or null if no mapping is found.
2170 * The style field of the input method highlight is ignored. The map
2171 * returned is unmodifiable.
2172 * @param highlight input method highlight
2173 * @return style attribute map, or {@code null}
2174 * @exception HeadlessException if
2175 * {@code GraphicsEnvironment.isHeadless} returns true
2176 * @see java.awt.GraphicsEnvironment#isHeadless
2177 * @since 1.3
2178 */
2179 public abstract Map<java.awt.font.TextAttribute,?>
2180 mapInputMethodHighlight(InputMethodHighlight highlight)
2181 throws HeadlessException;
2182
2183 private static PropertyChangeSupport createPropertyChangeSupport(Toolkit toolkit) {
2184 if (toolkit instanceof SunToolkit || toolkit instanceof HeadlessToolkit) {
2185 return new DesktopPropertyChangeSupport(toolkit);
2186 } else {
2187 return new PropertyChangeSupport(toolkit);
2188 }
2189 }
2190
2191 @SuppressWarnings("serial")
2192 private static class DesktopPropertyChangeSupport extends PropertyChangeSupport {
2193
2194 private static final StringBuilder PROP_CHANGE_SUPPORT_KEY =
2195 new StringBuilder("desktop property change support key");
2196 private final Object source;
2197
2198 public DesktopPropertyChangeSupport(Object sourceBean) {
2199 super(sourceBean);
2200 source = sourceBean;
2201 }
2202
2203 @Override
2204 public synchronized void addPropertyChangeListener(
2205 String propertyName,
2206 PropertyChangeListener listener)
2207 {
2208 PropertyChangeSupport pcs = (PropertyChangeSupport)
2209 AppContext.getAppContext().get(PROP_CHANGE_SUPPORT_KEY);
2210 if (null == pcs) {
2211 pcs = new PropertyChangeSupport(source);
2212 AppContext.getAppContext().put(PROP_CHANGE_SUPPORT_KEY, pcs);
2213 }
2214 pcs.addPropertyChangeListener(propertyName, listener);
2215 }
2216
2217 @Override
2218 public synchronized void removePropertyChangeListener(
2219 String propertyName,
2220 PropertyChangeListener listener)
2221 {
2222 PropertyChangeSupport pcs = (PropertyChangeSupport)
2223 AppContext.getAppContext().get(PROP_CHANGE_SUPPORT_KEY);
2224 if (null != pcs) {
2225 pcs.removePropertyChangeListener(propertyName, listener);
2226 }
2227 }
2228
2229 @Override
2230 public synchronized PropertyChangeListener[] getPropertyChangeListeners()
2231 {
2232 PropertyChangeSupport pcs = (PropertyChangeSupport)
2233 AppContext.getAppContext().get(PROP_CHANGE_SUPPORT_KEY);
2234 if (null != pcs) {
2235 return pcs.getPropertyChangeListeners();
2236 } else {
2237 return new PropertyChangeListener[0];
2238 }
2239 }
2240
2241 @Override
2242 public synchronized PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
2243 {
2244 PropertyChangeSupport pcs = (PropertyChangeSupport)
2245 AppContext.getAppContext().get(PROP_CHANGE_SUPPORT_KEY);
2246 if (null != pcs) {
2247 return pcs.getPropertyChangeListeners(propertyName);
2248 } else {
2249 return new PropertyChangeListener[0];
2250 }
2251 }
2252
2253 @Override
2254 public synchronized void addPropertyChangeListener(PropertyChangeListener listener) {
2255 PropertyChangeSupport pcs = (PropertyChangeSupport)
2256 AppContext.getAppContext().get(PROP_CHANGE_SUPPORT_KEY);
2257 if (null == pcs) {
2258 pcs = new PropertyChangeSupport(source);
2259 AppContext.getAppContext().put(PROP_CHANGE_SUPPORT_KEY, pcs);
2260 }
2261 pcs.addPropertyChangeListener(listener);
2262 }
2263
2264 @Override
2265 public synchronized void removePropertyChangeListener(PropertyChangeListener listener) {
2266 PropertyChangeSupport pcs = (PropertyChangeSupport)
2267 AppContext.getAppContext().get(PROP_CHANGE_SUPPORT_KEY);
2268 if (null != pcs) {
2269 pcs.removePropertyChangeListener(listener);
2270 }
2271 }
2272
2273 /*
2274 * we do expect that all other fireXXX() methods of java.beans.PropertyChangeSupport
2275 * use this method. If this will be changed we will need to change this class.
2276 */
2277 @Override
2278 public void firePropertyChange(final PropertyChangeEvent evt) {
2279 Object oldValue = evt.getOldValue();
2280 Object newValue = evt.getNewValue();
2281 String propertyName = evt.getPropertyName();
2282 if (oldValue != null && newValue != null && oldValue.equals(newValue)) {
2283 return;
2284 }
2285 Runnable updater = new Runnable() {
2286 public void run() {
2287 PropertyChangeSupport pcs = (PropertyChangeSupport)
2288 AppContext.getAppContext().get(PROP_CHANGE_SUPPORT_KEY);
2289 if (null != pcs) {
2290 pcs.firePropertyChange(evt);
2291 }
2292 }
2293 };
2294 final AppContext currentAppContext = AppContext.getAppContext();
2295 for (AppContext appContext : AppContext.getAppContexts()) {
2296 if (null == appContext || appContext.isDisposed()) {
2297 continue;
2298 }
2299 if (currentAppContext == appContext) {
2300 updater.run();
2301 } else {
2302 final PeerEvent e = new PeerEvent(source, updater, PeerEvent.ULTIMATE_PRIORITY_EVENT);
2303 SunToolkit.postEvent(appContext, e);
2304 }
2305 }
2306 }
2307 }
2308
2309 /**
2310 * Reports whether events from extra mouse buttons are allowed to be processed and posted into
2311 * {@code EventQueue}.
2312 * <br>
2313 * To change the returned value it is necessary to set the {@code sun.awt.enableExtraMouseButtons}
2314 * property before the {@code Toolkit} class initialization. This setting could be done on the application
2315 * startup by the following command:
2316 * <pre>
2317 * java -Dsun.awt.enableExtraMouseButtons=false Application
2318 * </pre>
2319 * Alternatively, the property could be set in the application by using the following code:
2320 * <pre>
2321 * System.setProperty("sun.awt.enableExtraMouseButtons", "true");
2322 * </pre>
2323 * before the {@code Toolkit} class initialization.
2324 * If not set by the time of the {@code Toolkit} class initialization, this property will be
2325 * initialized with {@code true}.
2326 * Changing this value after the {@code Toolkit} class initialization will have no effect.
2327 *
2328 * @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true
2329 * @return {@code true} if events from extra mouse buttons are allowed to be processed and posted;
2330 * {@code false} otherwise
2331 * @see System#getProperty(String propertyName)
2332 * @see System#setProperty(String propertyName, String value)
2333 * @see java.awt.EventQueue
2334 * @since 1.7
2335 */
2336 public boolean areExtraMouseButtonsEnabled() throws HeadlessException {
2337 GraphicsEnvironment.checkHeadless();
2338
2339 return Toolkit.getDefaultToolkit().areExtraMouseButtonsEnabled();
2340 }
2341 }
--- EOF ---