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