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