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