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