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