1 /* 2 * Copyright (c) 1995, 2017, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 package java.awt; 26 27 import java.io.PrintStream; 28 import java.io.PrintWriter; 29 import java.util.Objects; 30 import java.util.Vector; 31 import java.util.Locale; 32 import java.util.EventListener; 33 import java.util.HashSet; 34 import java.util.Map; 35 import java.util.Set; 36 import java.util.Collections; 37 import java.awt.peer.ComponentPeer; 38 import java.awt.peer.ContainerPeer; 39 import java.awt.peer.LightweightPeer; 40 import java.awt.image.BufferStrategy; 41 import java.awt.image.ImageObserver; 42 import java.awt.image.ImageProducer; 43 import java.awt.image.ColorModel; 44 import java.awt.image.VolatileImage; 45 import java.awt.event.*; 46 import java.io.Serializable; 47 import java.io.ObjectOutputStream; 48 import java.io.ObjectInputStream; 49 import java.io.IOException; 50 import java.beans.PropertyChangeListener; 51 import java.beans.PropertyChangeSupport; 52 import java.beans.Transient; 53 import java.awt.im.InputContext; 54 import java.awt.im.InputMethodRequests; 55 import java.awt.dnd.DropTarget; 56 import java.security.AccessController; 57 import java.security.AccessControlContext; 58 import javax.accessibility.*; 59 import java.applet.Applet; 60 import javax.swing.JComponent; 61 import javax.swing.JRootPane; 62 63 import sun.awt.ComponentFactory; 64 import sun.security.action.GetPropertyAction; 65 import sun.awt.AppContext; 66 import sun.awt.AWTAccessor; 67 import sun.awt.ConstrainableGraphics; 68 import sun.awt.SubRegionShowable; 69 import sun.awt.SunToolkit; 70 import sun.awt.EmbeddedFrame; 71 import sun.awt.dnd.SunDropTargetEvent; 72 import sun.awt.im.CompositionArea; 73 import sun.font.FontManager; 74 import sun.font.FontManagerFactory; 75 import sun.font.SunFontManager; 76 import sun.java2d.SunGraphics2D; 77 import sun.java2d.pipe.Region; 78 import sun.awt.image.VSyncedBSManager; 79 import sun.java2d.pipe.hw.ExtendedBufferCapabilities; 80 import static sun.java2d.pipe.hw.ExtendedBufferCapabilities.VSyncType.*; 81 import sun.awt.RequestFocusController; 82 import sun.java2d.SunGraphicsEnvironment; 83 import sun.swing.SwingAccessor; 84 import sun.util.logging.PlatformLogger; 85 86 /** 87 * A <em>component</em> is an object having a graphical representation 88 * that can be displayed on the screen and that can interact with the 89 * user. Examples of components are the buttons, checkboxes, and scrollbars 90 * of a typical graphical user interface. <p> 91 * The {@code Component} class is the abstract superclass of 92 * the nonmenu-related Abstract Window Toolkit components. Class 93 * {@code Component} can also be extended directly to create a 94 * lightweight component. A lightweight component is a component that is 95 * not associated with a native window. On the contrary, a heavyweight 96 * component is associated with a native window. The {@link #isLightweight()} 97 * method may be used to distinguish between the two kinds of the components. 98 * <p> 99 * Lightweight and heavyweight components may be mixed in a single component 100 * hierarchy. However, for correct operating of such a mixed hierarchy of 101 * components, the whole hierarchy must be valid. When the hierarchy gets 102 * invalidated, like after changing the bounds of components, or 103 * adding/removing components to/from containers, the whole hierarchy must be 104 * validated afterwards by means of the {@link Container#validate()} method 105 * invoked on the top-most invalid container of the hierarchy. 106 * 107 * <h3>Serialization</h3> 108 * It is important to note that only AWT listeners which conform 109 * to the {@code Serializable} protocol will be saved when 110 * the object is stored. If an AWT object has listeners that 111 * aren't marked serializable, they will be dropped at 112 * {@code writeObject} time. Developers will need, as always, 113 * to consider the implications of making an object serializable. 114 * One situation to watch out for is this: 115 * <pre> 116 * import java.awt.*; 117 * import java.awt.event.*; 118 * import java.io.Serializable; 119 * 120 * class MyApp implements ActionListener, Serializable 121 * { 122 * BigObjectThatShouldNotBeSerializedWithAButton bigOne; 123 * Button aButton = new Button(); 124 * 125 * MyApp() 126 * { 127 * // Oops, now aButton has a listener with a reference 128 * // to bigOne! 129 * aButton.addActionListener(this); 130 * } 131 * 132 * public void actionPerformed(ActionEvent e) 133 * { 134 * System.out.println("Hello There"); 135 * } 136 * } 137 * </pre> 138 * In this example, serializing {@code aButton} by itself 139 * will cause {@code MyApp} and everything it refers to 140 * to be serialized as well. The problem is that the listener 141 * is serializable by coincidence, not by design. To separate 142 * the decisions about {@code MyApp} and the 143 * {@code ActionListener} being serializable one can use a 144 * nested class, as in the following example: 145 * <pre> 146 * import java.awt.*; 147 * import java.awt.event.*; 148 * import java.io.Serializable; 149 * 150 * class MyApp implements java.io.Serializable 151 * { 152 * BigObjectThatShouldNotBeSerializedWithAButton bigOne; 153 * Button aButton = new Button(); 154 * 155 * static class MyActionListener implements ActionListener 156 * { 157 * public void actionPerformed(ActionEvent e) 158 * { 159 * System.out.println("Hello There"); 160 * } 161 * } 162 * 163 * MyApp() 164 * { 165 * aButton.addActionListener(new MyActionListener()); 166 * } 167 * } 168 * </pre> 169 * <p> 170 * <b>Note</b>: For more information on the paint mechanisms utilized 171 * by AWT and Swing, including information on how to write the most 172 * efficient painting code, see 173 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>. 174 * <p> 175 * For details on the focus subsystem, see 176 * <a href="http://docs.oracle.com/javase/tutorial/uiswing/misc/focus.html"> 177 * How to Use the Focus Subsystem</a>, 178 * a section in <em>The Java Tutorial</em>, and the 179 * <a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a> 180 * for more information. 181 * 182 * @author Arthur van Hoff 183 * @author Sami Shaio 184 */ 185 public abstract class Component implements ImageObserver, MenuContainer, 186 Serializable 187 { 188 189 private static final PlatformLogger log = PlatformLogger.getLogger("java.awt.Component"); 190 private static final PlatformLogger eventLog = PlatformLogger.getLogger("java.awt.event.Component"); 191 private static final PlatformLogger focusLog = PlatformLogger.getLogger("java.awt.focus.Component"); 192 private static final PlatformLogger mixingLog = PlatformLogger.getLogger("java.awt.mixing.Component"); 193 194 /** 195 * The peer of the component. The peer implements the component's 196 * behavior. The peer is set when the {@code Component} is 197 * added to a container that also is a peer. 198 * @see #addNotify 199 * @see #removeNotify 200 */ 201 transient volatile ComponentPeer peer; 202 203 /** 204 * The parent of the object. It may be {@code null} 205 * for top-level components. 206 * @see #getParent 207 */ 208 transient Container parent; 209 210 /** 211 * The {@code AppContext} of the component. Applets/Plugin may 212 * change the AppContext. 213 */ 214 transient AppContext appContext; 215 216 /** 217 * The x position of the component in the parent's coordinate system. 218 * 219 * @serial 220 * @see #getLocation 221 */ 222 int x; 223 224 /** 225 * The y position of the component in the parent's coordinate system. 226 * 227 * @serial 228 * @see #getLocation 229 */ 230 int y; 231 232 /** 233 * The width of the component. 234 * 235 * @serial 236 * @see #getSize 237 */ 238 int width; 239 240 /** 241 * The height of the component. 242 * 243 * @serial 244 * @see #getSize 245 */ 246 int height; 247 248 /** 249 * The foreground color for this component. 250 * {@code foreground} can be {@code null}. 251 * 252 * @serial 253 * @see #getForeground 254 * @see #setForeground 255 */ 256 Color foreground; 257 258 /** 259 * The background color for this component. 260 * {@code background} can be {@code null}. 261 * 262 * @serial 263 * @see #getBackground 264 * @see #setBackground 265 */ 266 Color background; 267 268 /** 269 * The font used by this component. 270 * The {@code font} can be {@code null}. 271 * 272 * @serial 273 * @see #getFont 274 * @see #setFont 275 */ 276 volatile Font font; 277 278 /** 279 * The font which the peer is currently using. 280 * ({@code null} if no peer exists.) 281 */ 282 Font peerFont; 283 284 /** 285 * The cursor displayed when pointer is over this component. 286 * This value can be {@code null}. 287 * 288 * @serial 289 * @see #getCursor 290 * @see #setCursor 291 */ 292 Cursor cursor; 293 294 /** 295 * The locale for the component. 296 * 297 * @serial 298 * @see #getLocale 299 * @see #setLocale 300 */ 301 Locale locale; 302 303 /** 304 * A reference to a {@code GraphicsConfiguration} object 305 * used to describe the characteristics of a graphics 306 * destination. 307 * This value can be {@code null}. 308 * 309 * @since 1.3 310 * @serial 311 * @see GraphicsConfiguration 312 * @see #getGraphicsConfiguration 313 */ 314 private transient volatile GraphicsConfiguration graphicsConfig; 315 316 /** 317 * A reference to a {@code BufferStrategy} object 318 * used to manipulate the buffers on this component. 319 * 320 * @since 1.4 321 * @see java.awt.image.BufferStrategy 322 * @see #getBufferStrategy() 323 */ 324 transient BufferStrategy bufferStrategy = null; 325 326 /** 327 * True when the object should ignore all repaint events. 328 * 329 * @since 1.4 330 * @serial 331 * @see #setIgnoreRepaint 332 * @see #getIgnoreRepaint 333 */ 334 boolean ignoreRepaint = false; 335 336 /** 337 * True when the object is visible. An object that is not 338 * visible is not drawn on the screen. 339 * 340 * @serial 341 * @see #isVisible 342 * @see #setVisible 343 */ 344 boolean visible = true; 345 346 /** 347 * True when the object is enabled. An object that is not 348 * enabled does not interact with the user. 349 * 350 * @serial 351 * @see #isEnabled 352 * @see #setEnabled 353 */ 354 boolean enabled = true; 355 356 /** 357 * True when the object is valid. An invalid object needs to 358 * be laid out. This flag is set to false when the object 359 * size is changed. 360 * 361 * @serial 362 * @see #isValid 363 * @see #validate 364 * @see #invalidate 365 */ 366 private volatile boolean valid = false; 367 368 /** 369 * The {@code DropTarget} associated with this component. 370 * 371 * @since 1.2 372 * @serial 373 * @see #setDropTarget 374 * @see #getDropTarget 375 */ 376 DropTarget dropTarget; 377 378 /** 379 * @serial 380 * @see #add 381 */ 382 Vector<PopupMenu> popups; 383 384 /** 385 * A component's name. 386 * This field can be {@code null}. 387 * 388 * @serial 389 * @see #getName 390 * @see #setName(String) 391 */ 392 private String name; 393 394 /** 395 * A bool to determine whether the name has 396 * been set explicitly. {@code nameExplicitlySet} will 397 * be false if the name has not been set and 398 * true if it has. 399 * 400 * @serial 401 * @see #getName 402 * @see #setName(String) 403 */ 404 private boolean nameExplicitlySet = false; 405 406 /** 407 * Indicates whether this Component can be focused. 408 * 409 * @serial 410 * @see #setFocusable 411 * @see #isFocusable 412 * @since 1.4 413 */ 414 private boolean focusable = true; 415 416 private static final int FOCUS_TRAVERSABLE_UNKNOWN = 0; 417 private static final int FOCUS_TRAVERSABLE_DEFAULT = 1; 418 private static final int FOCUS_TRAVERSABLE_SET = 2; 419 420 /** 421 * Tracks whether this Component is relying on default focus traversability. 422 * 423 * @serial 424 * @since 1.4 425 */ 426 private int isFocusTraversableOverridden = FOCUS_TRAVERSABLE_UNKNOWN; 427 428 /** 429 * The focus traversal keys. These keys will generate focus traversal 430 * behavior for Components for which focus traversal keys are enabled. If a 431 * value of null is specified for a traversal key, this Component inherits 432 * that traversal key from its parent. If all ancestors of this Component 433 * have null specified for that traversal key, then the current 434 * KeyboardFocusManager's default traversal key is used. 435 * 436 * @serial 437 * @see #setFocusTraversalKeys 438 * @see #getFocusTraversalKeys 439 * @since 1.4 440 */ 441 Set<AWTKeyStroke>[] focusTraversalKeys; 442 443 private static final String[] focusTraversalKeyPropertyNames = { 444 "forwardFocusTraversalKeys", 445 "backwardFocusTraversalKeys", 446 "upCycleFocusTraversalKeys", 447 "downCycleFocusTraversalKeys" 448 }; 449 450 /** 451 * Indicates whether focus traversal keys are enabled for this Component. 452 * Components for which focus traversal keys are disabled receive key 453 * events for focus traversal keys. Components for which focus traversal 454 * keys are enabled do not see these events; instead, the events are 455 * automatically converted to traversal operations. 456 * 457 * @serial 458 * @see #setFocusTraversalKeysEnabled 459 * @see #getFocusTraversalKeysEnabled 460 * @since 1.4 461 */ 462 private boolean focusTraversalKeysEnabled = true; 463 464 /** 465 * The locking object for AWT component-tree and layout operations. 466 * 467 * @see #getTreeLock 468 */ 469 static final Object LOCK = new AWTTreeLock(); 470 static class AWTTreeLock {} 471 472 /* 473 * The component's AccessControlContext. 474 */ 475 private transient volatile AccessControlContext acc = 476 AccessController.getContext(); 477 478 /** 479 * Minimum size. 480 * (This field perhaps should have been transient). 481 * 482 * @serial 483 */ 484 Dimension minSize; 485 486 /** 487 * Whether or not setMinimumSize has been invoked with a non-null value. 488 */ 489 boolean minSizeSet; 490 491 /** 492 * Preferred size. 493 * (This field perhaps should have been transient). 494 * 495 * @serial 496 */ 497 Dimension prefSize; 498 499 /** 500 * Whether or not setPreferredSize has been invoked with a non-null value. 501 */ 502 boolean prefSizeSet; 503 504 /** 505 * Maximum size 506 * 507 * @serial 508 */ 509 Dimension maxSize; 510 511 /** 512 * Whether or not setMaximumSize has been invoked with a non-null value. 513 */ 514 boolean maxSizeSet; 515 516 /** 517 * The orientation for this component. 518 * @see #getComponentOrientation 519 * @see #setComponentOrientation 520 */ 521 transient ComponentOrientation componentOrientation 522 = ComponentOrientation.UNKNOWN; 523 524 /** 525 * {@code newEventsOnly} will be true if the event is 526 * one of the event types enabled for the component. 527 * It will then allow for normal processing to 528 * continue. If it is false the event is passed 529 * to the component's parent and up the ancestor 530 * tree until the event has been consumed. 531 * 532 * @serial 533 * @see #dispatchEvent 534 */ 535 boolean newEventsOnly = false; 536 transient ComponentListener componentListener; 537 transient FocusListener focusListener; 538 transient HierarchyListener hierarchyListener; 539 transient HierarchyBoundsListener hierarchyBoundsListener; 540 transient KeyListener keyListener; 541 transient MouseListener mouseListener; 542 transient MouseMotionListener mouseMotionListener; 543 transient MouseWheelListener mouseWheelListener; 544 transient InputMethodListener inputMethodListener; 545 546 /** Internal, constants for serialization */ 547 static final String actionListenerK = "actionL"; 548 static final String adjustmentListenerK = "adjustmentL"; 549 static final String componentListenerK = "componentL"; 550 static final String containerListenerK = "containerL"; 551 static final String focusListenerK = "focusL"; 552 static final String itemListenerK = "itemL"; 553 static final String keyListenerK = "keyL"; 554 static final String mouseListenerK = "mouseL"; 555 static final String mouseMotionListenerK = "mouseMotionL"; 556 static final String mouseWheelListenerK = "mouseWheelL"; 557 static final String textListenerK = "textL"; 558 static final String ownedWindowK = "ownedL"; 559 static final String windowListenerK = "windowL"; 560 static final String inputMethodListenerK = "inputMethodL"; 561 static final String hierarchyListenerK = "hierarchyL"; 562 static final String hierarchyBoundsListenerK = "hierarchyBoundsL"; 563 static final String windowStateListenerK = "windowStateL"; 564 static final String windowFocusListenerK = "windowFocusL"; 565 566 /** 567 * The {@code eventMask} is ONLY set by subclasses via 568 * {@code enableEvents}. 569 * The mask should NOT be set when listeners are registered 570 * so that we can distinguish the difference between when 571 * listeners request events and subclasses request them. 572 * One bit is used to indicate whether input methods are 573 * enabled; this bit is set by {@code enableInputMethods} and is 574 * on by default. 575 * 576 * @serial 577 * @see #enableInputMethods 578 * @see AWTEvent 579 */ 580 long eventMask = AWTEvent.INPUT_METHODS_ENABLED_MASK; 581 582 /** 583 * Static properties for incremental drawing. 584 * @see #imageUpdate 585 */ 586 static boolean isInc; 587 static int incRate; 588 static { 589 /* ensure that the necessary native libraries are loaded */ 590 Toolkit.loadLibraries(); 591 /* initialize JNI field and method ids */ 592 if (!GraphicsEnvironment.isHeadless()) { 593 initIDs(); 594 } 595 596 String s = java.security.AccessController.doPrivileged( 597 new GetPropertyAction("awt.image.incrementaldraw")); 598 isInc = (s == null || s.equals("true")); 599 600 s = java.security.AccessController.doPrivileged( 601 new GetPropertyAction("awt.image.redrawrate")); 602 incRate = (s != null) ? Integer.parseInt(s) : 100; 603 } 604 605 /** 606 * Ease-of-use constant for {@code getAlignmentY()}. 607 * Specifies an alignment to the top of the component. 608 * @see #getAlignmentY 609 */ 610 public static final float TOP_ALIGNMENT = 0.0f; 611 612 /** 613 * Ease-of-use constant for {@code getAlignmentY} and 614 * {@code getAlignmentX}. Specifies an alignment to 615 * the center of the component 616 * @see #getAlignmentX 617 * @see #getAlignmentY 618 */ 619 public static final float CENTER_ALIGNMENT = 0.5f; 620 621 /** 622 * Ease-of-use constant for {@code getAlignmentY}. 623 * Specifies an alignment to the bottom of the component. 624 * @see #getAlignmentY 625 */ 626 public static final float BOTTOM_ALIGNMENT = 1.0f; 627 628 /** 629 * Ease-of-use constant for {@code getAlignmentX}. 630 * Specifies an alignment to the left side of the component. 631 * @see #getAlignmentX 632 */ 633 public static final float LEFT_ALIGNMENT = 0.0f; 634 635 /** 636 * Ease-of-use constant for {@code getAlignmentX}. 637 * Specifies an alignment to the right side of the component. 638 * @see #getAlignmentX 639 */ 640 public static final float RIGHT_ALIGNMENT = 1.0f; 641 642 /* 643 * JDK 1.1 serialVersionUID 644 */ 645 private static final long serialVersionUID = -7644114512714619750L; 646 647 /** 648 * If any {@code PropertyChangeListeners} have been registered, 649 * the {@code changeSupport} field describes them. 650 * 651 * @serial 652 * @since 1.2 653 * @see #addPropertyChangeListener 654 * @see #removePropertyChangeListener 655 * @see #firePropertyChange 656 */ 657 private PropertyChangeSupport changeSupport; 658 659 /* 660 * In some cases using "this" as an object to synchronize by 661 * can lead to a deadlock if client code also uses synchronization 662 * by a component object. For every such situation revealed we should 663 * consider possibility of replacing "this" with the package private 664 * objectLock object introduced below. So far there are 3 issues known: 665 * - CR 6708322 (the getName/setName methods); 666 * - CR 6608764 (the PropertyChangeListener machinery); 667 * - CR 7108598 (the Container.paint/KeyboardFocusManager.clearMostRecentFocusOwner methods). 668 * 669 * Note: this field is considered final, though readObject() prohibits 670 * initializing final fields. 671 */ 672 private transient Object objectLock = new Object(); 673 Object getObjectLock() { 674 return objectLock; 675 } 676 677 /* 678 * Returns the acc this component was constructed with. 679 */ 680 final AccessControlContext getAccessControlContext() { 681 if (acc == null) { 682 throw new SecurityException("Component is missing AccessControlContext"); 683 } 684 return acc; 685 } 686 687 boolean isPacked = false; 688 689 /** 690 * Pseudoparameter for direct Geometry API (setLocation, setBounds setSize 691 * to signal setBounds what's changing. Should be used under TreeLock. 692 * This is only needed due to the inability to change the cross-calling 693 * order of public and deprecated methods. 694 */ 695 private int boundsOp = ComponentPeer.DEFAULT_OPERATION; 696 697 /** 698 * Enumeration of the common ways the baseline of a component can 699 * change as the size changes. The baseline resize behavior is 700 * primarily for layout managers that need to know how the 701 * position of the baseline changes as the component size changes. 702 * In general the baseline resize behavior will be valid for sizes 703 * greater than or equal to the minimum size (the actual minimum 704 * size; not a developer specified minimum size). For sizes 705 * smaller than the minimum size the baseline may change in a way 706 * other than the baseline resize behavior indicates. Similarly, 707 * as the size approaches {@code Integer.MAX_VALUE} and/or 708 * {@code Short.MAX_VALUE} the baseline may change in a way 709 * other than the baseline resize behavior indicates. 710 * 711 * @see #getBaselineResizeBehavior 712 * @see #getBaseline(int,int) 713 * @since 1.6 714 */ 715 public enum BaselineResizeBehavior { 716 /** 717 * Indicates the baseline remains fixed relative to the 718 * y-origin. That is, {@code getBaseline} returns 719 * the same value regardless of the height or width. For example, a 720 * {@code JLabel} containing non-empty text with a 721 * vertical alignment of {@code TOP} should have a 722 * baseline type of {@code CONSTANT_ASCENT}. 723 */ 724 CONSTANT_ASCENT, 725 726 /** 727 * Indicates the baseline remains fixed relative to the height 728 * and does not change as the width is varied. That is, for 729 * any height H the difference between H and 730 * {@code getBaseline(w, H)} is the same. For example, a 731 * {@code JLabel} containing non-empty text with a 732 * vertical alignment of {@code BOTTOM} should have a 733 * baseline type of {@code CONSTANT_DESCENT}. 734 */ 735 CONSTANT_DESCENT, 736 737 /** 738 * Indicates the baseline remains a fixed distance from 739 * the center of the component. That is, for any height H the 740 * difference between {@code getBaseline(w, H)} and 741 * {@code H / 2} is the same (plus or minus one depending upon 742 * rounding error). 743 * <p> 744 * Because of possible rounding errors it is recommended 745 * you ask for the baseline with two consecutive heights and use 746 * the return value to determine if you need to pad calculations 747 * by 1. The following shows how to calculate the baseline for 748 * any height: 749 * <pre> 750 * Dimension preferredSize = component.getPreferredSize(); 751 * int baseline = getBaseline(preferredSize.width, 752 * preferredSize.height); 753 * int nextBaseline = getBaseline(preferredSize.width, 754 * preferredSize.height + 1); 755 * // Amount to add to height when calculating where baseline 756 * // lands for a particular height: 757 * int padding = 0; 758 * // Where the baseline is relative to the mid point 759 * int baselineOffset = baseline - height / 2; 760 * if (preferredSize.height % 2 == 0 && 761 * baseline != nextBaseline) { 762 * padding = 1; 763 * } 764 * else if (preferredSize.height % 2 == 1 && 765 * baseline == nextBaseline) { 766 * baselineOffset--; 767 * padding = 1; 768 * } 769 * // The following calculates where the baseline lands for 770 * // the height z: 771 * int calculatedBaseline = (z + padding) / 2 + baselineOffset; 772 * </pre> 773 */ 774 CENTER_OFFSET, 775 776 /** 777 * Indicates the baseline resize behavior can not be expressed using 778 * any of the other constants. This may also indicate the baseline 779 * varies with the width of the component. This is also returned 780 * by components that do not have a baseline. 781 */ 782 OTHER 783 } 784 785 /* 786 * The shape set with the applyCompoundShape() method. It includes the result 787 * of the HW/LW mixing related shape computation. It may also include 788 * the user-specified shape of the component. 789 * The 'null' value means the component has normal shape (or has no shape at all) 790 * and applyCompoundShape() will skip the following shape identical to normal. 791 */ 792 private transient Region compoundShape = null; 793 794 /* 795 * Represents the shape of this lightweight component to be cut out from 796 * heavyweight components should they intersect. Possible values: 797 * 1. null - consider the shape rectangular 798 * 2. EMPTY_REGION - nothing gets cut out (children still get cut out) 799 * 3. non-empty - this shape gets cut out. 800 */ 801 private transient Region mixingCutoutRegion = null; 802 803 /* 804 * Indicates whether addNotify() is complete 805 * (i.e. the peer is created). 806 */ 807 private transient boolean isAddNotifyComplete = false; 808 809 /** 810 * Should only be used in subclass getBounds to check that part of bounds 811 * is actually changing 812 */ 813 int getBoundsOp() { 814 assert Thread.holdsLock(getTreeLock()); 815 return boundsOp; 816 } 817 818 void setBoundsOp(int op) { 819 assert Thread.holdsLock(getTreeLock()); 820 if (op == ComponentPeer.RESET_OPERATION) { 821 boundsOp = ComponentPeer.DEFAULT_OPERATION; 822 } else 823 if (boundsOp == ComponentPeer.DEFAULT_OPERATION) { 824 boundsOp = op; 825 } 826 } 827 828 // Whether this Component has had the background erase flag 829 // specified via SunToolkit.disableBackgroundErase(). This is 830 // needed in order to make this function work on X11 platforms, 831 // where currently there is no chance to interpose on the creation 832 // of the peer and therefore the call to XSetBackground. 833 transient boolean backgroundEraseDisabled; 834 835 static { 836 AWTAccessor.setComponentAccessor(new AWTAccessor.ComponentAccessor() { 837 public void setBackgroundEraseDisabled(Component comp, boolean disabled) { 838 comp.backgroundEraseDisabled = disabled; 839 } 840 public boolean getBackgroundEraseDisabled(Component comp) { 841 return comp.backgroundEraseDisabled; 842 } 843 public Rectangle getBounds(Component comp) { 844 return new Rectangle(comp.x, comp.y, comp.width, comp.height); 845 } 846 public void setMixingCutoutShape(Component comp, Shape shape) { 847 comp.setMixingCutoutShape(shape); 848 } 849 850 public void setGraphicsConfiguration(Component comp, 851 GraphicsConfiguration gc) 852 { 853 comp.setGraphicsConfiguration(gc); 854 } 855 public void requestFocus(Component comp, FocusEvent.Cause cause) { 856 comp.requestFocus(cause); 857 } 858 public boolean canBeFocusOwner(Component comp) { 859 return comp.canBeFocusOwner(); 860 } 861 862 public boolean isVisible(Component comp) { 863 return comp.isVisible_NoClientCode(); 864 } 865 public void setRequestFocusController 866 (RequestFocusController requestController) 867 { 868 Component.setRequestFocusController(requestController); 869 } 870 public AppContext getAppContext(Component comp) { 871 return comp.appContext; 872 } 873 public void setAppContext(Component comp, AppContext appContext) { 874 comp.appContext = appContext; 875 } 876 public Container getParent(Component comp) { 877 return comp.getParent_NoClientCode(); 878 } 879 public void setParent(Component comp, Container parent) { 880 comp.parent = parent; 881 } 882 public void setSize(Component comp, int width, int height) { 883 comp.width = width; 884 comp.height = height; 885 } 886 public Point getLocation(Component comp) { 887 return comp.location_NoClientCode(); 888 } 889 public void setLocation(Component comp, int x, int y) { 890 comp.x = x; 891 comp.y = y; 892 } 893 public boolean isEnabled(Component comp) { 894 return comp.isEnabledImpl(); 895 } 896 public boolean isDisplayable(Component comp) { 897 return comp.peer != null; 898 } 899 public Cursor getCursor(Component comp) { 900 return comp.getCursor_NoClientCode(); 901 } 902 @SuppressWarnings("unchecked") 903 public <T extends ComponentPeer> T getPeer(Component comp) { 904 return (T) comp.peer; 905 } 906 public void setPeer(Component comp, ComponentPeer peer) { 907 comp.peer = peer; 908 } 909 public boolean isLightweight(Component comp) { 910 return (comp.peer instanceof LightweightPeer); 911 } 912 public boolean getIgnoreRepaint(Component comp) { 913 return comp.ignoreRepaint; 914 } 915 public int getWidth(Component comp) { 916 return comp.width; 917 } 918 public int getHeight(Component comp) { 919 return comp.height; 920 } 921 public int getX(Component comp) { 922 return comp.x; 923 } 924 public int getY(Component comp) { 925 return comp.y; 926 } 927 public Color getForeground(Component comp) { 928 return comp.foreground; 929 } 930 public Color getBackground(Component comp) { 931 return comp.background; 932 } 933 public void setBackground(Component comp, Color background) { 934 comp.background = background; 935 } 936 public Font getFont(Component comp) { 937 return comp.getFont_NoClientCode(); 938 } 939 public void processEvent(Component comp, AWTEvent e) { 940 comp.processEvent(e); 941 } 942 943 public AccessControlContext getAccessControlContext(Component comp) { 944 return comp.getAccessControlContext(); 945 } 946 947 public void revalidateSynchronously(Component comp) { 948 comp.revalidateSynchronously(); 949 } 950 951 @Override 952 public void createBufferStrategy(Component comp, int numBuffers, 953 BufferCapabilities caps) throws AWTException { 954 comp.createBufferStrategy(numBuffers, caps); 955 } 956 957 @Override 958 public BufferStrategy getBufferStrategy(Component comp) { 959 return comp.getBufferStrategy(); 960 } 961 }); 962 } 963 964 /** 965 * Constructs a new component. Class {@code Component} can be 966 * extended directly to create a lightweight component that does not 967 * utilize an opaque native window. A lightweight component must be 968 * hosted by a native container somewhere higher up in the component 969 * tree (for example, by a {@code Frame} object). 970 */ 971 protected Component() { 972 appContext = AppContext.getAppContext(); 973 } 974 975 @SuppressWarnings({"rawtypes", "unchecked"}) 976 void initializeFocusTraversalKeys() { 977 focusTraversalKeys = new Set[3]; 978 } 979 980 /** 981 * Constructs a name for this component. Called by {@code getName} 982 * when the name is {@code null}. 983 */ 984 String constructComponentName() { 985 return null; // For strict compliance with prior platform versions, a Component 986 // that doesn't set its name should return null from 987 // getName() 988 } 989 990 /** 991 * Gets the name of the component. 992 * @return this component's name 993 * @see #setName 994 * @since 1.1 995 */ 996 public String getName() { 997 if (name == null && !nameExplicitlySet) { 998 synchronized(getObjectLock()) { 999 if (name == null && !nameExplicitlySet) 1000 name = constructComponentName(); 1001 } 1002 } 1003 return name; 1004 } 1005 1006 /** 1007 * Sets the name of the component to the specified string. 1008 * @param name the string that is to be this 1009 * component's name 1010 * @see #getName 1011 * @since 1.1 1012 */ 1013 public void setName(String name) { 1014 String oldName; 1015 synchronized(getObjectLock()) { 1016 oldName = this.name; 1017 this.name = name; 1018 nameExplicitlySet = true; 1019 } 1020 firePropertyChange("name", oldName, name); 1021 } 1022 1023 /** 1024 * Gets the parent of this component. 1025 * @return the parent container of this component 1026 * @since 1.0 1027 */ 1028 public Container getParent() { 1029 return getParent_NoClientCode(); 1030 } 1031 1032 // NOTE: This method may be called by privileged threads. 1033 // This functionality is implemented in a package-private method 1034 // to insure that it cannot be overridden by client subclasses. 1035 // DO NOT INVOKE CLIENT CODE ON THIS THREAD! 1036 final Container getParent_NoClientCode() { 1037 return parent; 1038 } 1039 1040 // This method is overridden in the Window class to return null, 1041 // because the parent field of the Window object contains 1042 // the owner of the window, not its parent. 1043 Container getContainer() { 1044 return getParent_NoClientCode(); 1045 } 1046 1047 /** 1048 * Associate a {@code DropTarget} with this component. 1049 * The {@code Component} will receive drops only if it 1050 * is enabled. 1051 * 1052 * @see #isEnabled 1053 * @param dt The DropTarget 1054 */ 1055 1056 public synchronized void setDropTarget(DropTarget dt) { 1057 if (dt == dropTarget || (dropTarget != null && dropTarget.equals(dt))) 1058 return; 1059 1060 DropTarget old; 1061 1062 if ((old = dropTarget) != null) { 1063 dropTarget.removeNotify(); 1064 1065 DropTarget t = dropTarget; 1066 1067 dropTarget = null; 1068 1069 try { 1070 t.setComponent(null); 1071 } catch (IllegalArgumentException iae) { 1072 // ignore it. 1073 } 1074 } 1075 1076 // if we have a new one, and we have a peer, add it! 1077 1078 if ((dropTarget = dt) != null) { 1079 try { 1080 dropTarget.setComponent(this); 1081 dropTarget.addNotify(); 1082 } catch (IllegalArgumentException iae) { 1083 if (old != null) { 1084 try { 1085 old.setComponent(this); 1086 dropTarget.addNotify(); 1087 } catch (IllegalArgumentException iae1) { 1088 // ignore it! 1089 } 1090 } 1091 } 1092 } 1093 } 1094 1095 /** 1096 * Gets the {@code DropTarget} associated with this 1097 * {@code Component}. 1098 * 1099 * @return the drop target 1100 */ 1101 1102 public synchronized DropTarget getDropTarget() { return dropTarget; } 1103 1104 /** 1105 * Gets the {@code GraphicsConfiguration} associated with this 1106 * {@code Component}. 1107 * If the {@code Component} has not been assigned a specific 1108 * {@code GraphicsConfiguration}, 1109 * the {@code GraphicsConfiguration} of the 1110 * {@code Component} object's top-level container is 1111 * returned. 1112 * If the {@code Component} has been created, but not yet added 1113 * to a {@code Container}, this method returns {@code null}. 1114 * 1115 * @return the {@code GraphicsConfiguration} used by this 1116 * {@code Component} or {@code null} 1117 * @since 1.3 1118 */ 1119 public GraphicsConfiguration getGraphicsConfiguration() { 1120 return getGraphicsConfiguration_NoClientCode(); 1121 } 1122 1123 final GraphicsConfiguration getGraphicsConfiguration_NoClientCode() { 1124 return graphicsConfig; 1125 } 1126 1127 void setGraphicsConfiguration(GraphicsConfiguration gc) { 1128 synchronized(getTreeLock()) { 1129 if (updateGraphicsData(gc)) { 1130 removeNotify(); 1131 addNotify(); 1132 } 1133 } 1134 } 1135 1136 boolean updateGraphicsData(GraphicsConfiguration gc) { 1137 checkTreeLock(); 1138 1139 if (graphicsConfig == gc) { 1140 return false; 1141 } 1142 1143 graphicsConfig = gc; 1144 1145 ComponentPeer peer = this.peer; 1146 if (peer != null) { 1147 return peer.updateGraphicsData(gc); 1148 } 1149 return false; 1150 } 1151 1152 /** 1153 * Checks that this component's {@code GraphicsDevice} 1154 * {@code idString} matches the string argument. 1155 */ 1156 void checkGD(String stringID) { 1157 if (graphicsConfig != null) { 1158 if (!graphicsConfig.getDevice().getIDstring().equals(stringID)) { 1159 throw new IllegalArgumentException( 1160 "adding a container to a container on a different GraphicsDevice"); 1161 } 1162 } 1163 } 1164 1165 /** 1166 * Gets this component's locking object (the object that owns the thread 1167 * synchronization monitor) for AWT component-tree and layout 1168 * operations. 1169 * @return this component's locking object 1170 */ 1171 public final Object getTreeLock() { 1172 return LOCK; 1173 } 1174 1175 final void checkTreeLock() { 1176 if (!Thread.holdsLock(getTreeLock())) { 1177 throw new IllegalStateException("This function should be called while holding treeLock"); 1178 } 1179 } 1180 1181 /** 1182 * Gets the toolkit of this component. Note that 1183 * the frame that contains a component controls which 1184 * toolkit is used by that component. Therefore if the component 1185 * is moved from one frame to another, the toolkit it uses may change. 1186 * @return the toolkit of this component 1187 * @since 1.0 1188 */ 1189 public Toolkit getToolkit() { 1190 return getToolkitImpl(); 1191 } 1192 1193 /* 1194 * This is called by the native code, so client code can't 1195 * be called on the toolkit thread. 1196 */ 1197 final Toolkit getToolkitImpl() { 1198 Container parent = this.parent; 1199 if (parent != null) { 1200 return parent.getToolkitImpl(); 1201 } 1202 return Toolkit.getDefaultToolkit(); 1203 } 1204 1205 final ComponentFactory getComponentFactory() { 1206 final Toolkit toolkit = getToolkit(); 1207 if (toolkit instanceof ComponentFactory) { 1208 return (ComponentFactory) toolkit; 1209 } 1210 throw new AWTError("UI components are unsupported by: " + toolkit); 1211 } 1212 1213 /** 1214 * Determines whether this component is valid. A component is valid 1215 * when it is correctly sized and positioned within its parent 1216 * container and all its children are also valid. 1217 * In order to account for peers' size requirements, components are invalidated 1218 * before they are first shown on the screen. By the time the parent container 1219 * is fully realized, all its components will be valid. 1220 * @return {@code true} if the component is valid, {@code false} 1221 * otherwise 1222 * @see #validate 1223 * @see #invalidate 1224 * @since 1.0 1225 */ 1226 public boolean isValid() { 1227 return (peer != null) && valid; 1228 } 1229 1230 /** 1231 * Determines whether this component is displayable. A component is 1232 * displayable when it is connected to a native screen resource. 1233 * <p> 1234 * A component is made displayable either when it is added to 1235 * a displayable containment hierarchy or when its containment 1236 * hierarchy is made displayable. 1237 * A containment hierarchy is made displayable when its ancestor 1238 * window is either packed or made visible. 1239 * <p> 1240 * A component is made undisplayable either when it is removed from 1241 * a displayable containment hierarchy or when its containment hierarchy 1242 * is made undisplayable. A containment hierarchy is made 1243 * undisplayable when its ancestor window is disposed. 1244 * 1245 * @return {@code true} if the component is displayable, 1246 * {@code false} otherwise 1247 * @see Container#add(Component) 1248 * @see Window#pack 1249 * @see Window#show 1250 * @see Container#remove(Component) 1251 * @see Window#dispose 1252 * @since 1.2 1253 */ 1254 public boolean isDisplayable() { 1255 return peer != null; 1256 } 1257 1258 /** 1259 * Determines whether this component should be visible when its 1260 * parent is visible. Components are 1261 * initially visible, with the exception of top level components such 1262 * as {@code Frame} objects. 1263 * @return {@code true} if the component is visible, 1264 * {@code false} otherwise 1265 * @see #setVisible 1266 * @since 1.0 1267 */ 1268 @Transient 1269 public boolean isVisible() { 1270 return isVisible_NoClientCode(); 1271 } 1272 final boolean isVisible_NoClientCode() { 1273 return visible; 1274 } 1275 1276 /** 1277 * Determines whether this component will be displayed on the screen. 1278 * @return {@code true} if the component and all of its ancestors 1279 * until a toplevel window or null parent are visible, 1280 * {@code false} otherwise 1281 */ 1282 boolean isRecursivelyVisible() { 1283 return visible && (parent == null || parent.isRecursivelyVisible()); 1284 } 1285 1286 /** 1287 * Determines the bounds of a visible part of the component relative to its 1288 * parent. 1289 * 1290 * @return the visible part of bounds 1291 */ 1292 private Rectangle getRecursivelyVisibleBounds() { 1293 final Component container = getContainer(); 1294 final Rectangle bounds = getBounds(); 1295 if (container == null) { 1296 // we are top level window or haven't a container, return our bounds 1297 return bounds; 1298 } 1299 // translate the container's bounds to our coordinate space 1300 final Rectangle parentsBounds = container.getRecursivelyVisibleBounds(); 1301 parentsBounds.setLocation(0, 0); 1302 return parentsBounds.intersection(bounds); 1303 } 1304 1305 /** 1306 * Translates absolute coordinates into coordinates in the coordinate 1307 * space of this component. 1308 */ 1309 Point pointRelativeToComponent(Point absolute) { 1310 Point compCoords = getLocationOnScreen(); 1311 return new Point(absolute.x - compCoords.x, 1312 absolute.y - compCoords.y); 1313 } 1314 1315 /** 1316 * Assuming that mouse location is stored in PointerInfo passed 1317 * to this method, it finds a Component that is in the same 1318 * Window as this Component and is located under the mouse pointer. 1319 * If no such Component exists, null is returned. 1320 * NOTE: this method should be called under the protection of 1321 * tree lock, as it is done in Component.getMousePosition() and 1322 * Container.getMousePosition(boolean). 1323 */ 1324 Component findUnderMouseInWindow(PointerInfo pi) { 1325 if (!isShowing()) { 1326 return null; 1327 } 1328 Window win = getContainingWindow(); 1329 Toolkit toolkit = Toolkit.getDefaultToolkit(); 1330 if (!(toolkit instanceof ComponentFactory)) { 1331 return null; 1332 } 1333 if (!((ComponentFactory) toolkit).getMouseInfoPeer().isWindowUnderMouse(win)) { 1334 return null; 1335 } 1336 final boolean INCLUDE_DISABLED = true; 1337 Point relativeToWindow = win.pointRelativeToComponent(pi.getLocation()); 1338 Component inTheSameWindow = win.findComponentAt(relativeToWindow.x, 1339 relativeToWindow.y, 1340 INCLUDE_DISABLED); 1341 return inTheSameWindow; 1342 } 1343 1344 /** 1345 * Returns the position of the mouse pointer in this {@code Component}'s 1346 * coordinate space if the {@code Component} is directly under the mouse 1347 * pointer, otherwise returns {@code null}. 1348 * If the {@code Component} is not showing on the screen, this method 1349 * returns {@code null} even if the mouse pointer is above the area 1350 * where the {@code Component} would be displayed. 1351 * If the {@code Component} is partially or fully obscured by other 1352 * {@code Component}s or native windows, this method returns a non-null 1353 * value only if the mouse pointer is located above the unobscured part of the 1354 * {@code Component}. 1355 * <p> 1356 * For {@code Container}s it returns a non-null value if the mouse is 1357 * above the {@code Container} itself or above any of its descendants. 1358 * Use {@link Container#getMousePosition(boolean)} if you need to exclude children. 1359 * <p> 1360 * Sometimes the exact mouse coordinates are not important, and the only thing 1361 * that matters is whether a specific {@code Component} is under the mouse 1362 * pointer. If the return value of this method is {@code null}, mouse 1363 * pointer is not directly above the {@code Component}. 1364 * 1365 * @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true 1366 * @see #isShowing 1367 * @see Container#getMousePosition 1368 * @return mouse coordinates relative to this {@code Component}, or null 1369 * @since 1.5 1370 */ 1371 public Point getMousePosition() throws HeadlessException { 1372 if (GraphicsEnvironment.isHeadless()) { 1373 throw new HeadlessException(); 1374 } 1375 1376 PointerInfo pi = java.security.AccessController.doPrivileged( 1377 new java.security.PrivilegedAction<PointerInfo>() { 1378 public PointerInfo run() { 1379 return MouseInfo.getPointerInfo(); 1380 } 1381 } 1382 ); 1383 1384 synchronized (getTreeLock()) { 1385 Component inTheSameWindow = findUnderMouseInWindow(pi); 1386 if (!isSameOrAncestorOf(inTheSameWindow, true)) { 1387 return null; 1388 } 1389 return pointRelativeToComponent(pi.getLocation()); 1390 } 1391 } 1392 1393 /** 1394 * Overridden in Container. Must be called under TreeLock. 1395 */ 1396 boolean isSameOrAncestorOf(Component comp, boolean allowChildren) { 1397 return comp == this; 1398 } 1399 1400 /** 1401 * Determines whether this component is showing on screen. This means 1402 * that the component must be visible, and it must be in a container 1403 * that is visible and showing. 1404 * <p> 1405 * <strong>Note:</strong> sometimes there is no way to detect whether the 1406 * {@code Component} is actually visible to the user. This can happen when: 1407 * <ul> 1408 * <li>the component has been added to a visible {@code ScrollPane} but 1409 * the {@code Component} is not currently in the scroll pane's view port. 1410 * <li>the {@code Component} is obscured by another {@code Component} or 1411 * {@code Container}. 1412 * </ul> 1413 * @return {@code true} if the component is showing, 1414 * {@code false} otherwise 1415 * @see #setVisible 1416 * @since 1.0 1417 */ 1418 public boolean isShowing() { 1419 if (visible && (peer != null)) { 1420 Container parent = this.parent; 1421 return (parent == null) || parent.isShowing(); 1422 } 1423 return false; 1424 } 1425 1426 /** 1427 * Determines whether this component is enabled. An enabled component 1428 * can respond to user input and generate events. Components are 1429 * enabled initially by default. A component may be enabled or disabled by 1430 * calling its {@code setEnabled} method. 1431 * @return {@code true} if the component is enabled, 1432 * {@code false} otherwise 1433 * @see #setEnabled 1434 * @since 1.0 1435 */ 1436 public boolean isEnabled() { 1437 return isEnabledImpl(); 1438 } 1439 1440 /* 1441 * This is called by the native code, so client code can't 1442 * be called on the toolkit thread. 1443 */ 1444 final boolean isEnabledImpl() { 1445 return enabled; 1446 } 1447 1448 /** 1449 * Enables or disables this component, depending on the value of the 1450 * parameter {@code b}. An enabled component can respond to user 1451 * input and generate events. Components are enabled initially by default. 1452 * 1453 * <p>Note: Disabling a lightweight component does not prevent it from 1454 * receiving MouseEvents. 1455 * <p>Note: Disabling a heavyweight container prevents all components 1456 * in this container from receiving any input events. But disabling a 1457 * lightweight container affects only this container. 1458 * 1459 * @param b If {@code true}, this component is 1460 * enabled; otherwise this component is disabled 1461 * @see #isEnabled 1462 * @see #isLightweight 1463 * @since 1.1 1464 */ 1465 public void setEnabled(boolean b) { 1466 enable(b); 1467 } 1468 1469 /** 1470 * @deprecated As of JDK version 1.1, 1471 * replaced by {@code setEnabled(boolean)}. 1472 */ 1473 @Deprecated 1474 public void enable() { 1475 if (!enabled) { 1476 synchronized (getTreeLock()) { 1477 enabled = true; 1478 ComponentPeer peer = this.peer; 1479 if (peer != null) { 1480 peer.setEnabled(true); 1481 if (visible && !getRecursivelyVisibleBounds().isEmpty()) { 1482 updateCursorImmediately(); 1483 } 1484 } 1485 } 1486 if (accessibleContext != null) { 1487 accessibleContext.firePropertyChange( 1488 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 1489 null, AccessibleState.ENABLED); 1490 } 1491 } 1492 } 1493 1494 /** 1495 * Enables or disables this component. 1496 * 1497 * @param b {@code true} to enable this component; 1498 * otherwise {@code false} 1499 * 1500 * @deprecated As of JDK version 1.1, 1501 * replaced by {@code setEnabled(boolean)}. 1502 */ 1503 @Deprecated 1504 public void enable(boolean b) { 1505 if (b) { 1506 enable(); 1507 } else { 1508 disable(); 1509 } 1510 } 1511 1512 /** 1513 * @deprecated As of JDK version 1.1, 1514 * replaced by {@code setEnabled(boolean)}. 1515 */ 1516 @Deprecated 1517 public void disable() { 1518 if (enabled) { 1519 KeyboardFocusManager.clearMostRecentFocusOwner(this); 1520 synchronized (getTreeLock()) { 1521 enabled = false; 1522 // A disabled lw container is allowed to contain a focus owner. 1523 if ((isFocusOwner() || (containsFocus() && !isLightweight())) && 1524 KeyboardFocusManager.isAutoFocusTransferEnabled()) 1525 { 1526 // Don't clear the global focus owner. If transferFocus 1527 // fails, we want the focus to stay on the disabled 1528 // Component so that keyboard traversal, et. al. still 1529 // makes sense to the user. 1530 transferFocus(false); 1531 } 1532 ComponentPeer peer = this.peer; 1533 if (peer != null) { 1534 peer.setEnabled(false); 1535 if (visible && !getRecursivelyVisibleBounds().isEmpty()) { 1536 updateCursorImmediately(); 1537 } 1538 } 1539 } 1540 if (accessibleContext != null) { 1541 accessibleContext.firePropertyChange( 1542 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 1543 null, AccessibleState.ENABLED); 1544 } 1545 } 1546 } 1547 1548 /** 1549 * Returns true if this component is painted to an offscreen image 1550 * ("buffer") that's copied to the screen later. Component 1551 * subclasses that support double buffering should override this 1552 * method to return true if double buffering is enabled. 1553 * 1554 * @return false by default 1555 */ 1556 public boolean isDoubleBuffered() { 1557 return false; 1558 } 1559 1560 /** 1561 * Enables or disables input method support for this component. If input 1562 * method support is enabled and the component also processes key events, 1563 * incoming events are offered to 1564 * the current input method and will only be processed by the component or 1565 * dispatched to its listeners if the input method does not consume them. 1566 * By default, input method support is enabled. 1567 * 1568 * @param enable true to enable, false to disable 1569 * @see #processKeyEvent 1570 * @since 1.2 1571 */ 1572 public void enableInputMethods(boolean enable) { 1573 if (enable) { 1574 if ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) 1575 return; 1576 1577 // If this component already has focus, then activate the 1578 // input method by dispatching a synthesized focus gained 1579 // event. 1580 if (isFocusOwner()) { 1581 InputContext inputContext = getInputContext(); 1582 if (inputContext != null) { 1583 FocusEvent focusGainedEvent = 1584 new FocusEvent(this, FocusEvent.FOCUS_GAINED); 1585 inputContext.dispatchEvent(focusGainedEvent); 1586 } 1587 } 1588 1589 eventMask |= AWTEvent.INPUT_METHODS_ENABLED_MASK; 1590 } else { 1591 if ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) { 1592 InputContext inputContext = getInputContext(); 1593 if (inputContext != null) { 1594 inputContext.endComposition(); 1595 inputContext.removeNotify(this); 1596 } 1597 } 1598 eventMask &= ~AWTEvent.INPUT_METHODS_ENABLED_MASK; 1599 } 1600 } 1601 1602 /** 1603 * Shows or hides this component depending on the value of parameter 1604 * {@code b}. 1605 * <p> 1606 * This method changes layout-related information, and therefore, 1607 * invalidates the component hierarchy. 1608 * 1609 * @param b if {@code true}, shows this component; 1610 * otherwise, hides this component 1611 * @see #isVisible 1612 * @see #invalidate 1613 * @since 1.1 1614 */ 1615 public void setVisible(boolean b) { 1616 show(b); 1617 } 1618 1619 /** 1620 * @deprecated As of JDK version 1.1, 1621 * replaced by {@code setVisible(boolean)}. 1622 */ 1623 @Deprecated 1624 public void show() { 1625 if (!visible) { 1626 synchronized (getTreeLock()) { 1627 visible = true; 1628 mixOnShowing(); 1629 ComponentPeer peer = this.peer; 1630 if (peer != null) { 1631 peer.setVisible(true); 1632 createHierarchyEvents(HierarchyEvent.HIERARCHY_CHANGED, 1633 this, parent, 1634 HierarchyEvent.SHOWING_CHANGED, 1635 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK)); 1636 if (peer instanceof LightweightPeer) { 1637 repaint(); 1638 } 1639 updateCursorImmediately(); 1640 } 1641 1642 if (componentListener != null || 1643 (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 || 1644 Toolkit.enabledOnToolkit(AWTEvent.COMPONENT_EVENT_MASK)) { 1645 ComponentEvent e = new ComponentEvent(this, 1646 ComponentEvent.COMPONENT_SHOWN); 1647 Toolkit.getEventQueue().postEvent(e); 1648 } 1649 } 1650 Container parent = this.parent; 1651 if (parent != null) { 1652 parent.invalidate(); 1653 } 1654 } 1655 } 1656 1657 /** 1658 * Makes this component visible or invisible. 1659 * 1660 * @param b {@code true} to make this component visible; 1661 * otherwise {@code false} 1662 * 1663 * @deprecated As of JDK version 1.1, 1664 * replaced by {@code setVisible(boolean)}. 1665 */ 1666 @Deprecated 1667 public void show(boolean b) { 1668 if (b) { 1669 show(); 1670 } else { 1671 hide(); 1672 } 1673 } 1674 1675 boolean containsFocus() { 1676 return isFocusOwner(); 1677 } 1678 1679 void clearMostRecentFocusOwnerOnHide() { 1680 KeyboardFocusManager.clearMostRecentFocusOwner(this); 1681 } 1682 1683 void clearCurrentFocusCycleRootOnHide() { 1684 /* do nothing */ 1685 } 1686 1687 /** 1688 * @deprecated As of JDK version 1.1, 1689 * replaced by {@code setVisible(boolean)}. 1690 */ 1691 @Deprecated 1692 public void hide() { 1693 isPacked = false; 1694 1695 if (visible) { 1696 clearCurrentFocusCycleRootOnHide(); 1697 clearMostRecentFocusOwnerOnHide(); 1698 synchronized (getTreeLock()) { 1699 visible = false; 1700 mixOnHiding(isLightweight()); 1701 if (containsFocus() && KeyboardFocusManager.isAutoFocusTransferEnabled()) { 1702 transferFocus(true); 1703 } 1704 ComponentPeer peer = this.peer; 1705 if (peer != null) { 1706 peer.setVisible(false); 1707 createHierarchyEvents(HierarchyEvent.HIERARCHY_CHANGED, 1708 this, parent, 1709 HierarchyEvent.SHOWING_CHANGED, 1710 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK)); 1711 if (peer instanceof LightweightPeer) { 1712 repaint(); 1713 } 1714 updateCursorImmediately(); 1715 } 1716 if (componentListener != null || 1717 (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 || 1718 Toolkit.enabledOnToolkit(AWTEvent.COMPONENT_EVENT_MASK)) { 1719 ComponentEvent e = new ComponentEvent(this, 1720 ComponentEvent.COMPONENT_HIDDEN); 1721 Toolkit.getEventQueue().postEvent(e); 1722 } 1723 } 1724 Container parent = this.parent; 1725 if (parent != null) { 1726 parent.invalidate(); 1727 } 1728 } 1729 } 1730 1731 /** 1732 * Gets the foreground color of this component. 1733 * @return this component's foreground color; if this component does 1734 * not have a foreground color, the foreground color of its parent 1735 * is returned 1736 * @see #setForeground 1737 * @since 1.0 1738 */ 1739 @Transient 1740 public Color getForeground() { 1741 Color foreground = this.foreground; 1742 if (foreground != null) { 1743 return foreground; 1744 } 1745 Container parent = this.parent; 1746 return (parent != null) ? parent.getForeground() : null; 1747 } 1748 1749 /** 1750 * Sets the foreground color of this component. 1751 * @param c the color to become this component's 1752 * foreground color; if this parameter is {@code null} 1753 * then this component will inherit 1754 * the foreground color of its parent 1755 * @see #getForeground 1756 * @since 1.0 1757 */ 1758 public void setForeground(Color c) { 1759 Color oldColor = foreground; 1760 ComponentPeer peer = this.peer; 1761 foreground = c; 1762 if (peer != null) { 1763 c = getForeground(); 1764 if (c != null) { 1765 peer.setForeground(c); 1766 } 1767 } 1768 // This is a bound property, so report the change to 1769 // any registered listeners. (Cheap if there are none.) 1770 firePropertyChange("foreground", oldColor, c); 1771 } 1772 1773 /** 1774 * Returns whether the foreground color has been explicitly set for this 1775 * Component. If this method returns {@code false}, this Component is 1776 * inheriting its foreground color from an ancestor. 1777 * 1778 * @return {@code true} if the foreground color has been explicitly 1779 * set for this Component; {@code false} otherwise. 1780 * @since 1.4 1781 */ 1782 public boolean isForegroundSet() { 1783 return (foreground != null); 1784 } 1785 1786 /** 1787 * Gets the background color of this component. 1788 * @return this component's background color; if this component does 1789 * not have a background color, 1790 * the background color of its parent is returned 1791 * @see #setBackground 1792 * @since 1.0 1793 */ 1794 @Transient 1795 public Color getBackground() { 1796 Color background = this.background; 1797 if (background != null) { 1798 return background; 1799 } 1800 Container parent = this.parent; 1801 return (parent != null) ? parent.getBackground() : null; 1802 } 1803 1804 /** 1805 * Sets the background color of this component. 1806 * <p> 1807 * The background color affects each component differently and the 1808 * parts of the component that are affected by the background color 1809 * may differ between operating systems. 1810 * 1811 * @param c the color to become this component's color; 1812 * if this parameter is {@code null}, then this 1813 * component will inherit the background color of its parent 1814 * @see #getBackground 1815 * @since 1.0 1816 */ 1817 public void setBackground(Color c) { 1818 Color oldColor = background; 1819 ComponentPeer peer = this.peer; 1820 background = c; 1821 if (peer != null) { 1822 c = getBackground(); 1823 if (c != null) { 1824 peer.setBackground(c); 1825 } 1826 } 1827 // This is a bound property, so report the change to 1828 // any registered listeners. (Cheap if there are none.) 1829 firePropertyChange("background", oldColor, c); 1830 } 1831 1832 /** 1833 * Returns whether the background color has been explicitly set for this 1834 * Component. If this method returns {@code false}, this Component is 1835 * inheriting its background color from an ancestor. 1836 * 1837 * @return {@code true} if the background color has been explicitly 1838 * set for this Component; {@code false} otherwise. 1839 * @since 1.4 1840 */ 1841 public boolean isBackgroundSet() { 1842 return (background != null); 1843 } 1844 1845 /** 1846 * Gets the font of this component. 1847 * @return this component's font; if a font has not been set 1848 * for this component, the font of its parent is returned 1849 * @see #setFont 1850 * @since 1.0 1851 */ 1852 @Transient 1853 public Font getFont() { 1854 return getFont_NoClientCode(); 1855 } 1856 1857 // NOTE: This method may be called by privileged threads. 1858 // This functionality is implemented in a package-private method 1859 // to insure that it cannot be overridden by client subclasses. 1860 // DO NOT INVOKE CLIENT CODE ON THIS THREAD! 1861 final Font getFont_NoClientCode() { 1862 Font font = this.font; 1863 if (font != null) { 1864 return font; 1865 } 1866 Container parent = this.parent; 1867 return (parent != null) ? parent.getFont_NoClientCode() : null; 1868 } 1869 1870 /** 1871 * Sets the font of this component. 1872 * <p> 1873 * This method changes layout-related information, and therefore, 1874 * invalidates the component hierarchy. 1875 * 1876 * @param f the font to become this component's font; 1877 * if this parameter is {@code null} then this 1878 * component will inherit the font of its parent 1879 * @see #getFont 1880 * @see #invalidate 1881 * @since 1.0 1882 */ 1883 public void setFont(Font f) { 1884 Font oldFont, newFont; 1885 synchronized(getTreeLock()) { 1886 oldFont = font; 1887 newFont = font = f; 1888 ComponentPeer peer = this.peer; 1889 if (peer != null) { 1890 f = getFont(); 1891 if (f != null) { 1892 peer.setFont(f); 1893 peerFont = f; 1894 } 1895 } 1896 } 1897 // This is a bound property, so report the change to 1898 // any registered listeners. (Cheap if there are none.) 1899 firePropertyChange("font", oldFont, newFont); 1900 1901 // This could change the preferred size of the Component. 1902 // Fix for 6213660. Should compare old and new fonts and do not 1903 // call invalidate() if they are equal. 1904 if (f != oldFont && (oldFont == null || 1905 !oldFont.equals(f))) { 1906 invalidateIfValid(); 1907 } 1908 } 1909 1910 /** 1911 * Returns whether the font has been explicitly set for this Component. If 1912 * this method returns {@code false}, this Component is inheriting its 1913 * font from an ancestor. 1914 * 1915 * @return {@code true} if the font has been explicitly set for this 1916 * Component; {@code false} otherwise. 1917 * @since 1.4 1918 */ 1919 public boolean isFontSet() { 1920 return (font != null); 1921 } 1922 1923 /** 1924 * Gets the locale of this component. 1925 * @return this component's locale; if this component does not 1926 * have a locale, the locale of its parent is returned 1927 * @see #setLocale 1928 * @exception IllegalComponentStateException if the {@code Component} 1929 * does not have its own locale and has not yet been added to 1930 * a containment hierarchy such that the locale can be determined 1931 * from the containing parent 1932 * @since 1.1 1933 */ 1934 public Locale getLocale() { 1935 Locale locale = this.locale; 1936 if (locale != null) { 1937 return locale; 1938 } 1939 Container parent = this.parent; 1940 1941 if (parent == null) { 1942 throw new IllegalComponentStateException("This component must have a parent in order to determine its locale"); 1943 } else { 1944 return parent.getLocale(); 1945 } 1946 } 1947 1948 /** 1949 * Sets the locale of this component. This is a bound property. 1950 * <p> 1951 * This method changes layout-related information, and therefore, 1952 * invalidates the component hierarchy. 1953 * 1954 * @param l the locale to become this component's locale 1955 * @see #getLocale 1956 * @see #invalidate 1957 * @since 1.1 1958 */ 1959 public void setLocale(Locale l) { 1960 Locale oldValue = locale; 1961 locale = l; 1962 1963 // This is a bound property, so report the change to 1964 // any registered listeners. (Cheap if there are none.) 1965 firePropertyChange("locale", oldValue, l); 1966 1967 // This could change the preferred size of the Component. 1968 invalidateIfValid(); 1969 } 1970 1971 /** 1972 * Gets the instance of {@code ColorModel} used to display 1973 * the component on the output device. 1974 * @return the color model used by this component 1975 * @see java.awt.image.ColorModel 1976 * @see java.awt.peer.ComponentPeer#getColorModel() 1977 * @see Toolkit#getColorModel() 1978 * @since 1.0 1979 */ 1980 public ColorModel getColorModel() { 1981 ComponentPeer peer = this.peer; 1982 if ((peer != null) && ! (peer instanceof LightweightPeer)) { 1983 return peer.getColorModel(); 1984 } else if (GraphicsEnvironment.isHeadless()) { 1985 return ColorModel.getRGBdefault(); 1986 } // else 1987 return getToolkit().getColorModel(); 1988 } 1989 1990 /** 1991 * Gets the location of this component in the form of a 1992 * point specifying the component's top-left corner. 1993 * The location will be relative to the parent's coordinate space. 1994 * <p> 1995 * Due to the asynchronous nature of native event handling, this 1996 * method can return outdated values (for instance, after several calls 1997 * of {@code setLocation()} in rapid succession). For this 1998 * reason, the recommended method of obtaining a component's position is 1999 * within {@code java.awt.event.ComponentListener.componentMoved()}, 2000 * which is called after the operating system has finished moving the 2001 * component. 2002 * </p> 2003 * @return an instance of {@code Point} representing 2004 * the top-left corner of the component's bounds in 2005 * the coordinate space of the component's parent 2006 * @see #setLocation 2007 * @see #getLocationOnScreen 2008 * @since 1.1 2009 */ 2010 public Point getLocation() { 2011 return location(); 2012 } 2013 2014 /** 2015 * Gets the location of this component in the form of a point 2016 * specifying the component's top-left corner in the screen's 2017 * coordinate space. 2018 * @return an instance of {@code Point} representing 2019 * the top-left corner of the component's bounds in the 2020 * coordinate space of the screen 2021 * @throws IllegalComponentStateException if the 2022 * component is not showing on the screen 2023 * @see #setLocation 2024 * @see #getLocation 2025 */ 2026 public Point getLocationOnScreen() { 2027 synchronized (getTreeLock()) { 2028 return getLocationOnScreen_NoTreeLock(); 2029 } 2030 } 2031 2032 /* 2033 * a package private version of getLocationOnScreen 2034 * used by GlobalCursormanager to update cursor 2035 */ 2036 final Point getLocationOnScreen_NoTreeLock() { 2037 2038 if (peer != null && isShowing()) { 2039 if (peer instanceof LightweightPeer) { 2040 // lightweight component location needs to be translated 2041 // relative to a native component. 2042 Container host = getNativeContainer(); 2043 Point pt = host.peer.getLocationOnScreen(); 2044 for(Component c = this; c != host; c = c.getParent()) { 2045 pt.x += c.x; 2046 pt.y += c.y; 2047 } 2048 return pt; 2049 } else { 2050 Point pt = peer.getLocationOnScreen(); 2051 return pt; 2052 } 2053 } else { 2054 throw new IllegalComponentStateException("component must be showing on the screen to determine its location"); 2055 } 2056 } 2057 2058 2059 /** 2060 * Returns the location of this component's top left corner. 2061 * 2062 * @return the location of this component's top left corner 2063 * @deprecated As of JDK version 1.1, 2064 * replaced by {@code getLocation()}. 2065 */ 2066 @Deprecated 2067 public Point location() { 2068 return location_NoClientCode(); 2069 } 2070 2071 private Point location_NoClientCode() { 2072 return new Point(x, y); 2073 } 2074 2075 /** 2076 * Moves this component to a new location. The top-left corner of 2077 * the new location is specified by the {@code x} and {@code y} 2078 * parameters in the coordinate space of this component's parent. 2079 * <p> 2080 * This method changes layout-related information, and therefore, 2081 * invalidates the component hierarchy. 2082 * 2083 * @param x the <i>x</i>-coordinate of the new location's 2084 * top-left corner in the parent's coordinate space 2085 * @param y the <i>y</i>-coordinate of the new location's 2086 * top-left corner in the parent's coordinate space 2087 * @see #getLocation 2088 * @see #setBounds 2089 * @see #invalidate 2090 * @since 1.1 2091 */ 2092 public void setLocation(int x, int y) { 2093 move(x, y); 2094 } 2095 2096 /** 2097 * Moves this component to a new location. 2098 * 2099 * @param x the <i>x</i>-coordinate of the new location's 2100 * top-left corner in the parent's coordinate space 2101 * @param y the <i>y</i>-coordinate of the new location's 2102 * top-left corner in the parent's coordinate space 2103 * 2104 * @deprecated As of JDK version 1.1, 2105 * replaced by {@code setLocation(int, int)}. 2106 */ 2107 @Deprecated 2108 public void move(int x, int y) { 2109 synchronized(getTreeLock()) { 2110 setBoundsOp(ComponentPeer.SET_LOCATION); 2111 setBounds(x, y, width, height); 2112 } 2113 } 2114 2115 /** 2116 * Moves this component to a new location. The top-left corner of 2117 * the new location is specified by point {@code p}. Point 2118 * {@code p} is given in the parent's coordinate space. 2119 * <p> 2120 * This method changes layout-related information, and therefore, 2121 * invalidates the component hierarchy. 2122 * 2123 * @param p the point defining the top-left corner 2124 * of the new location, given in the coordinate space of this 2125 * component's parent 2126 * @see #getLocation 2127 * @see #setBounds 2128 * @see #invalidate 2129 * @since 1.1 2130 */ 2131 public void setLocation(Point p) { 2132 setLocation(p.x, p.y); 2133 } 2134 2135 /** 2136 * Returns the size of this component in the form of a 2137 * {@code Dimension} object. The {@code height} 2138 * field of the {@code Dimension} object contains 2139 * this component's height, and the {@code width} 2140 * field of the {@code Dimension} object contains 2141 * this component's width. 2142 * @return a {@code Dimension} object that indicates the 2143 * size of this component 2144 * @see #setSize 2145 * @since 1.1 2146 */ 2147 public Dimension getSize() { 2148 return size(); 2149 } 2150 2151 /** 2152 * Returns the size of this component in the form of a 2153 * {@code Dimension} object. 2154 * 2155 * @return the {@code Dimension} object that indicates the 2156 * size of this component 2157 * @deprecated As of JDK version 1.1, 2158 * replaced by {@code getSize()}. 2159 */ 2160 @Deprecated 2161 public Dimension size() { 2162 return new Dimension(width, height); 2163 } 2164 2165 /** 2166 * Resizes this component so that it has width {@code width} 2167 * and height {@code height}. 2168 * <p> 2169 * This method changes layout-related information, and therefore, 2170 * invalidates the component hierarchy. 2171 * 2172 * @param width the new width of this component in pixels 2173 * @param height the new height of this component in pixels 2174 * @see #getSize 2175 * @see #setBounds 2176 * @see #invalidate 2177 * @since 1.1 2178 */ 2179 public void setSize(int width, int height) { 2180 resize(width, height); 2181 } 2182 2183 /** 2184 * Resizes this component. 2185 * 2186 * @param width the new width of the component 2187 * @param height the new height of the component 2188 * @deprecated As of JDK version 1.1, 2189 * replaced by {@code setSize(int, int)}. 2190 */ 2191 @Deprecated 2192 public void resize(int width, int height) { 2193 synchronized(getTreeLock()) { 2194 setBoundsOp(ComponentPeer.SET_SIZE); 2195 setBounds(x, y, width, height); 2196 } 2197 } 2198 2199 /** 2200 * Resizes this component so that it has width {@code d.width} 2201 * and height {@code d.height}. 2202 * <p> 2203 * This method changes layout-related information, and therefore, 2204 * invalidates the component hierarchy. 2205 * 2206 * @param d the dimension specifying the new size 2207 * of this component 2208 * @throws NullPointerException if {@code d} is {@code null} 2209 * @see #setSize 2210 * @see #setBounds 2211 * @see #invalidate 2212 * @since 1.1 2213 */ 2214 public void setSize(Dimension d) { 2215 resize(d); 2216 } 2217 2218 /** 2219 * Resizes this component so that it has width {@code d.width} 2220 * and height {@code d.height}. 2221 * 2222 * @param d the new size of this component 2223 * @deprecated As of JDK version 1.1, 2224 * replaced by {@code setSize(Dimension)}. 2225 */ 2226 @Deprecated 2227 public void resize(Dimension d) { 2228 setSize(d.width, d.height); 2229 } 2230 2231 /** 2232 * Gets the bounds of this component in the form of a 2233 * {@code Rectangle} object. The bounds specify this 2234 * component's width, height, and location relative to 2235 * its parent. 2236 * @return a rectangle indicating this component's bounds 2237 * @see #setBounds 2238 * @see #getLocation 2239 * @see #getSize 2240 */ 2241 public Rectangle getBounds() { 2242 return bounds(); 2243 } 2244 2245 /** 2246 * Returns the bounding rectangle of this component. 2247 * 2248 * @return the bounding rectangle for this component 2249 * @deprecated As of JDK version 1.1, 2250 * replaced by {@code getBounds()}. 2251 */ 2252 @Deprecated 2253 public Rectangle bounds() { 2254 return new Rectangle(x, y, width, height); 2255 } 2256 2257 /** 2258 * Moves and resizes this component. The new location of the top-left 2259 * corner is specified by {@code x} and {@code y}, and the 2260 * new size is specified by {@code width} and {@code height}. 2261 * <p> 2262 * This method changes layout-related information, and therefore, 2263 * invalidates the component hierarchy. 2264 * 2265 * @param x the new <i>x</i>-coordinate of this component 2266 * @param y the new <i>y</i>-coordinate of this component 2267 * @param width the new {@code width} of this component 2268 * @param height the new {@code height} of this 2269 * component 2270 * @see #getBounds 2271 * @see #setLocation(int, int) 2272 * @see #setLocation(Point) 2273 * @see #setSize(int, int) 2274 * @see #setSize(Dimension) 2275 * @see #invalidate 2276 * @since 1.1 2277 */ 2278 public void setBounds(int x, int y, int width, int height) { 2279 reshape(x, y, width, height); 2280 } 2281 2282 /** 2283 * Reshapes the bounding rectangle for this component. 2284 * 2285 * @param x the <i>x</i> coordinate of the upper left corner of the rectangle 2286 * @param y the <i>y</i> coordinate of the upper left corner of the rectangle 2287 * @param width the width of the rectangle 2288 * @param height the height of the rectangle 2289 * 2290 * @deprecated As of JDK version 1.1, 2291 * replaced by {@code setBounds(int, int, int, int)}. 2292 */ 2293 @Deprecated 2294 public void reshape(int x, int y, int width, int height) { 2295 synchronized (getTreeLock()) { 2296 try { 2297 setBoundsOp(ComponentPeer.SET_BOUNDS); 2298 boolean resized = (this.width != width) || (this.height != height); 2299 boolean moved = (this.x != x) || (this.y != y); 2300 if (!resized && !moved) { 2301 return; 2302 } 2303 int oldX = this.x; 2304 int oldY = this.y; 2305 int oldWidth = this.width; 2306 int oldHeight = this.height; 2307 this.x = x; 2308 this.y = y; 2309 this.width = width; 2310 this.height = height; 2311 2312 if (resized) { 2313 isPacked = false; 2314 } 2315 2316 boolean needNotify = true; 2317 mixOnReshaping(); 2318 if (peer != null) { 2319 // LightweightPeer is an empty stub so can skip peer.reshape 2320 if (!(peer instanceof LightweightPeer)) { 2321 reshapeNativePeer(x, y, width, height, getBoundsOp()); 2322 // Check peer actually changed coordinates 2323 resized = (oldWidth != this.width) || (oldHeight != this.height); 2324 moved = (oldX != this.x) || (oldY != this.y); 2325 // fix for 5025858: do not send ComponentEvents for toplevel 2326 // windows here as it is done from peer or native code when 2327 // the window is really resized or moved, otherwise some 2328 // events may be sent twice 2329 if (this instanceof Window) { 2330 needNotify = false; 2331 } 2332 } 2333 if (resized) { 2334 invalidate(); 2335 } 2336 if (parent != null) { 2337 parent.invalidateIfValid(); 2338 } 2339 } 2340 if (needNotify) { 2341 notifyNewBounds(resized, moved); 2342 } 2343 repaintParentIfNeeded(oldX, oldY, oldWidth, oldHeight); 2344 } finally { 2345 setBoundsOp(ComponentPeer.RESET_OPERATION); 2346 } 2347 } 2348 } 2349 2350 private void repaintParentIfNeeded(int oldX, int oldY, int oldWidth, 2351 int oldHeight) 2352 { 2353 if (parent != null && peer instanceof LightweightPeer && isShowing()) { 2354 // Have the parent redraw the area this component occupied. 2355 parent.repaint(oldX, oldY, oldWidth, oldHeight); 2356 // Have the parent redraw the area this component *now* occupies. 2357 repaint(); 2358 } 2359 } 2360 2361 private void reshapeNativePeer(int x, int y, int width, int height, int op) { 2362 // native peer might be offset by more than direct 2363 // parent since parent might be lightweight. 2364 int nativeX = x; 2365 int nativeY = y; 2366 for (Component c = parent; 2367 (c != null) && (c.peer instanceof LightweightPeer); 2368 c = c.parent) 2369 { 2370 nativeX += c.x; 2371 nativeY += c.y; 2372 } 2373 peer.setBounds(nativeX, nativeY, width, height, op); 2374 } 2375 2376 @SuppressWarnings("deprecation") 2377 private void notifyNewBounds(boolean resized, boolean moved) { 2378 if (componentListener != null 2379 || (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 2380 || Toolkit.enabledOnToolkit(AWTEvent.COMPONENT_EVENT_MASK)) 2381 { 2382 if (resized) { 2383 ComponentEvent e = new ComponentEvent(this, 2384 ComponentEvent.COMPONENT_RESIZED); 2385 Toolkit.getEventQueue().postEvent(e); 2386 } 2387 if (moved) { 2388 ComponentEvent e = new ComponentEvent(this, 2389 ComponentEvent.COMPONENT_MOVED); 2390 Toolkit.getEventQueue().postEvent(e); 2391 } 2392 } else { 2393 if (this instanceof Container && ((Container)this).countComponents() > 0) { 2394 boolean enabledOnToolkit = 2395 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK); 2396 if (resized) { 2397 2398 ((Container)this).createChildHierarchyEvents( 2399 HierarchyEvent.ANCESTOR_RESIZED, 0, enabledOnToolkit); 2400 } 2401 if (moved) { 2402 ((Container)this).createChildHierarchyEvents( 2403 HierarchyEvent.ANCESTOR_MOVED, 0, enabledOnToolkit); 2404 } 2405 } 2406 } 2407 } 2408 2409 /** 2410 * Moves and resizes this component to conform to the new 2411 * bounding rectangle {@code r}. This component's new 2412 * position is specified by {@code r.x} and {@code r.y}, 2413 * and its new size is specified by {@code r.width} and 2414 * {@code r.height} 2415 * <p> 2416 * This method changes layout-related information, and therefore, 2417 * invalidates the component hierarchy. 2418 * 2419 * @param r the new bounding rectangle for this component 2420 * @throws NullPointerException if {@code r} is {@code null} 2421 * @see #getBounds 2422 * @see #setLocation(int, int) 2423 * @see #setLocation(Point) 2424 * @see #setSize(int, int) 2425 * @see #setSize(Dimension) 2426 * @see #invalidate 2427 * @since 1.1 2428 */ 2429 public void setBounds(Rectangle r) { 2430 setBounds(r.x, r.y, r.width, r.height); 2431 } 2432 2433 2434 /** 2435 * Returns the current x coordinate of the components origin. 2436 * This method is preferable to writing 2437 * {@code component.getBounds().x}, 2438 * or {@code component.getLocation().x} because it doesn't 2439 * cause any heap allocations. 2440 * 2441 * @return the current x coordinate of the components origin 2442 * @since 1.2 2443 */ 2444 public int getX() { 2445 return x; 2446 } 2447 2448 2449 /** 2450 * Returns the current y coordinate of the components origin. 2451 * This method is preferable to writing 2452 * {@code component.getBounds().y}, 2453 * or {@code component.getLocation().y} because it 2454 * doesn't cause any heap allocations. 2455 * 2456 * @return the current y coordinate of the components origin 2457 * @since 1.2 2458 */ 2459 public int getY() { 2460 return y; 2461 } 2462 2463 2464 /** 2465 * Returns the current width of this component. 2466 * This method is preferable to writing 2467 * {@code component.getBounds().width}, 2468 * or {@code component.getSize().width} because it 2469 * doesn't cause any heap allocations. 2470 * 2471 * @return the current width of this component 2472 * @since 1.2 2473 */ 2474 public int getWidth() { 2475 return width; 2476 } 2477 2478 2479 /** 2480 * Returns the current height of this component. 2481 * This method is preferable to writing 2482 * {@code component.getBounds().height}, 2483 * or {@code component.getSize().height} because it 2484 * doesn't cause any heap allocations. 2485 * 2486 * @return the current height of this component 2487 * @since 1.2 2488 */ 2489 public int getHeight() { 2490 return height; 2491 } 2492 2493 /** 2494 * Stores the bounds of this component into "return value" <b>rv</b> and 2495 * return <b>rv</b>. If rv is {@code null} a new 2496 * {@code Rectangle} is allocated. 2497 * This version of {@code getBounds} is useful if the caller 2498 * wants to avoid allocating a new {@code Rectangle} object 2499 * on the heap. 2500 * 2501 * @param rv the return value, modified to the components bounds 2502 * @return rv 2503 */ 2504 public Rectangle getBounds(Rectangle rv) { 2505 if (rv == null) { 2506 return new Rectangle(getX(), getY(), getWidth(), getHeight()); 2507 } 2508 else { 2509 rv.setBounds(getX(), getY(), getWidth(), getHeight()); 2510 return rv; 2511 } 2512 } 2513 2514 /** 2515 * Stores the width/height of this component into "return value" <b>rv</b> 2516 * and return <b>rv</b>. If rv is {@code null} a new 2517 * {@code Dimension} object is allocated. This version of 2518 * {@code getSize} is useful if the caller wants to avoid 2519 * allocating a new {@code Dimension} object on the heap. 2520 * 2521 * @param rv the return value, modified to the components size 2522 * @return rv 2523 */ 2524 public Dimension getSize(Dimension rv) { 2525 if (rv == null) { 2526 return new Dimension(getWidth(), getHeight()); 2527 } 2528 else { 2529 rv.setSize(getWidth(), getHeight()); 2530 return rv; 2531 } 2532 } 2533 2534 /** 2535 * Stores the x,y origin of this component into "return value" <b>rv</b> 2536 * and return <b>rv</b>. If rv is {@code null} a new 2537 * {@code Point} is allocated. 2538 * This version of {@code getLocation} is useful if the 2539 * caller wants to avoid allocating a new {@code Point} 2540 * object on the heap. 2541 * 2542 * @param rv the return value, modified to the components location 2543 * @return rv 2544 */ 2545 public Point getLocation(Point rv) { 2546 if (rv == null) { 2547 return new Point(getX(), getY()); 2548 } 2549 else { 2550 rv.setLocation(getX(), getY()); 2551 return rv; 2552 } 2553 } 2554 2555 /** 2556 * Returns true if this component is completely opaque, returns 2557 * false by default. 2558 * <p> 2559 * An opaque component paints every pixel within its 2560 * rectangular region. A non-opaque component paints only some of 2561 * its pixels, allowing the pixels underneath it to "show through". 2562 * A component that does not fully paint its pixels therefore 2563 * provides a degree of transparency. 2564 * <p> 2565 * Subclasses that guarantee to always completely paint their 2566 * contents should override this method and return true. 2567 * 2568 * @return true if this component is completely opaque 2569 * @see #isLightweight 2570 * @since 1.2 2571 */ 2572 public boolean isOpaque() { 2573 if (peer == null) { 2574 return false; 2575 } 2576 else { 2577 return !isLightweight(); 2578 } 2579 } 2580 2581 2582 /** 2583 * A lightweight component doesn't have a native toolkit peer. 2584 * Subclasses of {@code Component} and {@code Container}, 2585 * other than the ones defined in this package like {@code Button} 2586 * or {@code Scrollbar}, are lightweight. 2587 * All of the Swing components are lightweights. 2588 * <p> 2589 * This method will always return {@code false} if this component 2590 * is not displayable because it is impossible to determine the 2591 * weight of an undisplayable component. 2592 * 2593 * @return true if this component has a lightweight peer; false if 2594 * it has a native peer or no peer 2595 * @see #isDisplayable 2596 * @since 1.2 2597 */ 2598 public boolean isLightweight() { 2599 return peer instanceof LightweightPeer; 2600 } 2601 2602 2603 /** 2604 * Sets the preferred size of this component to a constant 2605 * value. Subsequent calls to {@code getPreferredSize} will always 2606 * return this value. Setting the preferred size to {@code null} 2607 * restores the default behavior. 2608 * 2609 * @param preferredSize The new preferred size, or null 2610 * @see #getPreferredSize 2611 * @see #isPreferredSizeSet 2612 * @since 1.5 2613 */ 2614 public void setPreferredSize(Dimension preferredSize) { 2615 Dimension old; 2616 // If the preferred size was set, use it as the old value, otherwise 2617 // use null to indicate we didn't previously have a set preferred 2618 // size. 2619 if (prefSizeSet) { 2620 old = this.prefSize; 2621 } 2622 else { 2623 old = null; 2624 } 2625 this.prefSize = preferredSize; 2626 prefSizeSet = (preferredSize != null); 2627 firePropertyChange("preferredSize", old, preferredSize); 2628 } 2629 2630 2631 /** 2632 * Returns true if the preferred size has been set to a 2633 * non-{@code null} value otherwise returns false. 2634 * 2635 * @return true if {@code setPreferredSize} has been invoked 2636 * with a non-null value. 2637 * @since 1.5 2638 */ 2639 public boolean isPreferredSizeSet() { 2640 return prefSizeSet; 2641 } 2642 2643 2644 /** 2645 * Gets the preferred size of this component. 2646 * @return a dimension object indicating this component's preferred size 2647 * @see #getMinimumSize 2648 * @see LayoutManager 2649 */ 2650 public Dimension getPreferredSize() { 2651 return preferredSize(); 2652 } 2653 2654 2655 /** 2656 * Returns the component's preferred size. 2657 * 2658 * @return the component's preferred size 2659 * @deprecated As of JDK version 1.1, 2660 * replaced by {@code getPreferredSize()}. 2661 */ 2662 @Deprecated 2663 public Dimension preferredSize() { 2664 /* Avoid grabbing the lock if a reasonable cached size value 2665 * is available. 2666 */ 2667 Dimension dim = prefSize; 2668 if (dim == null || !(isPreferredSizeSet() || isValid())) { 2669 synchronized (getTreeLock()) { 2670 prefSize = (peer != null) ? 2671 peer.getPreferredSize() : 2672 getMinimumSize(); 2673 dim = prefSize; 2674 } 2675 } 2676 return new Dimension(dim); 2677 } 2678 2679 /** 2680 * Sets the minimum size of this component to a constant 2681 * value. Subsequent calls to {@code getMinimumSize} will always 2682 * return this value. Setting the minimum size to {@code null} 2683 * restores the default behavior. 2684 * 2685 * @param minimumSize the new minimum size of this component 2686 * @see #getMinimumSize 2687 * @see #isMinimumSizeSet 2688 * @since 1.5 2689 */ 2690 public void setMinimumSize(Dimension minimumSize) { 2691 Dimension old; 2692 // If the minimum size was set, use it as the old value, otherwise 2693 // use null to indicate we didn't previously have a set minimum 2694 // size. 2695 if (minSizeSet) { 2696 old = this.minSize; 2697 } 2698 else { 2699 old = null; 2700 } 2701 this.minSize = minimumSize; 2702 minSizeSet = (minimumSize != null); 2703 firePropertyChange("minimumSize", old, minimumSize); 2704 } 2705 2706 /** 2707 * Returns whether or not {@code setMinimumSize} has been 2708 * invoked with a non-null value. 2709 * 2710 * @return true if {@code setMinimumSize} has been invoked with a 2711 * non-null value. 2712 * @since 1.5 2713 */ 2714 public boolean isMinimumSizeSet() { 2715 return minSizeSet; 2716 } 2717 2718 /** 2719 * Gets the minimum size of this component. 2720 * @return a dimension object indicating this component's minimum size 2721 * @see #getPreferredSize 2722 * @see LayoutManager 2723 */ 2724 public Dimension getMinimumSize() { 2725 return minimumSize(); 2726 } 2727 2728 /** 2729 * Returns the minimum size of this component. 2730 * 2731 * @return the minimum size of this component 2732 * @deprecated As of JDK version 1.1, 2733 * replaced by {@code getMinimumSize()}. 2734 */ 2735 @Deprecated 2736 public Dimension minimumSize() { 2737 /* Avoid grabbing the lock if a reasonable cached size value 2738 * is available. 2739 */ 2740 Dimension dim = minSize; 2741 if (dim == null || !(isMinimumSizeSet() || isValid())) { 2742 synchronized (getTreeLock()) { 2743 minSize = (peer != null) ? 2744 peer.getMinimumSize() : 2745 size(); 2746 dim = minSize; 2747 } 2748 } 2749 return new Dimension(dim); 2750 } 2751 2752 /** 2753 * Sets the maximum size of this component to a constant 2754 * value. Subsequent calls to {@code getMaximumSize} will always 2755 * return this value. Setting the maximum size to {@code null} 2756 * restores the default behavior. 2757 * 2758 * @param maximumSize a {@code Dimension} containing the 2759 * desired maximum allowable size 2760 * @see #getMaximumSize 2761 * @see #isMaximumSizeSet 2762 * @since 1.5 2763 */ 2764 public void setMaximumSize(Dimension maximumSize) { 2765 // If the maximum size was set, use it as the old value, otherwise 2766 // use null to indicate we didn't previously have a set maximum 2767 // size. 2768 Dimension old; 2769 if (maxSizeSet) { 2770 old = this.maxSize; 2771 } 2772 else { 2773 old = null; 2774 } 2775 this.maxSize = maximumSize; 2776 maxSizeSet = (maximumSize != null); 2777 firePropertyChange("maximumSize", old, maximumSize); 2778 } 2779 2780 /** 2781 * Returns true if the maximum size has been set to a non-{@code null} 2782 * value otherwise returns false. 2783 * 2784 * @return true if {@code maximumSize} is non-{@code null}, 2785 * false otherwise 2786 * @since 1.5 2787 */ 2788 public boolean isMaximumSizeSet() { 2789 return maxSizeSet; 2790 } 2791 2792 /** 2793 * Gets the maximum size of this component. 2794 * @return a dimension object indicating this component's maximum size 2795 * @see #getMinimumSize 2796 * @see #getPreferredSize 2797 * @see LayoutManager 2798 */ 2799 public Dimension getMaximumSize() { 2800 if (isMaximumSizeSet()) { 2801 return new Dimension(maxSize); 2802 } 2803 return new Dimension(Short.MAX_VALUE, Short.MAX_VALUE); 2804 } 2805 2806 /** 2807 * Returns the alignment along the x axis. This specifies how 2808 * the component would like to be aligned relative to other 2809 * components. The value should be a number between 0 and 1 2810 * where 0 represents alignment along the origin, 1 is aligned 2811 * the furthest away from the origin, 0.5 is centered, etc. 2812 * 2813 * @return the horizontal alignment of this component 2814 */ 2815 public float getAlignmentX() { 2816 return CENTER_ALIGNMENT; 2817 } 2818 2819 /** 2820 * Returns the alignment along the y axis. This specifies how 2821 * the component would like to be aligned relative to other 2822 * components. The value should be a number between 0 and 1 2823 * where 0 represents alignment along the origin, 1 is aligned 2824 * the furthest away from the origin, 0.5 is centered, etc. 2825 * 2826 * @return the vertical alignment of this component 2827 */ 2828 public float getAlignmentY() { 2829 return CENTER_ALIGNMENT; 2830 } 2831 2832 /** 2833 * Returns the baseline. The baseline is measured from the top of 2834 * the component. This method is primarily meant for 2835 * {@code LayoutManager}s to align components along their 2836 * baseline. A return value less than 0 indicates this component 2837 * does not have a reasonable baseline and that 2838 * {@code LayoutManager}s should not align this component on 2839 * its baseline. 2840 * <p> 2841 * The default implementation returns -1. Subclasses that support 2842 * baseline should override appropriately. If a value >= 0 is 2843 * returned, then the component has a valid baseline for any 2844 * size >= the minimum size and {@code getBaselineResizeBehavior} 2845 * can be used to determine how the baseline changes with size. 2846 * 2847 * @param width the width to get the baseline for 2848 * @param height the height to get the baseline for 2849 * @return the baseline or < 0 indicating there is no reasonable 2850 * baseline 2851 * @throws IllegalArgumentException if width or height is < 0 2852 * @see #getBaselineResizeBehavior 2853 * @see java.awt.FontMetrics 2854 * @since 1.6 2855 */ 2856 public int getBaseline(int width, int height) { 2857 if (width < 0 || height < 0) { 2858 throw new IllegalArgumentException( 2859 "Width and height must be >= 0"); 2860 } 2861 return -1; 2862 } 2863 2864 /** 2865 * Returns an enum indicating how the baseline of the component 2866 * changes as the size changes. This method is primarily meant for 2867 * layout managers and GUI builders. 2868 * <p> 2869 * The default implementation returns 2870 * {@code BaselineResizeBehavior.OTHER}. Subclasses that have a 2871 * baseline should override appropriately. Subclasses should 2872 * never return {@code null}; if the baseline can not be 2873 * calculated return {@code BaselineResizeBehavior.OTHER}. Callers 2874 * should first ask for the baseline using 2875 * {@code getBaseline} and if a value >= 0 is returned use 2876 * this method. It is acceptable for this method to return a 2877 * value other than {@code BaselineResizeBehavior.OTHER} even if 2878 * {@code getBaseline} returns a value less than 0. 2879 * 2880 * @return an enum indicating how the baseline changes as the component 2881 * size changes 2882 * @see #getBaseline(int, int) 2883 * @since 1.6 2884 */ 2885 public BaselineResizeBehavior getBaselineResizeBehavior() { 2886 return BaselineResizeBehavior.OTHER; 2887 } 2888 2889 /** 2890 * Prompts the layout manager to lay out this component. This is 2891 * usually called when the component (more specifically, container) 2892 * is validated. 2893 * @see #validate 2894 * @see LayoutManager 2895 */ 2896 public void doLayout() { 2897 layout(); 2898 } 2899 2900 /** 2901 * @deprecated As of JDK version 1.1, 2902 * replaced by {@code doLayout()}. 2903 */ 2904 @Deprecated 2905 public void layout() { 2906 } 2907 2908 /** 2909 * Validates this component. 2910 * <p> 2911 * The meaning of the term <i>validating</i> is defined by the ancestors of 2912 * this class. See {@link Container#validate} for more details. 2913 * 2914 * @see #invalidate 2915 * @see #doLayout() 2916 * @see LayoutManager 2917 * @see Container#validate 2918 * @since 1.0 2919 */ 2920 public void validate() { 2921 synchronized (getTreeLock()) { 2922 ComponentPeer peer = this.peer; 2923 boolean wasValid = isValid(); 2924 if (!wasValid && peer != null) { 2925 Font newfont = getFont(); 2926 Font oldfont = peerFont; 2927 if (newfont != oldfont && (oldfont == null 2928 || !oldfont.equals(newfont))) { 2929 peer.setFont(newfont); 2930 peerFont = newfont; 2931 } 2932 peer.layout(); 2933 } 2934 valid = true; 2935 if (!wasValid) { 2936 mixOnValidating(); 2937 } 2938 } 2939 } 2940 2941 /** 2942 * Invalidates this component and its ancestors. 2943 * <p> 2944 * By default, all the ancestors of the component up to the top-most 2945 * container of the hierarchy are marked invalid. If the {@code 2946 * java.awt.smartInvalidate} system property is set to {@code true}, 2947 * invalidation stops on the nearest validate root of this component. 2948 * Marking a container <i>invalid</i> indicates that the container needs to 2949 * be laid out. 2950 * <p> 2951 * This method is called automatically when any layout-related information 2952 * changes (e.g. setting the bounds of the component, or adding the 2953 * component to a container). 2954 * <p> 2955 * This method might be called often, so it should work fast. 2956 * 2957 * @see #validate 2958 * @see #doLayout 2959 * @see LayoutManager 2960 * @see java.awt.Container#isValidateRoot 2961 * @since 1.0 2962 */ 2963 public void invalidate() { 2964 synchronized (getTreeLock()) { 2965 /* Nullify cached layout and size information. 2966 * For efficiency, propagate invalidate() upwards only if 2967 * some other component hasn't already done so first. 2968 */ 2969 valid = false; 2970 if (!isPreferredSizeSet()) { 2971 prefSize = null; 2972 } 2973 if (!isMinimumSizeSet()) { 2974 minSize = null; 2975 } 2976 if (!isMaximumSizeSet()) { 2977 maxSize = null; 2978 } 2979 invalidateParent(); 2980 } 2981 } 2982 2983 /** 2984 * Invalidates the parent of this component if any. 2985 * 2986 * This method MUST BE invoked under the TreeLock. 2987 */ 2988 void invalidateParent() { 2989 if (parent != null) { 2990 parent.invalidateIfValid(); 2991 } 2992 } 2993 2994 /** Invalidates the component unless it is already invalid. 2995 */ 2996 final void invalidateIfValid() { 2997 if (isValid()) { 2998 invalidate(); 2999 } 3000 } 3001 3002 /** 3003 * Revalidates the component hierarchy up to the nearest validate root. 3004 * <p> 3005 * This method first invalidates the component hierarchy starting from this 3006 * component up to the nearest validate root. Afterwards, the component 3007 * hierarchy is validated starting from the nearest validate root. 3008 * <p> 3009 * This is a convenience method supposed to help application developers 3010 * avoid looking for validate roots manually. Basically, it's equivalent to 3011 * first calling the {@link #invalidate()} method on this component, and 3012 * then calling the {@link #validate()} method on the nearest validate 3013 * root. 3014 * 3015 * @see Container#isValidateRoot 3016 * @since 1.7 3017 */ 3018 public void revalidate() { 3019 revalidateSynchronously(); 3020 } 3021 3022 /** 3023 * Revalidates the component synchronously. 3024 */ 3025 final void revalidateSynchronously() { 3026 synchronized (getTreeLock()) { 3027 invalidate(); 3028 3029 Container root = getContainer(); 3030 if (root == null) { 3031 // There's no parents. Just validate itself. 3032 validate(); 3033 } else { 3034 while (!root.isValidateRoot()) { 3035 if (root.getContainer() == null) { 3036 // If there's no validate roots, we'll validate the 3037 // topmost container 3038 break; 3039 } 3040 3041 root = root.getContainer(); 3042 } 3043 3044 root.validate(); 3045 } 3046 } 3047 } 3048 3049 /** 3050 * Creates a graphics context for this component. This method will 3051 * return {@code null} if this component is currently not 3052 * displayable. 3053 * @return a graphics context for this component, or {@code null} 3054 * if it has none 3055 * @see #paint 3056 * @since 1.0 3057 */ 3058 public Graphics getGraphics() { 3059 if (peer instanceof LightweightPeer) { 3060 // This is for a lightweight component, need to 3061 // translate coordinate spaces and clip relative 3062 // to the parent. 3063 if (parent == null) return null; 3064 Graphics g = parent.getGraphics(); 3065 if (g == null) return null; 3066 if (g instanceof ConstrainableGraphics) { 3067 ((ConstrainableGraphics) g).constrain(x, y, width, height); 3068 } else { 3069 g.translate(x,y); 3070 g.setClip(0, 0, width, height); 3071 } 3072 g.setFont(getFont()); 3073 return g; 3074 } else { 3075 ComponentPeer peer = this.peer; 3076 return (peer != null) ? peer.getGraphics() : null; 3077 } 3078 } 3079 3080 final Graphics getGraphics_NoClientCode() { 3081 ComponentPeer peer = this.peer; 3082 if (peer instanceof LightweightPeer) { 3083 // This is for a lightweight component, need to 3084 // translate coordinate spaces and clip relative 3085 // to the parent. 3086 Container parent = this.parent; 3087 if (parent == null) return null; 3088 Graphics g = parent.getGraphics_NoClientCode(); 3089 if (g == null) return null; 3090 if (g instanceof ConstrainableGraphics) { 3091 ((ConstrainableGraphics) g).constrain(x, y, width, height); 3092 } else { 3093 g.translate(x,y); 3094 g.setClip(0, 0, width, height); 3095 } 3096 g.setFont(getFont_NoClientCode()); 3097 return g; 3098 } else { 3099 return (peer != null) ? peer.getGraphics() : null; 3100 } 3101 } 3102 3103 /** 3104 * Gets the font metrics for the specified font. 3105 * Warning: Since Font metrics are affected by the 3106 * {@link java.awt.font.FontRenderContext FontRenderContext} and 3107 * this method does not provide one, it can return only metrics for 3108 * the default render context which may not match that used when 3109 * rendering on the Component if {@link Graphics2D} functionality is being 3110 * used. Instead metrics can be obtained at rendering time by calling 3111 * {@link Graphics#getFontMetrics()} or text measurement APIs on the 3112 * {@link Font Font} class. 3113 * @param font the font for which font metrics is to be 3114 * obtained 3115 * @return the font metrics for {@code font} 3116 * @see #getFont 3117 * @see java.awt.peer.ComponentPeer#getFontMetrics(Font) 3118 * @see Toolkit#getFontMetrics(Font) 3119 * @since 1.0 3120 */ 3121 public FontMetrics getFontMetrics(Font font) { 3122 // This is an unsupported hack, but left in for a customer. 3123 // Do not remove. 3124 FontManager fm = FontManagerFactory.getInstance(); 3125 if (fm instanceof SunFontManager 3126 && ((SunFontManager) fm).usePlatformFontMetrics()) { 3127 3128 if (peer != null && 3129 !(peer instanceof LightweightPeer)) { 3130 return peer.getFontMetrics(font); 3131 } 3132 } 3133 return sun.font.FontDesignMetrics.getMetrics(font); 3134 } 3135 3136 /** 3137 * Sets the cursor image to the specified cursor. This cursor 3138 * image is displayed when the {@code contains} method for 3139 * this component returns true for the current cursor location, and 3140 * this Component is visible, displayable, and enabled. Setting the 3141 * cursor of a {@code Container} causes that cursor to be displayed 3142 * within all of the container's subcomponents, except for those 3143 * that have a non-{@code null} cursor. 3144 * <p> 3145 * The method may have no visual effect if the Java platform 3146 * implementation and/or the native system do not support 3147 * changing the mouse cursor shape. 3148 * @param cursor One of the constants defined 3149 * by the {@code Cursor} class; 3150 * if this parameter is {@code null} 3151 * then this component will inherit 3152 * the cursor of its parent 3153 * @see #isEnabled 3154 * @see #isShowing 3155 * @see #getCursor 3156 * @see #contains 3157 * @see Toolkit#createCustomCursor 3158 * @see Cursor 3159 * @since 1.1 3160 */ 3161 public void setCursor(Cursor cursor) { 3162 this.cursor = cursor; 3163 updateCursorImmediately(); 3164 } 3165 3166 /** 3167 * Updates the cursor. May not be invoked from the native 3168 * message pump. 3169 */ 3170 final void updateCursorImmediately() { 3171 if (peer instanceof LightweightPeer) { 3172 Container nativeContainer = getNativeContainer(); 3173 3174 if (nativeContainer == null) return; 3175 3176 ComponentPeer cPeer = nativeContainer.peer; 3177 3178 if (cPeer != null) { 3179 cPeer.updateCursorImmediately(); 3180 } 3181 } else if (peer != null) { 3182 peer.updateCursorImmediately(); 3183 } 3184 } 3185 3186 /** 3187 * Gets the cursor set in the component. If the component does 3188 * not have a cursor set, the cursor of its parent is returned. 3189 * If no cursor is set in the entire hierarchy, 3190 * {@code Cursor.DEFAULT_CURSOR} is returned. 3191 * 3192 * @return the cursor for this component 3193 * @see #setCursor 3194 * @since 1.1 3195 */ 3196 public Cursor getCursor() { 3197 return getCursor_NoClientCode(); 3198 } 3199 3200 final Cursor getCursor_NoClientCode() { 3201 Cursor cursor = this.cursor; 3202 if (cursor != null) { 3203 return cursor; 3204 } 3205 Container parent = this.parent; 3206 if (parent != null) { 3207 return parent.getCursor_NoClientCode(); 3208 } else { 3209 return Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR); 3210 } 3211 } 3212 3213 /** 3214 * Returns whether the cursor has been explicitly set for this Component. 3215 * If this method returns {@code false}, this Component is inheriting 3216 * its cursor from an ancestor. 3217 * 3218 * @return {@code true} if the cursor has been explicitly set for this 3219 * Component; {@code false} otherwise. 3220 * @since 1.4 3221 */ 3222 public boolean isCursorSet() { 3223 return (cursor != null); 3224 } 3225 3226 /** 3227 * Paints this component. 3228 * <p> 3229 * This method is called when the contents of the component should 3230 * be painted; such as when the component is first being shown or 3231 * is damaged and in need of repair. The clip rectangle in the 3232 * {@code Graphics} parameter is set to the area 3233 * which needs to be painted. 3234 * Subclasses of {@code Component} that override this 3235 * method need not call {@code super.paint(g)}. 3236 * <p> 3237 * For performance reasons, {@code Component}s with zero width 3238 * or height aren't considered to need painting when they are first shown, 3239 * and also aren't considered to need repair. 3240 * <p> 3241 * <b>Note</b>: For more information on the paint mechanisms utilitized 3242 * by AWT and Swing, including information on how to write the most 3243 * efficient painting code, see 3244 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>. 3245 * 3246 * @param g the graphics context to use for painting 3247 * @see #update 3248 * @since 1.0 3249 */ 3250 public void paint(Graphics g) { 3251 } 3252 3253 /** 3254 * Updates this component. 3255 * <p> 3256 * If this component is not a lightweight component, the 3257 * AWT calls the {@code update} method in response to 3258 * a call to {@code repaint}. You can assume that 3259 * the background is not cleared. 3260 * <p> 3261 * The {@code update} method of {@code Component} 3262 * calls this component's {@code paint} method to redraw 3263 * this component. This method is commonly overridden by subclasses 3264 * which need to do additional work in response to a call to 3265 * {@code repaint}. 3266 * Subclasses of Component that override this method should either 3267 * call {@code super.update(g)}, or call {@code paint(g)} 3268 * directly from their {@code update} method. 3269 * <p> 3270 * The origin of the graphics context, its 3271 * ({@code 0}, {@code 0}) coordinate point, is the 3272 * top-left corner of this component. The clipping region of the 3273 * graphics context is the bounding rectangle of this component. 3274 * 3275 * <p> 3276 * <b>Note</b>: For more information on the paint mechanisms utilitized 3277 * by AWT and Swing, including information on how to write the most 3278 * efficient painting code, see 3279 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>. 3280 * 3281 * @param g the specified context to use for updating 3282 * @see #paint 3283 * @see #repaint() 3284 * @since 1.0 3285 */ 3286 public void update(Graphics g) { 3287 paint(g); 3288 } 3289 3290 /** 3291 * Paints this component and all of its subcomponents. 3292 * <p> 3293 * The origin of the graphics context, its 3294 * ({@code 0}, {@code 0}) coordinate point, is the 3295 * top-left corner of this component. The clipping region of the 3296 * graphics context is the bounding rectangle of this component. 3297 * 3298 * @param g the graphics context to use for painting 3299 * @see #paint 3300 * @since 1.0 3301 */ 3302 public void paintAll(Graphics g) { 3303 if (isShowing()) { 3304 GraphicsCallback.PeerPaintCallback.getInstance(). 3305 runOneComponent(this, new Rectangle(0, 0, width, height), 3306 g, g.getClip(), 3307 GraphicsCallback.LIGHTWEIGHTS | 3308 GraphicsCallback.HEAVYWEIGHTS); 3309 } 3310 } 3311 3312 /** 3313 * Simulates the peer callbacks into java.awt for painting of 3314 * lightweight Components. 3315 * @param g the graphics context to use for painting 3316 * @see #paintAll 3317 */ 3318 void lightweightPaint(Graphics g) { 3319 paint(g); 3320 } 3321 3322 /** 3323 * Paints all the heavyweight subcomponents. 3324 */ 3325 void paintHeavyweightComponents(Graphics g) { 3326 } 3327 3328 /** 3329 * Repaints this component. 3330 * <p> 3331 * If this component is a lightweight component, this method 3332 * causes a call to this component's {@code paint} 3333 * method as soon as possible. Otherwise, this method causes 3334 * a call to this component's {@code update} method as soon 3335 * as possible. 3336 * <p> 3337 * <b>Note</b>: For more information on the paint mechanisms utilitized 3338 * by AWT and Swing, including information on how to write the most 3339 * efficient painting code, see 3340 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>. 3341 3342 * 3343 * @see #update(Graphics) 3344 * @since 1.0 3345 */ 3346 public void repaint() { 3347 repaint(0, 0, 0, width, height); 3348 } 3349 3350 /** 3351 * Repaints the component. If this component is a lightweight 3352 * component, this results in a call to {@code paint} 3353 * within {@code tm} milliseconds. 3354 * <p> 3355 * <b>Note</b>: For more information on the paint mechanisms utilitized 3356 * by AWT and Swing, including information on how to write the most 3357 * efficient painting code, see 3358 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>. 3359 * 3360 * @param tm maximum time in milliseconds before update 3361 * @see #paint 3362 * @see #update(Graphics) 3363 * @since 1.0 3364 */ 3365 public void repaint(long tm) { 3366 repaint(tm, 0, 0, width, height); 3367 } 3368 3369 /** 3370 * Repaints the specified rectangle of this component. 3371 * <p> 3372 * If this component is a lightweight component, this method 3373 * causes a call to this component's {@code paint} method 3374 * as soon as possible. Otherwise, this method causes a call to 3375 * this component's {@code update} method as soon as possible. 3376 * <p> 3377 * <b>Note</b>: For more information on the paint mechanisms utilitized 3378 * by AWT and Swing, including information on how to write the most 3379 * efficient painting code, see 3380 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>. 3381 * 3382 * @param x the <i>x</i> coordinate 3383 * @param y the <i>y</i> coordinate 3384 * @param width the width 3385 * @param height the height 3386 * @see #update(Graphics) 3387 * @since 1.0 3388 */ 3389 public void repaint(int x, int y, int width, int height) { 3390 repaint(0, x, y, width, height); 3391 } 3392 3393 /** 3394 * Repaints the specified rectangle of this component within 3395 * {@code tm} milliseconds. 3396 * <p> 3397 * If this component is a lightweight component, this method causes 3398 * a call to this component's {@code paint} method. 3399 * Otherwise, this method causes a call to this component's 3400 * {@code update} method. 3401 * <p> 3402 * <b>Note</b>: For more information on the paint mechanisms utilitized 3403 * by AWT and Swing, including information on how to write the most 3404 * efficient painting code, see 3405 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>. 3406 * 3407 * @param tm maximum time in milliseconds before update 3408 * @param x the <i>x</i> coordinate 3409 * @param y the <i>y</i> coordinate 3410 * @param width the width 3411 * @param height the height 3412 * @see #update(Graphics) 3413 * @since 1.0 3414 */ 3415 public void repaint(long tm, int x, int y, int width, int height) { 3416 if (this.peer instanceof LightweightPeer) { 3417 // Needs to be translated to parent coordinates since 3418 // a parent native container provides the actual repaint 3419 // services. Additionally, the request is restricted to 3420 // the bounds of the component. 3421 if (parent != null) { 3422 if (x < 0) { 3423 width += x; 3424 x = 0; 3425 } 3426 if (y < 0) { 3427 height += y; 3428 y = 0; 3429 } 3430 3431 int pwidth = (width > this.width) ? this.width : width; 3432 int pheight = (height > this.height) ? this.height : height; 3433 3434 if (pwidth <= 0 || pheight <= 0) { 3435 return; 3436 } 3437 3438 int px = this.x + x; 3439 int py = this.y + y; 3440 parent.repaint(tm, px, py, pwidth, pheight); 3441 } 3442 } else { 3443 if (isVisible() && (this.peer != null) && 3444 (width > 0) && (height > 0)) { 3445 PaintEvent e = new PaintEvent(this, PaintEvent.UPDATE, 3446 new Rectangle(x, y, width, height)); 3447 SunToolkit.postEvent(SunToolkit.targetToAppContext(this), e); 3448 } 3449 } 3450 } 3451 3452 /** 3453 * Prints this component. Applications should override this method 3454 * for components that must do special processing before being 3455 * printed or should be printed differently than they are painted. 3456 * <p> 3457 * The default implementation of this method calls the 3458 * {@code paint} method. 3459 * <p> 3460 * The origin of the graphics context, its 3461 * ({@code 0}, {@code 0}) coordinate point, is the 3462 * top-left corner of this component. The clipping region of the 3463 * graphics context is the bounding rectangle of this component. 3464 * @param g the graphics context to use for printing 3465 * @see #paint(Graphics) 3466 * @since 1.0 3467 */ 3468 public void print(Graphics g) { 3469 paint(g); 3470 } 3471 3472 /** 3473 * Prints this component and all of its subcomponents. 3474 * <p> 3475 * The origin of the graphics context, its 3476 * ({@code 0}, {@code 0}) coordinate point, is the 3477 * top-left corner of this component. The clipping region of the 3478 * graphics context is the bounding rectangle of this component. 3479 * @param g the graphics context to use for printing 3480 * @see #print(Graphics) 3481 * @since 1.0 3482 */ 3483 public void printAll(Graphics g) { 3484 if (isShowing()) { 3485 GraphicsCallback.PeerPrintCallback.getInstance(). 3486 runOneComponent(this, new Rectangle(0, 0, width, height), 3487 g, g.getClip(), 3488 GraphicsCallback.LIGHTWEIGHTS | 3489 GraphicsCallback.HEAVYWEIGHTS); 3490 } 3491 } 3492 3493 /** 3494 * Simulates the peer callbacks into java.awt for printing of 3495 * lightweight Components. 3496 * @param g the graphics context to use for printing 3497 * @see #printAll 3498 */ 3499 void lightweightPrint(Graphics g) { 3500 print(g); 3501 } 3502 3503 /** 3504 * Prints all the heavyweight subcomponents. 3505 */ 3506 void printHeavyweightComponents(Graphics g) { 3507 } 3508 3509 private Insets getInsets_NoClientCode() { 3510 ComponentPeer peer = this.peer; 3511 if (peer instanceof ContainerPeer) { 3512 return (Insets)((ContainerPeer)peer).getInsets().clone(); 3513 } 3514 return new Insets(0, 0, 0, 0); 3515 } 3516 3517 /** 3518 * Repaints the component when the image has changed. 3519 * This {@code imageUpdate} method of an {@code ImageObserver} 3520 * is called when more information about an 3521 * image which had been previously requested using an asynchronous 3522 * routine such as the {@code drawImage} method of 3523 * {@code Graphics} becomes available. 3524 * See the definition of {@code imageUpdate} for 3525 * more information on this method and its arguments. 3526 * <p> 3527 * The {@code imageUpdate} method of {@code Component} 3528 * incrementally draws an image on the component as more of the bits 3529 * of the image are available. 3530 * <p> 3531 * If the system property {@code awt.image.incrementaldraw} 3532 * is missing or has the value {@code true}, the image is 3533 * incrementally drawn. If the system property has any other value, 3534 * then the image is not drawn until it has been completely loaded. 3535 * <p> 3536 * Also, if incremental drawing is in effect, the value of the 3537 * system property {@code awt.image.redrawrate} is interpreted 3538 * as an integer to give the maximum redraw rate, in milliseconds. If 3539 * the system property is missing or cannot be interpreted as an 3540 * integer, the redraw rate is once every 100ms. 3541 * <p> 3542 * The interpretation of the {@code x}, {@code y}, 3543 * {@code width}, and {@code height} arguments depends on 3544 * the value of the {@code infoflags} argument. 3545 * 3546 * @param img the image being observed 3547 * @param infoflags see {@code imageUpdate} for more information 3548 * @param x the <i>x</i> coordinate 3549 * @param y the <i>y</i> coordinate 3550 * @param w the width 3551 * @param h the height 3552 * @return {@code false} if the infoflags indicate that the 3553 * image is completely loaded; {@code true} otherwise. 3554 * 3555 * @see java.awt.image.ImageObserver 3556 * @see Graphics#drawImage(Image, int, int, Color, java.awt.image.ImageObserver) 3557 * @see Graphics#drawImage(Image, int, int, java.awt.image.ImageObserver) 3558 * @see Graphics#drawImage(Image, int, int, int, int, Color, java.awt.image.ImageObserver) 3559 * @see Graphics#drawImage(Image, int, int, int, int, java.awt.image.ImageObserver) 3560 * @see java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int) 3561 * @since 1.0 3562 */ 3563 public boolean imageUpdate(Image img, int infoflags, 3564 int x, int y, int w, int h) { 3565 int rate = -1; 3566 if ((infoflags & (FRAMEBITS|ALLBITS)) != 0) { 3567 rate = 0; 3568 } else if ((infoflags & SOMEBITS) != 0) { 3569 if (isInc) { 3570 rate = incRate; 3571 if (rate < 0) { 3572 rate = 0; 3573 } 3574 } 3575 } 3576 if (rate >= 0) { 3577 repaint(rate, 0, 0, width, height); 3578 } 3579 return (infoflags & (ALLBITS|ABORT)) == 0; 3580 } 3581 3582 /** 3583 * Creates an image from the specified image producer. 3584 * @param producer the image producer 3585 * @return the image produced 3586 * @since 1.0 3587 */ 3588 public Image createImage(ImageProducer producer) { 3589 ComponentPeer peer = this.peer; 3590 if ((peer != null) && ! (peer instanceof LightweightPeer)) { 3591 return peer.createImage(producer); 3592 } 3593 return getToolkit().createImage(producer); 3594 } 3595 3596 /** 3597 * Creates an off-screen drawable image to be used for double buffering. 3598 * 3599 * @param width the specified width 3600 * @param height the specified height 3601 * @return an off-screen drawable image, which can be used for double 3602 * buffering. The {@code null} value if the component is not 3603 * displayable or {@code GraphicsEnvironment.isHeadless()} returns 3604 * {@code true}. 3605 * @see #isDisplayable 3606 * @see GraphicsEnvironment#isHeadless 3607 * @since 1.0 3608 */ 3609 public Image createImage(int width, int height) { 3610 ComponentPeer peer = this.peer; 3611 if (peer instanceof LightweightPeer) { 3612 if (parent != null) { return parent.createImage(width, height); } 3613 else { return null;} 3614 } else { 3615 return (peer != null) ? peer.createImage(width, height) : null; 3616 } 3617 } 3618 3619 /** 3620 * Creates a volatile off-screen drawable image to be used for double 3621 * buffering. 3622 * 3623 * @param width the specified width 3624 * @param height the specified height 3625 * @return an off-screen drawable image, which can be used for double 3626 * buffering. The {@code null} value if the component is not 3627 * displayable or {@code GraphicsEnvironment.isHeadless()} returns 3628 * {@code true}. 3629 * @see java.awt.image.VolatileImage 3630 * @see #isDisplayable 3631 * @see GraphicsEnvironment#isHeadless 3632 * @since 1.4 3633 */ 3634 public VolatileImage createVolatileImage(int width, int height) { 3635 ComponentPeer peer = this.peer; 3636 if (peer instanceof LightweightPeer) { 3637 if (parent != null) { 3638 return parent.createVolatileImage(width, height); 3639 } 3640 else { return null;} 3641 } else { 3642 return (peer != null) ? 3643 peer.createVolatileImage(width, height) : null; 3644 } 3645 } 3646 3647 /** 3648 * Creates a volatile off-screen drawable image, with the given 3649 * capabilities. The contents of this image may be lost at any time due to 3650 * operating system issues, so the image must be managed via the 3651 * {@code VolatileImage} interface. 3652 * 3653 * @param width the specified width 3654 * @param height the specified height 3655 * @param caps the image capabilities 3656 * @return a VolatileImage object, which can be used to manage surface 3657 * contents loss and capabilities. The {@code null} value if the 3658 * component is not displayable or 3659 * {@code GraphicsEnvironment.isHeadless()} returns {@code true}. 3660 * @throws AWTException if an image with the specified capabilities cannot 3661 * be created 3662 * @see java.awt.image.VolatileImage 3663 * @since 1.4 3664 */ 3665 public VolatileImage createVolatileImage(int width, int height, 3666 ImageCapabilities caps) 3667 throws AWTException { 3668 // REMIND : check caps 3669 return createVolatileImage(width, height); 3670 } 3671 3672 /** 3673 * Prepares an image for rendering on this component. The image 3674 * data is downloaded asynchronously in another thread and the 3675 * appropriate screen representation of the image is generated. 3676 * @param image the {@code Image} for which to 3677 * prepare a screen representation 3678 * @param observer the {@code ImageObserver} object 3679 * to be notified as the image is being prepared 3680 * @return {@code true} if the image has already been fully 3681 * prepared; {@code false} otherwise 3682 * @since 1.0 3683 */ 3684 public boolean prepareImage(Image image, ImageObserver observer) { 3685 return prepareImage(image, -1, -1, observer); 3686 } 3687 3688 /** 3689 * Prepares an image for rendering on this component at the 3690 * specified width and height. 3691 * <p> 3692 * The image data is downloaded asynchronously in another thread, 3693 * and an appropriately scaled screen representation of the image is 3694 * generated. 3695 * @param image the instance of {@code Image} 3696 * for which to prepare a screen representation 3697 * @param width the width of the desired screen representation 3698 * @param height the height of the desired screen representation 3699 * @param observer the {@code ImageObserver} object 3700 * to be notified as the image is being prepared 3701 * @return {@code true} if the image has already been fully 3702 * prepared; {@code false} otherwise 3703 * @see java.awt.image.ImageObserver 3704 * @since 1.0 3705 */ 3706 public boolean prepareImage(Image image, int width, int height, 3707 ImageObserver observer) { 3708 ComponentPeer peer = this.peer; 3709 if (peer instanceof LightweightPeer) { 3710 return (parent != null) 3711 ? parent.prepareImage(image, width, height, observer) 3712 : getToolkit().prepareImage(image, width, height, observer); 3713 } else { 3714 return (peer != null) 3715 ? peer.prepareImage(image, width, height, observer) 3716 : getToolkit().prepareImage(image, width, height, observer); 3717 } 3718 } 3719 3720 /** 3721 * Returns the status of the construction of a screen representation 3722 * of the specified image. 3723 * <p> 3724 * This method does not cause the image to begin loading. An 3725 * application must use the {@code prepareImage} method 3726 * to force the loading of an image. 3727 * <p> 3728 * Information on the flags returned by this method can be found 3729 * with the discussion of the {@code ImageObserver} interface. 3730 * @param image the {@code Image} object whose status 3731 * is being checked 3732 * @param observer the {@code ImageObserver} 3733 * object to be notified as the image is being prepared 3734 * @return the bitwise inclusive <b>OR</b> of 3735 * {@code ImageObserver} flags indicating what 3736 * information about the image is currently available 3737 * @see #prepareImage(Image, int, int, java.awt.image.ImageObserver) 3738 * @see Toolkit#checkImage(Image, int, int, java.awt.image.ImageObserver) 3739 * @see java.awt.image.ImageObserver 3740 * @since 1.0 3741 */ 3742 public int checkImage(Image image, ImageObserver observer) { 3743 return checkImage(image, -1, -1, observer); 3744 } 3745 3746 /** 3747 * Returns the status of the construction of a screen representation 3748 * of the specified image. 3749 * <p> 3750 * This method does not cause the image to begin loading. An 3751 * application must use the {@code prepareImage} method 3752 * to force the loading of an image. 3753 * <p> 3754 * The {@code checkImage} method of {@code Component} 3755 * calls its peer's {@code checkImage} method to calculate 3756 * the flags. If this component does not yet have a peer, the 3757 * component's toolkit's {@code checkImage} method is called 3758 * instead. 3759 * <p> 3760 * Information on the flags returned by this method can be found 3761 * with the discussion of the {@code ImageObserver} interface. 3762 * @param image the {@code Image} object whose status 3763 * is being checked 3764 * @param width the width of the scaled version 3765 * whose status is to be checked 3766 * @param height the height of the scaled version 3767 * whose status is to be checked 3768 * @param observer the {@code ImageObserver} object 3769 * to be notified as the image is being prepared 3770 * @return the bitwise inclusive <b>OR</b> of 3771 * {@code ImageObserver} flags indicating what 3772 * information about the image is currently available 3773 * @see #prepareImage(Image, int, int, java.awt.image.ImageObserver) 3774 * @see Toolkit#checkImage(Image, int, int, java.awt.image.ImageObserver) 3775 * @see java.awt.image.ImageObserver 3776 * @since 1.0 3777 */ 3778 public int checkImage(Image image, int width, int height, 3779 ImageObserver observer) { 3780 ComponentPeer peer = this.peer; 3781 if (peer instanceof LightweightPeer) { 3782 return (parent != null) 3783 ? parent.checkImage(image, width, height, observer) 3784 : getToolkit().checkImage(image, width, height, observer); 3785 } else { 3786 return (peer != null) 3787 ? peer.checkImage(image, width, height, observer) 3788 : getToolkit().checkImage(image, width, height, observer); 3789 } 3790 } 3791 3792 /** 3793 * Creates a new strategy for multi-buffering on this component. 3794 * Multi-buffering is useful for rendering performance. This method 3795 * attempts to create the best strategy available with the number of 3796 * buffers supplied. It will always create a {@code BufferStrategy} 3797 * with that number of buffers. 3798 * A page-flipping strategy is attempted first, then a blitting strategy 3799 * using accelerated buffers. Finally, an unaccelerated blitting 3800 * strategy is used. 3801 * <p> 3802 * Each time this method is called, 3803 * the existing buffer strategy for this component is discarded. 3804 * @param numBuffers number of buffers to create, including the front buffer 3805 * @exception IllegalArgumentException if numBuffers is less than 1. 3806 * @exception IllegalStateException if the component is not displayable 3807 * @see #isDisplayable 3808 * @see Window#getBufferStrategy() 3809 * @see Canvas#getBufferStrategy() 3810 * @since 1.4 3811 */ 3812 void createBufferStrategy(int numBuffers) { 3813 BufferCapabilities bufferCaps; 3814 if (numBuffers > 1) { 3815 // Try to create a page-flipping strategy 3816 bufferCaps = new BufferCapabilities(new ImageCapabilities(true), 3817 new ImageCapabilities(true), 3818 BufferCapabilities.FlipContents.UNDEFINED); 3819 try { 3820 createBufferStrategy(numBuffers, bufferCaps); 3821 return; // Success 3822 } catch (AWTException e) { 3823 // Failed 3824 } 3825 } 3826 // Try a blitting (but still accelerated) strategy 3827 bufferCaps = new BufferCapabilities(new ImageCapabilities(true), 3828 new ImageCapabilities(true), 3829 null); 3830 try { 3831 createBufferStrategy(numBuffers, bufferCaps); 3832 return; // Success 3833 } catch (AWTException e) { 3834 // Failed 3835 } 3836 // Try an unaccelerated blitting strategy 3837 bufferCaps = new BufferCapabilities(new ImageCapabilities(false), 3838 new ImageCapabilities(false), 3839 null); 3840 try { 3841 createBufferStrategy(numBuffers, bufferCaps); 3842 return; // Success 3843 } catch (AWTException e) { 3844 // Code should never reach here (an unaccelerated blitting 3845 // strategy should always work) 3846 throw new InternalError("Could not create a buffer strategy", e); 3847 } 3848 } 3849 3850 /** 3851 * Creates a new strategy for multi-buffering on this component with the 3852 * required buffer capabilities. This is useful, for example, if only 3853 * accelerated memory or page flipping is desired (as specified by the 3854 * buffer capabilities). 3855 * <p> 3856 * Each time this method 3857 * is called, {@code dispose} will be invoked on the existing 3858 * {@code BufferStrategy}. 3859 * @param numBuffers number of buffers to create 3860 * @param caps the required capabilities for creating the buffer strategy; 3861 * cannot be {@code null} 3862 * @exception AWTException if the capabilities supplied could not be 3863 * supported or met; this may happen, for example, if there is not enough 3864 * accelerated memory currently available, or if page flipping is specified 3865 * but not possible. 3866 * @exception IllegalArgumentException if numBuffers is less than 1, or if 3867 * caps is {@code null} 3868 * @see Window#getBufferStrategy() 3869 * @see Canvas#getBufferStrategy() 3870 * @since 1.4 3871 */ 3872 void createBufferStrategy(int numBuffers, 3873 BufferCapabilities caps) throws AWTException { 3874 // Check arguments 3875 if (numBuffers < 1) { 3876 throw new IllegalArgumentException( 3877 "Number of buffers must be at least 1"); 3878 } 3879 if (caps == null) { 3880 throw new IllegalArgumentException("No capabilities specified"); 3881 } 3882 // Destroy old buffers 3883 if (bufferStrategy != null) { 3884 bufferStrategy.dispose(); 3885 } 3886 if (numBuffers == 1) { 3887 bufferStrategy = new SingleBufferStrategy(caps); 3888 } else { 3889 SunGraphicsEnvironment sge = (SunGraphicsEnvironment) 3890 GraphicsEnvironment.getLocalGraphicsEnvironment(); 3891 if (!caps.isPageFlipping() && sge.isFlipStrategyPreferred(peer)) { 3892 caps = new ProxyCapabilities(caps); 3893 } 3894 // assert numBuffers > 1; 3895 if (caps.isPageFlipping()) { 3896 bufferStrategy = new FlipSubRegionBufferStrategy(numBuffers, caps); 3897 } else { 3898 bufferStrategy = new BltSubRegionBufferStrategy(numBuffers, caps); 3899 } 3900 } 3901 } 3902 3903 /** 3904 * This is a proxy capabilities class used when a FlipBufferStrategy 3905 * is created instead of the requested Blit strategy. 3906 * 3907 * @see sun.java2d.SunGraphicsEnvironment#isFlipStrategyPreferred(ComponentPeer) 3908 */ 3909 private class ProxyCapabilities extends ExtendedBufferCapabilities { 3910 private BufferCapabilities orig; 3911 private ProxyCapabilities(BufferCapabilities orig) { 3912 super(orig.getFrontBufferCapabilities(), 3913 orig.getBackBufferCapabilities(), 3914 orig.getFlipContents() == 3915 BufferCapabilities.FlipContents.BACKGROUND ? 3916 BufferCapabilities.FlipContents.BACKGROUND : 3917 BufferCapabilities.FlipContents.COPIED); 3918 this.orig = orig; 3919 } 3920 } 3921 3922 /** 3923 * @return the buffer strategy used by this component 3924 * @see Window#createBufferStrategy 3925 * @see Canvas#createBufferStrategy 3926 * @since 1.4 3927 */ 3928 BufferStrategy getBufferStrategy() { 3929 return bufferStrategy; 3930 } 3931 3932 /** 3933 * @return the back buffer currently used by this component's 3934 * BufferStrategy. If there is no BufferStrategy or no 3935 * back buffer, this method returns null. 3936 */ 3937 Image getBackBuffer() { 3938 if (bufferStrategy != null) { 3939 if (bufferStrategy instanceof BltBufferStrategy) { 3940 BltBufferStrategy bltBS = (BltBufferStrategy)bufferStrategy; 3941 return bltBS.getBackBuffer(); 3942 } else if (bufferStrategy instanceof FlipBufferStrategy) { 3943 FlipBufferStrategy flipBS = (FlipBufferStrategy)bufferStrategy; 3944 return flipBS.getBackBuffer(); 3945 } 3946 } 3947 return null; 3948 } 3949 3950 /** 3951 * Inner class for flipping buffers on a component. That component must 3952 * be a {@code Canvas} or {@code Window} or {@code Applet}. 3953 * @see Canvas 3954 * @see Window 3955 * @see Applet 3956 * @see java.awt.image.BufferStrategy 3957 * @author Michael Martak 3958 * @since 1.4 3959 */ 3960 protected class FlipBufferStrategy extends BufferStrategy { 3961 /** 3962 * The number of buffers 3963 */ 3964 protected int numBuffers; // = 0 3965 /** 3966 * The buffering capabilities 3967 */ 3968 protected BufferCapabilities caps; // = null 3969 /** 3970 * The drawing buffer 3971 */ 3972 protected Image drawBuffer; // = null 3973 /** 3974 * The drawing buffer as a volatile image 3975 */ 3976 protected VolatileImage drawVBuffer; // = null 3977 /** 3978 * Whether or not the drawing buffer has been recently restored from 3979 * a lost state. 3980 */ 3981 protected boolean validatedContents; // = false 3982 3983 /** 3984 * Size of the back buffers. (Note: these fields were added in 6.0 3985 * but kept package-private to avoid exposing them in the spec. 3986 * None of these fields/methods really should have been marked 3987 * protected when they were introduced in 1.4, but now we just have 3988 * to live with that decision.) 3989 */ 3990 3991 /** 3992 * The width of the back buffers 3993 */ 3994 int width; 3995 3996 /** 3997 * The height of the back buffers 3998 */ 3999 int height; 4000 4001 /** 4002 * Creates a new flipping buffer strategy for this component. 4003 * The component must be a {@code Canvas} or {@code Window} or 4004 * {@code Applet}. 4005 * @see Canvas 4006 * @see Window 4007 * @see Applet 4008 * @param numBuffers the number of buffers 4009 * @param caps the capabilities of the buffers 4010 * @exception AWTException if the capabilities supplied could not be 4011 * supported or met 4012 * @exception ClassCastException if the component is not a canvas or 4013 * window. 4014 * @exception IllegalStateException if the component has no peer 4015 * @exception IllegalArgumentException if {@code numBuffers} is less than two, 4016 * or if {@code BufferCapabilities.isPageFlipping} is not 4017 * {@code true}. 4018 * @see #createBuffers(int, BufferCapabilities) 4019 */ 4020 @SuppressWarnings("deprecation") 4021 protected FlipBufferStrategy(int numBuffers, BufferCapabilities caps) 4022 throws AWTException 4023 { 4024 if (!(Component.this instanceof Window) && 4025 !(Component.this instanceof Canvas) && 4026 !(Component.this instanceof Applet)) 4027 { 4028 throw new ClassCastException( 4029 "Component must be a Canvas or Window or Applet"); 4030 } 4031 this.numBuffers = numBuffers; 4032 this.caps = caps; 4033 createBuffers(numBuffers, caps); 4034 } 4035 4036 /** 4037 * Creates one or more complex, flipping buffers with the given 4038 * capabilities. 4039 * @param numBuffers number of buffers to create; must be greater than 4040 * one 4041 * @param caps the capabilities of the buffers. 4042 * {@code BufferCapabilities.isPageFlipping} must be 4043 * {@code true}. 4044 * @exception AWTException if the capabilities supplied could not be 4045 * supported or met 4046 * @exception IllegalStateException if the component has no peer 4047 * @exception IllegalArgumentException if numBuffers is less than two, 4048 * or if {@code BufferCapabilities.isPageFlipping} is not 4049 * {@code true}. 4050 * @see java.awt.BufferCapabilities#isPageFlipping() 4051 */ 4052 protected void createBuffers(int numBuffers, BufferCapabilities caps) 4053 throws AWTException 4054 { 4055 if (numBuffers < 2) { 4056 throw new IllegalArgumentException( 4057 "Number of buffers cannot be less than two"); 4058 } else if (peer == null) { 4059 throw new IllegalStateException( 4060 "Component must have a valid peer"); 4061 } else if (caps == null || !caps.isPageFlipping()) { 4062 throw new IllegalArgumentException( 4063 "Page flipping capabilities must be specified"); 4064 } 4065 4066 // save the current bounds 4067 width = getWidth(); 4068 height = getHeight(); 4069 4070 if (drawBuffer != null) { 4071 // dispose the existing backbuffers 4072 drawBuffer = null; 4073 drawVBuffer = null; 4074 destroyBuffers(); 4075 // ... then recreate the backbuffers 4076 } 4077 4078 if (caps instanceof ExtendedBufferCapabilities) { 4079 ExtendedBufferCapabilities ebc = 4080 (ExtendedBufferCapabilities)caps; 4081 if (ebc.getVSync() == VSYNC_ON) { 4082 // if this buffer strategy is not allowed to be v-synced, 4083 // change the caps that we pass to the peer but keep on 4084 // trying to create v-synced buffers; 4085 // do not throw IAE here in case it is disallowed, see 4086 // ExtendedBufferCapabilities for more info 4087 if (!VSyncedBSManager.vsyncAllowed(this)) { 4088 caps = ebc.derive(VSYNC_DEFAULT); 4089 } 4090 } 4091 } 4092 4093 peer.createBuffers(numBuffers, caps); 4094 updateInternalBuffers(); 4095 } 4096 4097 /** 4098 * Updates internal buffers (both volatile and non-volatile) 4099 * by requesting the back-buffer from the peer. 4100 */ 4101 private void updateInternalBuffers() { 4102 // get the images associated with the draw buffer 4103 drawBuffer = getBackBuffer(); 4104 if (drawBuffer instanceof VolatileImage) { 4105 drawVBuffer = (VolatileImage)drawBuffer; 4106 } else { 4107 drawVBuffer = null; 4108 } 4109 } 4110 4111 /** 4112 * @return direct access to the back buffer, as an image. 4113 * @exception IllegalStateException if the buffers have not yet 4114 * been created 4115 */ 4116 protected Image getBackBuffer() { 4117 if (peer != null) { 4118 return peer.getBackBuffer(); 4119 } else { 4120 throw new IllegalStateException( 4121 "Component must have a valid peer"); 4122 } 4123 } 4124 4125 /** 4126 * Flipping moves the contents of the back buffer to the front buffer, 4127 * either by copying or by moving the video pointer. 4128 * @param flipAction an integer value describing the flipping action 4129 * for the contents of the back buffer. This should be one of the 4130 * values of the {@code BufferCapabilities.FlipContents} 4131 * property. 4132 * @exception IllegalStateException if the buffers have not yet 4133 * been created 4134 * @see java.awt.BufferCapabilities#getFlipContents() 4135 */ 4136 protected void flip(BufferCapabilities.FlipContents flipAction) { 4137 if (peer != null) { 4138 Image backBuffer = getBackBuffer(); 4139 if (backBuffer != null) { 4140 peer.flip(0, 0, 4141 backBuffer.getWidth(null), 4142 backBuffer.getHeight(null), flipAction); 4143 } 4144 } else { 4145 throw new IllegalStateException( 4146 "Component must have a valid peer"); 4147 } 4148 } 4149 4150 void flipSubRegion(int x1, int y1, int x2, int y2, 4151 BufferCapabilities.FlipContents flipAction) 4152 { 4153 if (peer != null) { 4154 peer.flip(x1, y1, x2, y2, flipAction); 4155 } else { 4156 throw new IllegalStateException( 4157 "Component must have a valid peer"); 4158 } 4159 } 4160 4161 /** 4162 * Destroys the buffers created through this object 4163 */ 4164 protected void destroyBuffers() { 4165 VSyncedBSManager.releaseVsync(this); 4166 if (peer != null) { 4167 peer.destroyBuffers(); 4168 } else { 4169 throw new IllegalStateException( 4170 "Component must have a valid peer"); 4171 } 4172 } 4173 4174 /** 4175 * @return the buffering capabilities of this strategy 4176 */ 4177 public BufferCapabilities getCapabilities() { 4178 if (caps instanceof ProxyCapabilities) { 4179 return ((ProxyCapabilities)caps).orig; 4180 } else { 4181 return caps; 4182 } 4183 } 4184 4185 /** 4186 * @return the graphics on the drawing buffer. This method may not 4187 * be synchronized for performance reasons; use of this method by multiple 4188 * threads should be handled at the application level. Disposal of the 4189 * graphics object must be handled by the application. 4190 */ 4191 public Graphics getDrawGraphics() { 4192 revalidate(); 4193 return drawBuffer.getGraphics(); 4194 } 4195 4196 /** 4197 * Restore the drawing buffer if it has been lost 4198 */ 4199 protected void revalidate() { 4200 revalidate(true); 4201 } 4202 4203 void revalidate(boolean checkSize) { 4204 validatedContents = false; 4205 4206 if (checkSize && (getWidth() != width || getHeight() != height)) { 4207 // component has been resized; recreate the backbuffers 4208 try { 4209 createBuffers(numBuffers, caps); 4210 } catch (AWTException e) { 4211 // shouldn't be possible 4212 } 4213 validatedContents = true; 4214 } 4215 4216 // get the buffers from the peer every time since they 4217 // might have been replaced in response to a display change event 4218 updateInternalBuffers(); 4219 4220 // now validate the backbuffer 4221 if (drawVBuffer != null) { 4222 GraphicsConfiguration gc = 4223 getGraphicsConfiguration_NoClientCode(); 4224 int returnCode = drawVBuffer.validate(gc); 4225 if (returnCode == VolatileImage.IMAGE_INCOMPATIBLE) { 4226 try { 4227 createBuffers(numBuffers, caps); 4228 } catch (AWTException e) { 4229 // shouldn't be possible 4230 } 4231 if (drawVBuffer != null) { 4232 // backbuffers were recreated, so validate again 4233 drawVBuffer.validate(gc); 4234 } 4235 validatedContents = true; 4236 } else if (returnCode == VolatileImage.IMAGE_RESTORED) { 4237 validatedContents = true; 4238 } 4239 } 4240 } 4241 4242 /** 4243 * @return whether the drawing buffer was lost since the last call to 4244 * {@code getDrawGraphics} 4245 */ 4246 public boolean contentsLost() { 4247 if (drawVBuffer == null) { 4248 return false; 4249 } 4250 return drawVBuffer.contentsLost(); 4251 } 4252 4253 /** 4254 * @return whether the drawing buffer was recently restored from a lost 4255 * state and reinitialized to the default background color (white) 4256 */ 4257 public boolean contentsRestored() { 4258 return validatedContents; 4259 } 4260 4261 /** 4262 * Makes the next available buffer visible by either blitting or 4263 * flipping. 4264 */ 4265 public void show() { 4266 flip(caps.getFlipContents()); 4267 } 4268 4269 /** 4270 * Makes specified region of the next available buffer visible 4271 * by either blitting or flipping. 4272 */ 4273 void showSubRegion(int x1, int y1, int x2, int y2) { 4274 flipSubRegion(x1, y1, x2, y2, caps.getFlipContents()); 4275 } 4276 4277 /** 4278 * {@inheritDoc} 4279 * @since 1.6 4280 */ 4281 public void dispose() { 4282 if (Component.this.bufferStrategy == this) { 4283 Component.this.bufferStrategy = null; 4284 if (peer != null) { 4285 destroyBuffers(); 4286 } 4287 } 4288 } 4289 4290 } // Inner class FlipBufferStrategy 4291 4292 /** 4293 * Inner class for blitting offscreen surfaces to a component. 4294 * 4295 * @author Michael Martak 4296 * @since 1.4 4297 */ 4298 protected class BltBufferStrategy extends BufferStrategy { 4299 4300 /** 4301 * The buffering capabilities 4302 */ 4303 protected BufferCapabilities caps; // = null 4304 /** 4305 * The back buffers 4306 */ 4307 protected VolatileImage[] backBuffers; // = null 4308 /** 4309 * Whether or not the drawing buffer has been recently restored from 4310 * a lost state. 4311 */ 4312 protected boolean validatedContents; // = false 4313 /** 4314 * Width of the back buffers 4315 */ 4316 protected int width; 4317 /** 4318 * Height of the back buffers 4319 */ 4320 protected int height; 4321 4322 /** 4323 * Insets for the hosting Component. The size of the back buffer 4324 * is constrained by these. 4325 */ 4326 private Insets insets; 4327 4328 /** 4329 * Creates a new blt buffer strategy around a component 4330 * @param numBuffers number of buffers to create, including the 4331 * front buffer 4332 * @param caps the capabilities of the buffers 4333 */ 4334 protected BltBufferStrategy(int numBuffers, BufferCapabilities caps) { 4335 this.caps = caps; 4336 createBackBuffers(numBuffers - 1); 4337 } 4338 4339 /** 4340 * {@inheritDoc} 4341 * @since 1.6 4342 */ 4343 public void dispose() { 4344 if (backBuffers != null) { 4345 for (int counter = backBuffers.length - 1; counter >= 0; 4346 counter--) { 4347 if (backBuffers[counter] != null) { 4348 backBuffers[counter].flush(); 4349 backBuffers[counter] = null; 4350 } 4351 } 4352 } 4353 if (Component.this.bufferStrategy == this) { 4354 Component.this.bufferStrategy = null; 4355 } 4356 } 4357 4358 /** 4359 * Creates the back buffers 4360 * 4361 * @param numBuffers the number of buffers to create 4362 */ 4363 protected void createBackBuffers(int numBuffers) { 4364 if (numBuffers == 0) { 4365 backBuffers = null; 4366 } else { 4367 // save the current bounds 4368 width = getWidth(); 4369 height = getHeight(); 4370 insets = getInsets_NoClientCode(); 4371 int iWidth = width - insets.left - insets.right; 4372 int iHeight = height - insets.top - insets.bottom; 4373 4374 // It is possible for the component's width and/or height 4375 // to be 0 here. Force the size of the backbuffers to 4376 // be > 0 so that creating the image won't fail. 4377 iWidth = Math.max(1, iWidth); 4378 iHeight = Math.max(1, iHeight); 4379 if (backBuffers == null) { 4380 backBuffers = new VolatileImage[numBuffers]; 4381 } else { 4382 // flush any existing backbuffers 4383 for (int i = 0; i < numBuffers; i++) { 4384 if (backBuffers[i] != null) { 4385 backBuffers[i].flush(); 4386 backBuffers[i] = null; 4387 } 4388 } 4389 } 4390 4391 // create the backbuffers 4392 for (int i = 0; i < numBuffers; i++) { 4393 backBuffers[i] = createVolatileImage(iWidth, iHeight); 4394 } 4395 } 4396 } 4397 4398 /** 4399 * @return the buffering capabilities of this strategy 4400 */ 4401 public BufferCapabilities getCapabilities() { 4402 return caps; 4403 } 4404 4405 /** 4406 * @return the draw graphics 4407 */ 4408 public Graphics getDrawGraphics() { 4409 revalidate(); 4410 Image backBuffer = getBackBuffer(); 4411 if (backBuffer == null) { 4412 return getGraphics(); 4413 } 4414 SunGraphics2D g = (SunGraphics2D)backBuffer.getGraphics(); 4415 g.constrain(-insets.left, -insets.top, 4416 backBuffer.getWidth(null) + insets.left, 4417 backBuffer.getHeight(null) + insets.top); 4418 return g; 4419 } 4420 4421 /** 4422 * @return direct access to the back buffer, as an image. 4423 * If there is no back buffer, returns null. 4424 */ 4425 Image getBackBuffer() { 4426 if (backBuffers != null) { 4427 return backBuffers[backBuffers.length - 1]; 4428 } else { 4429 return null; 4430 } 4431 } 4432 4433 /** 4434 * Makes the next available buffer visible. 4435 */ 4436 public void show() { 4437 showSubRegion(insets.left, insets.top, 4438 width - insets.right, 4439 height - insets.bottom); 4440 } 4441 4442 /** 4443 * Package-private method to present a specific rectangular area 4444 * of this buffer. This class currently shows only the entire 4445 * buffer, by calling showSubRegion() with the full dimensions of 4446 * the buffer. Subclasses (e.g., BltSubRegionBufferStrategy 4447 * and FlipSubRegionBufferStrategy) may have region-specific show 4448 * methods that call this method with actual sub regions of the 4449 * buffer. 4450 */ 4451 void showSubRegion(int x1, int y1, int x2, int y2) { 4452 if (backBuffers == null) { 4453 return; 4454 } 4455 // Adjust location to be relative to client area. 4456 x1 -= insets.left; 4457 x2 -= insets.left; 4458 y1 -= insets.top; 4459 y2 -= insets.top; 4460 Graphics g = getGraphics_NoClientCode(); 4461 if (g == null) { 4462 // Not showing, bail 4463 return; 4464 } 4465 try { 4466 // First image copy is in terms of Frame's coordinates, need 4467 // to translate to client area. 4468 g.translate(insets.left, insets.top); 4469 for (int i = 0; i < backBuffers.length; i++) { 4470 g.drawImage(backBuffers[i], 4471 x1, y1, x2, y2, 4472 x1, y1, x2, y2, 4473 null); 4474 g.dispose(); 4475 g = null; 4476 g = backBuffers[i].getGraphics(); 4477 } 4478 } finally { 4479 if (g != null) { 4480 g.dispose(); 4481 } 4482 } 4483 } 4484 4485 /** 4486 * Restore the drawing buffer if it has been lost 4487 */ 4488 protected void revalidate() { 4489 revalidate(true); 4490 } 4491 4492 void revalidate(boolean checkSize) { 4493 validatedContents = false; 4494 4495 if (backBuffers == null) { 4496 return; 4497 } 4498 4499 if (checkSize) { 4500 Insets insets = getInsets_NoClientCode(); 4501 if (getWidth() != width || getHeight() != height || 4502 !insets.equals(this.insets)) { 4503 // component has been resized; recreate the backbuffers 4504 createBackBuffers(backBuffers.length); 4505 validatedContents = true; 4506 } 4507 } 4508 4509 // now validate the backbuffer 4510 GraphicsConfiguration gc = getGraphicsConfiguration_NoClientCode(); 4511 int returnCode = 4512 backBuffers[backBuffers.length - 1].validate(gc); 4513 if (returnCode == VolatileImage.IMAGE_INCOMPATIBLE) { 4514 if (checkSize) { 4515 createBackBuffers(backBuffers.length); 4516 // backbuffers were recreated, so validate again 4517 backBuffers[backBuffers.length - 1].validate(gc); 4518 } 4519 // else case means we're called from Swing on the toolkit 4520 // thread, don't recreate buffers as that'll deadlock 4521 // (creating VolatileImages invokes getting GraphicsConfig 4522 // which grabs treelock). 4523 validatedContents = true; 4524 } else if (returnCode == VolatileImage.IMAGE_RESTORED) { 4525 validatedContents = true; 4526 } 4527 } 4528 4529 /** 4530 * @return whether the drawing buffer was lost since the last call to 4531 * {@code getDrawGraphics} 4532 */ 4533 public boolean contentsLost() { 4534 if (backBuffers == null) { 4535 return false; 4536 } else { 4537 return backBuffers[backBuffers.length - 1].contentsLost(); 4538 } 4539 } 4540 4541 /** 4542 * @return whether the drawing buffer was recently restored from a lost 4543 * state and reinitialized to the default background color (white) 4544 */ 4545 public boolean contentsRestored() { 4546 return validatedContents; 4547 } 4548 } // Inner class BltBufferStrategy 4549 4550 /** 4551 * Private class to perform sub-region flipping. 4552 */ 4553 private class FlipSubRegionBufferStrategy extends FlipBufferStrategy 4554 implements SubRegionShowable 4555 { 4556 4557 protected FlipSubRegionBufferStrategy(int numBuffers, 4558 BufferCapabilities caps) 4559 throws AWTException 4560 { 4561 super(numBuffers, caps); 4562 } 4563 4564 public void show(int x1, int y1, int x2, int y2) { 4565 showSubRegion(x1, y1, x2, y2); 4566 } 4567 4568 // This is invoked by Swing on the toolkit thread. 4569 public boolean showIfNotLost(int x1, int y1, int x2, int y2) { 4570 if (!contentsLost()) { 4571 showSubRegion(x1, y1, x2, y2); 4572 return !contentsLost(); 4573 } 4574 return false; 4575 } 4576 } 4577 4578 /** 4579 * Private class to perform sub-region blitting. Swing will use 4580 * this subclass via the SubRegionShowable interface in order to 4581 * copy only the area changed during a repaint. 4582 * See javax.swing.BufferStrategyPaintManager. 4583 */ 4584 private class BltSubRegionBufferStrategy extends BltBufferStrategy 4585 implements SubRegionShowable 4586 { 4587 4588 protected BltSubRegionBufferStrategy(int numBuffers, 4589 BufferCapabilities caps) 4590 { 4591 super(numBuffers, caps); 4592 } 4593 4594 public void show(int x1, int y1, int x2, int y2) { 4595 showSubRegion(x1, y1, x2, y2); 4596 } 4597 4598 // This method is called by Swing on the toolkit thread. 4599 public boolean showIfNotLost(int x1, int y1, int x2, int y2) { 4600 if (!contentsLost()) { 4601 showSubRegion(x1, y1, x2, y2); 4602 return !contentsLost(); 4603 } 4604 return false; 4605 } 4606 } 4607 4608 /** 4609 * Inner class for flipping buffers on a component. That component must 4610 * be a {@code Canvas} or {@code Window}. 4611 * @see Canvas 4612 * @see Window 4613 * @see java.awt.image.BufferStrategy 4614 * @author Michael Martak 4615 * @since 1.4 4616 */ 4617 private class SingleBufferStrategy extends BufferStrategy { 4618 4619 private BufferCapabilities caps; 4620 4621 public SingleBufferStrategy(BufferCapabilities caps) { 4622 this.caps = caps; 4623 } 4624 public BufferCapabilities getCapabilities() { 4625 return caps; 4626 } 4627 public Graphics getDrawGraphics() { 4628 return getGraphics(); 4629 } 4630 public boolean contentsLost() { 4631 return false; 4632 } 4633 public boolean contentsRestored() { 4634 return false; 4635 } 4636 public void show() { 4637 // Do nothing 4638 } 4639 } // Inner class SingleBufferStrategy 4640 4641 /** 4642 * Sets whether or not paint messages received from the operating system 4643 * should be ignored. This does not affect paint events generated in 4644 * software by the AWT, unless they are an immediate response to an 4645 * OS-level paint message. 4646 * <p> 4647 * This is useful, for example, if running under full-screen mode and 4648 * better performance is desired, or if page-flipping is used as the 4649 * buffer strategy. 4650 * 4651 * @param ignoreRepaint {@code true} if the paint messages from the OS 4652 * should be ignored; otherwise {@code false} 4653 * 4654 * @since 1.4 4655 * @see #getIgnoreRepaint 4656 * @see Canvas#createBufferStrategy 4657 * @see Window#createBufferStrategy 4658 * @see java.awt.image.BufferStrategy 4659 * @see GraphicsDevice#setFullScreenWindow 4660 */ 4661 public void setIgnoreRepaint(boolean ignoreRepaint) { 4662 this.ignoreRepaint = ignoreRepaint; 4663 } 4664 4665 /** 4666 * @return whether or not paint messages received from the operating system 4667 * should be ignored. 4668 * 4669 * @since 1.4 4670 * @see #setIgnoreRepaint 4671 */ 4672 public boolean getIgnoreRepaint() { 4673 return ignoreRepaint; 4674 } 4675 4676 /** 4677 * Checks whether this component "contains" the specified point, 4678 * where {@code x} and {@code y} are defined to be 4679 * relative to the coordinate system of this component. 4680 * 4681 * @param x the <i>x</i> coordinate of the point 4682 * @param y the <i>y</i> coordinate of the point 4683 * @return {@code true} if the point is within the component; 4684 * otherwise {@code false} 4685 * @see #getComponentAt(int, int) 4686 * @since 1.1 4687 */ 4688 public boolean contains(int x, int y) { 4689 return inside(x, y); 4690 } 4691 4692 /** 4693 * Checks whether the point is inside of this component. 4694 * 4695 * @param x the <i>x</i> coordinate of the point 4696 * @param y the <i>y</i> coordinate of the point 4697 * @return {@code true} if the point is within the component; 4698 * otherwise {@code false} 4699 * @deprecated As of JDK version 1.1, 4700 * replaced by contains(int, int). 4701 */ 4702 @Deprecated 4703 public boolean inside(int x, int y) { 4704 return (x >= 0) && (x < width) && (y >= 0) && (y < height); 4705 } 4706 4707 /** 4708 * Checks whether this component "contains" the specified point, 4709 * where the point's <i>x</i> and <i>y</i> coordinates are defined 4710 * to be relative to the coordinate system of this component. 4711 * 4712 * @param p the point 4713 * @return {@code true} if the point is within the component; 4714 * otherwise {@code false} 4715 * @throws NullPointerException if {@code p} is {@code null} 4716 * @see #getComponentAt(Point) 4717 * @since 1.1 4718 */ 4719 public boolean contains(Point p) { 4720 return contains(p.x, p.y); 4721 } 4722 4723 /** 4724 * Determines if this component or one of its immediate 4725 * subcomponents contains the (<i>x</i>, <i>y</i>) location, 4726 * and if so, returns the containing component. This method only 4727 * looks one level deep. If the point (<i>x</i>, <i>y</i>) is 4728 * inside a subcomponent that itself has subcomponents, it does not 4729 * go looking down the subcomponent tree. 4730 * <p> 4731 * The {@code locate} method of {@code Component} simply 4732 * returns the component itself if the (<i>x</i>, <i>y</i>) 4733 * coordinate location is inside its bounding box, and {@code null} 4734 * otherwise. 4735 * @param x the <i>x</i> coordinate 4736 * @param y the <i>y</i> coordinate 4737 * @return the component or subcomponent that contains the 4738 * (<i>x</i>, <i>y</i>) location; 4739 * {@code null} if the location 4740 * is outside this component 4741 * @see #contains(int, int) 4742 * @since 1.0 4743 */ 4744 public Component getComponentAt(int x, int y) { 4745 return locate(x, y); 4746 } 4747 4748 /** 4749 * Returns the component occupying the position specified (this component, 4750 * or immediate child component, or null if neither 4751 * of the first two occupies the location). 4752 * 4753 * @param x the <i>x</i> coordinate to search for components at 4754 * @param y the <i>y</i> coordinate to search for components at 4755 * @return the component at the specified location or {@code null} 4756 * @deprecated As of JDK version 1.1, 4757 * replaced by getComponentAt(int, int). 4758 */ 4759 @Deprecated 4760 public Component locate(int x, int y) { 4761 return contains(x, y) ? this : null; 4762 } 4763 4764 /** 4765 * Returns the component or subcomponent that contains the 4766 * specified point. 4767 * @param p the point 4768 * @return the component at the specified location or {@code null} 4769 * @see java.awt.Component#contains 4770 * @since 1.1 4771 */ 4772 public Component getComponentAt(Point p) { 4773 return getComponentAt(p.x, p.y); 4774 } 4775 4776 /** 4777 * @param e the event to deliver 4778 * @deprecated As of JDK version 1.1, 4779 * replaced by {@code dispatchEvent(AWTEvent e)}. 4780 */ 4781 @Deprecated 4782 public void deliverEvent(Event e) { 4783 postEvent(e); 4784 } 4785 4786 /** 4787 * Dispatches an event to this component or one of its sub components. 4788 * Calls {@code processEvent} before returning for 1.1-style 4789 * events which have been enabled for the {@code Component}. 4790 * @param e the event 4791 */ 4792 public final void dispatchEvent(AWTEvent e) { 4793 dispatchEventImpl(e); 4794 } 4795 4796 @SuppressWarnings("deprecation") 4797 void dispatchEventImpl(AWTEvent e) { 4798 int id = e.getID(); 4799 4800 // Check that this component belongs to this app-context 4801 AppContext compContext = appContext; 4802 if (compContext != null && !compContext.equals(AppContext.getAppContext())) { 4803 if (eventLog.isLoggable(PlatformLogger.Level.FINE)) { 4804 eventLog.fine("Event " + e + " is being dispatched on the wrong AppContext"); 4805 } 4806 } 4807 4808 if (eventLog.isLoggable(PlatformLogger.Level.FINEST)) { 4809 eventLog.finest("{0}", e); 4810 } 4811 4812 /* 4813 * 0. Set timestamp and modifiers of current event. 4814 */ 4815 if (!(e instanceof KeyEvent)) { 4816 // Timestamp of a key event is set later in DKFM.preDispatchKeyEvent(KeyEvent). 4817 EventQueue.setCurrentEventAndMostRecentTime(e); 4818 } 4819 4820 /* 4821 * 1. Pre-dispatchers. Do any necessary retargeting/reordering here 4822 * before we notify AWTEventListeners. 4823 */ 4824 4825 if (e instanceof SunDropTargetEvent) { 4826 ((SunDropTargetEvent)e).dispatch(); 4827 return; 4828 } 4829 4830 if (!e.focusManagerIsDispatching) { 4831 // Invoke the private focus retargeting method which provides 4832 // lightweight Component support 4833 if (e.isPosted) { 4834 e = KeyboardFocusManager.retargetFocusEvent(e); 4835 e.isPosted = true; 4836 } 4837 4838 // Now, with the event properly targeted to a lightweight 4839 // descendant if necessary, invoke the public focus retargeting 4840 // and dispatching function 4841 if (KeyboardFocusManager.getCurrentKeyboardFocusManager(). 4842 dispatchEvent(e)) 4843 { 4844 return; 4845 } 4846 } 4847 if ((e instanceof FocusEvent) && focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 4848 focusLog.finest("" + e); 4849 } 4850 // MouseWheel may need to be retargeted here so that 4851 // AWTEventListener sees the event go to the correct 4852 // Component. If the MouseWheelEvent needs to go to an ancestor, 4853 // the event is dispatched to the ancestor, and dispatching here 4854 // stops. 4855 if (id == MouseEvent.MOUSE_WHEEL && 4856 (!eventTypeEnabled(id)) && 4857 (peer != null && !peer.handlesWheelScrolling()) && 4858 (dispatchMouseWheelToAncestor((MouseWheelEvent)e))) 4859 { 4860 return; 4861 } 4862 4863 /* 4864 * 2. Allow the Toolkit to pass this to AWTEventListeners. 4865 */ 4866 Toolkit toolkit = Toolkit.getDefaultToolkit(); 4867 toolkit.notifyAWTEventListeners(e); 4868 4869 4870 /* 4871 * 3. If no one has consumed a key event, allow the 4872 * KeyboardFocusManager to process it. 4873 */ 4874 if (!e.isConsumed()) { 4875 if (e instanceof java.awt.event.KeyEvent) { 4876 KeyboardFocusManager.getCurrentKeyboardFocusManager(). 4877 processKeyEvent(this, (KeyEvent)e); 4878 if (e.isConsumed()) { 4879 return; 4880 } 4881 } 4882 } 4883 4884 /* 4885 * 4. Allow input methods to process the event 4886 */ 4887 if (areInputMethodsEnabled()) { 4888 // We need to pass on InputMethodEvents since some host 4889 // input method adapters send them through the Java 4890 // event queue instead of directly to the component, 4891 // and the input context also handles the Java composition window 4892 if(((e instanceof InputMethodEvent) && !(this instanceof CompositionArea)) 4893 || 4894 // Otherwise, we only pass on input and focus events, because 4895 // a) input methods shouldn't know about semantic or component-level events 4896 // b) passing on the events takes time 4897 // c) isConsumed() is always true for semantic events. 4898 (e instanceof InputEvent) || (e instanceof FocusEvent)) { 4899 InputContext inputContext = getInputContext(); 4900 4901 4902 if (inputContext != null) { 4903 inputContext.dispatchEvent(e); 4904 if (e.isConsumed()) { 4905 if ((e instanceof FocusEvent) && focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 4906 focusLog.finest("3579: Skipping " + e); 4907 } 4908 return; 4909 } 4910 } 4911 } 4912 } else { 4913 // When non-clients get focus, we need to explicitly disable the native 4914 // input method. The native input method is actually not disabled when 4915 // the active/passive/peered clients loose focus. 4916 if (id == FocusEvent.FOCUS_GAINED) { 4917 InputContext inputContext = getInputContext(); 4918 if (inputContext != null && inputContext instanceof sun.awt.im.InputContext) { 4919 ((sun.awt.im.InputContext)inputContext).disableNativeIM(); 4920 } 4921 } 4922 } 4923 4924 4925 /* 4926 * 5. Pre-process any special events before delivery 4927 */ 4928 switch(id) { 4929 // Handling of the PAINT and UPDATE events is now done in the 4930 // peer's handleEvent() method so the background can be cleared 4931 // selectively for non-native components on Windows only. 4932 // - Fred.Ecks@Eng.sun.com, 5-8-98 4933 4934 case KeyEvent.KEY_PRESSED: 4935 case KeyEvent.KEY_RELEASED: 4936 Container p = (Container)((this instanceof Container) ? this : parent); 4937 if (p != null) { 4938 p.preProcessKeyEvent((KeyEvent)e); 4939 if (e.isConsumed()) { 4940 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 4941 focusLog.finest("Pre-process consumed event"); 4942 } 4943 return; 4944 } 4945 } 4946 break; 4947 4948 default: 4949 break; 4950 } 4951 4952 /* 4953 * 6. Deliver event for normal processing 4954 */ 4955 if (newEventsOnly) { 4956 // Filtering needs to really be moved to happen at a lower 4957 // level in order to get maximum performance gain; it is 4958 // here temporarily to ensure the API spec is honored. 4959 // 4960 if (eventEnabled(e)) { 4961 processEvent(e); 4962 } 4963 } else if (id == MouseEvent.MOUSE_WHEEL) { 4964 // newEventsOnly will be false for a listenerless ScrollPane, but 4965 // MouseWheelEvents still need to be dispatched to it so scrolling 4966 // can be done. 4967 autoProcessMouseWheel((MouseWheelEvent)e); 4968 } else if (!(e instanceof MouseEvent && !postsOldMouseEvents())) { 4969 // 4970 // backward compatibility 4971 // 4972 Event olde = e.convertToOld(); 4973 if (olde != null) { 4974 int key = olde.key; 4975 int modifiers = olde.modifiers; 4976 4977 postEvent(olde); 4978 if (olde.isConsumed()) { 4979 e.consume(); 4980 } 4981 // if target changed key or modifier values, copy them 4982 // back to original event 4983 // 4984 switch(olde.id) { 4985 case Event.KEY_PRESS: 4986 case Event.KEY_RELEASE: 4987 case Event.KEY_ACTION: 4988 case Event.KEY_ACTION_RELEASE: 4989 if (olde.key != key) { 4990 ((KeyEvent)e).setKeyChar(olde.getKeyEventChar()); 4991 } 4992 if (olde.modifiers != modifiers) { 4993 ((KeyEvent)e).setModifiers(olde.modifiers); 4994 } 4995 break; 4996 default: 4997 break; 4998 } 4999 } 5000 } 5001 5002 /* 5003 * 9. Allow the peer to process the event. 5004 * Except KeyEvents, they will be processed by peer after 5005 * all KeyEventPostProcessors 5006 * (see DefaultKeyboardFocusManager.dispatchKeyEvent()) 5007 */ 5008 if (!(e instanceof KeyEvent)) { 5009 ComponentPeer tpeer = peer; 5010 if (e instanceof FocusEvent && (tpeer == null || tpeer instanceof LightweightPeer)) { 5011 // if focus owner is lightweight then its native container 5012 // processes event 5013 Component source = (Component)e.getSource(); 5014 if (source != null) { 5015 Container target = source.getNativeContainer(); 5016 if (target != null) { 5017 tpeer = target.peer; 5018 } 5019 } 5020 } 5021 if (tpeer != null) { 5022 tpeer.handleEvent(e); 5023 } 5024 } 5025 } // dispatchEventImpl() 5026 5027 /* 5028 * If newEventsOnly is false, method is called so that ScrollPane can 5029 * override it and handle common-case mouse wheel scrolling. NOP 5030 * for Component. 5031 */ 5032 void autoProcessMouseWheel(MouseWheelEvent e) {} 5033 5034 /* 5035 * Dispatch given MouseWheelEvent to the first ancestor for which 5036 * MouseWheelEvents are enabled. 5037 * 5038 * Returns whether or not event was dispatched to an ancestor 5039 */ 5040 @SuppressWarnings("deprecation") 5041 boolean dispatchMouseWheelToAncestor(MouseWheelEvent e) { 5042 int newX, newY; 5043 newX = e.getX() + getX(); // Coordinates take into account at least 5044 newY = e.getY() + getY(); // the cursor's position relative to this 5045 // Component (e.getX()), and this Component's 5046 // position relative to its parent. 5047 MouseWheelEvent newMWE; 5048 5049 if (eventLog.isLoggable(PlatformLogger.Level.FINEST)) { 5050 eventLog.finest("dispatchMouseWheelToAncestor"); 5051 eventLog.finest("orig event src is of " + e.getSource().getClass()); 5052 } 5053 5054 /* parent field for Window refers to the owning Window. 5055 * MouseWheelEvents should NOT be propagated into owning Windows 5056 */ 5057 synchronized (getTreeLock()) { 5058 Container anc = getParent(); 5059 while (anc != null && !anc.eventEnabled(e)) { 5060 // fix coordinates to be relative to new event source 5061 newX += anc.getX(); 5062 newY += anc.getY(); 5063 5064 if (!(anc instanceof Window)) { 5065 anc = anc.getParent(); 5066 } 5067 else { 5068 break; 5069 } 5070 } 5071 5072 if (eventLog.isLoggable(PlatformLogger.Level.FINEST)) { 5073 eventLog.finest("new event src is " + anc.getClass()); 5074 } 5075 5076 if (anc != null && anc.eventEnabled(e)) { 5077 // Change event to be from new source, with new x,y 5078 // For now, just create a new event - yucky 5079 5080 newMWE = new MouseWheelEvent(anc, // new source 5081 e.getID(), 5082 e.getWhen(), 5083 e.getModifiers(), 5084 newX, // x relative to new source 5085 newY, // y relative to new source 5086 e.getXOnScreen(), 5087 e.getYOnScreen(), 5088 e.getClickCount(), 5089 e.isPopupTrigger(), 5090 e.getScrollType(), 5091 e.getScrollAmount(), 5092 e.getWheelRotation(), 5093 e.getPreciseWheelRotation()); 5094 ((AWTEvent)e).copyPrivateDataInto(newMWE); 5095 // When dispatching a wheel event to 5096 // ancestor, there is no need trying to find descendant 5097 // lightweights to dispatch event to. 5098 // If we dispatch the event to toplevel ancestor, 5099 // this could enclose the loop: 6480024. 5100 anc.dispatchEventToSelf(newMWE); 5101 if (newMWE.isConsumed()) { 5102 e.consume(); 5103 } 5104 return true; 5105 } 5106 } 5107 return false; 5108 } 5109 5110 boolean areInputMethodsEnabled() { 5111 // in 1.2, we assume input method support is required for all 5112 // components that handle key events, but components can turn off 5113 // input methods by calling enableInputMethods(false). 5114 return ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) && 5115 ((eventMask & AWTEvent.KEY_EVENT_MASK) != 0 || keyListener != null); 5116 } 5117 5118 // REMIND: remove when filtering is handled at lower level 5119 boolean eventEnabled(AWTEvent e) { 5120 return eventTypeEnabled(e.id); 5121 } 5122 5123 boolean eventTypeEnabled(int type) { 5124 switch(type) { 5125 case ComponentEvent.COMPONENT_MOVED: 5126 case ComponentEvent.COMPONENT_RESIZED: 5127 case ComponentEvent.COMPONENT_SHOWN: 5128 case ComponentEvent.COMPONENT_HIDDEN: 5129 if ((eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 || 5130 componentListener != null) { 5131 return true; 5132 } 5133 break; 5134 case FocusEvent.FOCUS_GAINED: 5135 case FocusEvent.FOCUS_LOST: 5136 if ((eventMask & AWTEvent.FOCUS_EVENT_MASK) != 0 || 5137 focusListener != null) { 5138 return true; 5139 } 5140 break; 5141 case KeyEvent.KEY_PRESSED: 5142 case KeyEvent.KEY_RELEASED: 5143 case KeyEvent.KEY_TYPED: 5144 if ((eventMask & AWTEvent.KEY_EVENT_MASK) != 0 || 5145 keyListener != null) { 5146 return true; 5147 } 5148 break; 5149 case MouseEvent.MOUSE_PRESSED: 5150 case MouseEvent.MOUSE_RELEASED: 5151 case MouseEvent.MOUSE_ENTERED: 5152 case MouseEvent.MOUSE_EXITED: 5153 case MouseEvent.MOUSE_CLICKED: 5154 if ((eventMask & AWTEvent.MOUSE_EVENT_MASK) != 0 || 5155 mouseListener != null) { 5156 return true; 5157 } 5158 break; 5159 case MouseEvent.MOUSE_MOVED: 5160 case MouseEvent.MOUSE_DRAGGED: 5161 if ((eventMask & AWTEvent.MOUSE_MOTION_EVENT_MASK) != 0 || 5162 mouseMotionListener != null) { 5163 return true; 5164 } 5165 break; 5166 case MouseEvent.MOUSE_WHEEL: 5167 if ((eventMask & AWTEvent.MOUSE_WHEEL_EVENT_MASK) != 0 || 5168 mouseWheelListener != null) { 5169 return true; 5170 } 5171 break; 5172 case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED: 5173 case InputMethodEvent.CARET_POSITION_CHANGED: 5174 if ((eventMask & AWTEvent.INPUT_METHOD_EVENT_MASK) != 0 || 5175 inputMethodListener != null) { 5176 return true; 5177 } 5178 break; 5179 case HierarchyEvent.HIERARCHY_CHANGED: 5180 if ((eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 || 5181 hierarchyListener != null) { 5182 return true; 5183 } 5184 break; 5185 case HierarchyEvent.ANCESTOR_MOVED: 5186 case HierarchyEvent.ANCESTOR_RESIZED: 5187 if ((eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 || 5188 hierarchyBoundsListener != null) { 5189 return true; 5190 } 5191 break; 5192 case ActionEvent.ACTION_PERFORMED: 5193 if ((eventMask & AWTEvent.ACTION_EVENT_MASK) != 0) { 5194 return true; 5195 } 5196 break; 5197 case TextEvent.TEXT_VALUE_CHANGED: 5198 if ((eventMask & AWTEvent.TEXT_EVENT_MASK) != 0) { 5199 return true; 5200 } 5201 break; 5202 case ItemEvent.ITEM_STATE_CHANGED: 5203 if ((eventMask & AWTEvent.ITEM_EVENT_MASK) != 0) { 5204 return true; 5205 } 5206 break; 5207 case AdjustmentEvent.ADJUSTMENT_VALUE_CHANGED: 5208 if ((eventMask & AWTEvent.ADJUSTMENT_EVENT_MASK) != 0) { 5209 return true; 5210 } 5211 break; 5212 default: 5213 break; 5214 } 5215 // 5216 // Always pass on events defined by external programs. 5217 // 5218 if (type > AWTEvent.RESERVED_ID_MAX) { 5219 return true; 5220 } 5221 return false; 5222 } 5223 5224 /** 5225 * @deprecated As of JDK version 1.1, 5226 * replaced by dispatchEvent(AWTEvent). 5227 */ 5228 @Deprecated 5229 public boolean postEvent(Event e) { 5230 ComponentPeer peer = this.peer; 5231 5232 if (handleEvent(e)) { 5233 e.consume(); 5234 return true; 5235 } 5236 5237 Component parent = this.parent; 5238 int eventx = e.x; 5239 int eventy = e.y; 5240 if (parent != null) { 5241 e.translate(x, y); 5242 if (parent.postEvent(e)) { 5243 e.consume(); 5244 return true; 5245 } 5246 // restore coords 5247 e.x = eventx; 5248 e.y = eventy; 5249 } 5250 return false; 5251 } 5252 5253 // Event source interfaces 5254 5255 /** 5256 * Adds the specified component listener to receive component events from 5257 * this component. 5258 * If listener {@code l} is {@code null}, 5259 * no exception is thrown and no action is performed. 5260 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5261 * >AWT Threading Issues</a> for details on AWT's threading model. 5262 * 5263 * @param l the component listener 5264 * @see java.awt.event.ComponentEvent 5265 * @see java.awt.event.ComponentListener 5266 * @see #removeComponentListener 5267 * @see #getComponentListeners 5268 * @since 1.1 5269 */ 5270 public synchronized void addComponentListener(ComponentListener l) { 5271 if (l == null) { 5272 return; 5273 } 5274 componentListener = AWTEventMulticaster.add(componentListener, l); 5275 newEventsOnly = true; 5276 } 5277 5278 /** 5279 * Removes the specified component listener so that it no longer 5280 * receives component events from this component. This method performs 5281 * no function, nor does it throw an exception, if the listener 5282 * specified by the argument was not previously added to this component. 5283 * If listener {@code l} is {@code null}, 5284 * no exception is thrown and no action is performed. 5285 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5286 * >AWT Threading Issues</a> for details on AWT's threading model. 5287 * @param l the component listener 5288 * @see java.awt.event.ComponentEvent 5289 * @see java.awt.event.ComponentListener 5290 * @see #addComponentListener 5291 * @see #getComponentListeners 5292 * @since 1.1 5293 */ 5294 public synchronized void removeComponentListener(ComponentListener l) { 5295 if (l == null) { 5296 return; 5297 } 5298 componentListener = AWTEventMulticaster.remove(componentListener, l); 5299 } 5300 5301 /** 5302 * Returns an array of all the component listeners 5303 * registered on this component. 5304 * 5305 * @return all {@code ComponentListener}s of this component 5306 * or an empty array if no component 5307 * listeners are currently registered 5308 * 5309 * @see #addComponentListener 5310 * @see #removeComponentListener 5311 * @since 1.4 5312 */ 5313 public synchronized ComponentListener[] getComponentListeners() { 5314 return getListeners(ComponentListener.class); 5315 } 5316 5317 /** 5318 * Adds the specified focus listener to receive focus events from 5319 * this component when this component gains input focus. 5320 * If listener {@code l} is {@code null}, 5321 * no exception is thrown and no action is performed. 5322 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5323 * >AWT Threading Issues</a> for details on AWT's threading model. 5324 * 5325 * @param l the focus listener 5326 * @see java.awt.event.FocusEvent 5327 * @see java.awt.event.FocusListener 5328 * @see #removeFocusListener 5329 * @see #getFocusListeners 5330 * @since 1.1 5331 */ 5332 public synchronized void addFocusListener(FocusListener l) { 5333 if (l == null) { 5334 return; 5335 } 5336 focusListener = AWTEventMulticaster.add(focusListener, l); 5337 newEventsOnly = true; 5338 5339 // if this is a lightweight component, enable focus events 5340 // in the native container. 5341 if (peer instanceof LightweightPeer) { 5342 parent.proxyEnableEvents(AWTEvent.FOCUS_EVENT_MASK); 5343 } 5344 } 5345 5346 /** 5347 * Removes the specified focus listener so that it no longer 5348 * receives focus events from this component. This method performs 5349 * no function, nor does it throw an exception, if the listener 5350 * specified by the argument was not previously added to this component. 5351 * If listener {@code l} is {@code null}, 5352 * no exception is thrown and no action is performed. 5353 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5354 * >AWT Threading Issues</a> for details on AWT's threading model. 5355 * 5356 * @param l the focus listener 5357 * @see java.awt.event.FocusEvent 5358 * @see java.awt.event.FocusListener 5359 * @see #addFocusListener 5360 * @see #getFocusListeners 5361 * @since 1.1 5362 */ 5363 public synchronized void removeFocusListener(FocusListener l) { 5364 if (l == null) { 5365 return; 5366 } 5367 focusListener = AWTEventMulticaster.remove(focusListener, l); 5368 } 5369 5370 /** 5371 * Returns an array of all the focus listeners 5372 * registered on this component. 5373 * 5374 * @return all of this component's {@code FocusListener}s 5375 * or an empty array if no component 5376 * listeners are currently registered 5377 * 5378 * @see #addFocusListener 5379 * @see #removeFocusListener 5380 * @since 1.4 5381 */ 5382 public synchronized FocusListener[] getFocusListeners() { 5383 return getListeners(FocusListener.class); 5384 } 5385 5386 /** 5387 * Adds the specified hierarchy listener to receive hierarchy changed 5388 * events from this component when the hierarchy to which this container 5389 * belongs changes. 5390 * If listener {@code l} is {@code null}, 5391 * no exception is thrown and no action is performed. 5392 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5393 * >AWT Threading Issues</a> for details on AWT's threading model. 5394 * 5395 * @param l the hierarchy listener 5396 * @see java.awt.event.HierarchyEvent 5397 * @see java.awt.event.HierarchyListener 5398 * @see #removeHierarchyListener 5399 * @see #getHierarchyListeners 5400 * @since 1.3 5401 */ 5402 public void addHierarchyListener(HierarchyListener l) { 5403 if (l == null) { 5404 return; 5405 } 5406 boolean notifyAncestors; 5407 synchronized (this) { 5408 notifyAncestors = 5409 (hierarchyListener == null && 5410 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) == 0); 5411 hierarchyListener = AWTEventMulticaster.add(hierarchyListener, l); 5412 notifyAncestors = (notifyAncestors && hierarchyListener != null); 5413 newEventsOnly = true; 5414 } 5415 if (notifyAncestors) { 5416 synchronized (getTreeLock()) { 5417 adjustListeningChildrenOnParent(AWTEvent.HIERARCHY_EVENT_MASK, 5418 1); 5419 } 5420 } 5421 } 5422 5423 /** 5424 * Removes the specified hierarchy listener so that it no longer 5425 * receives hierarchy changed events from this component. This method 5426 * performs no function, nor does it throw an exception, if the listener 5427 * specified by the argument was not previously added to this component. 5428 * If listener {@code l} is {@code null}, 5429 * no exception is thrown and no action is performed. 5430 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5431 * >AWT Threading Issues</a> for details on AWT's threading model. 5432 * 5433 * @param l the hierarchy listener 5434 * @see java.awt.event.HierarchyEvent 5435 * @see java.awt.event.HierarchyListener 5436 * @see #addHierarchyListener 5437 * @see #getHierarchyListeners 5438 * @since 1.3 5439 */ 5440 public void removeHierarchyListener(HierarchyListener l) { 5441 if (l == null) { 5442 return; 5443 } 5444 boolean notifyAncestors; 5445 synchronized (this) { 5446 notifyAncestors = 5447 (hierarchyListener != null && 5448 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) == 0); 5449 hierarchyListener = 5450 AWTEventMulticaster.remove(hierarchyListener, l); 5451 notifyAncestors = (notifyAncestors && hierarchyListener == null); 5452 } 5453 if (notifyAncestors) { 5454 synchronized (getTreeLock()) { 5455 adjustListeningChildrenOnParent(AWTEvent.HIERARCHY_EVENT_MASK, 5456 -1); 5457 } 5458 } 5459 } 5460 5461 /** 5462 * Returns an array of all the hierarchy listeners 5463 * registered on this component. 5464 * 5465 * @return all of this component's {@code HierarchyListener}s 5466 * or an empty array if no hierarchy 5467 * listeners are currently registered 5468 * 5469 * @see #addHierarchyListener 5470 * @see #removeHierarchyListener 5471 * @since 1.4 5472 */ 5473 public synchronized HierarchyListener[] getHierarchyListeners() { 5474 return getListeners(HierarchyListener.class); 5475 } 5476 5477 /** 5478 * Adds the specified hierarchy bounds listener to receive hierarchy 5479 * bounds events from this component when the hierarchy to which this 5480 * container belongs changes. 5481 * If listener {@code l} is {@code null}, 5482 * no exception is thrown and no action is performed. 5483 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5484 * >AWT Threading Issues</a> for details on AWT's threading model. 5485 * 5486 * @param l the hierarchy bounds listener 5487 * @see java.awt.event.HierarchyEvent 5488 * @see java.awt.event.HierarchyBoundsListener 5489 * @see #removeHierarchyBoundsListener 5490 * @see #getHierarchyBoundsListeners 5491 * @since 1.3 5492 */ 5493 public void addHierarchyBoundsListener(HierarchyBoundsListener l) { 5494 if (l == null) { 5495 return; 5496 } 5497 boolean notifyAncestors; 5498 synchronized (this) { 5499 notifyAncestors = 5500 (hierarchyBoundsListener == null && 5501 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) == 0); 5502 hierarchyBoundsListener = 5503 AWTEventMulticaster.add(hierarchyBoundsListener, l); 5504 notifyAncestors = (notifyAncestors && 5505 hierarchyBoundsListener != null); 5506 newEventsOnly = true; 5507 } 5508 if (notifyAncestors) { 5509 synchronized (getTreeLock()) { 5510 adjustListeningChildrenOnParent( 5511 AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK, 1); 5512 } 5513 } 5514 } 5515 5516 /** 5517 * Removes the specified hierarchy bounds listener so that it no longer 5518 * receives hierarchy bounds events from this component. This method 5519 * performs no function, nor does it throw an exception, if the listener 5520 * specified by the argument was not previously added to this component. 5521 * If listener {@code l} is {@code null}, 5522 * no exception is thrown and no action is performed. 5523 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5524 * >AWT Threading Issues</a> for details on AWT's threading model. 5525 * 5526 * @param l the hierarchy bounds listener 5527 * @see java.awt.event.HierarchyEvent 5528 * @see java.awt.event.HierarchyBoundsListener 5529 * @see #addHierarchyBoundsListener 5530 * @see #getHierarchyBoundsListeners 5531 * @since 1.3 5532 */ 5533 public void removeHierarchyBoundsListener(HierarchyBoundsListener l) { 5534 if (l == null) { 5535 return; 5536 } 5537 boolean notifyAncestors; 5538 synchronized (this) { 5539 notifyAncestors = 5540 (hierarchyBoundsListener != null && 5541 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) == 0); 5542 hierarchyBoundsListener = 5543 AWTEventMulticaster.remove(hierarchyBoundsListener, l); 5544 notifyAncestors = (notifyAncestors && 5545 hierarchyBoundsListener == null); 5546 } 5547 if (notifyAncestors) { 5548 synchronized (getTreeLock()) { 5549 adjustListeningChildrenOnParent( 5550 AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK, -1); 5551 } 5552 } 5553 } 5554 5555 // Should only be called while holding the tree lock 5556 int numListening(long mask) { 5557 // One mask or the other, but not neither or both. 5558 if (eventLog.isLoggable(PlatformLogger.Level.FINE)) { 5559 if ((mask != AWTEvent.HIERARCHY_EVENT_MASK) && 5560 (mask != AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK)) 5561 { 5562 eventLog.fine("Assertion failed"); 5563 } 5564 } 5565 if ((mask == AWTEvent.HIERARCHY_EVENT_MASK && 5566 (hierarchyListener != null || 5567 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0)) || 5568 (mask == AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK && 5569 (hierarchyBoundsListener != null || 5570 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0))) { 5571 return 1; 5572 } else { 5573 return 0; 5574 } 5575 } 5576 5577 // Should only be called while holding tree lock 5578 int countHierarchyMembers() { 5579 return 1; 5580 } 5581 // Should only be called while holding the tree lock 5582 int createHierarchyEvents(int id, Component changed, 5583 Container changedParent, long changeFlags, 5584 boolean enabledOnToolkit) { 5585 switch (id) { 5586 case HierarchyEvent.HIERARCHY_CHANGED: 5587 if (hierarchyListener != null || 5588 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 || 5589 enabledOnToolkit) { 5590 HierarchyEvent e = new HierarchyEvent(this, id, changed, 5591 changedParent, 5592 changeFlags); 5593 dispatchEvent(e); 5594 return 1; 5595 } 5596 break; 5597 case HierarchyEvent.ANCESTOR_MOVED: 5598 case HierarchyEvent.ANCESTOR_RESIZED: 5599 if (eventLog.isLoggable(PlatformLogger.Level.FINE)) { 5600 if (changeFlags != 0) { 5601 eventLog.fine("Assertion (changeFlags == 0) failed"); 5602 } 5603 } 5604 if (hierarchyBoundsListener != null || 5605 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 || 5606 enabledOnToolkit) { 5607 HierarchyEvent e = new HierarchyEvent(this, id, changed, 5608 changedParent); 5609 dispatchEvent(e); 5610 return 1; 5611 } 5612 break; 5613 default: 5614 // assert false 5615 if (eventLog.isLoggable(PlatformLogger.Level.FINE)) { 5616 eventLog.fine("This code must never be reached"); 5617 } 5618 break; 5619 } 5620 return 0; 5621 } 5622 5623 /** 5624 * Returns an array of all the hierarchy bounds listeners 5625 * registered on this component. 5626 * 5627 * @return all of this component's {@code HierarchyBoundsListener}s 5628 * or an empty array if no hierarchy bounds 5629 * listeners are currently registered 5630 * 5631 * @see #addHierarchyBoundsListener 5632 * @see #removeHierarchyBoundsListener 5633 * @since 1.4 5634 */ 5635 public synchronized HierarchyBoundsListener[] getHierarchyBoundsListeners() { 5636 return getListeners(HierarchyBoundsListener.class); 5637 } 5638 5639 /* 5640 * Should only be called while holding the tree lock. 5641 * It's added only for overriding in java.awt.Window 5642 * because parent in Window is owner. 5643 */ 5644 void adjustListeningChildrenOnParent(long mask, int num) { 5645 if (parent != null) { 5646 parent.adjustListeningChildren(mask, num); 5647 } 5648 } 5649 5650 /** 5651 * Adds the specified key listener to receive key events from 5652 * this component. 5653 * If l is null, no exception is thrown and no action is performed. 5654 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5655 * >AWT Threading Issues</a> for details on AWT's threading model. 5656 * 5657 * @param l the key listener. 5658 * @see java.awt.event.KeyEvent 5659 * @see java.awt.event.KeyListener 5660 * @see #removeKeyListener 5661 * @see #getKeyListeners 5662 * @since 1.1 5663 */ 5664 public synchronized void addKeyListener(KeyListener l) { 5665 if (l == null) { 5666 return; 5667 } 5668 keyListener = AWTEventMulticaster.add(keyListener, l); 5669 newEventsOnly = true; 5670 5671 // if this is a lightweight component, enable key events 5672 // in the native container. 5673 if (peer instanceof LightweightPeer) { 5674 parent.proxyEnableEvents(AWTEvent.KEY_EVENT_MASK); 5675 } 5676 } 5677 5678 /** 5679 * Removes the specified key listener so that it no longer 5680 * receives key events from this component. This method performs 5681 * no function, nor does it throw an exception, if the listener 5682 * specified by the argument was not previously added to this component. 5683 * If listener {@code l} is {@code null}, 5684 * no exception is thrown and no action is performed. 5685 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5686 * >AWT Threading Issues</a> for details on AWT's threading model. 5687 * 5688 * @param l the key listener 5689 * @see java.awt.event.KeyEvent 5690 * @see java.awt.event.KeyListener 5691 * @see #addKeyListener 5692 * @see #getKeyListeners 5693 * @since 1.1 5694 */ 5695 public synchronized void removeKeyListener(KeyListener l) { 5696 if (l == null) { 5697 return; 5698 } 5699 keyListener = AWTEventMulticaster.remove(keyListener, l); 5700 } 5701 5702 /** 5703 * Returns an array of all the key listeners 5704 * registered on this component. 5705 * 5706 * @return all of this component's {@code KeyListener}s 5707 * or an empty array if no key 5708 * listeners are currently registered 5709 * 5710 * @see #addKeyListener 5711 * @see #removeKeyListener 5712 * @since 1.4 5713 */ 5714 public synchronized KeyListener[] getKeyListeners() { 5715 return getListeners(KeyListener.class); 5716 } 5717 5718 /** 5719 * Adds the specified mouse listener to receive mouse events from 5720 * this component. 5721 * If listener {@code l} is {@code null}, 5722 * no exception is thrown and no action is performed. 5723 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5724 * >AWT Threading Issues</a> for details on AWT's threading model. 5725 * 5726 * @param l the mouse listener 5727 * @see java.awt.event.MouseEvent 5728 * @see java.awt.event.MouseListener 5729 * @see #removeMouseListener 5730 * @see #getMouseListeners 5731 * @since 1.1 5732 */ 5733 public synchronized void addMouseListener(MouseListener l) { 5734 if (l == null) { 5735 return; 5736 } 5737 mouseListener = AWTEventMulticaster.add(mouseListener,l); 5738 newEventsOnly = true; 5739 5740 // if this is a lightweight component, enable mouse events 5741 // in the native container. 5742 if (peer instanceof LightweightPeer) { 5743 parent.proxyEnableEvents(AWTEvent.MOUSE_EVENT_MASK); 5744 } 5745 } 5746 5747 /** 5748 * Removes the specified mouse listener so that it no longer 5749 * receives mouse events from this component. This method performs 5750 * no function, nor does it throw an exception, if the listener 5751 * specified by the argument was not previously added to this component. 5752 * If listener {@code l} is {@code null}, 5753 * no exception is thrown and no action is performed. 5754 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5755 * >AWT Threading Issues</a> for details on AWT's threading model. 5756 * 5757 * @param l the mouse listener 5758 * @see java.awt.event.MouseEvent 5759 * @see java.awt.event.MouseListener 5760 * @see #addMouseListener 5761 * @see #getMouseListeners 5762 * @since 1.1 5763 */ 5764 public synchronized void removeMouseListener(MouseListener l) { 5765 if (l == null) { 5766 return; 5767 } 5768 mouseListener = AWTEventMulticaster.remove(mouseListener, l); 5769 } 5770 5771 /** 5772 * Returns an array of all the mouse listeners 5773 * registered on this component. 5774 * 5775 * @return all of this component's {@code MouseListener}s 5776 * or an empty array if no mouse 5777 * listeners are currently registered 5778 * 5779 * @see #addMouseListener 5780 * @see #removeMouseListener 5781 * @since 1.4 5782 */ 5783 public synchronized MouseListener[] getMouseListeners() { 5784 return getListeners(MouseListener.class); 5785 } 5786 5787 /** 5788 * Adds the specified mouse motion listener to receive mouse motion 5789 * events from this component. 5790 * If listener {@code l} is {@code null}, 5791 * no exception is thrown and no action is performed. 5792 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5793 * >AWT Threading Issues</a> for details on AWT's threading model. 5794 * 5795 * @param l the mouse motion listener 5796 * @see java.awt.event.MouseEvent 5797 * @see java.awt.event.MouseMotionListener 5798 * @see #removeMouseMotionListener 5799 * @see #getMouseMotionListeners 5800 * @since 1.1 5801 */ 5802 public synchronized void addMouseMotionListener(MouseMotionListener l) { 5803 if (l == null) { 5804 return; 5805 } 5806 mouseMotionListener = AWTEventMulticaster.add(mouseMotionListener,l); 5807 newEventsOnly = true; 5808 5809 // if this is a lightweight component, enable mouse events 5810 // in the native container. 5811 if (peer instanceof LightweightPeer) { 5812 parent.proxyEnableEvents(AWTEvent.MOUSE_MOTION_EVENT_MASK); 5813 } 5814 } 5815 5816 /** 5817 * Removes the specified mouse motion listener so that it no longer 5818 * receives mouse motion events from this component. This method performs 5819 * no function, nor does it throw an exception, if the listener 5820 * specified by the argument was not previously added to this component. 5821 * If listener {@code l} is {@code null}, 5822 * no exception is thrown and no action is performed. 5823 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5824 * >AWT Threading Issues</a> for details on AWT's threading model. 5825 * 5826 * @param l the mouse motion listener 5827 * @see java.awt.event.MouseEvent 5828 * @see java.awt.event.MouseMotionListener 5829 * @see #addMouseMotionListener 5830 * @see #getMouseMotionListeners 5831 * @since 1.1 5832 */ 5833 public synchronized void removeMouseMotionListener(MouseMotionListener l) { 5834 if (l == null) { 5835 return; 5836 } 5837 mouseMotionListener = AWTEventMulticaster.remove(mouseMotionListener, l); 5838 } 5839 5840 /** 5841 * Returns an array of all the mouse motion listeners 5842 * registered on this component. 5843 * 5844 * @return all of this component's {@code MouseMotionListener}s 5845 * or an empty array if no mouse motion 5846 * listeners are currently registered 5847 * 5848 * @see #addMouseMotionListener 5849 * @see #removeMouseMotionListener 5850 * @since 1.4 5851 */ 5852 public synchronized MouseMotionListener[] getMouseMotionListeners() { 5853 return getListeners(MouseMotionListener.class); 5854 } 5855 5856 /** 5857 * Adds the specified mouse wheel listener to receive mouse wheel events 5858 * from this component. Containers also receive mouse wheel events from 5859 * sub-components. 5860 * <p> 5861 * For information on how mouse wheel events are dispatched, see 5862 * the class description for {@link MouseWheelEvent}. 5863 * <p> 5864 * If l is {@code null}, no exception is thrown and no 5865 * action is performed. 5866 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5867 * >AWT Threading Issues</a> for details on AWT's threading model. 5868 * 5869 * @param l the mouse wheel listener 5870 * @see java.awt.event.MouseWheelEvent 5871 * @see java.awt.event.MouseWheelListener 5872 * @see #removeMouseWheelListener 5873 * @see #getMouseWheelListeners 5874 * @since 1.4 5875 */ 5876 public synchronized void addMouseWheelListener(MouseWheelListener l) { 5877 if (l == null) { 5878 return; 5879 } 5880 mouseWheelListener = AWTEventMulticaster.add(mouseWheelListener,l); 5881 newEventsOnly = true; 5882 5883 // if this is a lightweight component, enable mouse events 5884 // in the native container. 5885 if (peer instanceof LightweightPeer) { 5886 parent.proxyEnableEvents(AWTEvent.MOUSE_WHEEL_EVENT_MASK); 5887 } 5888 } 5889 5890 /** 5891 * Removes the specified mouse wheel listener so that it no longer 5892 * receives mouse wheel events from this component. This method performs 5893 * no function, nor does it throw an exception, if the listener 5894 * specified by the argument was not previously added to this component. 5895 * If l is null, no exception is thrown and no action is performed. 5896 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5897 * >AWT Threading Issues</a> for details on AWT's threading model. 5898 * 5899 * @param l the mouse wheel listener. 5900 * @see java.awt.event.MouseWheelEvent 5901 * @see java.awt.event.MouseWheelListener 5902 * @see #addMouseWheelListener 5903 * @see #getMouseWheelListeners 5904 * @since 1.4 5905 */ 5906 public synchronized void removeMouseWheelListener(MouseWheelListener l) { 5907 if (l == null) { 5908 return; 5909 } 5910 mouseWheelListener = AWTEventMulticaster.remove(mouseWheelListener, l); 5911 } 5912 5913 /** 5914 * Returns an array of all the mouse wheel listeners 5915 * registered on this component. 5916 * 5917 * @return all of this component's {@code MouseWheelListener}s 5918 * or an empty array if no mouse wheel 5919 * listeners are currently registered 5920 * 5921 * @see #addMouseWheelListener 5922 * @see #removeMouseWheelListener 5923 * @since 1.4 5924 */ 5925 public synchronized MouseWheelListener[] getMouseWheelListeners() { 5926 return getListeners(MouseWheelListener.class); 5927 } 5928 5929 /** 5930 * Adds the specified input method listener to receive 5931 * input method events from this component. A component will 5932 * only receive input method events from input methods 5933 * if it also overrides {@code getInputMethodRequests} to return an 5934 * {@code InputMethodRequests} instance. 5935 * If listener {@code l} is {@code null}, 5936 * no exception is thrown and no action is performed. 5937 * <p>Refer to <a href="{@docRoot}/java/awt/doc-files/AWTThreadIssues.html#ListenersThreads" 5938 * >AWT Threading Issues</a> for details on AWT's threading model. 5939 * 5940 * @param l the input method listener 5941 * @see java.awt.event.InputMethodEvent 5942 * @see java.awt.event.InputMethodListener 5943 * @see #removeInputMethodListener 5944 * @see #getInputMethodListeners 5945 * @see #getInputMethodRequests 5946 * @since 1.2 5947 */ 5948 public synchronized void addInputMethodListener(InputMethodListener l) { 5949 if (l == null) { 5950 return; 5951 } 5952 inputMethodListener = AWTEventMulticaster.add(inputMethodListener, l); 5953 newEventsOnly = true; 5954 } 5955 5956 /** 5957 * Removes the specified input method listener so that it no longer 5958 * receives input method events from this component. This method performs 5959 * no function, nor does it throw an exception, if the listener 5960 * specified by the argument was not previously added to this component. 5961 * If listener {@code l} is {@code null}, 5962 * no exception is thrown and no action is performed. 5963 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads" 5964 * >AWT Threading Issues</a> for details on AWT's threading model. 5965 * 5966 * @param l the input method listener 5967 * @see java.awt.event.InputMethodEvent 5968 * @see java.awt.event.InputMethodListener 5969 * @see #addInputMethodListener 5970 * @see #getInputMethodListeners 5971 * @since 1.2 5972 */ 5973 public synchronized void removeInputMethodListener(InputMethodListener l) { 5974 if (l == null) { 5975 return; 5976 } 5977 inputMethodListener = AWTEventMulticaster.remove(inputMethodListener, l); 5978 } 5979 5980 /** 5981 * Returns an array of all the input method listeners 5982 * registered on this component. 5983 * 5984 * @return all of this component's {@code InputMethodListener}s 5985 * or an empty array if no input method 5986 * listeners are currently registered 5987 * 5988 * @see #addInputMethodListener 5989 * @see #removeInputMethodListener 5990 * @since 1.4 5991 */ 5992 public synchronized InputMethodListener[] getInputMethodListeners() { 5993 return getListeners(InputMethodListener.class); 5994 } 5995 5996 /** 5997 * Returns an array of all the objects currently registered 5998 * as <code><em>Foo</em>Listener</code>s 5999 * upon this {@code Component}. 6000 * <code><em>Foo</em>Listener</code>s are registered using the 6001 * <code>add<em>Foo</em>Listener</code> method. 6002 * 6003 * <p> 6004 * You can specify the {@code listenerType} argument 6005 * with a class literal, such as 6006 * <code><em>Foo</em>Listener.class</code>. 6007 * For example, you can query a 6008 * {@code Component c} 6009 * for its mouse listeners with the following code: 6010 * 6011 * <pre>MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));</pre> 6012 * 6013 * If no such listeners exist, this method returns an empty array. 6014 * 6015 * @param <T> the type of the listeners 6016 * @param listenerType the type of listeners requested; this parameter 6017 * should specify an interface that descends from 6018 * {@code java.util.EventListener} 6019 * @return an array of all objects registered as 6020 * <code><em>Foo</em>Listener</code>s on this component, 6021 * or an empty array if no such listeners have been added 6022 * @exception ClassCastException if {@code listenerType} 6023 * doesn't specify a class or interface that implements 6024 * {@code java.util.EventListener} 6025 * @throws NullPointerException if {@code listenerType} is {@code null} 6026 * @see #getComponentListeners 6027 * @see #getFocusListeners 6028 * @see #getHierarchyListeners 6029 * @see #getHierarchyBoundsListeners 6030 * @see #getKeyListeners 6031 * @see #getMouseListeners 6032 * @see #getMouseMotionListeners 6033 * @see #getMouseWheelListeners 6034 * @see #getInputMethodListeners 6035 * @see #getPropertyChangeListeners 6036 * 6037 * @since 1.3 6038 */ 6039 @SuppressWarnings("unchecked") 6040 public <T extends EventListener> T[] getListeners(Class<T> listenerType) { 6041 EventListener l = null; 6042 if (listenerType == ComponentListener.class) { 6043 l = componentListener; 6044 } else if (listenerType == FocusListener.class) { 6045 l = focusListener; 6046 } else if (listenerType == HierarchyListener.class) { 6047 l = hierarchyListener; 6048 } else if (listenerType == HierarchyBoundsListener.class) { 6049 l = hierarchyBoundsListener; 6050 } else if (listenerType == KeyListener.class) { 6051 l = keyListener; 6052 } else if (listenerType == MouseListener.class) { 6053 l = mouseListener; 6054 } else if (listenerType == MouseMotionListener.class) { 6055 l = mouseMotionListener; 6056 } else if (listenerType == MouseWheelListener.class) { 6057 l = mouseWheelListener; 6058 } else if (listenerType == InputMethodListener.class) { 6059 l = inputMethodListener; 6060 } else if (listenerType == PropertyChangeListener.class) { 6061 return (T[])getPropertyChangeListeners(); 6062 } 6063 return AWTEventMulticaster.getListeners(l, listenerType); 6064 } 6065 6066 /** 6067 * Gets the input method request handler which supports 6068 * requests from input methods for this component. A component 6069 * that supports on-the-spot text input must override this 6070 * method to return an {@code InputMethodRequests} instance. 6071 * At the same time, it also has to handle input method events. 6072 * 6073 * @return the input method request handler for this component, 6074 * {@code null} by default 6075 * @see #addInputMethodListener 6076 * @since 1.2 6077 */ 6078 public InputMethodRequests getInputMethodRequests() { 6079 return null; 6080 } 6081 6082 /** 6083 * Gets the input context used by this component for handling 6084 * the communication with input methods when text is entered 6085 * in this component. By default, the input context used for 6086 * the parent component is returned. Components may 6087 * override this to return a private input context. 6088 * 6089 * @return the input context used by this component; 6090 * {@code null} if no context can be determined 6091 * @since 1.2 6092 */ 6093 public InputContext getInputContext() { 6094 Container parent = this.parent; 6095 if (parent == null) { 6096 return null; 6097 } else { 6098 return parent.getInputContext(); 6099 } 6100 } 6101 6102 /** 6103 * Enables the events defined by the specified event mask parameter 6104 * to be delivered to this component. 6105 * <p> 6106 * Event types are automatically enabled when a listener for 6107 * that event type is added to the component. 6108 * <p> 6109 * This method only needs to be invoked by subclasses of 6110 * {@code Component} which desire to have the specified event 6111 * types delivered to {@code processEvent} regardless of whether 6112 * or not a listener is registered. 6113 * @param eventsToEnable the event mask defining the event types 6114 * @see #processEvent 6115 * @see #disableEvents 6116 * @see AWTEvent 6117 * @since 1.1 6118 */ 6119 protected final void enableEvents(long eventsToEnable) { 6120 long notifyAncestors = 0; 6121 synchronized (this) { 6122 if ((eventsToEnable & AWTEvent.HIERARCHY_EVENT_MASK) != 0 && 6123 hierarchyListener == null && 6124 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) == 0) { 6125 notifyAncestors |= AWTEvent.HIERARCHY_EVENT_MASK; 6126 } 6127 if ((eventsToEnable & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 && 6128 hierarchyBoundsListener == null && 6129 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) == 0) { 6130 notifyAncestors |= AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK; 6131 } 6132 eventMask |= eventsToEnable; 6133 newEventsOnly = true; 6134 } 6135 6136 // if this is a lightweight component, enable mouse events 6137 // in the native container. 6138 if (peer instanceof LightweightPeer) { 6139 parent.proxyEnableEvents(eventMask); 6140 } 6141 if (notifyAncestors != 0) { 6142 synchronized (getTreeLock()) { 6143 adjustListeningChildrenOnParent(notifyAncestors, 1); 6144 } 6145 } 6146 } 6147 6148 /** 6149 * Disables the events defined by the specified event mask parameter 6150 * from being delivered to this component. 6151 * @param eventsToDisable the event mask defining the event types 6152 * @see #enableEvents 6153 * @since 1.1 6154 */ 6155 protected final void disableEvents(long eventsToDisable) { 6156 long notifyAncestors = 0; 6157 synchronized (this) { 6158 if ((eventsToDisable & AWTEvent.HIERARCHY_EVENT_MASK) != 0 && 6159 hierarchyListener == null && 6160 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0) { 6161 notifyAncestors |= AWTEvent.HIERARCHY_EVENT_MASK; 6162 } 6163 if ((eventsToDisable & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK)!=0 && 6164 hierarchyBoundsListener == null && 6165 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0) { 6166 notifyAncestors |= AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK; 6167 } 6168 eventMask &= ~eventsToDisable; 6169 } 6170 if (notifyAncestors != 0) { 6171 synchronized (getTreeLock()) { 6172 adjustListeningChildrenOnParent(notifyAncestors, -1); 6173 } 6174 } 6175 } 6176 6177 transient sun.awt.EventQueueItem[] eventCache; 6178 6179 /** 6180 * @see #isCoalescingEnabled 6181 * @see #checkCoalescing 6182 */ 6183 private transient boolean coalescingEnabled = checkCoalescing(); 6184 6185 /** 6186 * Weak map of known coalesceEvent overriders. 6187 * Value indicates whether overriden. 6188 * Bootstrap classes are not included. 6189 */ 6190 private static final Map<Class<?>, Boolean> coalesceMap = 6191 new java.util.WeakHashMap<Class<?>, Boolean>(); 6192 6193 /** 6194 * Indicates whether this class overrides coalesceEvents. 6195 * It is assumed that all classes that are loaded from the bootstrap 6196 * do not. 6197 * The bootstrap class loader is assumed to be represented by null. 6198 * We do not check that the method really overrides 6199 * (it might be static, private or package private). 6200 */ 6201 private boolean checkCoalescing() { 6202 if (getClass().getClassLoader()==null) { 6203 return false; 6204 } 6205 final Class<? extends Component> clazz = getClass(); 6206 synchronized (coalesceMap) { 6207 // Check cache. 6208 Boolean value = coalesceMap.get(clazz); 6209 if (value != null) { 6210 return value; 6211 } 6212 6213 // Need to check non-bootstraps. 6214 Boolean enabled = java.security.AccessController.doPrivileged( 6215 new java.security.PrivilegedAction<Boolean>() { 6216 public Boolean run() { 6217 return isCoalesceEventsOverriden(clazz); 6218 } 6219 } 6220 ); 6221 coalesceMap.put(clazz, enabled); 6222 return enabled; 6223 } 6224 } 6225 6226 /** 6227 * Parameter types of coalesceEvents(AWTEvent,AWTEVent). 6228 */ 6229 private static final Class<?>[] coalesceEventsParams = { 6230 AWTEvent.class, AWTEvent.class 6231 }; 6232 6233 /** 6234 * Indicates whether a class or its superclasses override coalesceEvents. 6235 * Must be called with lock on coalesceMap and privileged. 6236 * @see #checkCoalescing 6237 */ 6238 private static boolean isCoalesceEventsOverriden(Class<?> clazz) { 6239 assert Thread.holdsLock(coalesceMap); 6240 6241 // First check superclass - we may not need to bother ourselves. 6242 Class<?> superclass = clazz.getSuperclass(); 6243 if (superclass == null) { 6244 // Only occurs on implementations that 6245 // do not use null to represent the bootstrap class loader. 6246 return false; 6247 } 6248 if (superclass.getClassLoader() != null) { 6249 Boolean value = coalesceMap.get(superclass); 6250 if (value == null) { 6251 // Not done already - recurse. 6252 if (isCoalesceEventsOverriden(superclass)) { 6253 coalesceMap.put(superclass, true); 6254 return true; 6255 } 6256 } else if (value) { 6257 return true; 6258 } 6259 } 6260 6261 try { 6262 // Throws if not overriden. 6263 clazz.getDeclaredMethod( 6264 "coalesceEvents", coalesceEventsParams 6265 ); 6266 return true; 6267 } catch (NoSuchMethodException e) { 6268 // Not present in this class. 6269 return false; 6270 } 6271 } 6272 6273 /** 6274 * Indicates whether coalesceEvents may do something. 6275 */ 6276 final boolean isCoalescingEnabled() { 6277 return coalescingEnabled; 6278 } 6279 6280 6281 /** 6282 * Potentially coalesce an event being posted with an existing 6283 * event. This method is called by {@code EventQueue.postEvent} 6284 * if an event with the same ID as the event to be posted is found in 6285 * the queue (both events must have this component as their source). 6286 * This method either returns a coalesced event which replaces 6287 * the existing event (and the new event is then discarded), or 6288 * {@code null} to indicate that no combining should be done 6289 * (add the second event to the end of the queue). Either event 6290 * parameter may be modified and returned, as the other one is discarded 6291 * unless {@code null} is returned. 6292 * <p> 6293 * This implementation of {@code coalesceEvents} coalesces 6294 * two event types: mouse move (and drag) events, 6295 * and paint (and update) events. 6296 * For mouse move events the last event is always returned, causing 6297 * intermediate moves to be discarded. For paint events, the new 6298 * event is coalesced into a complex {@code RepaintArea} in the peer. 6299 * The new {@code AWTEvent} is always returned. 6300 * 6301 * @param existingEvent the event already on the {@code EventQueue} 6302 * @param newEvent the event being posted to the 6303 * {@code EventQueue} 6304 * @return a coalesced event, or {@code null} indicating that no 6305 * coalescing was done 6306 */ 6307 protected AWTEvent coalesceEvents(AWTEvent existingEvent, 6308 AWTEvent newEvent) { 6309 return null; 6310 } 6311 6312 /** 6313 * Processes events occurring on this component. By default this 6314 * method calls the appropriate 6315 * <code>process<event type>Event</code> 6316 * method for the given class of event. 6317 * <p>Note that if the event parameter is {@code null} 6318 * the behavior is unspecified and may result in an 6319 * exception. 6320 * 6321 * @param e the event 6322 * @see #processComponentEvent 6323 * @see #processFocusEvent 6324 * @see #processKeyEvent 6325 * @see #processMouseEvent 6326 * @see #processMouseMotionEvent 6327 * @see #processInputMethodEvent 6328 * @see #processHierarchyEvent 6329 * @see #processMouseWheelEvent 6330 * @since 1.1 6331 */ 6332 protected void processEvent(AWTEvent e) { 6333 if (e instanceof FocusEvent) { 6334 processFocusEvent((FocusEvent)e); 6335 6336 } else if (e instanceof MouseEvent) { 6337 switch(e.getID()) { 6338 case MouseEvent.MOUSE_PRESSED: 6339 case MouseEvent.MOUSE_RELEASED: 6340 case MouseEvent.MOUSE_CLICKED: 6341 case MouseEvent.MOUSE_ENTERED: 6342 case MouseEvent.MOUSE_EXITED: 6343 processMouseEvent((MouseEvent)e); 6344 break; 6345 case MouseEvent.MOUSE_MOVED: 6346 case MouseEvent.MOUSE_DRAGGED: 6347 processMouseMotionEvent((MouseEvent)e); 6348 break; 6349 case MouseEvent.MOUSE_WHEEL: 6350 processMouseWheelEvent((MouseWheelEvent)e); 6351 break; 6352 } 6353 6354 } else if (e instanceof KeyEvent) { 6355 processKeyEvent((KeyEvent)e); 6356 6357 } else if (e instanceof ComponentEvent) { 6358 processComponentEvent((ComponentEvent)e); 6359 } else if (e instanceof InputMethodEvent) { 6360 processInputMethodEvent((InputMethodEvent)e); 6361 } else if (e instanceof HierarchyEvent) { 6362 switch (e.getID()) { 6363 case HierarchyEvent.HIERARCHY_CHANGED: 6364 processHierarchyEvent((HierarchyEvent)e); 6365 break; 6366 case HierarchyEvent.ANCESTOR_MOVED: 6367 case HierarchyEvent.ANCESTOR_RESIZED: 6368 processHierarchyBoundsEvent((HierarchyEvent)e); 6369 break; 6370 } 6371 } 6372 } 6373 6374 /** 6375 * Processes component events occurring on this component by 6376 * dispatching them to any registered 6377 * {@code ComponentListener} objects. 6378 * <p> 6379 * This method is not called unless component events are 6380 * enabled for this component. Component events are enabled 6381 * when one of the following occurs: 6382 * <ul> 6383 * <li>A {@code ComponentListener} object is registered 6384 * via {@code addComponentListener}. 6385 * <li>Component events are enabled via {@code enableEvents}. 6386 * </ul> 6387 * <p>Note that if the event parameter is {@code null} 6388 * the behavior is unspecified and may result in an 6389 * exception. 6390 * 6391 * @param e the component event 6392 * @see java.awt.event.ComponentEvent 6393 * @see java.awt.event.ComponentListener 6394 * @see #addComponentListener 6395 * @see #enableEvents 6396 * @since 1.1 6397 */ 6398 protected void processComponentEvent(ComponentEvent e) { 6399 ComponentListener listener = componentListener; 6400 if (listener != null) { 6401 int id = e.getID(); 6402 switch(id) { 6403 case ComponentEvent.COMPONENT_RESIZED: 6404 listener.componentResized(e); 6405 break; 6406 case ComponentEvent.COMPONENT_MOVED: 6407 listener.componentMoved(e); 6408 break; 6409 case ComponentEvent.COMPONENT_SHOWN: 6410 listener.componentShown(e); 6411 break; 6412 case ComponentEvent.COMPONENT_HIDDEN: 6413 listener.componentHidden(e); 6414 break; 6415 } 6416 } 6417 } 6418 6419 /** 6420 * Processes focus events occurring on this component by 6421 * dispatching them to any registered 6422 * {@code FocusListener} objects. 6423 * <p> 6424 * This method is not called unless focus events are 6425 * enabled for this component. Focus events are enabled 6426 * when one of the following occurs: 6427 * <ul> 6428 * <li>A {@code FocusListener} object is registered 6429 * via {@code addFocusListener}. 6430 * <li>Focus events are enabled via {@code enableEvents}. 6431 * </ul> 6432 * <p> 6433 * If focus events are enabled for a {@code Component}, 6434 * the current {@code KeyboardFocusManager} determines 6435 * whether or not a focus event should be dispatched to 6436 * registered {@code FocusListener} objects. If the 6437 * events are to be dispatched, the {@code KeyboardFocusManager} 6438 * calls the {@code Component}'s {@code dispatchEvent} 6439 * method, which results in a call to the {@code Component}'s 6440 * {@code processFocusEvent} method. 6441 * <p> 6442 * If focus events are enabled for a {@code Component}, calling 6443 * the {@code Component}'s {@code dispatchEvent} method 6444 * with a {@code FocusEvent} as the argument will result in a 6445 * call to the {@code Component}'s {@code processFocusEvent} 6446 * method regardless of the current {@code KeyboardFocusManager}. 6447 * 6448 * <p>Note that if the event parameter is {@code null} 6449 * the behavior is unspecified and may result in an 6450 * exception. 6451 * 6452 * @param e the focus event 6453 * @see java.awt.event.FocusEvent 6454 * @see java.awt.event.FocusListener 6455 * @see java.awt.KeyboardFocusManager 6456 * @see #addFocusListener 6457 * @see #enableEvents 6458 * @see #dispatchEvent 6459 * @since 1.1 6460 */ 6461 protected void processFocusEvent(FocusEvent e) { 6462 FocusListener listener = focusListener; 6463 if (listener != null) { 6464 int id = e.getID(); 6465 switch(id) { 6466 case FocusEvent.FOCUS_GAINED: 6467 listener.focusGained(e); 6468 break; 6469 case FocusEvent.FOCUS_LOST: 6470 listener.focusLost(e); 6471 break; 6472 } 6473 } 6474 } 6475 6476 /** 6477 * Processes key events occurring on this component by 6478 * dispatching them to any registered 6479 * {@code KeyListener} objects. 6480 * <p> 6481 * This method is not called unless key events are 6482 * enabled for this component. Key events are enabled 6483 * when one of the following occurs: 6484 * <ul> 6485 * <li>A {@code KeyListener} object is registered 6486 * via {@code addKeyListener}. 6487 * <li>Key events are enabled via {@code enableEvents}. 6488 * </ul> 6489 * 6490 * <p> 6491 * If key events are enabled for a {@code Component}, 6492 * the current {@code KeyboardFocusManager} determines 6493 * whether or not a key event should be dispatched to 6494 * registered {@code KeyListener} objects. The 6495 * {@code DefaultKeyboardFocusManager} will not dispatch 6496 * key events to a {@code Component} that is not the focus 6497 * owner or is not showing. 6498 * <p> 6499 * As of J2SE 1.4, {@code KeyEvent}s are redirected to 6500 * the focus owner. Please see the 6501 * <a href="doc-files/FocusSpec.html">Focus Specification</a> 6502 * for further information. 6503 * <p> 6504 * Calling a {@code Component}'s {@code dispatchEvent} 6505 * method with a {@code KeyEvent} as the argument will 6506 * result in a call to the {@code Component}'s 6507 * {@code processKeyEvent} method regardless of the 6508 * current {@code KeyboardFocusManager} as long as the 6509 * component is showing, focused, and enabled, and key events 6510 * are enabled on it. 6511 * <p>If the event parameter is {@code null} 6512 * the behavior is unspecified and may result in an 6513 * exception. 6514 * 6515 * @param e the key event 6516 * @see java.awt.event.KeyEvent 6517 * @see java.awt.event.KeyListener 6518 * @see java.awt.KeyboardFocusManager 6519 * @see java.awt.DefaultKeyboardFocusManager 6520 * @see #processEvent 6521 * @see #dispatchEvent 6522 * @see #addKeyListener 6523 * @see #enableEvents 6524 * @see #isShowing 6525 * @since 1.1 6526 */ 6527 protected void processKeyEvent(KeyEvent e) { 6528 KeyListener listener = keyListener; 6529 if (listener != null) { 6530 int id = e.getID(); 6531 switch(id) { 6532 case KeyEvent.KEY_TYPED: 6533 listener.keyTyped(e); 6534 break; 6535 case KeyEvent.KEY_PRESSED: 6536 listener.keyPressed(e); 6537 break; 6538 case KeyEvent.KEY_RELEASED: 6539 listener.keyReleased(e); 6540 break; 6541 } 6542 } 6543 } 6544 6545 /** 6546 * Processes mouse events occurring on this component by 6547 * dispatching them to any registered 6548 * {@code MouseListener} objects. 6549 * <p> 6550 * This method is not called unless mouse events are 6551 * enabled for this component. Mouse events are enabled 6552 * when one of the following occurs: 6553 * <ul> 6554 * <li>A {@code MouseListener} object is registered 6555 * via {@code addMouseListener}. 6556 * <li>Mouse events are enabled via {@code enableEvents}. 6557 * </ul> 6558 * <p>Note that if the event parameter is {@code null} 6559 * the behavior is unspecified and may result in an 6560 * exception. 6561 * 6562 * @param e the mouse event 6563 * @see java.awt.event.MouseEvent 6564 * @see java.awt.event.MouseListener 6565 * @see #addMouseListener 6566 * @see #enableEvents 6567 * @since 1.1 6568 */ 6569 protected void processMouseEvent(MouseEvent e) { 6570 MouseListener listener = mouseListener; 6571 if (listener != null) { 6572 int id = e.getID(); 6573 switch(id) { 6574 case MouseEvent.MOUSE_PRESSED: 6575 listener.mousePressed(e); 6576 break; 6577 case MouseEvent.MOUSE_RELEASED: 6578 listener.mouseReleased(e); 6579 break; 6580 case MouseEvent.MOUSE_CLICKED: 6581 listener.mouseClicked(e); 6582 break; 6583 case MouseEvent.MOUSE_EXITED: 6584 listener.mouseExited(e); 6585 break; 6586 case MouseEvent.MOUSE_ENTERED: 6587 listener.mouseEntered(e); 6588 break; 6589 } 6590 } 6591 } 6592 6593 /** 6594 * Processes mouse motion events occurring on this component by 6595 * dispatching them to any registered 6596 * {@code MouseMotionListener} objects. 6597 * <p> 6598 * This method is not called unless mouse motion events are 6599 * enabled for this component. Mouse motion events are enabled 6600 * when one of the following occurs: 6601 * <ul> 6602 * <li>A {@code MouseMotionListener} object is registered 6603 * via {@code addMouseMotionListener}. 6604 * <li>Mouse motion events are enabled via {@code enableEvents}. 6605 * </ul> 6606 * <p>Note that if the event parameter is {@code null} 6607 * the behavior is unspecified and may result in an 6608 * exception. 6609 * 6610 * @param e the mouse motion event 6611 * @see java.awt.event.MouseEvent 6612 * @see java.awt.event.MouseMotionListener 6613 * @see #addMouseMotionListener 6614 * @see #enableEvents 6615 * @since 1.1 6616 */ 6617 protected void processMouseMotionEvent(MouseEvent e) { 6618 MouseMotionListener listener = mouseMotionListener; 6619 if (listener != null) { 6620 int id = e.getID(); 6621 switch(id) { 6622 case MouseEvent.MOUSE_MOVED: 6623 listener.mouseMoved(e); 6624 break; 6625 case MouseEvent.MOUSE_DRAGGED: 6626 listener.mouseDragged(e); 6627 break; 6628 } 6629 } 6630 } 6631 6632 /** 6633 * Processes mouse wheel events occurring on this component by 6634 * dispatching them to any registered 6635 * {@code MouseWheelListener} objects. 6636 * <p> 6637 * This method is not called unless mouse wheel events are 6638 * enabled for this component. Mouse wheel events are enabled 6639 * when one of the following occurs: 6640 * <ul> 6641 * <li>A {@code MouseWheelListener} object is registered 6642 * via {@code addMouseWheelListener}. 6643 * <li>Mouse wheel events are enabled via {@code enableEvents}. 6644 * </ul> 6645 * <p> 6646 * For information on how mouse wheel events are dispatched, see 6647 * the class description for {@link MouseWheelEvent}. 6648 * <p> 6649 * Note that if the event parameter is {@code null} 6650 * the behavior is unspecified and may result in an 6651 * exception. 6652 * 6653 * @param e the mouse wheel event 6654 * @see java.awt.event.MouseWheelEvent 6655 * @see java.awt.event.MouseWheelListener 6656 * @see #addMouseWheelListener 6657 * @see #enableEvents 6658 * @since 1.4 6659 */ 6660 protected void processMouseWheelEvent(MouseWheelEvent e) { 6661 MouseWheelListener listener = mouseWheelListener; 6662 if (listener != null) { 6663 int id = e.getID(); 6664 switch(id) { 6665 case MouseEvent.MOUSE_WHEEL: 6666 listener.mouseWheelMoved(e); 6667 break; 6668 } 6669 } 6670 } 6671 6672 boolean postsOldMouseEvents() { 6673 return false; 6674 } 6675 6676 /** 6677 * Processes input method events occurring on this component by 6678 * dispatching them to any registered 6679 * {@code InputMethodListener} objects. 6680 * <p> 6681 * This method is not called unless input method events 6682 * are enabled for this component. Input method events are enabled 6683 * when one of the following occurs: 6684 * <ul> 6685 * <li>An {@code InputMethodListener} object is registered 6686 * via {@code addInputMethodListener}. 6687 * <li>Input method events are enabled via {@code enableEvents}. 6688 * </ul> 6689 * <p>Note that if the event parameter is {@code null} 6690 * the behavior is unspecified and may result in an 6691 * exception. 6692 * 6693 * @param e the input method event 6694 * @see java.awt.event.InputMethodEvent 6695 * @see java.awt.event.InputMethodListener 6696 * @see #addInputMethodListener 6697 * @see #enableEvents 6698 * @since 1.2 6699 */ 6700 protected void processInputMethodEvent(InputMethodEvent e) { 6701 InputMethodListener listener = inputMethodListener; 6702 if (listener != null) { 6703 int id = e.getID(); 6704 switch (id) { 6705 case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED: 6706 listener.inputMethodTextChanged(e); 6707 break; 6708 case InputMethodEvent.CARET_POSITION_CHANGED: 6709 listener.caretPositionChanged(e); 6710 break; 6711 } 6712 } 6713 } 6714 6715 /** 6716 * Processes hierarchy events occurring on this component by 6717 * dispatching them to any registered 6718 * {@code HierarchyListener} objects. 6719 * <p> 6720 * This method is not called unless hierarchy events 6721 * are enabled for this component. Hierarchy events are enabled 6722 * when one of the following occurs: 6723 * <ul> 6724 * <li>An {@code HierarchyListener} object is registered 6725 * via {@code addHierarchyListener}. 6726 * <li>Hierarchy events are enabled via {@code enableEvents}. 6727 * </ul> 6728 * <p>Note that if the event parameter is {@code null} 6729 * the behavior is unspecified and may result in an 6730 * exception. 6731 * 6732 * @param e the hierarchy event 6733 * @see java.awt.event.HierarchyEvent 6734 * @see java.awt.event.HierarchyListener 6735 * @see #addHierarchyListener 6736 * @see #enableEvents 6737 * @since 1.3 6738 */ 6739 protected void processHierarchyEvent(HierarchyEvent e) { 6740 HierarchyListener listener = hierarchyListener; 6741 if (listener != null) { 6742 int id = e.getID(); 6743 switch (id) { 6744 case HierarchyEvent.HIERARCHY_CHANGED: 6745 listener.hierarchyChanged(e); 6746 break; 6747 } 6748 } 6749 } 6750 6751 /** 6752 * Processes hierarchy bounds events occurring on this component by 6753 * dispatching them to any registered 6754 * {@code HierarchyBoundsListener} objects. 6755 * <p> 6756 * This method is not called unless hierarchy bounds events 6757 * are enabled for this component. Hierarchy bounds events are enabled 6758 * when one of the following occurs: 6759 * <ul> 6760 * <li>An {@code HierarchyBoundsListener} object is registered 6761 * via {@code addHierarchyBoundsListener}. 6762 * <li>Hierarchy bounds events are enabled via {@code enableEvents}. 6763 * </ul> 6764 * <p>Note that if the event parameter is {@code null} 6765 * the behavior is unspecified and may result in an 6766 * exception. 6767 * 6768 * @param e the hierarchy event 6769 * @see java.awt.event.HierarchyEvent 6770 * @see java.awt.event.HierarchyBoundsListener 6771 * @see #addHierarchyBoundsListener 6772 * @see #enableEvents 6773 * @since 1.3 6774 */ 6775 protected void processHierarchyBoundsEvent(HierarchyEvent e) { 6776 HierarchyBoundsListener listener = hierarchyBoundsListener; 6777 if (listener != null) { 6778 int id = e.getID(); 6779 switch (id) { 6780 case HierarchyEvent.ANCESTOR_MOVED: 6781 listener.ancestorMoved(e); 6782 break; 6783 case HierarchyEvent.ANCESTOR_RESIZED: 6784 listener.ancestorResized(e); 6785 break; 6786 } 6787 } 6788 } 6789 6790 /** 6791 * @param evt the event to handle 6792 * @return {@code true} if the event was handled, {@code false} otherwise 6793 * @deprecated As of JDK version 1.1 6794 * replaced by processEvent(AWTEvent). 6795 */ 6796 @Deprecated 6797 public boolean handleEvent(Event evt) { 6798 switch (evt.id) { 6799 case Event.MOUSE_ENTER: 6800 return mouseEnter(evt, evt.x, evt.y); 6801 6802 case Event.MOUSE_EXIT: 6803 return mouseExit(evt, evt.x, evt.y); 6804 6805 case Event.MOUSE_MOVE: 6806 return mouseMove(evt, evt.x, evt.y); 6807 6808 case Event.MOUSE_DOWN: 6809 return mouseDown(evt, evt.x, evt.y); 6810 6811 case Event.MOUSE_DRAG: 6812 return mouseDrag(evt, evt.x, evt.y); 6813 6814 case Event.MOUSE_UP: 6815 return mouseUp(evt, evt.x, evt.y); 6816 6817 case Event.KEY_PRESS: 6818 case Event.KEY_ACTION: 6819 return keyDown(evt, evt.key); 6820 6821 case Event.KEY_RELEASE: 6822 case Event.KEY_ACTION_RELEASE: 6823 return keyUp(evt, evt.key); 6824 6825 case Event.ACTION_EVENT: 6826 return action(evt, evt.arg); 6827 case Event.GOT_FOCUS: 6828 return gotFocus(evt, evt.arg); 6829 case Event.LOST_FOCUS: 6830 return lostFocus(evt, evt.arg); 6831 } 6832 return false; 6833 } 6834 6835 /** 6836 * @param evt the event to handle 6837 * @param x the x coordinate 6838 * @param y the y coordinate 6839 * @return {@code false} 6840 * @deprecated As of JDK version 1.1, 6841 * replaced by processMouseEvent(MouseEvent). 6842 */ 6843 @Deprecated 6844 public boolean mouseDown(Event evt, int x, int y) { 6845 return false; 6846 } 6847 6848 /** 6849 * @param evt the event to handle 6850 * @param x the x coordinate 6851 * @param y the y coordinate 6852 * @return {@code false} 6853 * @deprecated As of JDK version 1.1, 6854 * replaced by processMouseMotionEvent(MouseEvent). 6855 */ 6856 @Deprecated 6857 public boolean mouseDrag(Event evt, int x, int y) { 6858 return false; 6859 } 6860 6861 /** 6862 * @param evt the event to handle 6863 * @param x the x coordinate 6864 * @param y the y coordinate 6865 * @return {@code false} 6866 * @deprecated As of JDK version 1.1, 6867 * replaced by processMouseEvent(MouseEvent). 6868 */ 6869 @Deprecated 6870 public boolean mouseUp(Event evt, int x, int y) { 6871 return false; 6872 } 6873 6874 /** 6875 * @param evt the event to handle 6876 * @param x the x coordinate 6877 * @param y the y coordinate 6878 * @return {@code false} 6879 * @deprecated As of JDK version 1.1, 6880 * replaced by processMouseMotionEvent(MouseEvent). 6881 */ 6882 @Deprecated 6883 public boolean mouseMove(Event evt, int x, int y) { 6884 return false; 6885 } 6886 6887 /** 6888 * @param evt the event to handle 6889 * @param x the x coordinate 6890 * @param y the y coordinate 6891 * @return {@code false} 6892 * @deprecated As of JDK version 1.1, 6893 * replaced by processMouseEvent(MouseEvent). 6894 */ 6895 @Deprecated 6896 public boolean mouseEnter(Event evt, int x, int y) { 6897 return false; 6898 } 6899 6900 /** 6901 * @param evt the event to handle 6902 * @param x the x coordinate 6903 * @param y the y coordinate 6904 * @return {@code false} 6905 * @deprecated As of JDK version 1.1, 6906 * replaced by processMouseEvent(MouseEvent). 6907 */ 6908 @Deprecated 6909 public boolean mouseExit(Event evt, int x, int y) { 6910 return false; 6911 } 6912 6913 /** 6914 * @param evt the event to handle 6915 * @param key the key pressed 6916 * @return {@code false} 6917 * @deprecated As of JDK version 1.1, 6918 * replaced by processKeyEvent(KeyEvent). 6919 */ 6920 @Deprecated 6921 public boolean keyDown(Event evt, int key) { 6922 return false; 6923 } 6924 6925 /** 6926 * @param evt the event to handle 6927 * @param key the key pressed 6928 * @return {@code false} 6929 * @deprecated As of JDK version 1.1, 6930 * replaced by processKeyEvent(KeyEvent). 6931 */ 6932 @Deprecated 6933 public boolean keyUp(Event evt, int key) { 6934 return false; 6935 } 6936 6937 /** 6938 * @param evt the event to handle 6939 * @param what the object acted on 6940 * @return {@code false} 6941 * @deprecated As of JDK version 1.1, 6942 * should register this component as ActionListener on component 6943 * which fires action events. 6944 */ 6945 @Deprecated 6946 public boolean action(Event evt, Object what) { 6947 return false; 6948 } 6949 6950 /** 6951 * Makes this {@code Component} displayable by connecting it to a 6952 * native screen resource. 6953 * This method is called internally by the toolkit and should 6954 * not be called directly by programs. 6955 * <p> 6956 * This method changes layout-related information, and therefore, 6957 * invalidates the component hierarchy. 6958 * 6959 * @see #isDisplayable 6960 * @see #removeNotify 6961 * @see #invalidate 6962 * @since 1.0 6963 */ 6964 public void addNotify() { 6965 synchronized (getTreeLock()) { 6966 ComponentPeer peer = this.peer; 6967 if (peer == null || peer instanceof LightweightPeer){ 6968 if (peer == null) { 6969 // Update both the Component's peer variable and the local 6970 // variable we use for thread safety. 6971 this.peer = peer = getComponentFactory().createComponent(this); 6972 } 6973 6974 // This is a lightweight component which means it won't be 6975 // able to get window-related events by itself. If any 6976 // have been enabled, then the nearest native container must 6977 // be enabled. 6978 if (parent != null) { 6979 long mask = 0; 6980 if ((mouseListener != null) || ((eventMask & AWTEvent.MOUSE_EVENT_MASK) != 0)) { 6981 mask |= AWTEvent.MOUSE_EVENT_MASK; 6982 } 6983 if ((mouseMotionListener != null) || 6984 ((eventMask & AWTEvent.MOUSE_MOTION_EVENT_MASK) != 0)) { 6985 mask |= AWTEvent.MOUSE_MOTION_EVENT_MASK; 6986 } 6987 if ((mouseWheelListener != null ) || 6988 ((eventMask & AWTEvent.MOUSE_WHEEL_EVENT_MASK) != 0)) { 6989 mask |= AWTEvent.MOUSE_WHEEL_EVENT_MASK; 6990 } 6991 if (focusListener != null || (eventMask & AWTEvent.FOCUS_EVENT_MASK) != 0) { 6992 mask |= AWTEvent.FOCUS_EVENT_MASK; 6993 } 6994 if (keyListener != null || (eventMask & AWTEvent.KEY_EVENT_MASK) != 0) { 6995 mask |= AWTEvent.KEY_EVENT_MASK; 6996 } 6997 if (mask != 0) { 6998 parent.proxyEnableEvents(mask); 6999 } 7000 } 7001 } else { 7002 // It's native. If the parent is lightweight it will need some 7003 // help. 7004 Container parent = getContainer(); 7005 if (parent != null && parent.isLightweight()) { 7006 relocateComponent(); 7007 if (!parent.isRecursivelyVisibleUpToHeavyweightContainer()) 7008 { 7009 peer.setVisible(false); 7010 } 7011 } 7012 } 7013 invalidate(); 7014 7015 int npopups = (popups != null? popups.size() : 0); 7016 for (int i = 0 ; i < npopups ; i++) { 7017 PopupMenu popup = popups.elementAt(i); 7018 popup.addNotify(); 7019 } 7020 7021 if (dropTarget != null) dropTarget.addNotify(); 7022 7023 peerFont = getFont(); 7024 7025 if (getContainer() != null && !isAddNotifyComplete) { 7026 getContainer().increaseComponentCount(this); 7027 } 7028 7029 7030 // Update stacking order 7031 updateZOrder(); 7032 7033 if (!isAddNotifyComplete) { 7034 mixOnShowing(); 7035 } 7036 7037 isAddNotifyComplete = true; 7038 7039 if (hierarchyListener != null || 7040 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 || 7041 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK)) { 7042 HierarchyEvent e = 7043 new HierarchyEvent(this, HierarchyEvent.HIERARCHY_CHANGED, 7044 this, parent, 7045 HierarchyEvent.DISPLAYABILITY_CHANGED | 7046 ((isRecursivelyVisible()) 7047 ? HierarchyEvent.SHOWING_CHANGED 7048 : 0)); 7049 dispatchEvent(e); 7050 } 7051 } 7052 } 7053 7054 /** 7055 * Makes this {@code Component} undisplayable by destroying it native 7056 * screen resource. 7057 * <p> 7058 * This method is called by the toolkit internally and should 7059 * not be called directly by programs. Code overriding 7060 * this method should call {@code super.removeNotify} as 7061 * the first line of the overriding method. 7062 * 7063 * @see #isDisplayable 7064 * @see #addNotify 7065 * @since 1.0 7066 */ 7067 public void removeNotify() { 7068 KeyboardFocusManager.clearMostRecentFocusOwner(this); 7069 if (KeyboardFocusManager.getCurrentKeyboardFocusManager(). 7070 getPermanentFocusOwner() == this) 7071 { 7072 KeyboardFocusManager.getCurrentKeyboardFocusManager(). 7073 setGlobalPermanentFocusOwner(null); 7074 } 7075 7076 synchronized (getTreeLock()) { 7077 if (isFocusOwner() && KeyboardFocusManager.isAutoFocusTransferEnabledFor(this)) { 7078 transferFocus(true); 7079 } 7080 7081 if (getContainer() != null && isAddNotifyComplete) { 7082 getContainer().decreaseComponentCount(this); 7083 } 7084 7085 int npopups = (popups != null? popups.size() : 0); 7086 for (int i = 0 ; i < npopups ; i++) { 7087 PopupMenu popup = popups.elementAt(i); 7088 popup.removeNotify(); 7089 } 7090 // If there is any input context for this component, notify 7091 // that this component is being removed. (This has to be done 7092 // before hiding peer.) 7093 if ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) { 7094 InputContext inputContext = getInputContext(); 7095 if (inputContext != null) { 7096 inputContext.removeNotify(this); 7097 } 7098 } 7099 7100 ComponentPeer p = peer; 7101 if (p != null) { 7102 boolean isLightweight = isLightweight(); 7103 7104 if (bufferStrategy instanceof FlipBufferStrategy) { 7105 ((FlipBufferStrategy)bufferStrategy).destroyBuffers(); 7106 } 7107 7108 if (dropTarget != null) dropTarget.removeNotify(); 7109 7110 // Hide peer first to stop system events such as cursor moves. 7111 if (visible) { 7112 p.setVisible(false); 7113 } 7114 7115 peer = null; // Stop peer updates. 7116 peerFont = null; 7117 7118 Toolkit.getEventQueue().removeSourceEvents(this, false); 7119 KeyboardFocusManager.getCurrentKeyboardFocusManager(). 7120 discardKeyEvents(this); 7121 7122 p.dispose(); 7123 7124 mixOnHiding(isLightweight); 7125 7126 isAddNotifyComplete = false; 7127 // Nullifying compoundShape means that the component has normal shape 7128 // (or has no shape at all). 7129 this.compoundShape = null; 7130 } 7131 7132 if (hierarchyListener != null || 7133 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 || 7134 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK)) { 7135 HierarchyEvent e = 7136 new HierarchyEvent(this, HierarchyEvent.HIERARCHY_CHANGED, 7137 this, parent, 7138 HierarchyEvent.DISPLAYABILITY_CHANGED | 7139 ((isRecursivelyVisible()) 7140 ? HierarchyEvent.SHOWING_CHANGED 7141 : 0)); 7142 dispatchEvent(e); 7143 } 7144 } 7145 } 7146 7147 /** 7148 * @param evt the event to handle 7149 * @param what the object focused 7150 * @return {@code false} 7151 * @deprecated As of JDK version 1.1, 7152 * replaced by processFocusEvent(FocusEvent). 7153 */ 7154 @Deprecated 7155 public boolean gotFocus(Event evt, Object what) { 7156 return false; 7157 } 7158 7159 /** 7160 * @param evt the event to handle 7161 * @param what the object focused 7162 * @return {@code false} 7163 * @deprecated As of JDK version 1.1, 7164 * replaced by processFocusEvent(FocusEvent). 7165 */ 7166 @Deprecated 7167 public boolean lostFocus(Event evt, Object what) { 7168 return false; 7169 } 7170 7171 /** 7172 * Returns whether this {@code Component} can become the focus 7173 * owner. 7174 * 7175 * @return {@code true} if this {@code Component} is 7176 * focusable; {@code false} otherwise 7177 * @see #setFocusable 7178 * @since 1.1 7179 * @deprecated As of 1.4, replaced by {@code isFocusable()}. 7180 */ 7181 @Deprecated 7182 public boolean isFocusTraversable() { 7183 if (isFocusTraversableOverridden == FOCUS_TRAVERSABLE_UNKNOWN) { 7184 isFocusTraversableOverridden = FOCUS_TRAVERSABLE_DEFAULT; 7185 } 7186 return focusable; 7187 } 7188 7189 /** 7190 * Returns whether this Component can be focused. 7191 * 7192 * @return {@code true} if this Component is focusable; 7193 * {@code false} otherwise. 7194 * @see #setFocusable 7195 * @since 1.4 7196 */ 7197 public boolean isFocusable() { 7198 return isFocusTraversable(); 7199 } 7200 7201 /** 7202 * Sets the focusable state of this Component to the specified value. This 7203 * value overrides the Component's default focusability. 7204 * 7205 * @param focusable indicates whether this Component is focusable 7206 * @see #isFocusable 7207 * @since 1.4 7208 */ 7209 public void setFocusable(boolean focusable) { 7210 boolean oldFocusable; 7211 synchronized (this) { 7212 oldFocusable = this.focusable; 7213 this.focusable = focusable; 7214 } 7215 isFocusTraversableOverridden = FOCUS_TRAVERSABLE_SET; 7216 7217 firePropertyChange("focusable", oldFocusable, focusable); 7218 if (oldFocusable && !focusable) { 7219 if (isFocusOwner() && KeyboardFocusManager.isAutoFocusTransferEnabled()) { 7220 transferFocus(true); 7221 } 7222 KeyboardFocusManager.clearMostRecentFocusOwner(this); 7223 } 7224 } 7225 7226 final boolean isFocusTraversableOverridden() { 7227 return (isFocusTraversableOverridden != FOCUS_TRAVERSABLE_DEFAULT); 7228 } 7229 7230 /** 7231 * Sets the focus traversal keys for a given traversal operation for this 7232 * Component. 7233 * <p> 7234 * The default values for a Component's focus traversal keys are 7235 * implementation-dependent. Sun recommends that all implementations for a 7236 * particular native platform use the same default values. The 7237 * recommendations for Windows and Unix are listed below. These 7238 * recommendations are used in the Sun AWT implementations. 7239 * 7240 * <table class="striped"> 7241 * <caption>Recommended default values for a Component's focus traversal 7242 * keys</caption> 7243 * <thead> 7244 * <tr> 7245 * <th>Identifier</th> 7246 * <th>Meaning</th> 7247 * <th>Default</th> 7248 * </tr> 7249 * </thead> 7250 * <tbody> 7251 * <tr> 7252 * <td>KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS</td> 7253 * <td>Normal forward keyboard traversal</td> 7254 * <td>TAB on KEY_PRESSED, CTRL-TAB on KEY_PRESSED</td> 7255 * </tr> 7256 * <tr> 7257 * <td>KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS</td> 7258 * <td>Normal reverse keyboard traversal</td> 7259 * <td>SHIFT-TAB on KEY_PRESSED, CTRL-SHIFT-TAB on KEY_PRESSED</td> 7260 * </tr> 7261 * <tr> 7262 * <td>KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS</td> 7263 * <td>Go up one focus traversal cycle</td> 7264 * <td>none</td> 7265 * </tr> 7266 * </tbody> 7267 * </table> 7268 * 7269 * To disable a traversal key, use an empty Set; Collections.EMPTY_SET is 7270 * recommended. 7271 * <p> 7272 * Using the AWTKeyStroke API, client code can specify on which of two 7273 * specific KeyEvents, KEY_PRESSED or KEY_RELEASED, the focus traversal 7274 * operation will occur. Regardless of which KeyEvent is specified, 7275 * however, all KeyEvents related to the focus traversal key, including the 7276 * associated KEY_TYPED event, will be consumed, and will not be dispatched 7277 * to any Component. It is a runtime error to specify a KEY_TYPED event as 7278 * mapping to a focus traversal operation, or to map the same event to 7279 * multiple default focus traversal operations. 7280 * <p> 7281 * If a value of null is specified for the Set, this Component inherits the 7282 * Set from its parent. If all ancestors of this Component have null 7283 * specified for the Set, then the current KeyboardFocusManager's default 7284 * Set is used. 7285 * <p> 7286 * This method may throw a {@code ClassCastException} if any {@code Object} 7287 * in {@code keystrokes} is not an {@code AWTKeyStroke}. 7288 * 7289 * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, 7290 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or 7291 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS 7292 * @param keystrokes the Set of AWTKeyStroke for the specified operation 7293 * @see #getFocusTraversalKeys 7294 * @see KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS 7295 * @see KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS 7296 * @see KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS 7297 * @throws IllegalArgumentException if id is not one of 7298 * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, 7299 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or 7300 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, or if keystrokes 7301 * contains null, or if any keystroke represents a KEY_TYPED event, 7302 * or if any keystroke already maps to another focus traversal 7303 * operation for this Component 7304 * @since 1.4 7305 */ 7306 public void setFocusTraversalKeys(int id, 7307 Set<? extends AWTKeyStroke> keystrokes) 7308 { 7309 if (id < 0 || id >= KeyboardFocusManager.TRAVERSAL_KEY_LENGTH - 1) { 7310 throw new IllegalArgumentException("invalid focus traversal key identifier"); 7311 } 7312 7313 setFocusTraversalKeys_NoIDCheck(id, keystrokes); 7314 } 7315 7316 /** 7317 * Returns the Set of focus traversal keys for a given traversal operation 7318 * for this Component. (See 7319 * {@code setFocusTraversalKeys} for a full description of each key.) 7320 * <p> 7321 * If a Set of traversal keys has not been explicitly defined for this 7322 * Component, then this Component's parent's Set is returned. If no Set 7323 * has been explicitly defined for any of this Component's ancestors, then 7324 * the current KeyboardFocusManager's default Set is returned. 7325 * 7326 * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, 7327 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or 7328 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS 7329 * @return the Set of AWTKeyStrokes for the specified operation. The Set 7330 * will be unmodifiable, and may be empty. null will never be 7331 * returned. 7332 * @see #setFocusTraversalKeys 7333 * @see KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS 7334 * @see KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS 7335 * @see KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS 7336 * @throws IllegalArgumentException if id is not one of 7337 * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, 7338 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or 7339 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS 7340 * @since 1.4 7341 */ 7342 public Set<AWTKeyStroke> getFocusTraversalKeys(int id) { 7343 if (id < 0 || id >= KeyboardFocusManager.TRAVERSAL_KEY_LENGTH - 1) { 7344 throw new IllegalArgumentException("invalid focus traversal key identifier"); 7345 } 7346 7347 return getFocusTraversalKeys_NoIDCheck(id); 7348 } 7349 7350 // We define these methods so that Container does not need to repeat this 7351 // code. Container cannot call super.<method> because Container allows 7352 // DOWN_CYCLE_TRAVERSAL_KEY while Component does not. The Component method 7353 // would erroneously generate an IllegalArgumentException for 7354 // DOWN_CYCLE_TRAVERSAL_KEY. 7355 final void setFocusTraversalKeys_NoIDCheck(int id, Set<? extends AWTKeyStroke> keystrokes) { 7356 Set<AWTKeyStroke> oldKeys; 7357 7358 synchronized (this) { 7359 if (focusTraversalKeys == null) { 7360 initializeFocusTraversalKeys(); 7361 } 7362 7363 if (keystrokes != null) { 7364 for (AWTKeyStroke keystroke : keystrokes ) { 7365 7366 if (keystroke == null) { 7367 throw new IllegalArgumentException("cannot set null focus traversal key"); 7368 } 7369 7370 if (keystroke.getKeyChar() != KeyEvent.CHAR_UNDEFINED) { 7371 throw new IllegalArgumentException("focus traversal keys cannot map to KEY_TYPED events"); 7372 } 7373 7374 for (int i = 0; i < focusTraversalKeys.length; i++) { 7375 if (i == id) { 7376 continue; 7377 } 7378 7379 if (getFocusTraversalKeys_NoIDCheck(i).contains(keystroke)) 7380 { 7381 throw new IllegalArgumentException("focus traversal keys must be unique for a Component"); 7382 } 7383 } 7384 } 7385 } 7386 7387 oldKeys = focusTraversalKeys[id]; 7388 focusTraversalKeys[id] = (keystrokes != null) 7389 ? Collections.unmodifiableSet(new HashSet<AWTKeyStroke>(keystrokes)) 7390 : null; 7391 } 7392 7393 firePropertyChange(focusTraversalKeyPropertyNames[id], oldKeys, 7394 keystrokes); 7395 } 7396 final Set<AWTKeyStroke> getFocusTraversalKeys_NoIDCheck(int id) { 7397 // Okay to return Set directly because it is an unmodifiable view 7398 @SuppressWarnings("unchecked") 7399 Set<AWTKeyStroke> keystrokes = (focusTraversalKeys != null) 7400 ? focusTraversalKeys[id] 7401 : null; 7402 7403 if (keystrokes != null) { 7404 return keystrokes; 7405 } else { 7406 Container parent = this.parent; 7407 if (parent != null) { 7408 return parent.getFocusTraversalKeys(id); 7409 } else { 7410 return KeyboardFocusManager.getCurrentKeyboardFocusManager(). 7411 getDefaultFocusTraversalKeys(id); 7412 } 7413 } 7414 } 7415 7416 /** 7417 * Returns whether the Set of focus traversal keys for the given focus 7418 * traversal operation has been explicitly defined for this Component. If 7419 * this method returns {@code false}, this Component is inheriting the 7420 * Set from an ancestor, or from the current KeyboardFocusManager. 7421 * 7422 * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, 7423 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or 7424 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS 7425 * @return {@code true} if the Set of focus traversal keys for the 7426 * given focus traversal operation has been explicitly defined for 7427 * this Component; {@code false} otherwise. 7428 * @throws IllegalArgumentException if id is not one of 7429 * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, 7430 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or 7431 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS 7432 * @since 1.4 7433 */ 7434 public boolean areFocusTraversalKeysSet(int id) { 7435 if (id < 0 || id >= KeyboardFocusManager.TRAVERSAL_KEY_LENGTH - 1) { 7436 throw new IllegalArgumentException("invalid focus traversal key identifier"); 7437 } 7438 7439 return (focusTraversalKeys != null && focusTraversalKeys[id] != null); 7440 } 7441 7442 /** 7443 * Sets whether focus traversal keys are enabled for this Component. 7444 * Components for which focus traversal keys are disabled receive key 7445 * events for focus traversal keys. Components for which focus traversal 7446 * keys are enabled do not see these events; instead, the events are 7447 * automatically converted to traversal operations. 7448 * 7449 * @param focusTraversalKeysEnabled whether focus traversal keys are 7450 * enabled for this Component 7451 * @see #getFocusTraversalKeysEnabled 7452 * @see #setFocusTraversalKeys 7453 * @see #getFocusTraversalKeys 7454 * @since 1.4 7455 */ 7456 public void setFocusTraversalKeysEnabled(boolean 7457 focusTraversalKeysEnabled) { 7458 boolean oldFocusTraversalKeysEnabled; 7459 synchronized (this) { 7460 oldFocusTraversalKeysEnabled = this.focusTraversalKeysEnabled; 7461 this.focusTraversalKeysEnabled = focusTraversalKeysEnabled; 7462 } 7463 firePropertyChange("focusTraversalKeysEnabled", 7464 oldFocusTraversalKeysEnabled, 7465 focusTraversalKeysEnabled); 7466 } 7467 7468 /** 7469 * Returns whether focus traversal keys are enabled for this Component. 7470 * Components for which focus traversal keys are disabled receive key 7471 * events for focus traversal keys. Components for which focus traversal 7472 * keys are enabled do not see these events; instead, the events are 7473 * automatically converted to traversal operations. 7474 * 7475 * @return whether focus traversal keys are enabled for this Component 7476 * @see #setFocusTraversalKeysEnabled 7477 * @see #setFocusTraversalKeys 7478 * @see #getFocusTraversalKeys 7479 * @since 1.4 7480 */ 7481 public boolean getFocusTraversalKeysEnabled() { 7482 return focusTraversalKeysEnabled; 7483 } 7484 7485 /** 7486 * Requests that this Component get the input focus, and that this 7487 * Component's top-level ancestor become the focused Window. This 7488 * component must be displayable, focusable, visible and all of 7489 * its ancestors (with the exception of the top-level Window) must 7490 * be visible for the request to be granted. Every effort will be 7491 * made to honor the request; however, in some cases it may be 7492 * impossible to do so. Developers must never assume that this 7493 * Component is the focus owner until this Component receives a 7494 * FOCUS_GAINED event. If this request is denied because this 7495 * Component's top-level Window cannot become the focused Window, 7496 * the request will be remembered and will be granted when the 7497 * Window is later focused by the user. 7498 * <p> 7499 * This method cannot be used to set the focus owner to no Component at 7500 * all. Use {@code KeyboardFocusManager.clearGlobalFocusOwner()} 7501 * instead. 7502 * <p> 7503 * Because the focus behavior of this method is platform-dependent, 7504 * developers are strongly encouraged to use 7505 * {@code requestFocusInWindow} when possible. 7506 * 7507 * <p>Note: Not all focus transfers result from invoking this method. As 7508 * such, a component may receive focus without this or any of the other 7509 * {@code requestFocus} methods of {@code Component} being invoked. 7510 * 7511 * @see #requestFocusInWindow 7512 * @see java.awt.event.FocusEvent 7513 * @see #addFocusListener 7514 * @see #isFocusable 7515 * @see #isDisplayable 7516 * @see KeyboardFocusManager#clearGlobalFocusOwner 7517 * @since 1.0 7518 */ 7519 public void requestFocus() { 7520 requestFocusHelper(false, true); 7521 } 7522 7523 7524 /** 7525 * Requests by the reason of {@code cause} that this Component get the input 7526 * focus, and that this Component's top-level ancestor become the 7527 * focused Window. This component must be displayable, focusable, visible 7528 * and all of its ancestors (with the exception of the top-level Window) 7529 * must be visible for the request to be granted. Every effort will be 7530 * made to honor the request; however, in some cases it may be 7531 * impossible to do so. Developers must never assume that this 7532 * Component is the focus owner until this Component receives a 7533 * FOCUS_GAINED event. 7534 * <p> 7535 * The focus request effect may also depend on the provided 7536 * cause value. If this request is succeed the {@code FocusEvent} 7537 * generated in the result will receive the cause value specified as the 7538 * argument of method. If this request is denied because this Component's 7539 * top-level Window cannot become the focused Window, the request will be 7540 * remembered and will be granted when the Window is later focused by the 7541 * user. 7542 * <p> 7543 * This method cannot be used to set the focus owner to no Component at 7544 * all. Use {@code KeyboardFocusManager.clearGlobalFocusOwner()} 7545 * instead. 7546 * <p> 7547 * Because the focus behavior of this method is platform-dependent, 7548 * developers are strongly encouraged to use 7549 * {@code requestFocusInWindow(FocusEvent.Cause)} when possible. 7550 * 7551 * <p>Note: Not all focus transfers result from invoking this method. As 7552 * such, a component may receive focus without this or any of the other 7553 * {@code requestFocus} methods of {@code Component} being invoked. 7554 * 7555 * @param cause the cause why the focus is requested 7556 * @see FocusEvent 7557 * @see FocusEvent.Cause 7558 * @see #requestFocusInWindow(FocusEvent.Cause) 7559 * @see java.awt.event.FocusEvent 7560 * @see #addFocusListener 7561 * @see #isFocusable 7562 * @see #isDisplayable 7563 * @see KeyboardFocusManager#clearGlobalFocusOwner 7564 * @since 9 7565 */ 7566 public void requestFocus(FocusEvent.Cause cause) { 7567 requestFocusHelper(false, true, cause); 7568 } 7569 7570 /** 7571 * Requests that this {@code Component} get the input focus, 7572 * and that this {@code Component}'s top-level ancestor 7573 * become the focused {@code Window}. This component must be 7574 * displayable, focusable, visible and all of its ancestors (with 7575 * the exception of the top-level Window) must be visible for the 7576 * request to be granted. Every effort will be made to honor the 7577 * request; however, in some cases it may be impossible to do 7578 * so. Developers must never assume that this component is the 7579 * focus owner until this component receives a FOCUS_GAINED 7580 * event. If this request is denied because this component's 7581 * top-level window cannot become the focused window, the request 7582 * will be remembered and will be granted when the window is later 7583 * focused by the user. 7584 * <p> 7585 * This method returns a boolean value. If {@code false} is returned, 7586 * the request is <b>guaranteed to fail</b>. If {@code true} is 7587 * returned, the request will succeed <b>unless</b> it is vetoed, or an 7588 * extraordinary event, such as disposal of the component's peer, occurs 7589 * before the request can be granted by the native windowing system. Again, 7590 * while a return value of {@code true} indicates that the request is 7591 * likely to succeed, developers must never assume that this component is 7592 * the focus owner until this component receives a FOCUS_GAINED event. 7593 * <p> 7594 * This method cannot be used to set the focus owner to no component at 7595 * all. Use {@code KeyboardFocusManager.clearGlobalFocusOwner} 7596 * instead. 7597 * <p> 7598 * Because the focus behavior of this method is platform-dependent, 7599 * developers are strongly encouraged to use 7600 * {@code requestFocusInWindow} when possible. 7601 * <p> 7602 * Every effort will be made to ensure that {@code FocusEvent}s 7603 * generated as a 7604 * result of this request will have the specified temporary value. However, 7605 * because specifying an arbitrary temporary state may not be implementable 7606 * on all native windowing systems, correct behavior for this method can be 7607 * guaranteed only for lightweight {@code Component}s. 7608 * This method is not intended 7609 * for general use, but exists instead as a hook for lightweight component 7610 * libraries, such as Swing. 7611 * 7612 * <p>Note: Not all focus transfers result from invoking this method. As 7613 * such, a component may receive focus without this or any of the other 7614 * {@code requestFocus} methods of {@code Component} being invoked. 7615 * 7616 * @param temporary true if the focus change is temporary, 7617 * such as when the window loses the focus; for 7618 * more information on temporary focus changes see the 7619 *<a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a> 7620 * @return {@code false} if the focus change request is guaranteed to 7621 * fail; {@code true} if it is likely to succeed 7622 * @see java.awt.event.FocusEvent 7623 * @see #addFocusListener 7624 * @see #isFocusable 7625 * @see #isDisplayable 7626 * @see KeyboardFocusManager#clearGlobalFocusOwner 7627 * @since 1.4 7628 */ 7629 protected boolean requestFocus(boolean temporary) { 7630 return requestFocusHelper(temporary, true); 7631 } 7632 7633 /** 7634 * Requests by the reason of {@code cause} that this {@code Component} get 7635 * the input focus, and that this {@code Component}'s top-level ancestor 7636 * become the focused {@code Window}. This component must be 7637 * displayable, focusable, visible and all of its ancestors (with 7638 * the exception of the top-level Window) must be visible for the 7639 * request to be granted. Every effort will be made to honor the 7640 * request; however, in some cases it may be impossible to do 7641 * so. Developers must never assume that this component is the 7642 * focus owner until this component receives a FOCUS_GAINED 7643 * event. If this request is denied because this component's 7644 * top-level window cannot become the focused window, the request 7645 * will be remembered and will be granted when the window is later 7646 * focused by the user. 7647 * <p> 7648 * This method returns a boolean value. If {@code false} is returned, 7649 * the request is <b>guaranteed to fail</b>. If {@code true} is 7650 * returned, the request will succeed <b>unless</b> it is vetoed, or an 7651 * extraordinary event, such as disposal of the component's peer, occurs 7652 * before the request can be granted by the native windowing system. Again, 7653 * while a return value of {@code true} indicates that the request is 7654 * likely to succeed, developers must never assume that this component is 7655 * the focus owner until this component receives a FOCUS_GAINED event. 7656 * <p> 7657 * The focus request effect may also depend on the provided 7658 * cause value. If this request is succeed the {FocusEvent} 7659 * generated in the result will receive the cause value specified as the 7660 * argument of the method. 7661 * <p> 7662 * This method cannot be used to set the focus owner to no component at 7663 * all. Use {@code KeyboardFocusManager.clearGlobalFocusOwner} 7664 * instead. 7665 * <p> 7666 * Because the focus behavior of this method is platform-dependent, 7667 * developers are strongly encouraged to use 7668 * {@code requestFocusInWindow} when possible. 7669 * <p> 7670 * Every effort will be made to ensure that {@code FocusEvent}s 7671 * generated as a 7672 * result of this request will have the specified temporary value. However, 7673 * because specifying an arbitrary temporary state may not be implementable 7674 * on all native windowing systems, correct behavior for this method can be 7675 * guaranteed only for lightweight {@code Component}s. 7676 * This method is not intended 7677 * for general use, but exists instead as a hook for lightweight component 7678 * libraries, such as Swing. 7679 * <p> 7680 * Note: Not all focus transfers result from invoking this method. As 7681 * such, a component may receive focus without this or any of the other 7682 * {@code requestFocus} methods of {@code Component} being invoked. 7683 * 7684 * @param temporary true if the focus change is temporary, 7685 * such as when the window loses the focus; for 7686 * more information on temporary focus changes see the 7687 *<a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a> 7688 * 7689 * @param cause the cause why the focus is requested 7690 * @return {@code false} if the focus change request is guaranteed to 7691 * fail; {@code true} if it is likely to succeed 7692 * @see FocusEvent 7693 * @see FocusEvent.Cause 7694 * @see #addFocusListener 7695 * @see #isFocusable 7696 * @see #isDisplayable 7697 * @see KeyboardFocusManager#clearGlobalFocusOwner 7698 * @since 9 7699 */ 7700 protected boolean requestFocus(boolean temporary, FocusEvent.Cause cause) { 7701 return requestFocusHelper(temporary, true, cause); 7702 } 7703 7704 /** 7705 * Requests that this Component get the input focus, if this 7706 * Component's top-level ancestor is already the focused 7707 * Window. This component must be displayable, focusable, visible 7708 * and all of its ancestors (with the exception of the top-level 7709 * Window) must be visible for the request to be granted. Every 7710 * effort will be made to honor the request; however, in some 7711 * cases it may be impossible to do so. Developers must never 7712 * assume that this Component is the focus owner until this 7713 * Component receives a FOCUS_GAINED event. 7714 * <p> 7715 * This method returns a boolean value. If {@code false} is returned, 7716 * the request is <b>guaranteed to fail</b>. If {@code true} is 7717 * returned, the request will succeed <b>unless</b> it is vetoed, or an 7718 * extraordinary event, such as disposal of the Component's peer, occurs 7719 * before the request can be granted by the native windowing system. Again, 7720 * while a return value of {@code true} indicates that the request is 7721 * likely to succeed, developers must never assume that this Component is 7722 * the focus owner until this Component receives a FOCUS_GAINED event. 7723 * <p> 7724 * This method cannot be used to set the focus owner to no Component at 7725 * all. Use {@code KeyboardFocusManager.clearGlobalFocusOwner()} 7726 * instead. 7727 * <p> 7728 * The focus behavior of this method can be implemented uniformly across 7729 * platforms, and thus developers are strongly encouraged to use this 7730 * method over {@code requestFocus} when possible. Code which relies 7731 * on {@code requestFocus} may exhibit different focus behavior on 7732 * different platforms. 7733 * 7734 * <p>Note: Not all focus transfers result from invoking this method. As 7735 * such, a component may receive focus without this or any of the other 7736 * {@code requestFocus} methods of {@code Component} being invoked. 7737 * 7738 * @return {@code false} if the focus change request is guaranteed to 7739 * fail; {@code true} if it is likely to succeed 7740 * @see #requestFocus 7741 * @see java.awt.event.FocusEvent 7742 * @see #addFocusListener 7743 * @see #isFocusable 7744 * @see #isDisplayable 7745 * @see KeyboardFocusManager#clearGlobalFocusOwner 7746 * @since 1.4 7747 */ 7748 public boolean requestFocusInWindow() { 7749 return requestFocusHelper(false, false); 7750 } 7751 7752 /** 7753 * Requests by the reason of {@code cause} that this Component get the input 7754 * focus, if this Component's top-level ancestor is already the focused 7755 * Window. This component must be displayable, focusable, visible 7756 * and all of its ancestors (with the exception of the top-level 7757 * Window) must be visible for the request to be granted. Every 7758 * effort will be made to honor the request; however, in some 7759 * cases it may be impossible to do so. Developers must never 7760 * assume that this Component is the focus owner until this 7761 * Component receives a FOCUS_GAINED event. 7762 * <p> 7763 * This method returns a boolean value. If {@code false} is returned, 7764 * the request is <b>guaranteed to fail</b>. If {@code true} is 7765 * returned, the request will succeed <b>unless</b> it is vetoed, or an 7766 * extraordinary event, such as disposal of the Component's peer, occurs 7767 * before the request can be granted by the native windowing system. Again, 7768 * while a return value of {@code true} indicates that the request is 7769 * likely to succeed, developers must never assume that this Component is 7770 * the focus owner until this Component receives a FOCUS_GAINED event. 7771 * <p> 7772 * The focus request effect may also depend on the provided 7773 * cause value. If this request is succeed the {@code FocusEvent} 7774 * generated in the result will receive the cause value specified as the 7775 * argument of the method. 7776 * <p> 7777 * This method cannot be used to set the focus owner to no Component at 7778 * all. Use {@code KeyboardFocusManager.clearGlobalFocusOwner()} 7779 * instead. 7780 * <p> 7781 * The focus behavior of this method can be implemented uniformly across 7782 * platforms, and thus developers are strongly encouraged to use this 7783 * method over {@code requestFocus(FocusEvent.Cause)} when possible. 7784 * Code which relies on {@code requestFocus(FocusEvent.Cause)} may exhibit 7785 * different focus behavior on different platforms. 7786 * 7787 * <p>Note: Not all focus transfers result from invoking this method. As 7788 * such, a component may receive focus without this or any of the other 7789 * {@code requestFocus} methods of {@code Component} being invoked. 7790 * 7791 * @param cause the cause why the focus is requested 7792 * @return {@code false} if the focus change request is guaranteed to 7793 * fail; {@code true} if it is likely to succeed 7794 * @see #requestFocus(FocusEvent.Cause) 7795 * @see FocusEvent 7796 * @see FocusEvent.Cause 7797 * @see java.awt.event.FocusEvent 7798 * @see #addFocusListener 7799 * @see #isFocusable 7800 * @see #isDisplayable 7801 * @see KeyboardFocusManager#clearGlobalFocusOwner 7802 * @since 9 7803 */ 7804 public boolean requestFocusInWindow(FocusEvent.Cause cause) { 7805 return requestFocusHelper(false, false, cause); 7806 } 7807 7808 /** 7809 * Requests that this {@code Component} get the input focus, 7810 * if this {@code Component}'s top-level ancestor is already 7811 * the focused {@code Window}. This component must be 7812 * displayable, focusable, visible and all of its ancestors (with 7813 * the exception of the top-level Window) must be visible for the 7814 * request to be granted. Every effort will be made to honor the 7815 * request; however, in some cases it may be impossible to do 7816 * so. Developers must never assume that this component is the 7817 * focus owner until this component receives a FOCUS_GAINED event. 7818 * <p> 7819 * This method returns a boolean value. If {@code false} is returned, 7820 * the request is <b>guaranteed to fail</b>. If {@code true} is 7821 * returned, the request will succeed <b>unless</b> it is vetoed, or an 7822 * extraordinary event, such as disposal of the component's peer, occurs 7823 * before the request can be granted by the native windowing system. Again, 7824 * while a return value of {@code true} indicates that the request is 7825 * likely to succeed, developers must never assume that this component is 7826 * the focus owner until this component receives a FOCUS_GAINED event. 7827 * <p> 7828 * This method cannot be used to set the focus owner to no component at 7829 * all. Use {@code KeyboardFocusManager.clearGlobalFocusOwner} 7830 * instead. 7831 * <p> 7832 * The focus behavior of this method can be implemented uniformly across 7833 * platforms, and thus developers are strongly encouraged to use this 7834 * method over {@code requestFocus} when possible. Code which relies 7835 * on {@code requestFocus} may exhibit different focus behavior on 7836 * different platforms. 7837 * <p> 7838 * Every effort will be made to ensure that {@code FocusEvent}s 7839 * generated as a 7840 * result of this request will have the specified temporary value. However, 7841 * because specifying an arbitrary temporary state may not be implementable 7842 * on all native windowing systems, correct behavior for this method can be 7843 * guaranteed only for lightweight components. This method is not intended 7844 * for general use, but exists instead as a hook for lightweight component 7845 * libraries, such as Swing. 7846 * 7847 * <p>Note: Not all focus transfers result from invoking this method. As 7848 * such, a component may receive focus without this or any of the other 7849 * {@code requestFocus} methods of {@code Component} being invoked. 7850 * 7851 * @param temporary true if the focus change is temporary, 7852 * such as when the window loses the focus; for 7853 * more information on temporary focus changes see the 7854 *<a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a> 7855 * @return {@code false} if the focus change request is guaranteed to 7856 * fail; {@code true} if it is likely to succeed 7857 * @see #requestFocus 7858 * @see java.awt.event.FocusEvent 7859 * @see #addFocusListener 7860 * @see #isFocusable 7861 * @see #isDisplayable 7862 * @see KeyboardFocusManager#clearGlobalFocusOwner 7863 * @since 1.4 7864 */ 7865 protected boolean requestFocusInWindow(boolean temporary) { 7866 return requestFocusHelper(temporary, false); 7867 } 7868 7869 boolean requestFocusInWindow(boolean temporary, FocusEvent.Cause cause) { 7870 return requestFocusHelper(temporary, false, cause); 7871 } 7872 7873 final boolean requestFocusHelper(boolean temporary, 7874 boolean focusedWindowChangeAllowed) { 7875 return requestFocusHelper(temporary, focusedWindowChangeAllowed, FocusEvent.Cause.UNKNOWN); 7876 } 7877 7878 final boolean requestFocusHelper(boolean temporary, 7879 boolean focusedWindowChangeAllowed, 7880 FocusEvent.Cause cause) 7881 { 7882 // 1) Check if the event being dispatched is a system-generated mouse event. 7883 AWTEvent currentEvent = EventQueue.getCurrentEvent(); 7884 if (currentEvent instanceof MouseEvent && 7885 SunToolkit.isSystemGenerated(currentEvent)) 7886 { 7887 // 2) Sanity check: if the mouse event component source belongs to the same containing window. 7888 Component source = ((MouseEvent)currentEvent).getComponent(); 7889 if (source == null || source.getContainingWindow() == getContainingWindow()) { 7890 focusLog.finest("requesting focus by mouse event \"in window\""); 7891 7892 // If both the conditions are fulfilled the focus request should be strictly 7893 // bounded by the toplevel window. It's assumed that the mouse event activates 7894 // the window (if it wasn't active) and this makes it possible for a focus 7895 // request with a strong in-window requirement to change focus in the bounds 7896 // of the toplevel. If, by any means, due to asynchronous nature of the event 7897 // dispatching mechanism, the window happens to be natively inactive by the time 7898 // this focus request is eventually handled, it should not re-activate the 7899 // toplevel. Otherwise the result may not meet user expectations. See 6981400. 7900 focusedWindowChangeAllowed = false; 7901 } 7902 } 7903 if (!isRequestFocusAccepted(temporary, focusedWindowChangeAllowed, cause)) { 7904 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 7905 focusLog.finest("requestFocus is not accepted"); 7906 } 7907 return false; 7908 } 7909 // Update most-recent map 7910 KeyboardFocusManager.setMostRecentFocusOwner(this); 7911 7912 Component window = this; 7913 while ( (window != null) && !(window instanceof Window)) { 7914 if (!window.isVisible()) { 7915 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 7916 focusLog.finest("component is recursively invisible"); 7917 } 7918 return false; 7919 } 7920 window = window.parent; 7921 } 7922 7923 ComponentPeer peer = this.peer; 7924 Component heavyweight = (peer instanceof LightweightPeer) 7925 ? getNativeContainer() : this; 7926 if (heavyweight == null || !heavyweight.isVisible()) { 7927 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 7928 focusLog.finest("Component is not a part of visible hierarchy"); 7929 } 7930 return false; 7931 } 7932 peer = heavyweight.peer; 7933 if (peer == null) { 7934 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 7935 focusLog.finest("Peer is null"); 7936 } 7937 return false; 7938 } 7939 7940 // Focus this Component 7941 long time = 0; 7942 if (EventQueue.isDispatchThread()) { 7943 time = Toolkit.getEventQueue().getMostRecentKeyEventTime(); 7944 } else { 7945 // A focus request made from outside EDT should not be associated with any event 7946 // and so its time stamp is simply set to the current time. 7947 time = System.currentTimeMillis(); 7948 } 7949 7950 boolean success = peer.requestFocus 7951 (this, temporary, focusedWindowChangeAllowed, time, cause); 7952 if (!success) { 7953 KeyboardFocusManager.getCurrentKeyboardFocusManager 7954 (appContext).dequeueKeyEvents(time, this); 7955 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 7956 focusLog.finest("Peer request failed"); 7957 } 7958 } else { 7959 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 7960 focusLog.finest("Pass for " + this); 7961 } 7962 } 7963 return success; 7964 } 7965 7966 private boolean isRequestFocusAccepted(boolean temporary, 7967 boolean focusedWindowChangeAllowed, 7968 FocusEvent.Cause cause) 7969 { 7970 if (!isFocusable() || !isVisible()) { 7971 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 7972 focusLog.finest("Not focusable or not visible"); 7973 } 7974 return false; 7975 } 7976 7977 ComponentPeer peer = this.peer; 7978 if (peer == null) { 7979 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 7980 focusLog.finest("peer is null"); 7981 } 7982 return false; 7983 } 7984 7985 Window window = getContainingWindow(); 7986 if (window == null || !window.isFocusableWindow()) { 7987 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 7988 focusLog.finest("Component doesn't have toplevel"); 7989 } 7990 return false; 7991 } 7992 7993 // We have passed all regular checks for focus request, 7994 // now let's call RequestFocusController and see what it says. 7995 Component focusOwner = KeyboardFocusManager.getMostRecentFocusOwner(window); 7996 if (focusOwner == null) { 7997 // sometimes most recent focus owner may be null, but focus owner is not 7998 // e.g. we reset most recent focus owner if user removes focus owner 7999 focusOwner = KeyboardFocusManager.getCurrentKeyboardFocusManager().getFocusOwner(); 8000 if (focusOwner != null && focusOwner.getContainingWindow() != window) { 8001 focusOwner = null; 8002 } 8003 } 8004 8005 if (focusOwner == this || focusOwner == null) { 8006 // Controller is supposed to verify focus transfers and for this it 8007 // should know both from and to components. And it shouldn't verify 8008 // transfers from when these components are equal. 8009 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 8010 focusLog.finest("focus owner is null or this"); 8011 } 8012 return true; 8013 } 8014 8015 if (FocusEvent.Cause.ACTIVATION == cause) { 8016 // we shouldn't call RequestFocusController in case we are 8017 // in activation. We do request focus on component which 8018 // has got temporary focus lost and then on component which is 8019 // most recent focus owner. But most recent focus owner can be 8020 // changed by requestFocusXXX() call only, so this transfer has 8021 // been already approved. 8022 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 8023 focusLog.finest("cause is activation"); 8024 } 8025 return true; 8026 } 8027 8028 boolean ret = Component.requestFocusController.acceptRequestFocus(focusOwner, 8029 this, 8030 temporary, 8031 focusedWindowChangeAllowed, 8032 cause); 8033 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) { 8034 focusLog.finest("RequestFocusController returns {0}", ret); 8035 } 8036 8037 return ret; 8038 } 8039 8040 private static RequestFocusController requestFocusController = new DummyRequestFocusController(); 8041 8042 // Swing access this method through reflection to implement InputVerifier's functionality. 8043 // Perhaps, we should make this method public (later ;) 8044 private static class DummyRequestFocusController implements RequestFocusController { 8045 public boolean acceptRequestFocus(Component from, Component to, 8046 boolean temporary, boolean focusedWindowChangeAllowed, 8047 FocusEvent.Cause cause) 8048 { 8049 return true; 8050 } 8051 }; 8052 8053 static synchronized void setRequestFocusController(RequestFocusController requestController) 8054 { 8055 if (requestController == null) { 8056 requestFocusController = new DummyRequestFocusController(); 8057 } else { 8058 requestFocusController = requestController; 8059 } 8060 } 8061 8062 /** 8063 * Returns the Container which is the focus cycle root of this Component's 8064 * focus traversal cycle. Each focus traversal cycle has only a single 8065 * focus cycle root and each Component which is not a Container belongs to 8066 * only a single focus traversal cycle. Containers which are focus cycle 8067 * roots belong to two cycles: one rooted at the Container itself, and one 8068 * rooted at the Container's nearest focus-cycle-root ancestor. For such 8069 * Containers, this method will return the Container's nearest focus-cycle- 8070 * root ancestor. 8071 * 8072 * @return this Component's nearest focus-cycle-root ancestor 8073 * @see Container#isFocusCycleRoot() 8074 * @since 1.4 8075 */ 8076 public Container getFocusCycleRootAncestor() { 8077 Container rootAncestor = this.parent; 8078 while (rootAncestor != null && !rootAncestor.isFocusCycleRoot()) { 8079 rootAncestor = rootAncestor.parent; 8080 } 8081 return rootAncestor; 8082 } 8083 8084 /** 8085 * Returns whether the specified Container is the focus cycle root of this 8086 * Component's focus traversal cycle. Each focus traversal cycle has only 8087 * a single focus cycle root and each Component which is not a Container 8088 * belongs to only a single focus traversal cycle. 8089 * 8090 * @param container the Container to be tested 8091 * @return {@code true} if the specified Container is a focus-cycle- 8092 * root of this Component; {@code false} otherwise 8093 * @see Container#isFocusCycleRoot() 8094 * @since 1.4 8095 */ 8096 public boolean isFocusCycleRoot(Container container) { 8097 Container rootAncestor = getFocusCycleRootAncestor(); 8098 return (rootAncestor == container); 8099 } 8100 8101 Container getTraversalRoot() { 8102 return getFocusCycleRootAncestor(); 8103 } 8104 8105 /** 8106 * Transfers the focus to the next component, as though this Component were 8107 * the focus owner. 8108 * @see #requestFocus() 8109 * @since 1.1 8110 */ 8111 public void transferFocus() { 8112 nextFocus(); 8113 } 8114 8115 /** 8116 * @deprecated As of JDK version 1.1, 8117 * replaced by transferFocus(). 8118 */ 8119 @Deprecated 8120 public void nextFocus() { 8121 transferFocus(false); 8122 } 8123 8124 boolean transferFocus(boolean clearOnFailure) { 8125 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) { 8126 focusLog.finer("clearOnFailure = " + clearOnFailure); 8127 } 8128 Component toFocus = getNextFocusCandidate(); 8129 boolean res = false; 8130 if (toFocus != null && !toFocus.isFocusOwner() && toFocus != this) { 8131 res = toFocus.requestFocusInWindow(FocusEvent.Cause.TRAVERSAL_FORWARD); 8132 } 8133 if (clearOnFailure && !res) { 8134 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) { 8135 focusLog.finer("clear global focus owner"); 8136 } 8137 KeyboardFocusManager.getCurrentKeyboardFocusManager().clearGlobalFocusOwnerPriv(); 8138 } 8139 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) { 8140 focusLog.finer("returning result: " + res); 8141 } 8142 return res; 8143 } 8144 8145 @SuppressWarnings("deprecation") 8146 final Component getNextFocusCandidate() { 8147 Container rootAncestor = getTraversalRoot(); 8148 Component comp = this; 8149 while (rootAncestor != null && 8150 !(rootAncestor.isShowing() && rootAncestor.canBeFocusOwner())) 8151 { 8152 comp = rootAncestor; 8153 rootAncestor = comp.getFocusCycleRootAncestor(); 8154 } 8155 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) { 8156 focusLog.finer("comp = " + comp + ", root = " + rootAncestor); 8157 } 8158 Component candidate = null; 8159 if (rootAncestor != null) { 8160 FocusTraversalPolicy policy = rootAncestor.getFocusTraversalPolicy(); 8161 Component toFocus = policy.getComponentAfter(rootAncestor, comp); 8162 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) { 8163 focusLog.finer("component after is " + toFocus); 8164 } 8165 if (toFocus == null) { 8166 toFocus = policy.getDefaultComponent(rootAncestor); 8167 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) { 8168 focusLog.finer("default component is " + toFocus); 8169 } 8170 } 8171 if (toFocus == null) { 8172 Applet applet = EmbeddedFrame.getAppletIfAncestorOf(this); 8173 if (applet != null) { 8174 toFocus = applet; 8175 } 8176 } 8177 candidate = toFocus; 8178 } 8179 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) { 8180 focusLog.finer("Focus transfer candidate: " + candidate); 8181 } 8182 return candidate; 8183 } 8184 8185 /** 8186 * Transfers the focus to the previous component, as though this Component 8187 * were the focus owner. 8188 * @see #requestFocus() 8189 * @since 1.4 8190 */ 8191 public void transferFocusBackward() { 8192 transferFocusBackward(false); 8193 } 8194 8195 boolean transferFocusBackward(boolean clearOnFailure) { 8196 Container rootAncestor = getTraversalRoot(); 8197 Component comp = this; 8198 while (rootAncestor != null && 8199 !(rootAncestor.isShowing() && rootAncestor.canBeFocusOwner())) 8200 { 8201 comp = rootAncestor; 8202 rootAncestor = comp.getFocusCycleRootAncestor(); 8203 } 8204 boolean res = false; 8205 if (rootAncestor != null) { 8206 FocusTraversalPolicy policy = rootAncestor.getFocusTraversalPolicy(); 8207 Component toFocus = policy.getComponentBefore(rootAncestor, comp); 8208 if (toFocus == null) { 8209 toFocus = policy.getDefaultComponent(rootAncestor); 8210 } 8211 if (toFocus != null) { 8212 res = toFocus.requestFocusInWindow(FocusEvent.Cause.TRAVERSAL_BACKWARD); 8213 } 8214 } 8215 if (clearOnFailure && !res) { 8216 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) { 8217 focusLog.finer("clear global focus owner"); 8218 } 8219 KeyboardFocusManager.getCurrentKeyboardFocusManager().clearGlobalFocusOwnerPriv(); 8220 } 8221 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) { 8222 focusLog.finer("returning result: " + res); 8223 } 8224 return res; 8225 } 8226 8227 /** 8228 * Transfers the focus up one focus traversal cycle. Typically, the focus 8229 * owner is set to this Component's focus cycle root, and the current focus 8230 * cycle root is set to the new focus owner's focus cycle root. If, 8231 * however, this Component's focus cycle root is a Window, then the focus 8232 * owner is set to the focus cycle root's default Component to focus, and 8233 * the current focus cycle root is unchanged. 8234 * 8235 * @see #requestFocus() 8236 * @see Container#isFocusCycleRoot() 8237 * @see Container#setFocusCycleRoot(boolean) 8238 * @since 1.4 8239 */ 8240 public void transferFocusUpCycle() { 8241 Container rootAncestor; 8242 for (rootAncestor = getFocusCycleRootAncestor(); 8243 rootAncestor != null && !(rootAncestor.isShowing() && 8244 rootAncestor.isFocusable() && 8245 rootAncestor.isEnabled()); 8246 rootAncestor = rootAncestor.getFocusCycleRootAncestor()) { 8247 } 8248 8249 if (rootAncestor != null) { 8250 Container rootAncestorRootAncestor = 8251 rootAncestor.getFocusCycleRootAncestor(); 8252 Container fcr = (rootAncestorRootAncestor != null) ? 8253 rootAncestorRootAncestor : rootAncestor; 8254 8255 KeyboardFocusManager.getCurrentKeyboardFocusManager(). 8256 setGlobalCurrentFocusCycleRootPriv(fcr); 8257 rootAncestor.requestFocus(FocusEvent.Cause.TRAVERSAL_UP); 8258 } else { 8259 Window window = getContainingWindow(); 8260 8261 if (window != null) { 8262 Component toFocus = window.getFocusTraversalPolicy(). 8263 getDefaultComponent(window); 8264 if (toFocus != null) { 8265 KeyboardFocusManager.getCurrentKeyboardFocusManager(). 8266 setGlobalCurrentFocusCycleRootPriv(window); 8267 toFocus.requestFocus(FocusEvent.Cause.TRAVERSAL_UP); 8268 } 8269 } 8270 } 8271 } 8272 8273 /** 8274 * Returns {@code true} if this {@code Component} is the 8275 * focus owner. This method is obsolete, and has been replaced by 8276 * {@code isFocusOwner()}. 8277 * 8278 * @return {@code true} if this {@code Component} is the 8279 * focus owner; {@code false} otherwise 8280 * @since 1.2 8281 */ 8282 public boolean hasFocus() { 8283 return (KeyboardFocusManager.getCurrentKeyboardFocusManager(). 8284 getFocusOwner() == this); 8285 } 8286 8287 /** 8288 * Returns {@code true} if this {@code Component} is the 8289 * focus owner. 8290 * 8291 * @return {@code true} if this {@code Component} is the 8292 * focus owner; {@code false} otherwise 8293 * @since 1.4 8294 */ 8295 public boolean isFocusOwner() { 8296 return hasFocus(); 8297 } 8298 8299 /* 8300 * Used to disallow auto-focus-transfer on disposal of the focus owner 8301 * in the process of disposing its parent container. 8302 */ 8303 private boolean autoFocusTransferOnDisposal = true; 8304 8305 void setAutoFocusTransferOnDisposal(boolean value) { 8306 autoFocusTransferOnDisposal = value; 8307 } 8308 8309 boolean isAutoFocusTransferOnDisposal() { 8310 return autoFocusTransferOnDisposal; 8311 } 8312 8313 /** 8314 * Adds the specified popup menu to the component. 8315 * @param popup the popup menu to be added to the component. 8316 * @see #remove(MenuComponent) 8317 * @exception NullPointerException if {@code popup} is {@code null} 8318 * @since 1.1 8319 */ 8320 public void add(PopupMenu popup) { 8321 synchronized (getTreeLock()) { 8322 if (popup.parent != null) { 8323 popup.parent.remove(popup); 8324 } 8325 if (popups == null) { 8326 popups = new Vector<PopupMenu>(); 8327 } 8328 popups.addElement(popup); 8329 popup.parent = this; 8330 8331 if (peer != null) { 8332 if (popup.peer == null) { 8333 popup.addNotify(); 8334 } 8335 } 8336 } 8337 } 8338 8339 /** 8340 * Removes the specified popup menu from the component. 8341 * @param popup the popup menu to be removed 8342 * @see #add(PopupMenu) 8343 * @since 1.1 8344 */ 8345 @SuppressWarnings("unchecked") 8346 public void remove(MenuComponent popup) { 8347 synchronized (getTreeLock()) { 8348 if (popups == null) { 8349 return; 8350 } 8351 int index = popups.indexOf(popup); 8352 if (index >= 0) { 8353 PopupMenu pmenu = (PopupMenu)popup; 8354 if (pmenu.peer != null) { 8355 pmenu.removeNotify(); 8356 } 8357 pmenu.parent = null; 8358 popups.removeElementAt(index); 8359 if (popups.size() == 0) { 8360 popups = null; 8361 } 8362 } 8363 } 8364 } 8365 8366 /** 8367 * Returns a string representing the state of this component. This 8368 * method is intended to be used only for debugging purposes, and the 8369 * content and format of the returned string may vary between 8370 * implementations. The returned string may be empty but may not be 8371 * {@code null}. 8372 * 8373 * @return a string representation of this component's state 8374 * @since 1.0 8375 */ 8376 protected String paramString() { 8377 final String thisName = Objects.toString(getName(), ""); 8378 final String invalid = isValid() ? "" : ",invalid"; 8379 final String hidden = visible ? "" : ",hidden"; 8380 final String disabled = enabled ? "" : ",disabled"; 8381 return thisName + ',' + x + ',' + y + ',' + width + 'x' + height 8382 + invalid + hidden + disabled; 8383 } 8384 8385 /** 8386 * Returns a string representation of this component and its values. 8387 * @return a string representation of this component 8388 * @since 1.0 8389 */ 8390 public String toString() { 8391 return getClass().getName() + '[' + paramString() + ']'; 8392 } 8393 8394 /** 8395 * Prints a listing of this component to the standard system output 8396 * stream {@code System.out}. 8397 * @see java.lang.System#out 8398 * @since 1.0 8399 */ 8400 public void list() { 8401 list(System.out, 0); 8402 } 8403 8404 /** 8405 * Prints a listing of this component to the specified output 8406 * stream. 8407 * @param out a print stream 8408 * @throws NullPointerException if {@code out} is {@code null} 8409 * @since 1.0 8410 */ 8411 public void list(PrintStream out) { 8412 list(out, 0); 8413 } 8414 8415 /** 8416 * Prints out a list, starting at the specified indentation, to the 8417 * specified print stream. 8418 * @param out a print stream 8419 * @param indent number of spaces to indent 8420 * @see java.io.PrintStream#println(java.lang.Object) 8421 * @throws NullPointerException if {@code out} is {@code null} 8422 * @since 1.0 8423 */ 8424 public void list(PrintStream out, int indent) { 8425 for (int i = 0 ; i < indent ; i++) { 8426 out.print(" "); 8427 } 8428 out.println(this); 8429 } 8430 8431 /** 8432 * Prints a listing to the specified print writer. 8433 * @param out the print writer to print to 8434 * @throws NullPointerException if {@code out} is {@code null} 8435 * @since 1.1 8436 */ 8437 public void list(PrintWriter out) { 8438 list(out, 0); 8439 } 8440 8441 /** 8442 * Prints out a list, starting at the specified indentation, to 8443 * the specified print writer. 8444 * @param out the print writer to print to 8445 * @param indent the number of spaces to indent 8446 * @throws NullPointerException if {@code out} is {@code null} 8447 * @see java.io.PrintStream#println(java.lang.Object) 8448 * @since 1.1 8449 */ 8450 public void list(PrintWriter out, int indent) { 8451 for (int i = 0 ; i < indent ; i++) { 8452 out.print(" "); 8453 } 8454 out.println(this); 8455 } 8456 8457 /* 8458 * Fetches the native container somewhere higher up in the component 8459 * tree that contains this component. 8460 */ 8461 final Container getNativeContainer() { 8462 Container p = getContainer(); 8463 while (p != null && p.peer instanceof LightweightPeer) { 8464 p = p.getContainer(); 8465 } 8466 return p; 8467 } 8468 8469 /** 8470 * Adds a PropertyChangeListener to the listener list. The listener is 8471 * registered for all bound properties of this class, including the 8472 * following: 8473 * <ul> 8474 * <li>this Component's font ("font")</li> 8475 * <li>this Component's background color ("background")</li> 8476 * <li>this Component's foreground color ("foreground")</li> 8477 * <li>this Component's focusability ("focusable")</li> 8478 * <li>this Component's focus traversal keys enabled state 8479 * ("focusTraversalKeysEnabled")</li> 8480 * <li>this Component's Set of FORWARD_TRAVERSAL_KEYS 8481 * ("forwardFocusTraversalKeys")</li> 8482 * <li>this Component's Set of BACKWARD_TRAVERSAL_KEYS 8483 * ("backwardFocusTraversalKeys")</li> 8484 * <li>this Component's Set of UP_CYCLE_TRAVERSAL_KEYS 8485 * ("upCycleFocusTraversalKeys")</li> 8486 * <li>this Component's preferred size ("preferredSize")</li> 8487 * <li>this Component's minimum size ("minimumSize")</li> 8488 * <li>this Component's maximum size ("maximumSize")</li> 8489 * <li>this Component's name ("name")</li> 8490 * </ul> 8491 * Note that if this {@code Component} is inheriting a bound property, then no 8492 * event will be fired in response to a change in the inherited property. 8493 * <p> 8494 * If {@code listener} is {@code null}, 8495 * no exception is thrown and no action is performed. 8496 * 8497 * @param listener the property change listener to be added 8498 * 8499 * @see #removePropertyChangeListener 8500 * @see #getPropertyChangeListeners 8501 * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) 8502 */ 8503 public void addPropertyChangeListener( 8504 PropertyChangeListener listener) { 8505 synchronized (getObjectLock()) { 8506 if (listener == null) { 8507 return; 8508 } 8509 if (changeSupport == null) { 8510 changeSupport = new PropertyChangeSupport(this); 8511 } 8512 changeSupport.addPropertyChangeListener(listener); 8513 } 8514 } 8515 8516 /** 8517 * Removes a PropertyChangeListener from the listener list. This method 8518 * should be used to remove PropertyChangeListeners that were registered 8519 * for all bound properties of this class. 8520 * <p> 8521 * If listener is null, no exception is thrown and no action is performed. 8522 * 8523 * @param listener the PropertyChangeListener to be removed 8524 * 8525 * @see #addPropertyChangeListener 8526 * @see #getPropertyChangeListeners 8527 * @see #removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener) 8528 */ 8529 public void removePropertyChangeListener( 8530 PropertyChangeListener listener) { 8531 synchronized (getObjectLock()) { 8532 if (listener == null || changeSupport == null) { 8533 return; 8534 } 8535 changeSupport.removePropertyChangeListener(listener); 8536 } 8537 } 8538 8539 /** 8540 * Returns an array of all the property change listeners 8541 * registered on this component. 8542 * 8543 * @return all of this component's {@code PropertyChangeListener}s 8544 * or an empty array if no property change 8545 * listeners are currently registered 8546 * 8547 * @see #addPropertyChangeListener 8548 * @see #removePropertyChangeListener 8549 * @see #getPropertyChangeListeners(java.lang.String) 8550 * @see java.beans.PropertyChangeSupport#getPropertyChangeListeners 8551 * @since 1.4 8552 */ 8553 public PropertyChangeListener[] getPropertyChangeListeners() { 8554 synchronized (getObjectLock()) { 8555 if (changeSupport == null) { 8556 return new PropertyChangeListener[0]; 8557 } 8558 return changeSupport.getPropertyChangeListeners(); 8559 } 8560 } 8561 8562 /** 8563 * Adds a PropertyChangeListener to the listener list for a specific 8564 * property. The specified property may be user-defined, or one of the 8565 * following: 8566 * <ul> 8567 * <li>this Component's font ("font")</li> 8568 * <li>this Component's background color ("background")</li> 8569 * <li>this Component's foreground color ("foreground")</li> 8570 * <li>this Component's focusability ("focusable")</li> 8571 * <li>this Component's focus traversal keys enabled state 8572 * ("focusTraversalKeysEnabled")</li> 8573 * <li>this Component's Set of FORWARD_TRAVERSAL_KEYS 8574 * ("forwardFocusTraversalKeys")</li> 8575 * <li>this Component's Set of BACKWARD_TRAVERSAL_KEYS 8576 * ("backwardFocusTraversalKeys")</li> 8577 * <li>this Component's Set of UP_CYCLE_TRAVERSAL_KEYS 8578 * ("upCycleFocusTraversalKeys")</li> 8579 * </ul> 8580 * Note that if this {@code Component} is inheriting a bound property, then no 8581 * event will be fired in response to a change in the inherited property. 8582 * <p> 8583 * If {@code propertyName} or {@code listener} is {@code null}, 8584 * no exception is thrown and no action is taken. 8585 * 8586 * @param propertyName one of the property names listed above 8587 * @param listener the property change listener to be added 8588 * 8589 * @see #removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) 8590 * @see #getPropertyChangeListeners(java.lang.String) 8591 * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) 8592 */ 8593 public void addPropertyChangeListener( 8594 String propertyName, 8595 PropertyChangeListener listener) { 8596 synchronized (getObjectLock()) { 8597 if (listener == null) { 8598 return; 8599 } 8600 if (changeSupport == null) { 8601 changeSupport = new PropertyChangeSupport(this); 8602 } 8603 changeSupport.addPropertyChangeListener(propertyName, listener); 8604 } 8605 } 8606 8607 /** 8608 * Removes a {@code PropertyChangeListener} from the listener 8609 * list for a specific property. This method should be used to remove 8610 * {@code PropertyChangeListener}s 8611 * that were registered for a specific bound property. 8612 * <p> 8613 * If {@code propertyName} or {@code listener} is {@code null}, 8614 * no exception is thrown and no action is taken. 8615 * 8616 * @param propertyName a valid property name 8617 * @param listener the PropertyChangeListener to be removed 8618 * 8619 * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) 8620 * @see #getPropertyChangeListeners(java.lang.String) 8621 * @see #removePropertyChangeListener(java.beans.PropertyChangeListener) 8622 */ 8623 public void removePropertyChangeListener( 8624 String propertyName, 8625 PropertyChangeListener listener) { 8626 synchronized (getObjectLock()) { 8627 if (listener == null || changeSupport == null) { 8628 return; 8629 } 8630 changeSupport.removePropertyChangeListener(propertyName, listener); 8631 } 8632 } 8633 8634 /** 8635 * Returns an array of all the listeners which have been associated 8636 * with the named property. 8637 * 8638 * @param propertyName the property name 8639 * @return all of the {@code PropertyChangeListener}s associated with 8640 * the named property; if no such listeners have been added or 8641 * if {@code propertyName} is {@code null}, an empty 8642 * array is returned 8643 * 8644 * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) 8645 * @see #removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) 8646 * @see #getPropertyChangeListeners 8647 * @since 1.4 8648 */ 8649 public PropertyChangeListener[] getPropertyChangeListeners(String propertyName) { 8650 synchronized (getObjectLock()) { 8651 if (changeSupport == null) { 8652 return new PropertyChangeListener[0]; 8653 } 8654 return changeSupport.getPropertyChangeListeners(propertyName); 8655 } 8656 } 8657 8658 /** 8659 * Support for reporting bound property changes for Object properties. 8660 * This method can be called when a bound property has changed and it will 8661 * send the appropriate PropertyChangeEvent to any registered 8662 * PropertyChangeListeners. 8663 * 8664 * @param propertyName the property whose value has changed 8665 * @param oldValue the property's previous value 8666 * @param newValue the property's new value 8667 */ 8668 protected void firePropertyChange(String propertyName, 8669 Object oldValue, Object newValue) { 8670 PropertyChangeSupport changeSupport; 8671 synchronized (getObjectLock()) { 8672 changeSupport = this.changeSupport; 8673 } 8674 if (changeSupport == null || 8675 (oldValue != null && newValue != null && oldValue.equals(newValue))) { 8676 return; 8677 } 8678 changeSupport.firePropertyChange(propertyName, oldValue, newValue); 8679 } 8680 8681 /** 8682 * Support for reporting bound property changes for boolean properties. 8683 * This method can be called when a bound property has changed and it will 8684 * send the appropriate PropertyChangeEvent to any registered 8685 * PropertyChangeListeners. 8686 * 8687 * @param propertyName the property whose value has changed 8688 * @param oldValue the property's previous value 8689 * @param newValue the property's new value 8690 * @since 1.4 8691 */ 8692 protected void firePropertyChange(String propertyName, 8693 boolean oldValue, boolean newValue) { 8694 PropertyChangeSupport changeSupport = this.changeSupport; 8695 if (changeSupport == null || oldValue == newValue) { 8696 return; 8697 } 8698 changeSupport.firePropertyChange(propertyName, oldValue, newValue); 8699 } 8700 8701 /** 8702 * Support for reporting bound property changes for integer properties. 8703 * This method can be called when a bound property has changed and it will 8704 * send the appropriate PropertyChangeEvent to any registered 8705 * PropertyChangeListeners. 8706 * 8707 * @param propertyName the property whose value has changed 8708 * @param oldValue the property's previous value 8709 * @param newValue the property's new value 8710 * @since 1.4 8711 */ 8712 protected void firePropertyChange(String propertyName, 8713 int oldValue, int newValue) { 8714 PropertyChangeSupport changeSupport = this.changeSupport; 8715 if (changeSupport == null || oldValue == newValue) { 8716 return; 8717 } 8718 changeSupport.firePropertyChange(propertyName, oldValue, newValue); 8719 } 8720 8721 /** 8722 * Reports a bound property change. 8723 * 8724 * @param propertyName the programmatic name of the property 8725 * that was changed 8726 * @param oldValue the old value of the property (as a byte) 8727 * @param newValue the new value of the property (as a byte) 8728 * @see #firePropertyChange(java.lang.String, java.lang.Object, 8729 * java.lang.Object) 8730 * @since 1.5 8731 */ 8732 public void firePropertyChange(String propertyName, byte oldValue, byte newValue) { 8733 if (changeSupport == null || oldValue == newValue) { 8734 return; 8735 } 8736 firePropertyChange(propertyName, Byte.valueOf(oldValue), Byte.valueOf(newValue)); 8737 } 8738 8739 /** 8740 * Reports a bound property change. 8741 * 8742 * @param propertyName the programmatic name of the property 8743 * that was changed 8744 * @param oldValue the old value of the property (as a char) 8745 * @param newValue the new value of the property (as a char) 8746 * @see #firePropertyChange(java.lang.String, java.lang.Object, 8747 * java.lang.Object) 8748 * @since 1.5 8749 */ 8750 public void firePropertyChange(String propertyName, char oldValue, char newValue) { 8751 if (changeSupport == null || oldValue == newValue) { 8752 return; 8753 } 8754 firePropertyChange(propertyName, Character.valueOf(oldValue), Character.valueOf(newValue)); 8755 } 8756 8757 /** 8758 * Reports a bound property change. 8759 * 8760 * @param propertyName the programmatic name of the property 8761 * that was changed 8762 * @param oldValue the old value of the property (as a short) 8763 * @param newValue the new value of the property (as a short) 8764 * @see #firePropertyChange(java.lang.String, java.lang.Object, 8765 * java.lang.Object) 8766 * @since 1.5 8767 */ 8768 public void firePropertyChange(String propertyName, short oldValue, short newValue) { 8769 if (changeSupport == null || oldValue == newValue) { 8770 return; 8771 } 8772 firePropertyChange(propertyName, Short.valueOf(oldValue), Short.valueOf(newValue)); 8773 } 8774 8775 8776 /** 8777 * Reports a bound property change. 8778 * 8779 * @param propertyName the programmatic name of the property 8780 * that was changed 8781 * @param oldValue the old value of the property (as a long) 8782 * @param newValue the new value of the property (as a long) 8783 * @see #firePropertyChange(java.lang.String, java.lang.Object, 8784 * java.lang.Object) 8785 * @since 1.5 8786 */ 8787 public void firePropertyChange(String propertyName, long oldValue, long newValue) { 8788 if (changeSupport == null || oldValue == newValue) { 8789 return; 8790 } 8791 firePropertyChange(propertyName, Long.valueOf(oldValue), Long.valueOf(newValue)); 8792 } 8793 8794 /** 8795 * Reports a bound property change. 8796 * 8797 * @param propertyName the programmatic name of the property 8798 * that was changed 8799 * @param oldValue the old value of the property (as a float) 8800 * @param newValue the new value of the property (as a float) 8801 * @see #firePropertyChange(java.lang.String, java.lang.Object, 8802 * java.lang.Object) 8803 * @since 1.5 8804 */ 8805 public void firePropertyChange(String propertyName, float oldValue, float newValue) { 8806 if (changeSupport == null || oldValue == newValue) { 8807 return; 8808 } 8809 firePropertyChange(propertyName, Float.valueOf(oldValue), Float.valueOf(newValue)); 8810 } 8811 8812 /** 8813 * Reports a bound property change. 8814 * 8815 * @param propertyName the programmatic name of the property 8816 * that was changed 8817 * @param oldValue the old value of the property (as a double) 8818 * @param newValue the new value of the property (as a double) 8819 * @see #firePropertyChange(java.lang.String, java.lang.Object, 8820 * java.lang.Object) 8821 * @since 1.5 8822 */ 8823 public void firePropertyChange(String propertyName, double oldValue, double newValue) { 8824 if (changeSupport == null || oldValue == newValue) { 8825 return; 8826 } 8827 firePropertyChange(propertyName, Double.valueOf(oldValue), Double.valueOf(newValue)); 8828 } 8829 8830 8831 // Serialization support. 8832 8833 /** 8834 * Component Serialized Data Version. 8835 * 8836 * @serial 8837 */ 8838 private int componentSerializedDataVersion = 4; 8839 8840 /** 8841 * This hack is for Swing serialization. It will invoke 8842 * the Swing package private method {@code compWriteObjectNotify}. 8843 */ 8844 private void doSwingSerialization() { 8845 if (!(this instanceof JComponent)) { 8846 return; 8847 } 8848 @SuppressWarnings("deprecation") 8849 Package swingPackage = Package.getPackage("javax.swing"); 8850 // For Swing serialization to correctly work Swing needs to 8851 // be notified before Component does it's serialization. This 8852 // hack accommodates this. 8853 // 8854 // Swing classes MUST be loaded by the bootstrap class loader, 8855 // otherwise we don't consider them. 8856 for (Class<?> klass = Component.this.getClass(); klass != null; 8857 klass = klass.getSuperclass()) { 8858 if (klass.getPackage() == swingPackage && 8859 klass.getClassLoader() == null) { 8860 8861 SwingAccessor.getJComponentAccessor() 8862 .compWriteObjectNotify((JComponent) this); 8863 return; 8864 } 8865 } 8866 } 8867 8868 /** 8869 * Writes default serializable fields to stream. Writes 8870 * a variety of serializable listeners as optional data. 8871 * The non-serializable listeners are detected and 8872 * no attempt is made to serialize them. 8873 * 8874 * @param s the {@code ObjectOutputStream} to write 8875 * @serialData {@code null} terminated sequence of 8876 * 0 or more pairs; the pair consists of a {@code String} 8877 * and an {@code Object}; the {@code String} indicates 8878 * the type of object and is one of the following (as of 1.4): 8879 * {@code componentListenerK} indicating an 8880 * {@code ComponentListener} object; 8881 * {@code focusListenerK} indicating an 8882 * {@code FocusListener} object; 8883 * {@code keyListenerK} indicating an 8884 * {@code KeyListener} object; 8885 * {@code mouseListenerK} indicating an 8886 * {@code MouseListener} object; 8887 * {@code mouseMotionListenerK} indicating an 8888 * {@code MouseMotionListener} object; 8889 * {@code inputMethodListenerK} indicating an 8890 * {@code InputMethodListener} object; 8891 * {@code hierarchyListenerK} indicating an 8892 * {@code HierarchyListener} object; 8893 * {@code hierarchyBoundsListenerK} indicating an 8894 * {@code HierarchyBoundsListener} object; 8895 * {@code mouseWheelListenerK} indicating an 8896 * {@code MouseWheelListener} object 8897 * @serialData an optional {@code ComponentOrientation} 8898 * (after {@code inputMethodListener}, as of 1.2) 8899 * 8900 * @see AWTEventMulticaster#save(java.io.ObjectOutputStream, java.lang.String, java.util.EventListener) 8901 * @see #componentListenerK 8902 * @see #focusListenerK 8903 * @see #keyListenerK 8904 * @see #mouseListenerK 8905 * @see #mouseMotionListenerK 8906 * @see #inputMethodListenerK 8907 * @see #hierarchyListenerK 8908 * @see #hierarchyBoundsListenerK 8909 * @see #mouseWheelListenerK 8910 * @see #readObject(ObjectInputStream) 8911 */ 8912 private void writeObject(ObjectOutputStream s) 8913 throws IOException 8914 { 8915 doSwingSerialization(); 8916 8917 s.defaultWriteObject(); 8918 8919 AWTEventMulticaster.save(s, componentListenerK, componentListener); 8920 AWTEventMulticaster.save(s, focusListenerK, focusListener); 8921 AWTEventMulticaster.save(s, keyListenerK, keyListener); 8922 AWTEventMulticaster.save(s, mouseListenerK, mouseListener); 8923 AWTEventMulticaster.save(s, mouseMotionListenerK, mouseMotionListener); 8924 AWTEventMulticaster.save(s, inputMethodListenerK, inputMethodListener); 8925 8926 s.writeObject(null); 8927 s.writeObject(componentOrientation); 8928 8929 AWTEventMulticaster.save(s, hierarchyListenerK, hierarchyListener); 8930 AWTEventMulticaster.save(s, hierarchyBoundsListenerK, 8931 hierarchyBoundsListener); 8932 s.writeObject(null); 8933 8934 AWTEventMulticaster.save(s, mouseWheelListenerK, mouseWheelListener); 8935 s.writeObject(null); 8936 8937 } 8938 8939 /** 8940 * Reads the {@code ObjectInputStream} and if it isn't 8941 * {@code null} adds a listener to receive a variety 8942 * of events fired by the component. 8943 * Unrecognized keys or values will be ignored. 8944 * 8945 * @param s the {@code ObjectInputStream} to read 8946 * @see #writeObject(ObjectOutputStream) 8947 */ 8948 private void readObject(ObjectInputStream s) 8949 throws ClassNotFoundException, IOException 8950 { 8951 objectLock = new Object(); 8952 8953 acc = AccessController.getContext(); 8954 8955 s.defaultReadObject(); 8956 8957 appContext = AppContext.getAppContext(); 8958 coalescingEnabled = checkCoalescing(); 8959 if (componentSerializedDataVersion < 4) { 8960 // These fields are non-transient and rely on default 8961 // serialization. However, the default values are insufficient, 8962 // so we need to set them explicitly for object data streams prior 8963 // to 1.4. 8964 focusable = true; 8965 isFocusTraversableOverridden = FOCUS_TRAVERSABLE_UNKNOWN; 8966 initializeFocusTraversalKeys(); 8967 focusTraversalKeysEnabled = true; 8968 } 8969 8970 Object keyOrNull; 8971 while(null != (keyOrNull = s.readObject())) { 8972 String key = ((String)keyOrNull).intern(); 8973 8974 if (componentListenerK == key) 8975 addComponentListener((ComponentListener)(s.readObject())); 8976 8977 else if (focusListenerK == key) 8978 addFocusListener((FocusListener)(s.readObject())); 8979 8980 else if (keyListenerK == key) 8981 addKeyListener((KeyListener)(s.readObject())); 8982 8983 else if (mouseListenerK == key) 8984 addMouseListener((MouseListener)(s.readObject())); 8985 8986 else if (mouseMotionListenerK == key) 8987 addMouseMotionListener((MouseMotionListener)(s.readObject())); 8988 8989 else if (inputMethodListenerK == key) 8990 addInputMethodListener((InputMethodListener)(s.readObject())); 8991 8992 else // skip value for unrecognized key 8993 s.readObject(); 8994 8995 } 8996 8997 // Read the component's orientation if it's present 8998 Object orient = null; 8999 9000 try { 9001 orient = s.readObject(); 9002 } catch (java.io.OptionalDataException e) { 9003 // JDK 1.1 instances will not have this optional data. 9004 // e.eof will be true to indicate that there is no more 9005 // data available for this object. 9006 // If e.eof is not true, throw the exception as it 9007 // might have been caused by reasons unrelated to 9008 // componentOrientation. 9009 9010 if (!e.eof) { 9011 throw (e); 9012 } 9013 } 9014 9015 if (orient != null) { 9016 componentOrientation = (ComponentOrientation)orient; 9017 } else { 9018 componentOrientation = ComponentOrientation.UNKNOWN; 9019 } 9020 9021 try { 9022 while(null != (keyOrNull = s.readObject())) { 9023 String key = ((String)keyOrNull).intern(); 9024 9025 if (hierarchyListenerK == key) { 9026 addHierarchyListener((HierarchyListener)(s.readObject())); 9027 } 9028 else if (hierarchyBoundsListenerK == key) { 9029 addHierarchyBoundsListener((HierarchyBoundsListener) 9030 (s.readObject())); 9031 } 9032 else { 9033 // skip value for unrecognized key 9034 s.readObject(); 9035 } 9036 } 9037 } catch (java.io.OptionalDataException e) { 9038 // JDK 1.1/1.2 instances will not have this optional data. 9039 // e.eof will be true to indicate that there is no more 9040 // data available for this object. 9041 // If e.eof is not true, throw the exception as it 9042 // might have been caused by reasons unrelated to 9043 // hierarchy and hierarchyBounds listeners. 9044 9045 if (!e.eof) { 9046 throw (e); 9047 } 9048 } 9049 9050 try { 9051 while (null != (keyOrNull = s.readObject())) { 9052 String key = ((String)keyOrNull).intern(); 9053 9054 if (mouseWheelListenerK == key) { 9055 addMouseWheelListener((MouseWheelListener)(s.readObject())); 9056 } 9057 else { 9058 // skip value for unrecognized key 9059 s.readObject(); 9060 } 9061 } 9062 } catch (java.io.OptionalDataException e) { 9063 // pre-1.3 instances will not have this optional data. 9064 // e.eof will be true to indicate that there is no more 9065 // data available for this object. 9066 // If e.eof is not true, throw the exception as it 9067 // might have been caused by reasons unrelated to 9068 // mouse wheel listeners 9069 9070 if (!e.eof) { 9071 throw (e); 9072 } 9073 } 9074 9075 if (popups != null) { 9076 int npopups = popups.size(); 9077 for (int i = 0 ; i < npopups ; i++) { 9078 PopupMenu popup = popups.elementAt(i); 9079 popup.parent = this; 9080 } 9081 } 9082 } 9083 9084 /** 9085 * Sets the language-sensitive orientation that is to be used to order 9086 * the elements or text within this component. Language-sensitive 9087 * {@code LayoutManager} and {@code Component} 9088 * subclasses will use this property to 9089 * determine how to lay out and draw components. 9090 * <p> 9091 * At construction time, a component's orientation is set to 9092 * {@code ComponentOrientation.UNKNOWN}, 9093 * indicating that it has not been specified 9094 * explicitly. The UNKNOWN orientation behaves the same as 9095 * {@code ComponentOrientation.LEFT_TO_RIGHT}. 9096 * <p> 9097 * To set the orientation of a single component, use this method. 9098 * To set the orientation of an entire component 9099 * hierarchy, use 9100 * {@link #applyComponentOrientation applyComponentOrientation}. 9101 * <p> 9102 * This method changes layout-related information, and therefore, 9103 * invalidates the component hierarchy. 9104 * 9105 * @param o the orientation to be set 9106 * 9107 * @see ComponentOrientation 9108 * @see #invalidate 9109 * 9110 * @author Laura Werner, IBM 9111 */ 9112 public void setComponentOrientation(ComponentOrientation o) { 9113 ComponentOrientation oldValue = componentOrientation; 9114 componentOrientation = o; 9115 9116 // This is a bound property, so report the change to 9117 // any registered listeners. (Cheap if there are none.) 9118 firePropertyChange("componentOrientation", oldValue, o); 9119 9120 // This could change the preferred size of the Component. 9121 invalidateIfValid(); 9122 } 9123 9124 /** 9125 * Retrieves the language-sensitive orientation that is to be used to order 9126 * the elements or text within this component. {@code LayoutManager} 9127 * and {@code Component} 9128 * subclasses that wish to respect orientation should call this method to 9129 * get the component's orientation before performing layout or drawing. 9130 * 9131 * @return the orientation to order the elements or text 9132 * @see ComponentOrientation 9133 * 9134 * @author Laura Werner, IBM 9135 */ 9136 public ComponentOrientation getComponentOrientation() { 9137 return componentOrientation; 9138 } 9139 9140 /** 9141 * Sets the {@code ComponentOrientation} property of this component 9142 * and all components contained within it. 9143 * <p> 9144 * This method changes layout-related information, and therefore, 9145 * invalidates the component hierarchy. 9146 * 9147 * 9148 * @param orientation the new component orientation of this component and 9149 * the components contained within it. 9150 * @exception NullPointerException if {@code orientation} is null. 9151 * @see #setComponentOrientation 9152 * @see #getComponentOrientation 9153 * @see #invalidate 9154 * @since 1.4 9155 */ 9156 public void applyComponentOrientation(ComponentOrientation orientation) { 9157 if (orientation == null) { 9158 throw new NullPointerException(); 9159 } 9160 setComponentOrientation(orientation); 9161 } 9162 9163 final boolean canBeFocusOwner() { 9164 // It is enabled, visible, focusable. 9165 if (isEnabled() && isDisplayable() && isVisible() && isFocusable()) { 9166 return true; 9167 } 9168 return false; 9169 } 9170 9171 /** 9172 * Checks that this component meets the prerequisites to be focus owner: 9173 * - it is enabled, visible, focusable 9174 * - it's parents are all enabled and showing 9175 * - top-level window is focusable 9176 * - if focus cycle root has DefaultFocusTraversalPolicy then it also checks that this policy accepts 9177 * this component as focus owner 9178 * @since 1.5 9179 */ 9180 final boolean canBeFocusOwnerRecursively() { 9181 // - it is enabled, visible, focusable 9182 if (!canBeFocusOwner()) { 9183 return false; 9184 } 9185 9186 // - it's parents are all enabled and showing 9187 synchronized(getTreeLock()) { 9188 if (parent != null) { 9189 return parent.canContainFocusOwner(this); 9190 } 9191 } 9192 return true; 9193 } 9194 9195 /** 9196 * Fix the location of the HW component in a LW container hierarchy. 9197 */ 9198 final void relocateComponent() { 9199 synchronized (getTreeLock()) { 9200 if (peer == null) { 9201 return; 9202 } 9203 int nativeX = x; 9204 int nativeY = y; 9205 for (Component cont = getContainer(); 9206 cont != null && cont.isLightweight(); 9207 cont = cont.getContainer()) 9208 { 9209 nativeX += cont.x; 9210 nativeY += cont.y; 9211 } 9212 peer.setBounds(nativeX, nativeY, width, height, 9213 ComponentPeer.SET_LOCATION); 9214 } 9215 } 9216 9217 /** 9218 * Returns the {@code Window} ancestor of the component. 9219 * @return Window ancestor of the component or component by itself if it is Window; 9220 * null, if component is not a part of window hierarchy 9221 */ 9222 Window getContainingWindow() { 9223 return SunToolkit.getContainingWindow(this); 9224 } 9225 9226 /** 9227 * Initialize JNI field and method IDs 9228 */ 9229 private static native void initIDs(); 9230 9231 /* 9232 * --- Accessibility Support --- 9233 * 9234 * Component will contain all of the methods in interface Accessible, 9235 * though it won't actually implement the interface - that will be up 9236 * to the individual objects which extend Component. 9237 */ 9238 9239 /** 9240 * The {@code AccessibleContext} associated with this {@code Component}. 9241 */ 9242 protected AccessibleContext accessibleContext = null; 9243 9244 /** 9245 * Gets the {@code AccessibleContext} associated 9246 * with this {@code Component}. 9247 * The method implemented by this base 9248 * class returns null. Classes that extend {@code Component} 9249 * should implement this method to return the 9250 * {@code AccessibleContext} associated with the subclass. 9251 * 9252 * 9253 * @return the {@code AccessibleContext} of this 9254 * {@code Component} 9255 * @since 1.3 9256 */ 9257 public AccessibleContext getAccessibleContext() { 9258 return accessibleContext; 9259 } 9260 9261 /** 9262 * Inner class of Component used to provide default support for 9263 * accessibility. This class is not meant to be used directly by 9264 * application developers, but is instead meant only to be 9265 * subclassed by component developers. 9266 * <p> 9267 * The class used to obtain the accessible role for this object. 9268 * @since 1.3 9269 */ 9270 protected abstract class AccessibleAWTComponent extends AccessibleContext 9271 implements Serializable, AccessibleComponent { 9272 9273 private static final long serialVersionUID = 642321655757800191L; 9274 9275 /** 9276 * Though the class is abstract, this should be called by 9277 * all sub-classes. 9278 */ 9279 protected AccessibleAWTComponent() { 9280 } 9281 9282 /** 9283 * Number of PropertyChangeListener objects registered. It's used 9284 * to add/remove ComponentListener and FocusListener to track 9285 * target Component's state. 9286 */ 9287 private transient volatile int propertyListenersCount = 0; 9288 9289 /** 9290 * A component listener to track show/hide/resize events 9291 * and convert them to PropertyChange events. 9292 */ 9293 protected ComponentListener accessibleAWTComponentHandler = null; 9294 9295 /** 9296 * A listener to track focus events 9297 * and convert them to PropertyChange events. 9298 */ 9299 protected FocusListener accessibleAWTFocusHandler = null; 9300 9301 /** 9302 * Fire PropertyChange listener, if one is registered, 9303 * when shown/hidden.. 9304 * @since 1.3 9305 */ 9306 protected class AccessibleAWTComponentHandler implements ComponentListener { 9307 public void componentHidden(ComponentEvent e) { 9308 if (accessibleContext != null) { 9309 accessibleContext.firePropertyChange( 9310 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 9311 AccessibleState.VISIBLE, null); 9312 } 9313 } 9314 9315 public void componentShown(ComponentEvent e) { 9316 if (accessibleContext != null) { 9317 accessibleContext.firePropertyChange( 9318 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 9319 null, AccessibleState.VISIBLE); 9320 } 9321 } 9322 9323 public void componentMoved(ComponentEvent e) { 9324 } 9325 9326 public void componentResized(ComponentEvent e) { 9327 } 9328 } // inner class AccessibleAWTComponentHandler 9329 9330 9331 /** 9332 * Fire PropertyChange listener, if one is registered, 9333 * when focus events happen 9334 * @since 1.3 9335 */ 9336 protected class AccessibleAWTFocusHandler implements FocusListener { 9337 public void focusGained(FocusEvent event) { 9338 if (accessibleContext != null) { 9339 accessibleContext.firePropertyChange( 9340 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 9341 null, AccessibleState.FOCUSED); 9342 } 9343 } 9344 public void focusLost(FocusEvent event) { 9345 if (accessibleContext != null) { 9346 accessibleContext.firePropertyChange( 9347 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 9348 AccessibleState.FOCUSED, null); 9349 } 9350 } 9351 } // inner class AccessibleAWTFocusHandler 9352 9353 9354 /** 9355 * Adds a {@code PropertyChangeListener} to the listener list. 9356 * 9357 * @param listener the property change listener to be added 9358 */ 9359 public void addPropertyChangeListener(PropertyChangeListener listener) { 9360 if (accessibleAWTComponentHandler == null) { 9361 accessibleAWTComponentHandler = new AccessibleAWTComponentHandler(); 9362 } 9363 if (accessibleAWTFocusHandler == null) { 9364 accessibleAWTFocusHandler = new AccessibleAWTFocusHandler(); 9365 } 9366 if (propertyListenersCount++ == 0) { 9367 Component.this.addComponentListener(accessibleAWTComponentHandler); 9368 Component.this.addFocusListener(accessibleAWTFocusHandler); 9369 } 9370 super.addPropertyChangeListener(listener); 9371 } 9372 9373 /** 9374 * Remove a PropertyChangeListener from the listener list. 9375 * This removes a PropertyChangeListener that was registered 9376 * for all properties. 9377 * 9378 * @param listener The PropertyChangeListener to be removed 9379 */ 9380 public void removePropertyChangeListener(PropertyChangeListener listener) { 9381 if (--propertyListenersCount == 0) { 9382 Component.this.removeComponentListener(accessibleAWTComponentHandler); 9383 Component.this.removeFocusListener(accessibleAWTFocusHandler); 9384 } 9385 super.removePropertyChangeListener(listener); 9386 } 9387 9388 // AccessibleContext methods 9389 // 9390 /** 9391 * Gets the accessible name of this object. This should almost never 9392 * return {@code java.awt.Component.getName()}, 9393 * as that generally isn't a localized name, 9394 * and doesn't have meaning for the user. If the 9395 * object is fundamentally a text object (e.g. a menu item), the 9396 * accessible name should be the text of the object (e.g. "save"). 9397 * If the object has a tooltip, the tooltip text may also be an 9398 * appropriate String to return. 9399 * 9400 * @return the localized name of the object -- can be 9401 * {@code null} if this 9402 * object does not have a name 9403 * @see javax.accessibility.AccessibleContext#setAccessibleName 9404 */ 9405 public String getAccessibleName() { 9406 return accessibleName; 9407 } 9408 9409 /** 9410 * Gets the accessible description of this object. This should be 9411 * a concise, localized description of what this object is - what 9412 * is its meaning to the user. If the object has a tooltip, the 9413 * tooltip text may be an appropriate string to return, assuming 9414 * it contains a concise description of the object (instead of just 9415 * the name of the object - e.g. a "Save" icon on a toolbar that 9416 * had "save" as the tooltip text shouldn't return the tooltip 9417 * text as the description, but something like "Saves the current 9418 * text document" instead). 9419 * 9420 * @return the localized description of the object -- can be 9421 * {@code null} if this object does not have a description 9422 * @see javax.accessibility.AccessibleContext#setAccessibleDescription 9423 */ 9424 public String getAccessibleDescription() { 9425 return accessibleDescription; 9426 } 9427 9428 /** 9429 * Gets the role of this object. 9430 * 9431 * @return an instance of {@code AccessibleRole} 9432 * describing the role of the object 9433 * @see javax.accessibility.AccessibleRole 9434 */ 9435 public AccessibleRole getAccessibleRole() { 9436 return AccessibleRole.AWT_COMPONENT; 9437 } 9438 9439 /** 9440 * Gets the state of this object. 9441 * 9442 * @return an instance of {@code AccessibleStateSet} 9443 * containing the current state set of the object 9444 * @see javax.accessibility.AccessibleState 9445 */ 9446 public AccessibleStateSet getAccessibleStateSet() { 9447 return Component.this.getAccessibleStateSet(); 9448 } 9449 9450 /** 9451 * Gets the {@code Accessible} parent of this object. 9452 * If the parent of this object implements {@code Accessible}, 9453 * this method should simply return {@code getParent}. 9454 * 9455 * @return the {@code Accessible} parent of this 9456 * object -- can be {@code null} if this 9457 * object does not have an {@code Accessible} parent 9458 */ 9459 public Accessible getAccessibleParent() { 9460 if (accessibleParent != null) { 9461 return accessibleParent; 9462 } else { 9463 Container parent = getParent(); 9464 if (parent instanceof Accessible) { 9465 return (Accessible) parent; 9466 } 9467 } 9468 return null; 9469 } 9470 9471 /** 9472 * Gets the index of this object in its accessible parent. 9473 * 9474 * @return the index of this object in its parent; or -1 if this 9475 * object does not have an accessible parent 9476 * @see #getAccessibleParent 9477 */ 9478 public int getAccessibleIndexInParent() { 9479 return Component.this.getAccessibleIndexInParent(); 9480 } 9481 9482 /** 9483 * Returns the number of accessible children in the object. If all 9484 * of the children of this object implement {@code Accessible}, 9485 * then this method should return the number of children of this object. 9486 * 9487 * @return the number of accessible children in the object 9488 */ 9489 public int getAccessibleChildrenCount() { 9490 return 0; // Components don't have children 9491 } 9492 9493 /** 9494 * Returns the nth {@code Accessible} child of the object. 9495 * 9496 * @param i zero-based index of child 9497 * @return the nth {@code Accessible} child of the object 9498 */ 9499 public Accessible getAccessibleChild(int i) { 9500 return null; // Components don't have children 9501 } 9502 9503 /** 9504 * Returns the locale of this object. 9505 * 9506 * @return the locale of this object 9507 */ 9508 public Locale getLocale() { 9509 return Component.this.getLocale(); 9510 } 9511 9512 /** 9513 * Gets the {@code AccessibleComponent} associated 9514 * with this object if one exists. 9515 * Otherwise return {@code null}. 9516 * 9517 * @return the component 9518 */ 9519 public AccessibleComponent getAccessibleComponent() { 9520 return this; 9521 } 9522 9523 9524 // AccessibleComponent methods 9525 // 9526 /** 9527 * Gets the background color of this object. 9528 * 9529 * @return the background color, if supported, of the object; 9530 * otherwise, {@code null} 9531 */ 9532 public Color getBackground() { 9533 return Component.this.getBackground(); 9534 } 9535 9536 /** 9537 * Sets the background color of this object. 9538 * (For transparency, see {@code isOpaque}.) 9539 * 9540 * @param c the new {@code Color} for the background 9541 * @see Component#isOpaque 9542 */ 9543 public void setBackground(Color c) { 9544 Component.this.setBackground(c); 9545 } 9546 9547 /** 9548 * Gets the foreground color of this object. 9549 * 9550 * @return the foreground color, if supported, of the object; 9551 * otherwise, {@code null} 9552 */ 9553 public Color getForeground() { 9554 return Component.this.getForeground(); 9555 } 9556 9557 /** 9558 * Sets the foreground color of this object. 9559 * 9560 * @param c the new {@code Color} for the foreground 9561 */ 9562 public void setForeground(Color c) { 9563 Component.this.setForeground(c); 9564 } 9565 9566 /** 9567 * Gets the {@code Cursor} of this object. 9568 * 9569 * @return the {@code Cursor}, if supported, 9570 * of the object; otherwise, {@code null} 9571 */ 9572 public Cursor getCursor() { 9573 return Component.this.getCursor(); 9574 } 9575 9576 /** 9577 * Sets the {@code Cursor} of this object. 9578 * <p> 9579 * The method may have no visual effect if the Java platform 9580 * implementation and/or the native system do not support 9581 * changing the mouse cursor shape. 9582 * @param cursor the new {@code Cursor} for the object 9583 */ 9584 public void setCursor(Cursor cursor) { 9585 Component.this.setCursor(cursor); 9586 } 9587 9588 /** 9589 * Gets the {@code Font} of this object. 9590 * 9591 * @return the {@code Font}, if supported, 9592 * for the object; otherwise, {@code null} 9593 */ 9594 public Font getFont() { 9595 return Component.this.getFont(); 9596 } 9597 9598 /** 9599 * Sets the {@code Font} of this object. 9600 * 9601 * @param f the new {@code Font} for the object 9602 */ 9603 public void setFont(Font f) { 9604 Component.this.setFont(f); 9605 } 9606 9607 /** 9608 * Gets the {@code FontMetrics} of this object. 9609 * 9610 * @param f the {@code Font} 9611 * @return the {@code FontMetrics}, if supported, 9612 * the object; otherwise, {@code null} 9613 * @see #getFont 9614 */ 9615 public FontMetrics getFontMetrics(Font f) { 9616 if (f == null) { 9617 return null; 9618 } else { 9619 return Component.this.getFontMetrics(f); 9620 } 9621 } 9622 9623 /** 9624 * Determines if the object is enabled. 9625 * 9626 * @return true if object is enabled; otherwise, false 9627 */ 9628 public boolean isEnabled() { 9629 return Component.this.isEnabled(); 9630 } 9631 9632 /** 9633 * Sets the enabled state of the object. 9634 * 9635 * @param b if true, enables this object; otherwise, disables it 9636 */ 9637 public void setEnabled(boolean b) { 9638 boolean old = Component.this.isEnabled(); 9639 Component.this.setEnabled(b); 9640 if (b != old) { 9641 if (accessibleContext != null) { 9642 if (b) { 9643 accessibleContext.firePropertyChange( 9644 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 9645 null, AccessibleState.ENABLED); 9646 } else { 9647 accessibleContext.firePropertyChange( 9648 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 9649 AccessibleState.ENABLED, null); 9650 } 9651 } 9652 } 9653 } 9654 9655 /** 9656 * Determines if the object is visible. Note: this means that the 9657 * object intends to be visible; however, it may not in fact be 9658 * showing on the screen because one of the objects that this object 9659 * is contained by is not visible. To determine if an object is 9660 * showing on the screen, use {@code isShowing}. 9661 * 9662 * @return true if object is visible; otherwise, false 9663 */ 9664 public boolean isVisible() { 9665 return Component.this.isVisible(); 9666 } 9667 9668 /** 9669 * Sets the visible state of the object. 9670 * 9671 * @param b if true, shows this object; otherwise, hides it 9672 */ 9673 public void setVisible(boolean b) { 9674 boolean old = Component.this.isVisible(); 9675 Component.this.setVisible(b); 9676 if (b != old) { 9677 if (accessibleContext != null) { 9678 if (b) { 9679 accessibleContext.firePropertyChange( 9680 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 9681 null, AccessibleState.VISIBLE); 9682 } else { 9683 accessibleContext.firePropertyChange( 9684 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 9685 AccessibleState.VISIBLE, null); 9686 } 9687 } 9688 } 9689 } 9690 9691 /** 9692 * Determines if the object is showing. This is determined by checking 9693 * the visibility of the object and ancestors of the object. Note: 9694 * this will return true even if the object is obscured by another 9695 * (for example, it happens to be underneath a menu that was pulled 9696 * down). 9697 * 9698 * @return true if object is showing; otherwise, false 9699 */ 9700 public boolean isShowing() { 9701 return Component.this.isShowing(); 9702 } 9703 9704 /** 9705 * Checks whether the specified point is within this object's bounds, 9706 * where the point's x and y coordinates are defined to be relative to 9707 * the coordinate system of the object. 9708 * 9709 * @param p the {@code Point} relative to the 9710 * coordinate system of the object 9711 * @return true if object contains {@code Point}; otherwise false 9712 */ 9713 public boolean contains(Point p) { 9714 return Component.this.contains(p); 9715 } 9716 9717 /** 9718 * Returns the location of the object on the screen. 9719 * 9720 * @return location of object on screen -- can be 9721 * {@code null} if this object is not on the screen 9722 */ 9723 public Point getLocationOnScreen() { 9724 synchronized (Component.this.getTreeLock()) { 9725 if (Component.this.isShowing()) { 9726 return Component.this.getLocationOnScreen(); 9727 } else { 9728 return null; 9729 } 9730 } 9731 } 9732 9733 /** 9734 * Gets the location of the object relative to the parent in the form 9735 * of a point specifying the object's top-left corner in the screen's 9736 * coordinate space. 9737 * 9738 * @return an instance of Point representing the top-left corner of 9739 * the object's bounds in the coordinate space of the screen; 9740 * {@code null} if this object or its parent are not on the screen 9741 */ 9742 public Point getLocation() { 9743 return Component.this.getLocation(); 9744 } 9745 9746 /** 9747 * Sets the location of the object relative to the parent. 9748 * @param p the coordinates of the object 9749 */ 9750 public void setLocation(Point p) { 9751 Component.this.setLocation(p); 9752 } 9753 9754 /** 9755 * Gets the bounds of this object in the form of a Rectangle object. 9756 * The bounds specify this object's width, height, and location 9757 * relative to its parent. 9758 * 9759 * @return a rectangle indicating this component's bounds; 9760 * {@code null} if this object is not on the screen 9761 */ 9762 public Rectangle getBounds() { 9763 return Component.this.getBounds(); 9764 } 9765 9766 /** 9767 * Sets the bounds of this object in the form of a 9768 * {@code Rectangle} object. 9769 * The bounds specify this object's width, height, and location 9770 * relative to its parent. 9771 * 9772 * @param r a rectangle indicating this component's bounds 9773 */ 9774 public void setBounds(Rectangle r) { 9775 Component.this.setBounds(r); 9776 } 9777 9778 /** 9779 * Returns the size of this object in the form of a 9780 * {@code Dimension} object. The height field of the 9781 * {@code Dimension} object contains this object's 9782 * height, and the width field of the {@code Dimension} 9783 * object contains this object's width. 9784 * 9785 * @return a {@code Dimension} object that indicates 9786 * the size of this component; {@code null} if 9787 * this object is not on the screen 9788 */ 9789 public Dimension getSize() { 9790 return Component.this.getSize(); 9791 } 9792 9793 /** 9794 * Resizes this object so that it has width and height. 9795 * 9796 * @param d the dimension specifying the new size of the object 9797 */ 9798 public void setSize(Dimension d) { 9799 Component.this.setSize(d); 9800 } 9801 9802 /** 9803 * Returns the {@code Accessible} child, 9804 * if one exists, contained at the local 9805 * coordinate {@code Point}. Otherwise returns 9806 * {@code null}. 9807 * 9808 * @param p the point defining the top-left corner of 9809 * the {@code Accessible}, given in the 9810 * coordinate space of the object's parent 9811 * @return the {@code Accessible}, if it exists, 9812 * at the specified location; else {@code null} 9813 */ 9814 public Accessible getAccessibleAt(Point p) { 9815 return null; // Components don't have children 9816 } 9817 9818 /** 9819 * Returns whether this object can accept focus or not. 9820 * 9821 * @return true if object can accept focus; otherwise false 9822 */ 9823 public boolean isFocusTraversable() { 9824 return Component.this.isFocusTraversable(); 9825 } 9826 9827 /** 9828 * Requests focus for this object. 9829 */ 9830 public void requestFocus() { 9831 Component.this.requestFocus(); 9832 } 9833 9834 /** 9835 * Adds the specified focus listener to receive focus events from this 9836 * component. 9837 * 9838 * @param l the focus listener 9839 */ 9840 public void addFocusListener(FocusListener l) { 9841 Component.this.addFocusListener(l); 9842 } 9843 9844 /** 9845 * Removes the specified focus listener so it no longer receives focus 9846 * events from this component. 9847 * 9848 * @param l the focus listener 9849 */ 9850 public void removeFocusListener(FocusListener l) { 9851 Component.this.removeFocusListener(l); 9852 } 9853 9854 } // inner class AccessibleAWTComponent 9855 9856 9857 /** 9858 * Gets the index of this object in its accessible parent. 9859 * If this object does not have an accessible parent, returns 9860 * -1. 9861 * 9862 * @return the index of this object in its accessible parent 9863 */ 9864 int getAccessibleIndexInParent() { 9865 synchronized (getTreeLock()) { 9866 9867 AccessibleContext accContext = getAccessibleContext(); 9868 if (accContext == null) { 9869 return -1; 9870 } 9871 9872 Accessible parent = accContext.getAccessibleParent(); 9873 if (parent == null) { 9874 return -1; 9875 } 9876 9877 accContext = parent.getAccessibleContext(); 9878 for (int i = 0; i < accContext.getAccessibleChildrenCount(); i++) { 9879 if (this.equals(accContext.getAccessibleChild(i))) { 9880 return i; 9881 } 9882 } 9883 9884 return -1; 9885 } 9886 } 9887 9888 /** 9889 * Gets the current state set of this object. 9890 * 9891 * @return an instance of {@code AccessibleStateSet} 9892 * containing the current state set of the object 9893 * @see AccessibleState 9894 */ 9895 AccessibleStateSet getAccessibleStateSet() { 9896 synchronized (getTreeLock()) { 9897 AccessibleStateSet states = new AccessibleStateSet(); 9898 if (this.isEnabled()) { 9899 states.add(AccessibleState.ENABLED); 9900 } 9901 if (this.isFocusTraversable()) { 9902 states.add(AccessibleState.FOCUSABLE); 9903 } 9904 if (this.isVisible()) { 9905 states.add(AccessibleState.VISIBLE); 9906 } 9907 if (this.isShowing()) { 9908 states.add(AccessibleState.SHOWING); 9909 } 9910 if (this.isFocusOwner()) { 9911 states.add(AccessibleState.FOCUSED); 9912 } 9913 if (this instanceof Accessible) { 9914 AccessibleContext ac = ((Accessible) this).getAccessibleContext(); 9915 if (ac != null) { 9916 Accessible ap = ac.getAccessibleParent(); 9917 if (ap != null) { 9918 AccessibleContext pac = ap.getAccessibleContext(); 9919 if (pac != null) { 9920 AccessibleSelection as = pac.getAccessibleSelection(); 9921 if (as != null) { 9922 states.add(AccessibleState.SELECTABLE); 9923 int i = ac.getAccessibleIndexInParent(); 9924 if (i >= 0) { 9925 if (as.isAccessibleChildSelected(i)) { 9926 states.add(AccessibleState.SELECTED); 9927 } 9928 } 9929 } 9930 } 9931 } 9932 } 9933 } 9934 if (Component.isInstanceOf(this, "javax.swing.JComponent")) { 9935 if (((javax.swing.JComponent) this).isOpaque()) { 9936 states.add(AccessibleState.OPAQUE); 9937 } 9938 } 9939 return states; 9940 } 9941 } 9942 9943 /** 9944 * Checks that the given object is instance of the given class. 9945 * @param obj Object to be checked 9946 * @param className The name of the class. Must be fully-qualified class name. 9947 * @return true, if this object is instanceof given class, 9948 * false, otherwise, or if obj or className is null 9949 */ 9950 static boolean isInstanceOf(Object obj, String className) { 9951 if (obj == null) return false; 9952 if (className == null) return false; 9953 9954 Class<?> cls = obj.getClass(); 9955 while (cls != null) { 9956 if (cls.getName().equals(className)) { 9957 return true; 9958 } 9959 cls = cls.getSuperclass(); 9960 } 9961 return false; 9962 } 9963 9964 9965 // ************************** MIXING CODE ******************************* 9966 9967 /** 9968 * Check whether we can trust the current bounds of the component. 9969 * The return value of false indicates that the container of the 9970 * component is invalid, and therefore needs to be laid out, which would 9971 * probably mean changing the bounds of its children. 9972 * Null-layout of the container or absence of the container mean 9973 * the bounds of the component are final and can be trusted. 9974 */ 9975 final boolean areBoundsValid() { 9976 Container cont = getContainer(); 9977 return cont == null || cont.isValid() || cont.getLayout() == null; 9978 } 9979 9980 /** 9981 * Applies the shape to the component 9982 * @param shape Shape to be applied to the component 9983 */ 9984 void applyCompoundShape(Region shape) { 9985 checkTreeLock(); 9986 9987 if (!areBoundsValid()) { 9988 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 9989 mixingLog.fine("this = " + this + "; areBoundsValid = " + areBoundsValid()); 9990 } 9991 return; 9992 } 9993 9994 if (!isLightweight()) { 9995 ComponentPeer peer = this.peer; 9996 if (peer != null) { 9997 // The Region class has some optimizations. That's why 9998 // we should manually check whether it's empty and 9999 // substitute the object ourselves. Otherwise we end up 10000 // with some incorrect Region object with loX being 10001 // greater than the hiX for instance. 10002 if (shape.isEmpty()) { 10003 shape = Region.EMPTY_REGION; 10004 } 10005 10006 10007 // Note: the shape is not really copied/cloned. We create 10008 // the Region object ourselves, so there's no any possibility 10009 // to modify the object outside of the mixing code. 10010 // Nullifying compoundShape means that the component has normal shape 10011 // (or has no shape at all). 10012 if (shape.equals(getNormalShape())) { 10013 if (this.compoundShape == null) { 10014 return; 10015 } 10016 this.compoundShape = null; 10017 peer.applyShape(null); 10018 } else { 10019 if (shape.equals(getAppliedShape())) { 10020 return; 10021 } 10022 this.compoundShape = shape; 10023 Point compAbsolute = getLocationOnWindow(); 10024 if (mixingLog.isLoggable(PlatformLogger.Level.FINER)) { 10025 mixingLog.fine("this = " + this + 10026 "; compAbsolute=" + compAbsolute + "; shape=" + shape); 10027 } 10028 peer.applyShape(shape.getTranslatedRegion(-compAbsolute.x, -compAbsolute.y)); 10029 } 10030 } 10031 } 10032 } 10033 10034 /** 10035 * Returns the shape previously set with applyCompoundShape(). 10036 * If the component is LW or no shape was applied yet, 10037 * the method returns the normal shape. 10038 */ 10039 private Region getAppliedShape() { 10040 checkTreeLock(); 10041 //XXX: if we allow LW components to have a shape, this must be changed 10042 return (this.compoundShape == null || isLightweight()) ? getNormalShape() : this.compoundShape; 10043 } 10044 10045 Point getLocationOnWindow() { 10046 checkTreeLock(); 10047 Point curLocation = getLocation(); 10048 10049 for (Container parent = getContainer(); 10050 parent != null && !(parent instanceof Window); 10051 parent = parent.getContainer()) 10052 { 10053 curLocation.x += parent.getX(); 10054 curLocation.y += parent.getY(); 10055 } 10056 10057 return curLocation; 10058 } 10059 10060 /** 10061 * Returns the full shape of the component located in window coordinates 10062 */ 10063 final Region getNormalShape() { 10064 checkTreeLock(); 10065 //XXX: we may take into account a user-specified shape for this component 10066 Point compAbsolute = getLocationOnWindow(); 10067 return 10068 Region.getInstanceXYWH( 10069 compAbsolute.x, 10070 compAbsolute.y, 10071 getWidth(), 10072 getHeight() 10073 ); 10074 } 10075 10076 /** 10077 * Returns the "opaque shape" of the component. 10078 * 10079 * The opaque shape of a lightweight components is the actual shape that 10080 * needs to be cut off of the heavyweight components in order to mix this 10081 * lightweight component correctly with them. 10082 * 10083 * The method is overriden in the java.awt.Container to handle non-opaque 10084 * containers containing opaque children. 10085 * 10086 * See 6637655 for details. 10087 */ 10088 Region getOpaqueShape() { 10089 checkTreeLock(); 10090 if (mixingCutoutRegion != null) { 10091 return mixingCutoutRegion; 10092 } else { 10093 return getNormalShape(); 10094 } 10095 } 10096 10097 final int getSiblingIndexAbove() { 10098 checkTreeLock(); 10099 Container parent = getContainer(); 10100 if (parent == null) { 10101 return -1; 10102 } 10103 10104 int nextAbove = parent.getComponentZOrder(this) - 1; 10105 10106 return nextAbove < 0 ? -1 : nextAbove; 10107 } 10108 10109 final ComponentPeer getHWPeerAboveMe() { 10110 checkTreeLock(); 10111 10112 Container cont = getContainer(); 10113 int indexAbove = getSiblingIndexAbove(); 10114 10115 while (cont != null) { 10116 for (int i = indexAbove; i > -1; i--) { 10117 Component comp = cont.getComponent(i); 10118 if (comp != null && comp.isDisplayable() && !comp.isLightweight()) { 10119 return comp.peer; 10120 } 10121 } 10122 // traversing the hierarchy up to the closest HW container; 10123 // further traversing may return a component that is not actually 10124 // a native sibling of this component and this kind of z-order 10125 // request may not be allowed by the underlying system (6852051). 10126 if (!cont.isLightweight()) { 10127 break; 10128 } 10129 10130 indexAbove = cont.getSiblingIndexAbove(); 10131 cont = cont.getContainer(); 10132 } 10133 10134 return null; 10135 } 10136 10137 final int getSiblingIndexBelow() { 10138 checkTreeLock(); 10139 Container parent = getContainer(); 10140 if (parent == null) { 10141 return -1; 10142 } 10143 10144 int nextBelow = parent.getComponentZOrder(this) + 1; 10145 10146 return nextBelow >= parent.getComponentCount() ? -1 : nextBelow; 10147 } 10148 10149 final boolean isNonOpaqueForMixing() { 10150 return mixingCutoutRegion != null && 10151 mixingCutoutRegion.isEmpty(); 10152 } 10153 10154 private Region calculateCurrentShape() { 10155 checkTreeLock(); 10156 Region s = getNormalShape(); 10157 10158 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10159 mixingLog.fine("this = " + this + "; normalShape=" + s); 10160 } 10161 10162 if (getContainer() != null) { 10163 Component comp = this; 10164 Container cont = comp.getContainer(); 10165 10166 while (cont != null) { 10167 for (int index = comp.getSiblingIndexAbove(); index != -1; --index) { 10168 /* It is assumed that: 10169 * 10170 * getComponent(getContainer().getComponentZOrder(comp)) == comp 10171 * 10172 * The assumption has been made according to the current 10173 * implementation of the Container class. 10174 */ 10175 Component c = cont.getComponent(index); 10176 if (c.isLightweight() && c.isShowing()) { 10177 s = s.getDifference(c.getOpaqueShape()); 10178 } 10179 } 10180 10181 if (cont.isLightweight()) { 10182 s = s.getIntersection(cont.getNormalShape()); 10183 } else { 10184 break; 10185 } 10186 10187 comp = cont; 10188 cont = cont.getContainer(); 10189 } 10190 } 10191 10192 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10193 mixingLog.fine("currentShape=" + s); 10194 } 10195 10196 return s; 10197 } 10198 10199 void applyCurrentShape() { 10200 checkTreeLock(); 10201 if (!areBoundsValid()) { 10202 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10203 mixingLog.fine("this = " + this + "; areBoundsValid = " + areBoundsValid()); 10204 } 10205 return; // Because applyCompoundShape() ignores such components anyway 10206 } 10207 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10208 mixingLog.fine("this = " + this); 10209 } 10210 applyCompoundShape(calculateCurrentShape()); 10211 } 10212 10213 final void subtractAndApplyShape(Region s) { 10214 checkTreeLock(); 10215 10216 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10217 mixingLog.fine("this = " + this + "; s=" + s); 10218 } 10219 10220 applyCompoundShape(getAppliedShape().getDifference(s)); 10221 } 10222 10223 private final void applyCurrentShapeBelowMe() { 10224 checkTreeLock(); 10225 Container parent = getContainer(); 10226 if (parent != null && parent.isShowing()) { 10227 // First, reapply shapes of my siblings 10228 parent.recursiveApplyCurrentShape(getSiblingIndexBelow()); 10229 10230 // Second, if my container is non-opaque, reapply shapes of siblings of my container 10231 Container parent2 = parent.getContainer(); 10232 while (!parent.isOpaque() && parent2 != null) { 10233 parent2.recursiveApplyCurrentShape(parent.getSiblingIndexBelow()); 10234 10235 parent = parent2; 10236 parent2 = parent.getContainer(); 10237 } 10238 } 10239 } 10240 10241 final void subtractAndApplyShapeBelowMe() { 10242 checkTreeLock(); 10243 Container parent = getContainer(); 10244 if (parent != null && isShowing()) { 10245 Region opaqueShape = getOpaqueShape(); 10246 10247 // First, cut my siblings 10248 parent.recursiveSubtractAndApplyShape(opaqueShape, getSiblingIndexBelow()); 10249 10250 // Second, if my container is non-opaque, cut siblings of my container 10251 Container parent2 = parent.getContainer(); 10252 while (!parent.isOpaque() && parent2 != null) { 10253 parent2.recursiveSubtractAndApplyShape(opaqueShape, parent.getSiblingIndexBelow()); 10254 10255 parent = parent2; 10256 parent2 = parent.getContainer(); 10257 } 10258 } 10259 } 10260 10261 void mixOnShowing() { 10262 synchronized (getTreeLock()) { 10263 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10264 mixingLog.fine("this = " + this); 10265 } 10266 if (!isMixingNeeded()) { 10267 return; 10268 } 10269 if (isLightweight()) { 10270 subtractAndApplyShapeBelowMe(); 10271 } else { 10272 applyCurrentShape(); 10273 } 10274 } 10275 } 10276 10277 void mixOnHiding(boolean isLightweight) { 10278 // We cannot be sure that the peer exists at this point, so we need the argument 10279 // to find out whether the hiding component is (well, actually was) a LW or a HW. 10280 synchronized (getTreeLock()) { 10281 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10282 mixingLog.fine("this = " + this + "; isLightweight = " + isLightweight); 10283 } 10284 if (!isMixingNeeded()) { 10285 return; 10286 } 10287 if (isLightweight) { 10288 applyCurrentShapeBelowMe(); 10289 } 10290 } 10291 } 10292 10293 void mixOnReshaping() { 10294 synchronized (getTreeLock()) { 10295 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10296 mixingLog.fine("this = " + this); 10297 } 10298 if (!isMixingNeeded()) { 10299 return; 10300 } 10301 if (isLightweight()) { 10302 applyCurrentShapeBelowMe(); 10303 } else { 10304 applyCurrentShape(); 10305 } 10306 } 10307 } 10308 10309 void mixOnZOrderChanging(int oldZorder, int newZorder) { 10310 synchronized (getTreeLock()) { 10311 boolean becameHigher = newZorder < oldZorder; 10312 Container parent = getContainer(); 10313 10314 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10315 mixingLog.fine("this = " + this + 10316 "; oldZorder=" + oldZorder + "; newZorder=" + newZorder + "; parent=" + parent); 10317 } 10318 if (!isMixingNeeded()) { 10319 return; 10320 } 10321 if (isLightweight()) { 10322 if (becameHigher) { 10323 if (parent != null && isShowing()) { 10324 parent.recursiveSubtractAndApplyShape(getOpaqueShape(), getSiblingIndexBelow(), oldZorder); 10325 } 10326 } else { 10327 if (parent != null) { 10328 parent.recursiveApplyCurrentShape(oldZorder, newZorder); 10329 } 10330 } 10331 } else { 10332 if (becameHigher) { 10333 applyCurrentShape(); 10334 } else { 10335 if (parent != null) { 10336 Region shape = getAppliedShape(); 10337 10338 for (int index = oldZorder; index < newZorder; index++) { 10339 Component c = parent.getComponent(index); 10340 if (c.isLightweight() && c.isShowing()) { 10341 shape = shape.getDifference(c.getOpaqueShape()); 10342 } 10343 } 10344 applyCompoundShape(shape); 10345 } 10346 } 10347 } 10348 } 10349 } 10350 10351 void mixOnValidating() { 10352 // This method gets overriden in the Container. Obviously, a plain 10353 // non-container components don't need to handle validation. 10354 } 10355 10356 final boolean isMixingNeeded() { 10357 if (SunToolkit.getSunAwtDisableMixing()) { 10358 if (mixingLog.isLoggable(PlatformLogger.Level.FINEST)) { 10359 mixingLog.finest("this = " + this + "; Mixing disabled via sun.awt.disableMixing"); 10360 } 10361 return false; 10362 } 10363 if (!areBoundsValid()) { 10364 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10365 mixingLog.fine("this = " + this + "; areBoundsValid = " + areBoundsValid()); 10366 } 10367 return false; 10368 } 10369 Window window = getContainingWindow(); 10370 if (window != null) { 10371 if (!window.hasHeavyweightDescendants() || !window.hasLightweightDescendants() || window.isDisposing()) { 10372 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10373 mixingLog.fine("containing window = " + window + 10374 "; has h/w descendants = " + window.hasHeavyweightDescendants() + 10375 "; has l/w descendants = " + window.hasLightweightDescendants() + 10376 "; disposing = " + window.isDisposing()); 10377 } 10378 return false; 10379 } 10380 } else { 10381 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) { 10382 mixingLog.fine("this = " + this + "; containing window is null"); 10383 } 10384 return false; 10385 } 10386 return true; 10387 } 10388 10389 /** 10390 * Sets a 'mixing-cutout' shape for this lightweight component. 10391 * 10392 * This method is used exclusively for the purposes of the 10393 * Heavyweight/Lightweight Components Mixing feature and will 10394 * have no effect if applied to a heavyweight component. 10395 * 10396 * By default a lightweight component is treated as an opaque rectangle for 10397 * the purposes of the Heavyweight/Lightweight Components Mixing feature. 10398 * This method enables developers to set an arbitrary shape to be cut out 10399 * from heavyweight components positioned underneath the lightweight 10400 * component in the z-order. 10401 * <p> 10402 * The {@code shape} argument may have the following values: 10403 * <ul> 10404 * <li>{@code null} - reverts the default cutout shape (the rectangle equal 10405 * to the component's {@code getBounds()}) 10406 * <li><i>empty-shape</i> - does not cut out anything from heavyweight 10407 * components. This makes this lightweight component effectively 10408 * transparent. Note that descendants of the lightweight component still 10409 * affect the shapes of heavyweight components. An example of an 10410 * <i>empty-shape</i> is {@code new Rectangle()}. 10411 * <li><i>non-empty-shape</i> - the given shape will be cut out from 10412 * heavyweight components. 10413 * </ul> 10414 * <p> 10415 * The most common example when the 'mixing-cutout' shape is needed is a 10416 * glass pane component. The {@link JRootPane#setGlassPane} method 10417 * automatically sets the <i>empty-shape</i> as the 'mixing-cutout' shape 10418 * for the given glass pane component. If a developer needs some other 10419 * 'mixing-cutout' shape for the glass pane (which is rare), this must be 10420 * changed manually after installing the glass pane to the root pane. 10421 * 10422 * @param shape the new 'mixing-cutout' shape 10423 * @since 9 10424 */ 10425 public void setMixingCutoutShape(Shape shape) { 10426 Region region = shape == null ? null : Region.getInstance(shape, null); 10427 10428 synchronized (getTreeLock()) { 10429 boolean needShowing = false; 10430 boolean needHiding = false; 10431 10432 if (!isNonOpaqueForMixing()) { 10433 needHiding = true; 10434 } 10435 10436 mixingCutoutRegion = region; 10437 10438 if (!isNonOpaqueForMixing()) { 10439 needShowing = true; 10440 } 10441 10442 if (isMixingNeeded()) { 10443 if (needHiding) { 10444 mixOnHiding(isLightweight()); 10445 } 10446 if (needShowing) { 10447 mixOnShowing(); 10448 } 10449 } 10450 } 10451 } 10452 10453 // ****************** END OF MIXING CODE ******************************** 10454 10455 // Note that the method is overriden in the Window class, 10456 // a window doesn't need to be updated in the Z-order. 10457 void updateZOrder() { 10458 peer.setZOrder(getHWPeerAboveMe()); 10459 } 10460 10461 }