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