1 /* 2 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 package javax.swing; 26 27 28 import java.util.HashSet; 29 import java.util.Hashtable; 30 import java.util.Dictionary; 31 import java.util.Enumeration; 32 import java.util.Locale; 33 import java.util.Vector; 34 import java.util.EventListener; 35 import java.util.Set; 36 import java.util.Map; 37 import java.util.HashMap; 38 39 import java.awt.*; 40 import java.awt.event.*; 41 import java.awt.image.VolatileImage; 42 import java.awt.Graphics2D; 43 import java.awt.peer.LightweightPeer; 44 import java.awt.dnd.DropTarget; 45 import java.awt.font.FontRenderContext; 46 import java.beans.PropertyChangeListener; 47 import java.beans.VetoableChangeListener; 48 import java.beans.VetoableChangeSupport; 49 import java.beans.Transient; 50 51 import java.applet.Applet; 52 53 import java.io.Serializable; 54 import java.io.ObjectOutputStream; 55 import java.io.ObjectInputStream; 56 import java.io.IOException; 57 import java.io.ObjectInputValidation; 58 import java.io.InvalidObjectException; 59 60 import javax.swing.border.*; 61 import javax.swing.event.*; 62 import javax.swing.plaf.*; 63 import static javax.swing.ClientPropertyKey.*; 64 import javax.accessibility.*; 65 66 import sun.swing.SwingUtilities2; 67 import sun.swing.UIClientPropertyKey; 68 69 /** 70 * The base class for all Swing components except top-level containers. 71 * To use a component that inherits from <code>JComponent</code>, 72 * you must place the component in a containment hierarchy 73 * whose root is a top-level Swing container. 74 * Top-level Swing containers -- 75 * such as <code>JFrame</code>, <code>JDialog</code>, 76 * and <code>JApplet</code> -- 77 * are specialized components 78 * that provide a place for other Swing components to paint themselves. 79 * For an explanation of containment hierarchies, see 80 * <a 81 href="http://java.sun.com/docs/books/tutorial/uiswing/overview/hierarchy.html">Swing Components and the Containment Hierarchy</a>, 82 * a section in <em>The Java Tutorial</em>. 83 * 84 * <p> 85 * The <code>JComponent</code> class provides: 86 * <ul> 87 * <li>The base class for both standard and custom components 88 * that use the Swing architecture. 89 * <li>A "pluggable look and feel" (L&F) that can be specified by the 90 * programmer or (optionally) selected by the user at runtime. 91 * The look and feel for each component is provided by a 92 * <em>UI delegate</em> -- an object that descends from 93 * {@link javax.swing.plaf.ComponentUI}. 94 * See <a 95 * href="http://java.sun.com/docs/books/tutorial/uiswing/misc/plaf.html">How 96 * to Set the Look and Feel</a> 97 * in <em>The Java Tutorial</em> 98 * for more information. 99 * <li>Comprehensive keystroke handling. 100 * See the document <a 101 * href="http://java.sun.com/products/jfc/tsc/special_report/kestrel/keybindings.html">Keyboard 102 * Bindings in Swing</a>, 103 * an article in <em>The Swing Connection</em>, 104 * for more information. 105 * <li>Support for tool tips -- 106 * short descriptions that pop up when the cursor lingers 107 * over a component. 108 * See <a 109 * href="http://java.sun.com/docs/books/tutorial/uiswing/components/tooltip.html">How 110 * to Use Tool Tips</a> 111 * in <em>The Java Tutorial</em> 112 * for more information. 113 * <li>Support for accessibility. 114 * <code>JComponent</code> contains all of the methods in the 115 * <code>Accessible</code> interface, 116 * but it doesn't actually implement the interface. That is the 117 * responsibility of the individual classes 118 * that extend <code>JComponent</code>. 119 * <li>Support for component-specific properties. 120 * With the {@link #putClientProperty} 121 * and {@link #getClientProperty} methods, 122 * you can associate name-object pairs 123 * with any object that descends from <code>JComponent</code>. 124 * <li>An infrastructure for painting 125 * that includes double buffering and support for borders. 126 * For more information see <a 127 * href="http://java.sun.com/docs/books/tutorial/uiswing/overview/draw.html">Painting</a> and 128 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/border.html">How 129 * to Use Borders</a>, 130 * both of which are sections in <em>The Java Tutorial</em>. 131 * </ul> 132 * For more information on these subjects, see the 133 * <a href="package-summary.html#package_description">Swing package description</a> 134 * and <em>The Java Tutorial</em> section 135 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/components/jcomponent.html">The JComponent Class</a>. 136 * <p> 137 * <code>JComponent</code> and its subclasses document default values 138 * for certain properties. For example, <code>JTable</code> documents the 139 * default row height as 16. Each <code>JComponent</code> subclass 140 * that has a <code>ComponentUI</code> will create the 141 * <code>ComponentUI</code> as part of its constructor. In order 142 * to provide a particular look and feel each 143 * <code>ComponentUI</code> may set properties back on the 144 * <code>JComponent</code> that created it. For example, a custom 145 * look and feel may require <code>JTable</code>s to have a row 146 * height of 24. The documented defaults are the value of a property 147 * BEFORE the <code>ComponentUI</code> has been installed. If you 148 * need a specific value for a particular property you should 149 * explicitly set it. 150 * <p> 151 * In release 1.4, the focus subsystem was rearchitected. 152 * For more information, see 153 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 154 * How to Use the Focus Subsystem</a>, 155 * a section in <em>The Java Tutorial</em>. 156 * <p> 157 * <strong>Warning:</strong> Swing is not thread safe. For more 158 * information see <a 159 * href="package-summary.html#threading">Swing's Threading 160 * Policy</a>. 161 * <p> 162 * <strong>Warning:</strong> 163 * Serialized objects of this class will not be compatible with 164 * future Swing releases. The current serialization support is 165 * appropriate for short term storage or RMI between applications running 166 * the same version of Swing. As of 1.4, support for long term storage 167 * of all JavaBeans<sup><font size="-2">TM</font></sup> 168 * has been added to the <code>java.beans</code> package. 169 * Please see {@link java.beans.XMLEncoder}. 170 * 171 * @see KeyStroke 172 * @see Action 173 * @see #setBorder 174 * @see #registerKeyboardAction 175 * @see JOptionPane 176 * @see #setDebugGraphicsOptions 177 * @see #setToolTipText 178 * @see #setAutoscrolls 179 * 180 * @author Hans Muller 181 * @author Arnaud Weber 182 */ 183 public abstract class JComponent extends Container implements Serializable, 184 TransferHandler.HasGetTransferHandler 185 { 186 /** 187 * @see #getUIClassID 188 * @see #writeObject 189 */ 190 private static final String uiClassID = "ComponentUI"; 191 192 /** 193 * @see #readObject 194 */ 195 private static final Hashtable<ObjectInputStream, ReadObjectCallback> readObjectCallbacks = 196 new Hashtable<ObjectInputStream, ReadObjectCallback>(1); 197 198 /** 199 * Keys to use for forward focus traversal when the JComponent is 200 * managing focus. 201 */ 202 private static Set<KeyStroke> managingFocusForwardTraversalKeys; 203 204 /** 205 * Keys to use for backward focus traversal when the JComponent is 206 * managing focus. 207 */ 208 private static Set<KeyStroke> managingFocusBackwardTraversalKeys; 209 210 // Following are the possible return values from getObscuredState. 211 private static final int NOT_OBSCURED = 0; 212 private static final int PARTIALLY_OBSCURED = 1; 213 private static final int COMPLETELY_OBSCURED = 2; 214 215 /** 216 * Set to true when DebugGraphics has been loaded. 217 */ 218 static boolean DEBUG_GRAPHICS_LOADED; 219 220 /** 221 * Key used to look up a value from the AppContext to determine the 222 * JComponent the InputVerifier is running for. That is, if 223 * AppContext.get(INPUT_VERIFIER_SOURCE_KEY) returns non-null, it 224 * indicates the EDT is calling into the InputVerifier from the 225 * returned component. 226 */ 227 private static final Object INPUT_VERIFIER_SOURCE_KEY = 228 new StringBuilder("InputVerifierSourceKey"); 229 230 /* The following fields support set methods for the corresponding 231 * java.awt.Component properties. 232 */ 233 private boolean isAlignmentXSet; 234 private float alignmentX; 235 private boolean isAlignmentYSet; 236 private float alignmentY; 237 238 /** 239 * Backing store for JComponent properties and listeners 240 */ 241 242 /** The look and feel delegate for this component. */ 243 protected transient ComponentUI ui; 244 /** A list of event listeners for this component. */ 245 protected EventListenerList listenerList = new EventListenerList(); 246 247 private transient ArrayTable clientProperties; 248 private VetoableChangeSupport vetoableChangeSupport; 249 /** 250 * Whether or not autoscroll has been enabled. 251 */ 252 private boolean autoscrolls; 253 private Border border; 254 private int flags; 255 256 /* Input verifier for this component */ 257 private InputVerifier inputVerifier = null; 258 259 private boolean verifyInputWhenFocusTarget = true; 260 261 /** 262 * Set in <code>_paintImmediately</code>. 263 * Will indicate the child that initiated the painting operation. 264 * If <code>paintingChild</code> is opaque, no need to paint 265 * any child components after <code>paintingChild</code>. 266 * Test used in <code>paintChildren</code>. 267 */ 268 transient Component paintingChild; 269 270 /** 271 * Constant used for <code>registerKeyboardAction</code> that 272 * means that the command should be invoked when 273 * the component has the focus. 274 */ 275 public static final int WHEN_FOCUSED = 0; 276 277 /** 278 * Constant used for <code>registerKeyboardAction</code> that 279 * means that the command should be invoked when the receiving 280 * component is an ancestor of the focused component or is 281 * itself the focused component. 282 */ 283 public static final int WHEN_ANCESTOR_OF_FOCUSED_COMPONENT = 1; 284 285 /** 286 * Constant used for <code>registerKeyboardAction</code> that 287 * means that the command should be invoked when 288 * the receiving component is in the window that has the focus 289 * or is itself the focused component. 290 */ 291 public static final int WHEN_IN_FOCUSED_WINDOW = 2; 292 293 /** 294 * Constant used by some of the APIs to mean that no condition is defined. 295 */ 296 public static final int UNDEFINED_CONDITION = -1; 297 298 /** 299 * The key used by <code>JComponent</code> to access keyboard bindings. 300 */ 301 private static final String KEYBOARD_BINDINGS_KEY = "_KeyboardBindings"; 302 303 /** 304 * An array of <code>KeyStroke</code>s used for 305 * <code>WHEN_IN_FOCUSED_WINDOW</code> are stashed 306 * in the client properties under this string. 307 */ 308 private static final String WHEN_IN_FOCUSED_WINDOW_BINDINGS = "_WhenInFocusedWindow"; 309 310 /** 311 * The comment to display when the cursor is over the component, 312 * also known as a "value tip", "flyover help", or "flyover label". 313 */ 314 public static final String TOOL_TIP_TEXT_KEY = "ToolTipText"; 315 316 private static final String NEXT_FOCUS = "nextFocus"; 317 318 /** 319 * <code>JPopupMenu</code> assigned to this component 320 * and all of its childrens 321 */ 322 private JPopupMenu popupMenu; 323 324 /** Private flags **/ 325 private static final int IS_DOUBLE_BUFFERED = 0; 326 private static final int ANCESTOR_USING_BUFFER = 1; 327 private static final int IS_PAINTING_TILE = 2; 328 private static final int IS_OPAQUE = 3; 329 private static final int KEY_EVENTS_ENABLED = 4; 330 private static final int FOCUS_INPUTMAP_CREATED = 5; 331 private static final int ANCESTOR_INPUTMAP_CREATED = 6; 332 private static final int WIF_INPUTMAP_CREATED = 7; 333 private static final int ACTIONMAP_CREATED = 8; 334 private static final int CREATED_DOUBLE_BUFFER = 9; 335 // bit 10 is free 336 private static final int IS_PRINTING = 11; 337 private static final int IS_PRINTING_ALL = 12; 338 private static final int IS_REPAINTING = 13; 339 /** Bits 14-21 are used to handle nested writeObject calls. **/ 340 private static final int WRITE_OBJ_COUNTER_FIRST = 14; 341 private static final int RESERVED_1 = 15; 342 private static final int RESERVED_2 = 16; 343 private static final int RESERVED_3 = 17; 344 private static final int RESERVED_4 = 18; 345 private static final int RESERVED_5 = 19; 346 private static final int RESERVED_6 = 20; 347 private static final int WRITE_OBJ_COUNTER_LAST = 21; 348 349 private static final int REQUEST_FOCUS_DISABLED = 22; 350 private static final int INHERITS_POPUP_MENU = 23; 351 private static final int OPAQUE_SET = 24; 352 private static final int AUTOSCROLLS_SET = 25; 353 private static final int FOCUS_TRAVERSAL_KEYS_FORWARD_SET = 26; 354 private static final int FOCUS_TRAVERSAL_KEYS_BACKWARD_SET = 27; 355 private static final int REVALIDATE_RUNNABLE_SCHEDULED = 28; 356 357 /** 358 * Temporary rectangles. 359 */ 360 private static java.util.List<Rectangle> tempRectangles = new java.util.ArrayList<Rectangle>(11); 361 362 /** Used for <code>WHEN_FOCUSED</code> bindings. */ 363 private InputMap focusInputMap; 364 /** Used for <code>WHEN_ANCESTOR_OF_FOCUSED_COMPONENT</code> bindings. */ 365 private InputMap ancestorInputMap; 366 /** Used for <code>WHEN_IN_FOCUSED_KEY</code> bindings. */ 367 private ComponentInputMap windowInputMap; 368 369 /** ActionMap. */ 370 private ActionMap actionMap; 371 372 /** Key used to store the default locale in an AppContext **/ 373 private static final String defaultLocale = "JComponent.defaultLocale"; 374 375 private static Component componentObtainingGraphicsFrom; 376 private static Object componentObtainingGraphicsFromLock = new 377 StringBuilder("componentObtainingGraphicsFrom"); 378 379 /** 380 * AA text hints. 381 */ 382 transient private Object aaTextInfo; 383 384 static Graphics safelyGetGraphics(Component c) { 385 return safelyGetGraphics(c, SwingUtilities.getRoot(c)); 386 } 387 388 static Graphics safelyGetGraphics(Component c, Component root) { 389 synchronized(componentObtainingGraphicsFromLock) { 390 componentObtainingGraphicsFrom = root; 391 Graphics g = c.getGraphics(); 392 componentObtainingGraphicsFrom = null; 393 return g; 394 } 395 } 396 397 static void getGraphicsInvoked(Component root) { 398 if (!JComponent.isComponentObtainingGraphicsFrom(root)) { 399 JRootPane rootPane = ((RootPaneContainer)root).getRootPane(); 400 if (rootPane != null) { 401 rootPane.disableTrueDoubleBuffering(); 402 } 403 } 404 } 405 406 407 /** 408 * Returns true if {@code c} is the component the graphics is being 409 * requested of. This is intended for use when getGraphics is invoked. 410 */ 411 private static boolean isComponentObtainingGraphicsFrom(Component c) { 412 synchronized(componentObtainingGraphicsFromLock) { 413 return (componentObtainingGraphicsFrom == c); 414 } 415 } 416 417 /** 418 * Returns the Set of <code>KeyStroke</code>s to use if the component 419 * is managing focus for forward focus traversal. 420 */ 421 static Set<KeyStroke> getManagingFocusForwardTraversalKeys() { 422 synchronized(JComponent.class) { 423 if (managingFocusForwardTraversalKeys == null) { 424 managingFocusForwardTraversalKeys = new HashSet<KeyStroke>(1); 425 managingFocusForwardTraversalKeys.add( 426 KeyStroke.getKeyStroke(KeyEvent.VK_TAB, 427 InputEvent.CTRL_MASK)); 428 } 429 } 430 return managingFocusForwardTraversalKeys; 431 } 432 433 /** 434 * Returns the Set of <code>KeyStroke</code>s to use if the component 435 * is managing focus for backward focus traversal. 436 */ 437 static Set<KeyStroke> getManagingFocusBackwardTraversalKeys() { 438 synchronized(JComponent.class) { 439 if (managingFocusBackwardTraversalKeys == null) { 440 managingFocusBackwardTraversalKeys = new HashSet<KeyStroke>(1); 441 managingFocusBackwardTraversalKeys.add( 442 KeyStroke.getKeyStroke(KeyEvent.VK_TAB, 443 InputEvent.SHIFT_MASK | 444 InputEvent.CTRL_MASK)); 445 } 446 } 447 return managingFocusBackwardTraversalKeys; 448 } 449 450 private static Rectangle fetchRectangle() { 451 synchronized(tempRectangles) { 452 Rectangle rect; 453 int size = tempRectangles.size(); 454 if (size > 0) { 455 rect = tempRectangles.remove(size - 1); 456 } 457 else { 458 rect = new Rectangle(0, 0, 0, 0); 459 } 460 return rect; 461 } 462 } 463 464 private static void recycleRectangle(Rectangle rect) { 465 synchronized(tempRectangles) { 466 tempRectangles.add(rect); 467 } 468 } 469 470 /** 471 * Sets whether or not <code>getComponentPopupMenu</code> should delegate 472 * to the parent if this component does not have a <code>JPopupMenu</code> 473 * assigned to it. 474 * <p> 475 * The default value for this is false, but some <code>JComponent</code> 476 * subclasses that are implemented as a number of <code>JComponent</code>s 477 * may set this to true. 478 * <p> 479 * This is a bound property. 480 * 481 * @param value whether or not the JPopupMenu is inherited 482 * @see #setComponentPopupMenu 483 * @beaninfo 484 * bound: true 485 * description: Whether or not the JPopupMenu is inherited 486 * @since 1.5 487 */ 488 public void setInheritsPopupMenu(boolean value) { 489 boolean oldValue = getFlag(INHERITS_POPUP_MENU); 490 setFlag(INHERITS_POPUP_MENU, value); 491 firePropertyChange("inheritsPopupMenu", oldValue, value); 492 } 493 494 /** 495 * Returns true if the JPopupMenu should be inherited from the parent. 496 * 497 * @see #setComponentPopupMenu 498 * @since 1.5 499 */ 500 public boolean getInheritsPopupMenu() { 501 return getFlag(INHERITS_POPUP_MENU); 502 } 503 504 /** 505 * Sets the <code>JPopupMenu</code> for this <code>JComponent</code>. 506 * The UI is responsible for registering bindings and adding the necessary 507 * listeners such that the <code>JPopupMenu</code> will be shown at 508 * the appropriate time. When the <code>JPopupMenu</code> is shown 509 * depends upon the look and feel: some may show it on a mouse event, 510 * some may enable a key binding. 511 * <p> 512 * If <code>popup</code> is null, and <code>getInheritsPopupMenu</code> 513 * returns true, then <code>getComponentPopupMenu</code> will be delegated 514 * to the parent. This provides for a way to make all child components 515 * inherit the popupmenu of the parent. 516 * <p> 517 * This is a bound property. 518 * 519 * @param popup - the popup that will be assigned to this component 520 * may be null 521 * @see #getComponentPopupMenu 522 * @beaninfo 523 * bound: true 524 * preferred: true 525 * description: Popup to show 526 * @since 1.5 527 */ 528 public void setComponentPopupMenu(JPopupMenu popup) { 529 if(popup != null) { 530 enableEvents(AWTEvent.MOUSE_EVENT_MASK); 531 } 532 JPopupMenu oldPopup = this.popupMenu; 533 this.popupMenu = popup; 534 firePropertyChange("componentPopupMenu", oldPopup, popup); 535 } 536 537 /** 538 * Returns <code>JPopupMenu</code> that assigned for this component. 539 * If this component does not have a <code>JPopupMenu</code> assigned 540 * to it and <code>getInheritsPopupMenu</code> is true, this 541 * will return <code>getParent().getComponentPopupMenu()</code> (assuming 542 * the parent is valid.) 543 * 544 * @return <code>JPopupMenu</code> assigned for this component 545 * or <code>null</code> if no popup assigned 546 * @see #setComponentPopupMenu 547 * @since 1.5 548 */ 549 public JPopupMenu getComponentPopupMenu() { 550 551 if(!getInheritsPopupMenu()) { 552 return popupMenu; 553 } 554 555 if(popupMenu == null) { 556 // Search parents for its popup 557 Container parent = getParent(); 558 while (parent != null) { 559 if(parent instanceof JComponent) { 560 return ((JComponent)parent).getComponentPopupMenu(); 561 } 562 if(parent instanceof Window || 563 parent instanceof Applet) { 564 // Reached toplevel, break and return null 565 break; 566 } 567 parent = parent.getParent(); 568 } 569 return null; 570 } 571 572 return popupMenu; 573 } 574 575 /** 576 * Default <code>JComponent</code> constructor. This constructor does 577 * very little initialization beyond calling the <code>Container</code> 578 * constructor. For example, the initial layout manager is 579 * <code>null</code>. It does, however, set the component's locale 580 * property to the value returned by 581 * <code>JComponent.getDefaultLocale</code>. 582 * 583 * @see #getDefaultLocale 584 */ 585 public JComponent() { 586 super(); 587 // We enable key events on all JComponents so that accessibility 588 // bindings will work everywhere. This is a partial fix to BugID 589 // 4282211. 590 enableEvents(AWTEvent.KEY_EVENT_MASK); 591 if (isManagingFocus()) { 592 LookAndFeel.installProperty(this, 593 "focusTraversalKeysForward", 594 getManagingFocusForwardTraversalKeys()); 595 LookAndFeel.installProperty(this, 596 "focusTraversalKeysBackward", 597 getManagingFocusBackwardTraversalKeys()); 598 } 599 600 super.setLocale( JComponent.getDefaultLocale() ); 601 } 602 603 604 /** 605 * Resets the UI property to a value from the current look and feel. 606 * <code>JComponent</code> subclasses must override this method 607 * like this: 608 * <pre> 609 * public void updateUI() { 610 * setUI((SliderUI)UIManager.getUI(this); 611 * } 612 * </pre> 613 * 614 * @see #setUI 615 * @see UIManager#getLookAndFeel 616 * @see UIManager#getUI 617 */ 618 public void updateUI() {} 619 620 621 /** 622 * Sets the look and feel delegate for this component. 623 * <code>JComponent</code> subclasses generally override this method 624 * to narrow the argument type. For example, in <code>JSlider</code>: 625 * <pre> 626 * public void setUI(SliderUI newUI) { 627 * super.setUI(newUI); 628 * } 629 * </pre> 630 * <p> 631 * Additionally <code>JComponent</code> subclasses must provide a 632 * <code>getUI</code> method that returns the correct type. For example: 633 * <pre> 634 * public SliderUI getUI() { 635 * return (SliderUI)ui; 636 * } 637 * </pre> 638 * 639 * @param newUI the new UI delegate 640 * @see #updateUI 641 * @see UIManager#getLookAndFeel 642 * @see UIManager#getUI 643 * @beaninfo 644 * bound: true 645 * hidden: true 646 * attribute: visualUpdate true 647 * description: The component's look and feel delegate. 648 */ 649 protected void setUI(ComponentUI newUI) { 650 /* We do not check that the UI instance is different 651 * before allowing the switch in order to enable the 652 * same UI instance *with different default settings* 653 * to be installed. 654 */ 655 656 uninstallUIAndProperties(); 657 658 // aaText shouldn't persist between look and feels, reset it. 659 aaTextInfo = 660 UIManager.getDefaults().get(SwingUtilities2.AA_TEXT_PROPERTY_KEY); 661 ComponentUI oldUI = ui; 662 ui = newUI; 663 if (ui != null) { 664 ui.installUI(this); 665 } 666 667 firePropertyChange("UI", oldUI, newUI); 668 revalidate(); 669 repaint(); 670 } 671 672 /** 673 * Uninstalls the UI, if any, and any client properties designated 674 * as being specific to the installed UI - instances of 675 * {@code UIClientPropertyKey}. 676 */ 677 private void uninstallUIAndProperties() { 678 if (ui != null) { 679 ui.uninstallUI(this); 680 //clean UIClientPropertyKeys from client properties 681 if (clientProperties != null) { 682 synchronized(clientProperties) { 683 Object[] clientPropertyKeys = 684 clientProperties.getKeys(null); 685 if (clientPropertyKeys != null) { 686 for (Object key : clientPropertyKeys) { 687 if (key instanceof UIClientPropertyKey) { 688 putClientProperty(key, null); 689 } 690 } 691 } 692 } 693 } 694 } 695 } 696 697 /** 698 * Returns the <code>UIDefaults</code> key used to 699 * look up the name of the <code>swing.plaf.ComponentUI</code> 700 * class that defines the look and feel 701 * for this component. Most applications will never need to 702 * call this method. Subclasses of <code>JComponent</code> that support 703 * pluggable look and feel should override this method to 704 * return a <code>UIDefaults</code> key that maps to the 705 * <code>ComponentUI</code> subclass that defines their look and feel. 706 * 707 * @return the <code>UIDefaults</code> key for a 708 * <code>ComponentUI</code> subclass 709 * @see UIDefaults#getUI 710 * @beaninfo 711 * expert: true 712 * description: UIClassID 713 */ 714 public String getUIClassID() { 715 return uiClassID; 716 } 717 718 719 /** 720 * Returns the graphics object used to paint this component. 721 * If <code>DebugGraphics</code> is turned on we create a new 722 * <code>DebugGraphics</code> object if necessary. 723 * Otherwise we just configure the 724 * specified graphics object's foreground and font. 725 * 726 * @param g the original <code>Graphics</code> object 727 * @return a <code>Graphics</code> object configured for this component 728 */ 729 protected Graphics getComponentGraphics(Graphics g) { 730 Graphics componentGraphics = g; 731 if (ui != null && DEBUG_GRAPHICS_LOADED) { 732 if ((DebugGraphics.debugComponentCount() != 0) && 733 (shouldDebugGraphics() != 0) && 734 !(g instanceof DebugGraphics)) { 735 componentGraphics = new DebugGraphics(g,this); 736 } 737 } 738 componentGraphics.setColor(getForeground()); 739 componentGraphics.setFont(getFont()); 740 741 return componentGraphics; 742 } 743 744 745 /** 746 * Calls the UI delegate's paint method, if the UI delegate 747 * is non-<code>null</code>. We pass the delegate a copy of the 748 * <code>Graphics</code> object to protect the rest of the 749 * paint code from irrevocable changes 750 * (for example, <code>Graphics.translate</code>). 751 * <p> 752 * If you override this in a subclass you should not make permanent 753 * changes to the passed in <code>Graphics</code>. For example, you 754 * should not alter the clip <code>Rectangle</code> or modify the 755 * transform. If you need to do these operations you may find it 756 * easier to create a new <code>Graphics</code> from the passed in 757 * <code>Graphics</code> and manipulate it. Further, if you do not 758 * invoker super's implementation you must honor the opaque property, 759 * that is 760 * if this component is opaque, you must completely fill in the background 761 * in a non-opaque color. If you do not honor the opaque property you 762 * will likely see visual artifacts. 763 * <p> 764 * The passed in <code>Graphics</code> object might 765 * have a transform other than the identify transform 766 * installed on it. In this case, you might get 767 * unexpected results if you cumulatively apply 768 * another transform. 769 * 770 * @param g the <code>Graphics</code> object to protect 771 * @see #paint 772 * @see ComponentUI 773 */ 774 protected void paintComponent(Graphics g) { 775 if (ui != null) { 776 Graphics scratchGraphics = (g == null) ? null : g.create(); 777 try { 778 ui.update(scratchGraphics, this); 779 } 780 finally { 781 scratchGraphics.dispose(); 782 } 783 } 784 } 785 786 /** 787 * Paints this component's children. 788 * If <code>shouldUseBuffer</code> is true, 789 * no component ancestor has a buffer and 790 * the component children can use a buffer if they have one. 791 * Otherwise, one ancestor has a buffer currently in use and children 792 * should not use a buffer to paint. 793 * @param g the <code>Graphics</code> context in which to paint 794 * @see #paint 795 * @see java.awt.Container#paint 796 */ 797 protected void paintChildren(Graphics g) { 798 Graphics sg = g; 799 800 synchronized(getTreeLock()) { 801 int i = getComponentCount() - 1; 802 if (i < 0) { 803 return; 804 } 805 // If we are only to paint to a specific child, determine 806 // its index. 807 if (paintingChild != null && 808 (paintingChild instanceof JComponent) && 809 paintingChild.isOpaque()) { 810 for (; i >= 0; i--) { 811 if (getComponent(i) == paintingChild){ 812 break; 813 } 814 } 815 } 816 Rectangle tmpRect = fetchRectangle(); 817 boolean checkSiblings = (!isOptimizedDrawingEnabled() && 818 checkIfChildObscuredBySibling()); 819 Rectangle clipBounds = null; 820 if (checkSiblings) { 821 clipBounds = sg.getClipBounds(); 822 if (clipBounds == null) { 823 clipBounds = new Rectangle(0, 0, getWidth(), 824 getHeight()); 825 } 826 } 827 boolean printing = getFlag(IS_PRINTING); 828 final Window window = SwingUtilities.getWindowAncestor(this); 829 final boolean isWindowOpaque = window == null || window.isOpaque(); 830 for (; i >= 0 ; i--) { 831 Component comp = getComponent(i); 832 if (comp == null) { 833 continue; 834 } 835 836 final boolean isJComponent = comp instanceof JComponent; 837 838 // Enable painting of heavyweights in non-opaque windows. 839 // See 6884960 840 if ((!isWindowOpaque || isJComponent || 841 isLightweightComponent(comp)) && comp.isVisible()) 842 { 843 Rectangle cr; 844 845 cr = comp.getBounds(tmpRect); 846 847 boolean hitClip = g.hitClip(cr.x, cr.y, cr.width, 848 cr.height); 849 850 if (hitClip) { 851 if (checkSiblings && i > 0) { 852 int x = cr.x; 853 int y = cr.y; 854 int width = cr.width; 855 int height = cr.height; 856 SwingUtilities.computeIntersection 857 (clipBounds.x, clipBounds.y, 858 clipBounds.width, clipBounds.height, cr); 859 860 if(getObscuredState(i, cr.x, cr.y, cr.width, 861 cr.height) == COMPLETELY_OBSCURED) { 862 continue; 863 } 864 cr.x = x; 865 cr.y = y; 866 cr.width = width; 867 cr.height = height; 868 } 869 Graphics cg = sg.create(cr.x, cr.y, cr.width, 870 cr.height); 871 cg.setColor(comp.getForeground()); 872 cg.setFont(comp.getFont()); 873 boolean shouldSetFlagBack = false; 874 try { 875 if(isJComponent) { 876 if(getFlag(ANCESTOR_USING_BUFFER)) { 877 ((JComponent)comp).setFlag( 878 ANCESTOR_USING_BUFFER,true); 879 shouldSetFlagBack = true; 880 } 881 if(getFlag(IS_PAINTING_TILE)) { 882 ((JComponent)comp).setFlag( 883 IS_PAINTING_TILE,true); 884 shouldSetFlagBack = true; 885 } 886 if(!printing) { 887 comp.paint(cg); 888 } 889 else { 890 if (!getFlag(IS_PRINTING_ALL)) { 891 comp.print(cg); 892 } 893 else { 894 comp.printAll(cg); 895 } 896 } 897 } else { 898 // The component is either lightweight, or 899 // heavyweight in a non-opaque window 900 if (!printing) { 901 comp.paint(cg); 902 } 903 else { 904 if (!getFlag(IS_PRINTING_ALL)) { 905 comp.print(cg); 906 } 907 else { 908 comp.printAll(cg); 909 } 910 } 911 } 912 } finally { 913 cg.dispose(); 914 if(shouldSetFlagBack) { 915 ((JComponent)comp).setFlag( 916 ANCESTOR_USING_BUFFER,false); 917 ((JComponent)comp).setFlag( 918 IS_PAINTING_TILE,false); 919 } 920 } 921 } 922 } 923 924 } 925 recycleRectangle(tmpRect); 926 } 927 } 928 929 /** 930 * Paints the component's border. 931 * <p> 932 * If you override this in a subclass you should not make permanent 933 * changes to the passed in <code>Graphics</code>. For example, you 934 * should not alter the clip <code>Rectangle</code> or modify the 935 * transform. If you need to do these operations you may find it 936 * easier to create a new <code>Graphics</code> from the passed in 937 * <code>Graphics</code> and manipulate it. 938 * 939 * @param g the <code>Graphics</code> context in which to paint 940 * 941 * @see #paint 942 * @see #setBorder 943 */ 944 protected void paintBorder(Graphics g) { 945 Border border = getBorder(); 946 if (border != null) { 947 border.paintBorder(this, g, 0, 0, getWidth(), getHeight()); 948 } 949 } 950 951 952 /** 953 * Calls <code>paint</code>. Doesn't clear the background but see 954 * <code>ComponentUI.update</code>, which is called by 955 * <code>paintComponent</code>. 956 * 957 * @param g the <code>Graphics</code> context in which to paint 958 * @see #paint 959 * @see #paintComponent 960 * @see javax.swing.plaf.ComponentUI 961 */ 962 public void update(Graphics g) { 963 paint(g); 964 } 965 966 967 /** 968 * Invoked by Swing to draw components. 969 * Applications should not invoke <code>paint</code> directly, 970 * but should instead use the <code>repaint</code> method to 971 * schedule the component for redrawing. 972 * <p> 973 * This method actually delegates the work of painting to three 974 * protected methods: <code>paintComponent</code>, 975 * <code>paintBorder</code>, 976 * and <code>paintChildren</code>. They're called in the order 977 * listed to ensure that children appear on top of component itself. 978 * Generally speaking, the component and its children should not 979 * paint in the insets area allocated to the border. Subclasses can 980 * just override this method, as always. A subclass that just 981 * wants to specialize the UI (look and feel) delegate's 982 * <code>paint</code> method should just override 983 * <code>paintComponent</code>. 984 * 985 * @param g the <code>Graphics</code> context in which to paint 986 * @see #paintComponent 987 * @see #paintBorder 988 * @see #paintChildren 989 * @see #getComponentGraphics 990 * @see #repaint 991 */ 992 public void paint(Graphics g) { 993 boolean shouldClearPaintFlags = false; 994 995 if ((getWidth() <= 0) || (getHeight() <= 0)) { 996 return; 997 } 998 999 Graphics componentGraphics = getComponentGraphics(g); 1000 Graphics co = componentGraphics.create(); 1001 try { 1002 RepaintManager repaintManager = RepaintManager.currentManager(this); 1003 Rectangle clipRect = co.getClipBounds(); 1004 int clipX; 1005 int clipY; 1006 int clipW; 1007 int clipH; 1008 if (clipRect == null) { 1009 clipX = clipY = 0; 1010 clipW = getWidth(); 1011 clipH = getHeight(); 1012 } 1013 else { 1014 clipX = clipRect.x; 1015 clipY = clipRect.y; 1016 clipW = clipRect.width; 1017 clipH = clipRect.height; 1018 } 1019 1020 if(clipW > getWidth()) { 1021 clipW = getWidth(); 1022 } 1023 if(clipH > getHeight()) { 1024 clipH = getHeight(); 1025 } 1026 1027 if(getParent() != null && !(getParent() instanceof JComponent)) { 1028 adjustPaintFlags(); 1029 shouldClearPaintFlags = true; 1030 } 1031 1032 int bw,bh; 1033 boolean printing = getFlag(IS_PRINTING); 1034 if (!printing && repaintManager.isDoubleBufferingEnabled() && 1035 !getFlag(ANCESTOR_USING_BUFFER) && isDoubleBuffered() && 1036 (getFlag(IS_REPAINTING) || repaintManager.isPainting())) 1037 { 1038 repaintManager.beginPaint(); 1039 try { 1040 repaintManager.paint(this, this, co, clipX, clipY, clipW, 1041 clipH); 1042 } finally { 1043 repaintManager.endPaint(); 1044 } 1045 } 1046 else { 1047 // Will ocassionaly happen in 1.2, especially when printing. 1048 if (clipRect == null) { 1049 co.setClip(clipX, clipY, clipW, clipH); 1050 } 1051 1052 if (!rectangleIsObscured(clipX,clipY,clipW,clipH)) { 1053 if (!printing) { 1054 paintComponent(co); 1055 paintBorder(co); 1056 } 1057 else { 1058 printComponent(co); 1059 printBorder(co); 1060 } 1061 } 1062 if (!printing) { 1063 paintChildren(co); 1064 } 1065 else { 1066 printChildren(co); 1067 } 1068 } 1069 } finally { 1070 co.dispose(); 1071 if(shouldClearPaintFlags) { 1072 setFlag(ANCESTOR_USING_BUFFER,false); 1073 setFlag(IS_PAINTING_TILE,false); 1074 setFlag(IS_PRINTING,false); 1075 setFlag(IS_PRINTING_ALL,false); 1076 } 1077 } 1078 } 1079 1080 // paint forcing use of the double buffer. This is used for historical 1081 // reasons: JViewport, when scrolling, previously directly invoked paint 1082 // while turning off double buffering at the RepaintManager level, this 1083 // codes simulates that. 1084 void paintForceDoubleBuffered(Graphics g) { 1085 RepaintManager rm = RepaintManager.currentManager(this); 1086 Rectangle clip = g.getClipBounds(); 1087 rm.beginPaint(); 1088 setFlag(IS_REPAINTING, true); 1089 try { 1090 rm.paint(this, this, g, clip.x, clip.y, clip.width, clip.height); 1091 } finally { 1092 rm.endPaint(); 1093 setFlag(IS_REPAINTING, false); 1094 } 1095 } 1096 1097 /** 1098 * Returns true if this component, or any of its ancestors, are in 1099 * the processing of painting. 1100 */ 1101 boolean isPainting() { 1102 Container component = this; 1103 while (component != null) { 1104 if (component instanceof JComponent && 1105 ((JComponent)component).getFlag(ANCESTOR_USING_BUFFER)) { 1106 return true; 1107 } 1108 component = component.getParent(); 1109 } 1110 return false; 1111 } 1112 1113 private void adjustPaintFlags() { 1114 JComponent jparent; 1115 Container parent; 1116 for(parent = getParent() ; parent != null ; parent = 1117 parent.getParent()) { 1118 if(parent instanceof JComponent) { 1119 jparent = (JComponent) parent; 1120 if(jparent.getFlag(ANCESTOR_USING_BUFFER)) 1121 setFlag(ANCESTOR_USING_BUFFER, true); 1122 if(jparent.getFlag(IS_PAINTING_TILE)) 1123 setFlag(IS_PAINTING_TILE, true); 1124 if(jparent.getFlag(IS_PRINTING)) 1125 setFlag(IS_PRINTING, true); 1126 if(jparent.getFlag(IS_PRINTING_ALL)) 1127 setFlag(IS_PRINTING_ALL, true); 1128 break; 1129 } 1130 } 1131 } 1132 1133 /** 1134 * Invoke this method to print the component. This method invokes 1135 * <code>print</code> on the component. 1136 * 1137 * @param g the <code>Graphics</code> context in which to paint 1138 * @see #print 1139 * @see #printComponent 1140 * @see #printBorder 1141 * @see #printChildren 1142 */ 1143 public void printAll(Graphics g) { 1144 setFlag(IS_PRINTING_ALL, true); 1145 try { 1146 print(g); 1147 } 1148 finally { 1149 setFlag(IS_PRINTING_ALL, false); 1150 } 1151 } 1152 1153 /** 1154 * Invoke this method to print the component to the specified 1155 * <code>Graphics</code>. This method will result in invocations 1156 * of <code>printComponent</code>, <code>printBorder</code> and 1157 * <code>printChildren</code>. It is recommended that you override 1158 * one of the previously mentioned methods rather than this one if 1159 * your intention is to customize the way printing looks. However, 1160 * it can be useful to override this method should you want to prepare 1161 * state before invoking the superclass behavior. As an example, 1162 * if you wanted to change the component's background color before 1163 * printing, you could do the following: 1164 * <pre> 1165 * public void print(Graphics g) { 1166 * Color orig = getBackground(); 1167 * setBackground(Color.WHITE); 1168 * 1169 * // wrap in try/finally so that we always restore the state 1170 * try { 1171 * super.print(g); 1172 * } finally { 1173 * setBackground(orig); 1174 * } 1175 * } 1176 * </pre> 1177 * <p> 1178 * Alternatively, or for components that delegate painting to other objects, 1179 * you can query during painting whether or not the component is in the 1180 * midst of a print operation. The <code>isPaintingForPrint</code> method provides 1181 * this ability and its return value will be changed by this method: to 1182 * <code>true</code> immediately before rendering and to <code>false</code> 1183 * immediately after. With each change a property change event is fired on 1184 * this component with the name <code>"paintingForPrint"</code>. 1185 * <p> 1186 * This method sets the component's state such that the double buffer 1187 * will not be used: painting will be done directly on the passed in 1188 * <code>Graphics</code>. 1189 * 1190 * @param g the <code>Graphics</code> context in which to paint 1191 * @see #printComponent 1192 * @see #printBorder 1193 * @see #printChildren 1194 * @see #isPaintingForPrint 1195 */ 1196 public void print(Graphics g) { 1197 setFlag(IS_PRINTING, true); 1198 firePropertyChange("paintingForPrint", false, true); 1199 try { 1200 paint(g); 1201 } 1202 finally { 1203 setFlag(IS_PRINTING, false); 1204 firePropertyChange("paintingForPrint", true, false); 1205 } 1206 } 1207 1208 /** 1209 * This is invoked during a printing operation. This is implemented to 1210 * invoke <code>paintComponent</code> on the component. Override this 1211 * if you wish to add special painting behavior when printing. 1212 * 1213 * @param g the <code>Graphics</code> context in which to paint 1214 * @see #print 1215 * @since 1.3 1216 */ 1217 protected void printComponent(Graphics g) { 1218 paintComponent(g); 1219 } 1220 1221 /** 1222 * Prints this component's children. This is implemented to invoke 1223 * <code>paintChildren</code> on the component. Override this if you 1224 * wish to print the children differently than painting. 1225 * 1226 * @param g the <code>Graphics</code> context in which to paint 1227 * @see #print 1228 * @since 1.3 1229 */ 1230 protected void printChildren(Graphics g) { 1231 paintChildren(g); 1232 } 1233 1234 /** 1235 * Prints the component's border. This is implemented to invoke 1236 * <code>paintBorder</code> on the component. Override this if you 1237 * wish to print the border differently that it is painted. 1238 * 1239 * @param g the <code>Graphics</code> context in which to paint 1240 * @see #print 1241 * @since 1.3 1242 */ 1243 protected void printBorder(Graphics g) { 1244 paintBorder(g); 1245 } 1246 1247 /** 1248 * Returns true if the component is currently painting a tile. 1249 * If this method returns true, paint will be called again for another 1250 * tile. This method returns false if you are not painting a tile or 1251 * if the last tile is painted. 1252 * Use this method to keep some state you might need between tiles. 1253 * 1254 * @return true if the component is currently painting a tile, 1255 * false otherwise 1256 */ 1257 public boolean isPaintingTile() { 1258 return getFlag(IS_PAINTING_TILE); 1259 } 1260 1261 /** 1262 * Returns <code>true</code> if the current painting operation on this 1263 * component is part of a <code>print</code> operation. This method is 1264 * useful when you want to customize what you print versus what you show 1265 * on the screen. 1266 * <p> 1267 * You can detect changes in the value of this property by listening for 1268 * property change events on this component with name 1269 * <code>"paintingForPrint"</code>. 1270 * <p> 1271 * Note: This method provides complimentary functionality to that provided 1272 * by other high level Swing printing APIs. However, it deals strictly with 1273 * painting and should not be confused as providing information on higher 1274 * level print processes. For example, a {@link javax.swing.JTable#print()} 1275 * operation doesn't necessarily result in a continuous rendering of the 1276 * full component, and the return value of this method can change multiple 1277 * times during that operation. It is even possible for the component to be 1278 * painted to the screen while the printing process is ongoing. In such a 1279 * case, the return value of this method is <code>true</code> when, and only 1280 * when, the table is being painted as part of the printing process. 1281 * 1282 * @return true if the current painting operation on this component 1283 * is part of a print operation 1284 * @see #print 1285 * @since 1.6 1286 */ 1287 public final boolean isPaintingForPrint() { 1288 return getFlag(IS_PRINTING); 1289 } 1290 1291 /** 1292 * In release 1.4, the focus subsystem was rearchitected. 1293 * For more information, see 1294 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 1295 * How to Use the Focus Subsystem</a>, 1296 * a section in <em>The Java Tutorial</em>. 1297 * <p> 1298 * Changes this <code>JComponent</code>'s focus traversal keys to 1299 * CTRL+TAB and CTRL+SHIFT+TAB. Also prevents 1300 * <code>SortingFocusTraversalPolicy</code> from considering descendants 1301 * of this JComponent when computing a focus traversal cycle. 1302 * 1303 * @see java.awt.Component#setFocusTraversalKeys 1304 * @see SortingFocusTraversalPolicy 1305 * @deprecated As of 1.4, replaced by 1306 * <code>Component.setFocusTraversalKeys(int, Set)</code> and 1307 * <code>Container.setFocusCycleRoot(boolean)</code>. 1308 */ 1309 @Deprecated 1310 public boolean isManagingFocus() { 1311 return false; 1312 } 1313 1314 private void registerNextFocusableComponent() { 1315 registerNextFocusableComponent(getNextFocusableComponent()); 1316 } 1317 1318 private void registerNextFocusableComponent(Component 1319 nextFocusableComponent) { 1320 if (nextFocusableComponent == null) { 1321 return; 1322 } 1323 1324 Container nearestRoot = 1325 (isFocusCycleRoot()) ? this : getFocusCycleRootAncestor(); 1326 FocusTraversalPolicy policy = nearestRoot.getFocusTraversalPolicy(); 1327 if (!(policy instanceof LegacyGlueFocusTraversalPolicy)) { 1328 policy = new LegacyGlueFocusTraversalPolicy(policy); 1329 nearestRoot.setFocusTraversalPolicy(policy); 1330 } 1331 ((LegacyGlueFocusTraversalPolicy)policy). 1332 setNextFocusableComponent(this, nextFocusableComponent); 1333 } 1334 1335 private void deregisterNextFocusableComponent() { 1336 Component nextFocusableComponent = getNextFocusableComponent(); 1337 if (nextFocusableComponent == null) { 1338 return; 1339 } 1340 1341 Container nearestRoot = 1342 (isFocusCycleRoot()) ? this : getFocusCycleRootAncestor(); 1343 if (nearestRoot == null) { 1344 return; 1345 } 1346 FocusTraversalPolicy policy = nearestRoot.getFocusTraversalPolicy(); 1347 if (policy instanceof LegacyGlueFocusTraversalPolicy) { 1348 ((LegacyGlueFocusTraversalPolicy)policy). 1349 unsetNextFocusableComponent(this, nextFocusableComponent); 1350 } 1351 } 1352 1353 /** 1354 * In release 1.4, the focus subsystem was rearchitected. 1355 * For more information, see 1356 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 1357 * How to Use the Focus Subsystem</a>, 1358 * a section in <em>The Java Tutorial</em>. 1359 * <p> 1360 * Overrides the default <code>FocusTraversalPolicy</code> for this 1361 * <code>JComponent</code>'s focus traversal cycle by unconditionally 1362 * setting the specified <code>Component</code> as the next 1363 * <code>Component</code> in the cycle, and this <code>JComponent</code> 1364 * as the specified <code>Component</code>'s previous 1365 * <code>Component</code> in the cycle. 1366 * 1367 * @param aComponent the <code>Component</code> that should follow this 1368 * <code>JComponent</code> in the focus traversal cycle 1369 * 1370 * @see #getNextFocusableComponent 1371 * @see java.awt.FocusTraversalPolicy 1372 * @deprecated As of 1.4, replaced by <code>FocusTraversalPolicy</code> 1373 */ 1374 @Deprecated 1375 public void setNextFocusableComponent(Component aComponent) { 1376 boolean displayable = isDisplayable(); 1377 if (displayable) { 1378 deregisterNextFocusableComponent(); 1379 } 1380 putClientProperty(NEXT_FOCUS, aComponent); 1381 if (displayable) { 1382 registerNextFocusableComponent(aComponent); 1383 } 1384 } 1385 1386 /** 1387 * In release 1.4, the focus subsystem was rearchitected. 1388 * For more information, see 1389 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 1390 * How to Use the Focus Subsystem</a>, 1391 * a section in <em>The Java Tutorial</em>. 1392 * <p> 1393 * Returns the <code>Component</code> set by a prior call to 1394 * <code>setNextFocusableComponent(Component)</code> on this 1395 * <code>JComponent</code>. 1396 * 1397 * @return the <code>Component</code> that will follow this 1398 * <code>JComponent</code> in the focus traversal cycle, or 1399 * <code>null</code> if none has been explicitly specified 1400 * 1401 * @see #setNextFocusableComponent 1402 * @deprecated As of 1.4, replaced by <code>FocusTraversalPolicy</code>. 1403 */ 1404 @Deprecated 1405 public Component getNextFocusableComponent() { 1406 return (Component)getClientProperty(NEXT_FOCUS); 1407 } 1408 1409 /** 1410 * Provides a hint as to whether or not this <code>JComponent</code> 1411 * should get focus. This is only a hint, and it is up to consumers that 1412 * are requesting focus to honor this property. This is typically honored 1413 * for mouse operations, but not keyboard operations. For example, look 1414 * and feels could verify this property is true before requesting focus 1415 * during a mouse operation. This would often times be used if you did 1416 * not want a mouse press on a <code>JComponent</code> to steal focus, 1417 * but did want the <code>JComponent</code> to be traversable via the 1418 * keyboard. If you do not want this <code>JComponent</code> focusable at 1419 * all, use the <code>setFocusable</code> method instead. 1420 * <p> 1421 * Please see 1422 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 1423 * How to Use the Focus Subsystem</a>, 1424 * a section in <em>The Java Tutorial</em>, 1425 * for more information. 1426 * 1427 * @param requestFocusEnabled indicates whether you want this 1428 * <code>JComponent</code> to be focusable or not 1429 * @see <a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a> 1430 * @see java.awt.Component#setFocusable 1431 */ 1432 public void setRequestFocusEnabled(boolean requestFocusEnabled) { 1433 setFlag(REQUEST_FOCUS_DISABLED, !requestFocusEnabled); 1434 } 1435 1436 /** 1437 * Returns <code>true</code> if this <code>JComponent</code> should 1438 * get focus; otherwise returns <code>false</code>. 1439 * <p> 1440 * Please see 1441 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 1442 * How to Use the Focus Subsystem</a>, 1443 * a section in <em>The Java Tutorial</em>, 1444 * for more information. 1445 * 1446 * @return <code>true</code> if this component should get focus, 1447 * otherwise returns <code>false</code> 1448 * @see #setRequestFocusEnabled 1449 * @see <a href="../../java/awt/doc-files/FocusSpec.html">Focus 1450 * Specification</a> 1451 * @see java.awt.Component#isFocusable 1452 */ 1453 public boolean isRequestFocusEnabled() { 1454 return !getFlag(REQUEST_FOCUS_DISABLED); 1455 } 1456 1457 /** 1458 * Requests that this <code>Component</code> gets the input focus. 1459 * Refer to {@link java.awt.Component#requestFocus() 1460 * Component.requestFocus()} for a complete description of 1461 * this method. 1462 * <p> 1463 * Note that the use of this method is discouraged because 1464 * its behavior is platform dependent. Instead we recommend the 1465 * use of {@link #requestFocusInWindow() requestFocusInWindow()}. 1466 * If you would like more information on focus, see 1467 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 1468 * How to Use the Focus Subsystem</a>, 1469 * a section in <em>The Java Tutorial</em>. 1470 * 1471 * @see java.awt.Component#requestFocusInWindow() 1472 * @see java.awt.Component#requestFocusInWindow(boolean) 1473 * @since 1.4 1474 */ 1475 public void requestFocus() { 1476 super.requestFocus(); 1477 } 1478 1479 /** 1480 * Requests that this <code>Component</code> gets the input focus. 1481 * Refer to {@link java.awt.Component#requestFocus(boolean) 1482 * Component.requestFocus(boolean)} for a complete description of 1483 * this method. 1484 * <p> 1485 * Note that the use of this method is discouraged because 1486 * its behavior is platform dependent. Instead we recommend the 1487 * use of {@link #requestFocusInWindow(boolean) 1488 * requestFocusInWindow(boolean)}. 1489 * If you would like more information on focus, see 1490 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 1491 * How to Use the Focus Subsystem</a>, 1492 * a section in <em>The Java Tutorial</em>. 1493 * 1494 * @param temporary boolean indicating if the focus change is temporary 1495 * @return <code>false</code> if the focus change request is guaranteed to 1496 * fail; <code>true</code> if it is likely to succeed 1497 * @see java.awt.Component#requestFocusInWindow() 1498 * @see java.awt.Component#requestFocusInWindow(boolean) 1499 * @since 1.4 1500 */ 1501 public boolean requestFocus(boolean temporary) { 1502 return super.requestFocus(temporary); 1503 } 1504 1505 /** 1506 * Requests that this <code>Component</code> gets the input focus. 1507 * Refer to {@link java.awt.Component#requestFocusInWindow() 1508 * Component.requestFocusInWindow()} for a complete description of 1509 * this method. 1510 * <p> 1511 * If you would like more information on focus, see 1512 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 1513 * How to Use the Focus Subsystem</a>, 1514 * a section in <em>The Java Tutorial</em>. 1515 * 1516 * @return <code>false</code> if the focus change request is guaranteed to 1517 * fail; <code>true</code> if it is likely to succeed 1518 * @see java.awt.Component#requestFocusInWindow() 1519 * @see java.awt.Component#requestFocusInWindow(boolean) 1520 * @since 1.4 1521 */ 1522 public boolean requestFocusInWindow() { 1523 return super.requestFocusInWindow(); 1524 } 1525 1526 /** 1527 * Requests that this <code>Component</code> gets the input focus. 1528 * Refer to {@link java.awt.Component#requestFocusInWindow(boolean) 1529 * Component.requestFocusInWindow(boolean)} for a complete description of 1530 * this method. 1531 * <p> 1532 * If you would like more information on focus, see 1533 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 1534 * How to Use the Focus Subsystem</a>, 1535 * a section in <em>The Java Tutorial</em>. 1536 * 1537 * @param temporary boolean indicating if the focus change is temporary 1538 * @return <code>false</code> if the focus change request is guaranteed to 1539 * fail; <code>true</code> if it is likely to succeed 1540 * @see java.awt.Component#requestFocusInWindow() 1541 * @see java.awt.Component#requestFocusInWindow(boolean) 1542 * @since 1.4 1543 */ 1544 protected boolean requestFocusInWindow(boolean temporary) { 1545 return super.requestFocusInWindow(temporary); 1546 } 1547 1548 /** 1549 * Requests that this Component get the input focus, and that this 1550 * Component's top-level ancestor become the focused Window. This component 1551 * must be displayable, visible, and focusable for the request to be 1552 * granted. 1553 * <p> 1554 * This method is intended for use by focus implementations. Client code 1555 * should not use this method; instead, it should use 1556 * <code>requestFocusInWindow()</code>. 1557 * 1558 * @see #requestFocusInWindow() 1559 */ 1560 public void grabFocus() { 1561 requestFocus(); 1562 } 1563 1564 /** 1565 * Sets the value to indicate whether input verifier for the 1566 * current focus owner will be called before this component requests 1567 * focus. The default is true. Set to false on components such as a 1568 * Cancel button or a scrollbar, which should activate even if the 1569 * input in the current focus owner is not "passed" by the input 1570 * verifier for that component. 1571 * 1572 * @param verifyInputWhenFocusTarget value for the 1573 * <code>verifyInputWhenFocusTarget</code> property 1574 * @see InputVerifier 1575 * @see #setInputVerifier 1576 * @see #getInputVerifier 1577 * @see #getVerifyInputWhenFocusTarget 1578 * 1579 * @since 1.3 1580 * @beaninfo 1581 * bound: true 1582 * description: Whether the Component verifies input before accepting 1583 * focus. 1584 */ 1585 public void setVerifyInputWhenFocusTarget(boolean 1586 verifyInputWhenFocusTarget) { 1587 boolean oldVerifyInputWhenFocusTarget = 1588 this.verifyInputWhenFocusTarget; 1589 this.verifyInputWhenFocusTarget = verifyInputWhenFocusTarget; 1590 firePropertyChange("verifyInputWhenFocusTarget", 1591 oldVerifyInputWhenFocusTarget, 1592 verifyInputWhenFocusTarget); 1593 } 1594 1595 /** 1596 * Returns the value that indicates whether the input verifier for the 1597 * current focus owner will be called before this component requests 1598 * focus. 1599 * 1600 * @return value of the <code>verifyInputWhenFocusTarget</code> property 1601 * 1602 * @see InputVerifier 1603 * @see #setInputVerifier 1604 * @see #getInputVerifier 1605 * @see #setVerifyInputWhenFocusTarget 1606 * 1607 * @since 1.3 1608 */ 1609 public boolean getVerifyInputWhenFocusTarget() { 1610 return verifyInputWhenFocusTarget; 1611 } 1612 1613 1614 /** 1615 * Gets the <code>FontMetrics</code> for the specified <code>Font</code>. 1616 * 1617 * @param font the font for which font metrics is to be 1618 * obtained 1619 * @return the font metrics for <code>font</code> 1620 * @throws NullPointerException if <code>font</code> is null 1621 * @since 1.5 1622 */ 1623 public FontMetrics getFontMetrics(Font font) { 1624 return SwingUtilities2.getFontMetrics(this, font); 1625 } 1626 1627 1628 /** 1629 * Sets the preferred size of this component. 1630 * If <code>preferredSize</code> is <code>null</code>, the UI will 1631 * be asked for the preferred size. 1632 * @beaninfo 1633 * preferred: true 1634 * bound: true 1635 * description: The preferred size of the component. 1636 */ 1637 public void setPreferredSize(Dimension preferredSize) { 1638 super.setPreferredSize(preferredSize); 1639 } 1640 1641 1642 /** 1643 * If the <code>preferredSize</code> has been set to a 1644 * non-<code>null</code> value just returns it. 1645 * If the UI delegate's <code>getPreferredSize</code> 1646 * method returns a non <code>null</code> value then return that; 1647 * otherwise defer to the component's layout manager. 1648 * 1649 * @return the value of the <code>preferredSize</code> property 1650 * @see #setPreferredSize 1651 * @see ComponentUI 1652 */ 1653 @Transient 1654 public Dimension getPreferredSize() { 1655 if (isPreferredSizeSet()) { 1656 return super.getPreferredSize(); 1657 } 1658 Dimension size = null; 1659 if (ui != null) { 1660 size = ui.getPreferredSize(this); 1661 } 1662 return (size != null) ? size : super.getPreferredSize(); 1663 } 1664 1665 1666 /** 1667 * Sets the maximum size of this component to a constant 1668 * value. Subsequent calls to <code>getMaximumSize</code> will always 1669 * return this value; the component's UI will not be asked 1670 * to compute it. Setting the maximum size to <code>null</code> 1671 * restores the default behavior. 1672 * 1673 * @param maximumSize a <code>Dimension</code> containing the 1674 * desired maximum allowable size 1675 * @see #getMaximumSize 1676 * @beaninfo 1677 * bound: true 1678 * description: The maximum size of the component. 1679 */ 1680 public void setMaximumSize(Dimension maximumSize) { 1681 super.setMaximumSize(maximumSize); 1682 } 1683 1684 1685 /** 1686 * If the maximum size has been set to a non-<code>null</code> value 1687 * just returns it. If the UI delegate's <code>getMaximumSize</code> 1688 * method returns a non-<code>null</code> value then return that; 1689 * otherwise defer to the component's layout manager. 1690 * 1691 * @return the value of the <code>maximumSize</code> property 1692 * @see #setMaximumSize 1693 * @see ComponentUI 1694 */ 1695 @Transient 1696 public Dimension getMaximumSize() { 1697 if (isMaximumSizeSet()) { 1698 return super.getMaximumSize(); 1699 } 1700 Dimension size = null; 1701 if (ui != null) { 1702 size = ui.getMaximumSize(this); 1703 } 1704 return (size != null) ? size : super.getMaximumSize(); 1705 } 1706 1707 1708 /** 1709 * Sets the minimum size of this component to a constant 1710 * value. Subsequent calls to <code>getMinimumSize</code> will always 1711 * return this value; the component's UI will not be asked 1712 * to compute it. Setting the minimum size to <code>null</code> 1713 * restores the default behavior. 1714 * 1715 * @param minimumSize the new minimum size of this component 1716 * @see #getMinimumSize 1717 * @beaninfo 1718 * bound: true 1719 * description: The minimum size of the component. 1720 */ 1721 public void setMinimumSize(Dimension minimumSize) { 1722 super.setMinimumSize(minimumSize); 1723 } 1724 1725 /** 1726 * If the minimum size has been set to a non-<code>null</code> value 1727 * just returns it. If the UI delegate's <code>getMinimumSize</code> 1728 * method returns a non-<code>null</code> value then return that; otherwise 1729 * defer to the component's layout manager. 1730 * 1731 * @return the value of the <code>minimumSize</code> property 1732 * @see #setMinimumSize 1733 * @see ComponentUI 1734 */ 1735 @Transient 1736 public Dimension getMinimumSize() { 1737 if (isMinimumSizeSet()) { 1738 return super.getMinimumSize(); 1739 } 1740 Dimension size = null; 1741 if (ui != null) { 1742 size = ui.getMinimumSize(this); 1743 } 1744 return (size != null) ? size : super.getMinimumSize(); 1745 } 1746 1747 /** 1748 * Gives the UI delegate an opportunity to define the precise 1749 * shape of this component for the sake of mouse processing. 1750 * 1751 * @return true if this component logically contains x,y 1752 * @see java.awt.Component#contains(int, int) 1753 * @see ComponentUI 1754 */ 1755 public boolean contains(int x, int y) { 1756 return (ui != null) ? ui.contains(this, x, y) : super.contains(x, y); 1757 } 1758 1759 /** 1760 * Sets the border of this component. The <code>Border</code> object is 1761 * responsible for defining the insets for the component 1762 * (overriding any insets set directly on the component) and 1763 * for optionally rendering any border decorations within the 1764 * bounds of those insets. Borders should be used (rather 1765 * than insets) for creating both decorative and non-decorative 1766 * (such as margins and padding) regions for a swing component. 1767 * Compound borders can be used to nest multiple borders within a 1768 * single component. 1769 * <p> 1770 * Although technically you can set the border on any object 1771 * that inherits from <code>JComponent</code>, the look and 1772 * feel implementation of many standard Swing components 1773 * doesn't work well with user-set borders. In general, 1774 * when you want to set a border on a standard Swing 1775 * component other than <code>JPanel</code> or <code>JLabel</code>, 1776 * we recommend that you put the component in a <code>JPanel</code> 1777 * and set the border on the <code>JPanel</code>. 1778 * <p> 1779 * This is a bound property. 1780 * 1781 * @param border the border to be rendered for this component 1782 * @see Border 1783 * @see CompoundBorder 1784 * @beaninfo 1785 * bound: true 1786 * preferred: true 1787 * attribute: visualUpdate true 1788 * description: The component's border. 1789 */ 1790 public void setBorder(Border border) { 1791 Border oldBorder = this.border; 1792 1793 this.border = border; 1794 firePropertyChange("border", oldBorder, border); 1795 if (border != oldBorder) { 1796 if (border == null || oldBorder == null || 1797 !(border.getBorderInsets(this).equals(oldBorder.getBorderInsets(this)))) { 1798 revalidate(); 1799 } 1800 repaint(); 1801 } 1802 } 1803 1804 /** 1805 * Returns the border of this component or <code>null</code> if no 1806 * border is currently set. 1807 * 1808 * @return the border object for this component 1809 * @see #setBorder 1810 */ 1811 public Border getBorder() { 1812 return border; 1813 } 1814 1815 /** 1816 * If a border has been set on this component, returns the 1817 * border's insets; otherwise calls <code>super.getInsets</code>. 1818 * 1819 * @return the value of the insets property 1820 * @see #setBorder 1821 */ 1822 public Insets getInsets() { 1823 if (border != null) { 1824 return border.getBorderInsets(this); 1825 } 1826 return super.getInsets(); 1827 } 1828 1829 /** 1830 * Returns an <code>Insets</code> object containing this component's inset 1831 * values. The passed-in <code>Insets</code> object will be reused 1832 * if possible. 1833 * Calling methods cannot assume that the same object will be returned, 1834 * however. All existing values within this object are overwritten. 1835 * If <code>insets</code> is null, this will allocate a new one. 1836 * 1837 * @param insets the <code>Insets</code> object, which can be reused 1838 * @return the <code>Insets</code> object 1839 * @see #getInsets 1840 * @beaninfo 1841 * expert: true 1842 */ 1843 public Insets getInsets(Insets insets) { 1844 if (insets == null) { 1845 insets = new Insets(0, 0, 0, 0); 1846 } 1847 if (border != null) { 1848 if (border instanceof AbstractBorder) { 1849 return ((AbstractBorder)border).getBorderInsets(this, insets); 1850 } else { 1851 // Can't reuse border insets because the Border interface 1852 // can't be enhanced. 1853 return border.getBorderInsets(this); 1854 } 1855 } else { 1856 // super.getInsets() always returns an Insets object with 1857 // all of its value zeroed. No need for a new object here. 1858 insets.left = insets.top = insets.right = insets.bottom = 0; 1859 return insets; 1860 } 1861 } 1862 1863 /** 1864 * Overrides <code>Container.getAlignmentY</code> to return 1865 * the horizontal alignment. 1866 * 1867 * @return the value of the <code>alignmentY</code> property 1868 * @see #setAlignmentY 1869 * @see java.awt.Component#getAlignmentY 1870 */ 1871 public float getAlignmentY() { 1872 if (isAlignmentYSet) { 1873 return alignmentY; 1874 } 1875 return super.getAlignmentY(); 1876 } 1877 1878 /** 1879 * Sets the the horizontal alignment. 1880 * 1881 * @param alignmentY the new horizontal alignment 1882 * @see #getAlignmentY 1883 * @beaninfo 1884 * description: The preferred vertical alignment of the component. 1885 */ 1886 public void setAlignmentY(float alignmentY) { 1887 this.alignmentY = alignmentY > 1.0f ? 1.0f : alignmentY < 0.0f ? 0.0f : alignmentY; 1888 isAlignmentYSet = true; 1889 } 1890 1891 1892 /** 1893 * Overrides <code>Container.getAlignmentX</code> to return 1894 * the vertical alignment. 1895 * 1896 * @return the value of the <code>alignmentX</code> property 1897 * @see #setAlignmentX 1898 * @see java.awt.Component#getAlignmentX 1899 */ 1900 public float getAlignmentX() { 1901 if (isAlignmentXSet) { 1902 return alignmentX; 1903 } 1904 return super.getAlignmentX(); 1905 } 1906 1907 /** 1908 * Sets the the vertical alignment. 1909 * 1910 * @param alignmentX the new vertical alignment 1911 * @see #getAlignmentX 1912 * @beaninfo 1913 * description: The preferred horizontal alignment of the component. 1914 */ 1915 public void setAlignmentX(float alignmentX) { 1916 this.alignmentX = alignmentX > 1.0f ? 1.0f : alignmentX < 0.0f ? 0.0f : alignmentX; 1917 isAlignmentXSet = true; 1918 } 1919 1920 /** 1921 * Sets the input verifier for this component. 1922 * 1923 * @param inputVerifier the new input verifier 1924 * @since 1.3 1925 * @see InputVerifier 1926 * @beaninfo 1927 * bound: true 1928 * description: The component's input verifier. 1929 */ 1930 public void setInputVerifier(InputVerifier inputVerifier) { 1931 InputVerifier oldInputVerifier = (InputVerifier)getClientProperty( 1932 JComponent_INPUT_VERIFIER); 1933 putClientProperty(JComponent_INPUT_VERIFIER, inputVerifier); 1934 firePropertyChange("inputVerifier", oldInputVerifier, inputVerifier); 1935 } 1936 1937 /** 1938 * Returns the input verifier for this component. 1939 * 1940 * @return the <code>inputVerifier</code> property 1941 * @since 1.3 1942 * @see InputVerifier 1943 */ 1944 public InputVerifier getInputVerifier() { 1945 return (InputVerifier)getClientProperty(JComponent_INPUT_VERIFIER); 1946 } 1947 1948 /** 1949 * Returns this component's graphics context, which lets you draw 1950 * on a component. Use this method to get a <code>Graphics</code> object and 1951 * then invoke operations on that object to draw on the component. 1952 * @return this components graphics context 1953 */ 1954 public Graphics getGraphics() { 1955 if (DEBUG_GRAPHICS_LOADED && shouldDebugGraphics() != 0) { 1956 DebugGraphics graphics = new DebugGraphics(super.getGraphics(), 1957 this); 1958 return graphics; 1959 } 1960 return super.getGraphics(); 1961 } 1962 1963 1964 /** Enables or disables diagnostic information about every graphics 1965 * operation performed within the component or one of its children. 1966 * 1967 * @param debugOptions determines how the component should display 1968 * the information; one of the following options: 1969 * <ul> 1970 * <li>DebugGraphics.LOG_OPTION - causes a text message to be printed. 1971 * <li>DebugGraphics.FLASH_OPTION - causes the drawing to flash several 1972 * times. 1973 * <li>DebugGraphics.BUFFERED_OPTION - creates an 1974 * <code>ExternalWindow</code> that displays the operations 1975 * performed on the View's offscreen buffer. 1976 * <li>DebugGraphics.NONE_OPTION disables debugging. 1977 * <li>A value of 0 causes no changes to the debugging options. 1978 * </ul> 1979 * <code>debugOptions</code> is bitwise OR'd into the current value 1980 * 1981 * @beaninfo 1982 * preferred: true 1983 * enum: NONE_OPTION DebugGraphics.NONE_OPTION 1984 * LOG_OPTION DebugGraphics.LOG_OPTION 1985 * FLASH_OPTION DebugGraphics.FLASH_OPTION 1986 * BUFFERED_OPTION DebugGraphics.BUFFERED_OPTION 1987 * description: Diagnostic options for graphics operations. 1988 */ 1989 public void setDebugGraphicsOptions(int debugOptions) { 1990 DebugGraphics.setDebugOptions(this, debugOptions); 1991 } 1992 1993 /** Returns the state of graphics debugging. 1994 * 1995 * @return a bitwise OR'd flag of zero or more of the following options: 1996 * <ul> 1997 * <li>DebugGraphics.LOG_OPTION - causes a text message to be printed. 1998 * <li>DebugGraphics.FLASH_OPTION - causes the drawing to flash several 1999 * times. 2000 * <li>DebugGraphics.BUFFERED_OPTION - creates an 2001 * <code>ExternalWindow</code> that displays the operations 2002 * performed on the View's offscreen buffer. 2003 * <li>DebugGraphics.NONE_OPTION disables debugging. 2004 * <li>A value of 0 causes no changes to the debugging options. 2005 * </ul> 2006 * @see #setDebugGraphicsOptions 2007 */ 2008 public int getDebugGraphicsOptions() { 2009 return DebugGraphics.getDebugOptions(this); 2010 } 2011 2012 2013 /** 2014 * Returns true if debug information is enabled for this 2015 * <code>JComponent</code> or one of its parents. 2016 */ 2017 int shouldDebugGraphics() { 2018 return DebugGraphics.shouldComponentDebug(this); 2019 } 2020 2021 /** 2022 * This method is now obsolete, please use a combination of 2023 * <code>getActionMap()</code> and <code>getInputMap()</code> for 2024 * similiar behavior. For example, to bind the <code>KeyStroke</code> 2025 * <code>aKeyStroke</code> to the <code>Action</code> <code>anAction</code> 2026 * now use: 2027 * <pre> 2028 * component.getInputMap().put(aKeyStroke, aCommand); 2029 * component.getActionMap().put(aCommmand, anAction); 2030 * </pre> 2031 * The above assumes you want the binding to be applicable for 2032 * <code>WHEN_FOCUSED</code>. To register bindings for other focus 2033 * states use the <code>getInputMap</code> method that takes an integer. 2034 * <p> 2035 * Register a new keyboard action. 2036 * <code>anAction</code> will be invoked if a key event matching 2037 * <code>aKeyStroke</code> occurs and <code>aCondition</code> is verified. 2038 * The <code>KeyStroke</code> object defines a 2039 * particular combination of a keyboard key and one or more modifiers 2040 * (alt, shift, ctrl, meta). 2041 * <p> 2042 * The <code>aCommand</code> will be set in the delivered event if 2043 * specified. 2044 * <p> 2045 * The <code>aCondition</code> can be one of: 2046 * <blockquote> 2047 * <DL> 2048 * <DT>WHEN_FOCUSED 2049 * <DD>The action will be invoked only when the keystroke occurs 2050 * while the component has the focus. 2051 * <DT>WHEN_IN_FOCUSED_WINDOW 2052 * <DD>The action will be invoked when the keystroke occurs while 2053 * the component has the focus or if the component is in the 2054 * window that has the focus. Note that the component need not 2055 * be an immediate descendent of the window -- it can be 2056 * anywhere in the window's containment hierarchy. In other 2057 * words, whenever <em>any</em> component in the window has the focus, 2058 * the action registered with this component is invoked. 2059 * <DT>WHEN_ANCESTOR_OF_FOCUSED_COMPONENT 2060 * <DD>The action will be invoked when the keystroke occurs while the 2061 * component has the focus or if the component is an ancestor of 2062 * the component that has the focus. 2063 * </DL> 2064 * </blockquote> 2065 * <p> 2066 * The combination of keystrokes and conditions lets you define high 2067 * level (semantic) action events for a specified keystroke+modifier 2068 * combination (using the KeyStroke class) and direct to a parent or 2069 * child of a component that has the focus, or to the component itself. 2070 * In other words, in any hierarchical structure of components, an 2071 * arbitrary key-combination can be immediately directed to the 2072 * appropriate component in the hierarchy, and cause a specific method 2073 * to be invoked (usually by way of adapter objects). 2074 * <p> 2075 * If an action has already been registered for the receiving 2076 * container, with the same charCode and the same modifiers, 2077 * <code>anAction</code> will replace the action. 2078 * 2079 * @param anAction the <code>Action</code> to be registered 2080 * @param aCommand the command to be set in the delivered event 2081 * @param aKeyStroke the <code>KeyStroke</code> to bind to the action 2082 * @param aCondition the condition that needs to be met, see above 2083 * @see KeyStroke 2084 */ 2085 public void registerKeyboardAction(ActionListener anAction,String aCommand,KeyStroke aKeyStroke,int aCondition) { 2086 2087 InputMap inputMap = getInputMap(aCondition, true); 2088 2089 if (inputMap != null) { 2090 ActionMap actionMap = getActionMap(true); 2091 ActionStandin action = new ActionStandin(anAction, aCommand); 2092 inputMap.put(aKeyStroke, action); 2093 if (actionMap != null) { 2094 actionMap.put(action, action); 2095 } 2096 } 2097 } 2098 2099 /** 2100 * Registers any bound <code>WHEN_IN_FOCUSED_WINDOW</code> actions with 2101 * the <code>KeyboardManager</code>. If <code>onlyIfNew</code> 2102 * is true only actions that haven't been registered are pushed 2103 * to the <code>KeyboardManager</code>; 2104 * otherwise all actions are pushed to the <code>KeyboardManager</code>. 2105 * 2106 * @param onlyIfNew if true, only actions that haven't been registered 2107 * are pushed to the <code>KeyboardManager</code> 2108 */ 2109 private void registerWithKeyboardManager(boolean onlyIfNew) { 2110 InputMap inputMap = getInputMap(WHEN_IN_FOCUSED_WINDOW, false); 2111 KeyStroke[] strokes; 2112 Hashtable<KeyStroke, KeyStroke> registered = 2113 (Hashtable<KeyStroke, KeyStroke>)getClientProperty 2114 (WHEN_IN_FOCUSED_WINDOW_BINDINGS); 2115 2116 if (inputMap != null) { 2117 // Push any new KeyStrokes to the KeyboardManager. 2118 strokes = inputMap.allKeys(); 2119 if (strokes != null) { 2120 for (int counter = strokes.length - 1; counter >= 0; 2121 counter--) { 2122 if (!onlyIfNew || registered == null || 2123 registered.get(strokes[counter]) == null) { 2124 registerWithKeyboardManager(strokes[counter]); 2125 } 2126 if (registered != null) { 2127 registered.remove(strokes[counter]); 2128 } 2129 } 2130 } 2131 } 2132 else { 2133 strokes = null; 2134 } 2135 // Remove any old ones. 2136 if (registered != null && registered.size() > 0) { 2137 Enumeration<KeyStroke> keys = registered.keys(); 2138 2139 while (keys.hasMoreElements()) { 2140 KeyStroke ks = keys.nextElement(); 2141 unregisterWithKeyboardManager(ks); 2142 } 2143 registered.clear(); 2144 } 2145 // Updated the registered Hashtable. 2146 if (strokes != null && strokes.length > 0) { 2147 if (registered == null) { 2148 registered = new Hashtable<KeyStroke, KeyStroke>(strokes.length); 2149 putClientProperty(WHEN_IN_FOCUSED_WINDOW_BINDINGS, registered); 2150 } 2151 for (int counter = strokes.length - 1; counter >= 0; counter--) { 2152 registered.put(strokes[counter], strokes[counter]); 2153 } 2154 } 2155 else { 2156 putClientProperty(WHEN_IN_FOCUSED_WINDOW_BINDINGS, null); 2157 } 2158 } 2159 2160 /** 2161 * Unregisters all the previously registered 2162 * <code>WHEN_IN_FOCUSED_WINDOW</code> <code>KeyStroke</code> bindings. 2163 */ 2164 private void unregisterWithKeyboardManager() { 2165 Hashtable<KeyStroke, KeyStroke> registered = 2166 (Hashtable<KeyStroke, KeyStroke>)getClientProperty 2167 (WHEN_IN_FOCUSED_WINDOW_BINDINGS); 2168 2169 if (registered != null && registered.size() > 0) { 2170 Enumeration<KeyStroke> keys = registered.keys(); 2171 2172 while (keys.hasMoreElements()) { 2173 KeyStroke ks = keys.nextElement(); 2174 unregisterWithKeyboardManager(ks); 2175 } 2176 } 2177 putClientProperty(WHEN_IN_FOCUSED_WINDOW_BINDINGS, null); 2178 } 2179 2180 /** 2181 * Invoked from <code>ComponentInputMap</code> when its bindings change. 2182 * If <code>inputMap</code> is the current <code>windowInputMap</code> 2183 * (or a parent of the window <code>InputMap</code>) 2184 * the <code>KeyboardManager</code> is notified of the new bindings. 2185 * 2186 * @param inputMap the map containing the new bindings 2187 */ 2188 void componentInputMapChanged(ComponentInputMap inputMap) { 2189 InputMap km = getInputMap(WHEN_IN_FOCUSED_WINDOW, false); 2190 2191 while (km != inputMap && km != null) { 2192 km = km.getParent(); 2193 } 2194 if (km != null) { 2195 registerWithKeyboardManager(false); 2196 } 2197 } 2198 2199 private void registerWithKeyboardManager(KeyStroke aKeyStroke) { 2200 KeyboardManager.getCurrentManager().registerKeyStroke(aKeyStroke,this); 2201 } 2202 2203 private void unregisterWithKeyboardManager(KeyStroke aKeyStroke) { 2204 KeyboardManager.getCurrentManager().unregisterKeyStroke(aKeyStroke, 2205 this); 2206 } 2207 2208 /** 2209 * This method is now obsolete, please use a combination of 2210 * <code>getActionMap()</code> and <code>getInputMap()</code> for 2211 * similiar behavior. 2212 */ 2213 public void registerKeyboardAction(ActionListener anAction,KeyStroke aKeyStroke,int aCondition) { 2214 registerKeyboardAction(anAction,null,aKeyStroke,aCondition); 2215 } 2216 2217 /** 2218 * This method is now obsolete. To unregister an existing binding 2219 * you can either remove the binding from the 2220 * <code>ActionMap/InputMap</code>, or place a dummy binding the 2221 * <code>InputMap</code>. Removing the binding from the 2222 * <code>InputMap</code> allows bindings in parent <code>InputMap</code>s 2223 * to be active, whereas putting a dummy binding in the 2224 * <code>InputMap</code> effectively disables 2225 * the binding from ever happening. 2226 * <p> 2227 * Unregisters a keyboard action. 2228 * This will remove the binding from the <code>ActionMap</code> 2229 * (if it exists) as well as the <code>InputMap</code>s. 2230 */ 2231 public void unregisterKeyboardAction(KeyStroke aKeyStroke) { 2232 ActionMap am = getActionMap(false); 2233 for (int counter = 0; counter < 3; counter++) { 2234 InputMap km = getInputMap(counter, false); 2235 if (km != null) { 2236 Object actionID = km.get(aKeyStroke); 2237 2238 if (am != null && actionID != null) { 2239 am.remove(actionID); 2240 } 2241 km.remove(aKeyStroke); 2242 } 2243 } 2244 } 2245 2246 /** 2247 * Returns the <code>KeyStrokes</code> that will initiate 2248 * registered actions. 2249 * 2250 * @return an array of <code>KeyStroke</code> objects 2251 * @see #registerKeyboardAction 2252 */ 2253 public KeyStroke[] getRegisteredKeyStrokes() { 2254 int[] counts = new int[3]; 2255 KeyStroke[][] strokes = new KeyStroke[3][]; 2256 2257 for (int counter = 0; counter < 3; counter++) { 2258 InputMap km = getInputMap(counter, false); 2259 strokes[counter] = (km != null) ? km.allKeys() : null; 2260 counts[counter] = (strokes[counter] != null) ? 2261 strokes[counter].length : 0; 2262 } 2263 KeyStroke[] retValue = new KeyStroke[counts[0] + counts[1] + 2264 counts[2]]; 2265 for (int counter = 0, last = 0; counter < 3; counter++) { 2266 if (counts[counter] > 0) { 2267 System.arraycopy(strokes[counter], 0, retValue, last, 2268 counts[counter]); 2269 last += counts[counter]; 2270 } 2271 } 2272 return retValue; 2273 } 2274 2275 /** 2276 * Returns the condition that determines whether a registered action 2277 * occurs in response to the specified keystroke. 2278 * <p> 2279 * For Java 2 platform v1.3, a <code>KeyStroke</code> can be associated 2280 * with more than one condition. 2281 * For example, 'a' could be bound for the two 2282 * conditions <code>WHEN_FOCUSED</code> and 2283 * <code>WHEN_IN_FOCUSED_WINDOW</code> condition. 2284 * 2285 * @return the action-keystroke condition 2286 */ 2287 public int getConditionForKeyStroke(KeyStroke aKeyStroke) { 2288 for (int counter = 0; counter < 3; counter++) { 2289 InputMap inputMap = getInputMap(counter, false); 2290 if (inputMap != null && inputMap.get(aKeyStroke) != null) { 2291 return counter; 2292 } 2293 } 2294 return UNDEFINED_CONDITION; 2295 } 2296 2297 /** 2298 * Returns the object that will perform the action registered for a 2299 * given keystroke. 2300 * 2301 * @return the <code>ActionListener</code> 2302 * object invoked when the keystroke occurs 2303 */ 2304 public ActionListener getActionForKeyStroke(KeyStroke aKeyStroke) { 2305 ActionMap am = getActionMap(false); 2306 2307 if (am == null) { 2308 return null; 2309 } 2310 for (int counter = 0; counter < 3; counter++) { 2311 InputMap inputMap = getInputMap(counter, false); 2312 if (inputMap != null) { 2313 Object actionBinding = inputMap.get(aKeyStroke); 2314 2315 if (actionBinding != null) { 2316 Action action = am.get(actionBinding); 2317 if (action instanceof ActionStandin) { 2318 return ((ActionStandin)action).actionListener; 2319 } 2320 return action; 2321 } 2322 } 2323 } 2324 return null; 2325 } 2326 2327 /** 2328 * Unregisters all the bindings in the first tier <code>InputMaps</code> 2329 * and <code>ActionMap</code>. This has the effect of removing any 2330 * local bindings, and allowing the bindings defined in parent 2331 * <code>InputMap/ActionMaps</code> 2332 * (the UI is usually defined in the second tier) to persist. 2333 */ 2334 public void resetKeyboardActions() { 2335 // Keys 2336 for (int counter = 0; counter < 3; counter++) { 2337 InputMap inputMap = getInputMap(counter, false); 2338 2339 if (inputMap != null) { 2340 inputMap.clear(); 2341 } 2342 } 2343 2344 // Actions 2345 ActionMap am = getActionMap(false); 2346 2347 if (am != null) { 2348 am.clear(); 2349 } 2350 } 2351 2352 /** 2353 * Sets the <code>InputMap</code> to use under the condition 2354 * <code>condition</code> to 2355 * <code>map</code>. A <code>null</code> value implies you 2356 * do not want any bindings to be used, even from the UI. This will 2357 * not reinstall the UI <code>InputMap</code> (if there was one). 2358 * <code>condition</code> has one of the following values: 2359 * <ul> 2360 * <li><code>WHEN_IN_FOCUSED_WINDOW</code> 2361 * <li><code>WHEN_FOCUSED</code> 2362 * <li><code>WHEN_ANCESTOR_OF_FOCUSED_COMPONENT</code> 2363 * </ul> 2364 * If <code>condition</code> is <code>WHEN_IN_FOCUSED_WINDOW</code> 2365 * and <code>map</code> is not a <code>ComponentInputMap</code>, an 2366 * <code>IllegalArgumentException</code> will be thrown. 2367 * Similarly, if <code>condition</code> is not one of the values 2368 * listed, an <code>IllegalArgumentException</code> will be thrown. 2369 * 2370 * @param condition one of the values listed above 2371 * @param map the <code>InputMap</code> to use for the given condition 2372 * @exception IllegalArgumentException if <code>condition</code> is 2373 * <code>WHEN_IN_FOCUSED_WINDOW</code> and <code>map</code> 2374 * is not an instance of <code>ComponentInputMap</code>; or 2375 * if <code>condition</code> is not one of the legal values 2376 * specified above 2377 * @since 1.3 2378 */ 2379 public final void setInputMap(int condition, InputMap map) { 2380 switch (condition) { 2381 case WHEN_IN_FOCUSED_WINDOW: 2382 if (map != null && !(map instanceof ComponentInputMap)) { 2383 throw new IllegalArgumentException("WHEN_IN_FOCUSED_WINDOW InputMaps must be of type ComponentInputMap"); 2384 } 2385 windowInputMap = (ComponentInputMap)map; 2386 setFlag(WIF_INPUTMAP_CREATED, true); 2387 registerWithKeyboardManager(false); 2388 break; 2389 case WHEN_ANCESTOR_OF_FOCUSED_COMPONENT: 2390 ancestorInputMap = map; 2391 setFlag(ANCESTOR_INPUTMAP_CREATED, true); 2392 break; 2393 case WHEN_FOCUSED: 2394 focusInputMap = map; 2395 setFlag(FOCUS_INPUTMAP_CREATED, true); 2396 break; 2397 default: 2398 throw new IllegalArgumentException("condition must be one of JComponent.WHEN_IN_FOCUSED_WINDOW, JComponent.WHEN_FOCUSED or JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT"); 2399 } 2400 } 2401 2402 /** 2403 * Returns the <code>InputMap</code> that is used during 2404 * <code>condition</code>. 2405 * 2406 * @param condition one of WHEN_IN_FOCUSED_WINDOW, WHEN_FOCUSED, 2407 * WHEN_ANCESTOR_OF_FOCUSED_COMPONENT 2408 * @return the <code>InputMap</code> for the specified 2409 * <code>condition</code> 2410 * @since 1.3 2411 */ 2412 public final InputMap getInputMap(int condition) { 2413 return getInputMap(condition, true); 2414 } 2415 2416 /** 2417 * Returns the <code>InputMap</code> that is used when the 2418 * component has focus. 2419 * This is convenience method for <code>getInputMap(WHEN_FOCUSED)</code>. 2420 * 2421 * @return the <code>InputMap</code> used when the component has focus 2422 * @since 1.3 2423 */ 2424 public final InputMap getInputMap() { 2425 return getInputMap(WHEN_FOCUSED, true); 2426 } 2427 2428 /** 2429 * Sets the <code>ActionMap</code> to <code>am</code>. This does not set 2430 * the parent of the <code>am</code> to be the <code>ActionMap</code> 2431 * from the UI (if there was one), it is up to the caller to have done this. 2432 * 2433 * @param am the new <code>ActionMap</code> 2434 * @since 1.3 2435 */ 2436 public final void setActionMap(ActionMap am) { 2437 actionMap = am; 2438 setFlag(ACTIONMAP_CREATED, true); 2439 } 2440 2441 /** 2442 * Returns the <code>ActionMap</code> used to determine what 2443 * <code>Action</code> to fire for particular <code>KeyStroke</code> 2444 * binding. The returned <code>ActionMap</code>, unless otherwise 2445 * set, will have the <code>ActionMap</code> from the UI set as the parent. 2446 * 2447 * @return the <code>ActionMap</code> containing the key/action bindings 2448 * @since 1.3 2449 */ 2450 public final ActionMap getActionMap() { 2451 return getActionMap(true); 2452 } 2453 2454 /** 2455 * Returns the <code>InputMap</code> to use for condition 2456 * <code>condition</code>. If the <code>InputMap</code> hasn't 2457 * been created, and <code>create</code> is 2458 * true, it will be created. 2459 * 2460 * @param condition one of the following values: 2461 * <ul> 2462 * <li>JComponent.FOCUS_INPUTMAP_CREATED 2463 * <li>JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT 2464 * <li>JComponent.WHEN_IN_FOCUSED_WINDOW 2465 * </ul> 2466 * @param create if true, create the <code>InputMap</code> if it 2467 * is not already created 2468 * @return the <code>InputMap</code> for the given <code>condition</code>; 2469 * if <code>create</code> is false and the <code>InputMap</code> 2470 * hasn't been created, returns <code>null</code> 2471 * @exception IllegalArgumentException if <code>condition</code> 2472 * is not one of the legal values listed above 2473 */ 2474 final InputMap getInputMap(int condition, boolean create) { 2475 switch (condition) { 2476 case WHEN_FOCUSED: 2477 if (getFlag(FOCUS_INPUTMAP_CREATED)) { 2478 return focusInputMap; 2479 } 2480 // Hasn't been created yet. 2481 if (create) { 2482 InputMap km = new InputMap(); 2483 setInputMap(condition, km); 2484 return km; 2485 } 2486 break; 2487 case WHEN_ANCESTOR_OF_FOCUSED_COMPONENT: 2488 if (getFlag(ANCESTOR_INPUTMAP_CREATED)) { 2489 return ancestorInputMap; 2490 } 2491 // Hasn't been created yet. 2492 if (create) { 2493 InputMap km = new InputMap(); 2494 setInputMap(condition, km); 2495 return km; 2496 } 2497 break; 2498 case WHEN_IN_FOCUSED_WINDOW: 2499 if (getFlag(WIF_INPUTMAP_CREATED)) { 2500 return windowInputMap; 2501 } 2502 // Hasn't been created yet. 2503 if (create) { 2504 ComponentInputMap km = new ComponentInputMap(this); 2505 setInputMap(condition, km); 2506 return km; 2507 } 2508 break; 2509 default: 2510 throw new IllegalArgumentException("condition must be one of JComponent.WHEN_IN_FOCUSED_WINDOW, JComponent.WHEN_FOCUSED or JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT"); 2511 } 2512 return null; 2513 } 2514 2515 /** 2516 * Finds and returns the appropriate <code>ActionMap</code>. 2517 * 2518 * @param create if true, create the <code>ActionMap</code> if it 2519 * is not already created 2520 * @return the <code>ActionMap</code> for this component; if the 2521 * <code>create</code> flag is false and there is no 2522 * current <code>ActionMap</code>, returns <code>null</code> 2523 */ 2524 final ActionMap getActionMap(boolean create) { 2525 if (getFlag(ACTIONMAP_CREATED)) { 2526 return actionMap; 2527 } 2528 // Hasn't been created. 2529 if (create) { 2530 ActionMap am = new ActionMap(); 2531 setActionMap(am); 2532 return am; 2533 } 2534 return null; 2535 } 2536 2537 /** 2538 * Returns the baseline. The baseline is measured from the top of 2539 * the component. This method is primarily meant for 2540 * <code>LayoutManager</code>s to align components along their 2541 * baseline. A return value less than 0 indicates this component 2542 * does not have a reasonable baseline and that 2543 * <code>LayoutManager</code>s should not align this component on 2544 * its baseline. 2545 * <p> 2546 * This method calls into the <code>ComponentUI</code> method of the 2547 * same name. If this component does not have a <code>ComponentUI</code> 2548 * -1 will be returned. If a value >= 0 is 2549 * returned, then the component has a valid baseline for any 2550 * size >= the minimum size and <code>getBaselineResizeBehavior</code> 2551 * can be used to determine how the baseline changes with size. 2552 * 2553 * @throws IllegalArgumentException {@inheritDoc} 2554 * @see #getBaselineResizeBehavior 2555 * @see java.awt.FontMetrics 2556 * @since 1.6 2557 */ 2558 public int getBaseline(int width, int height) { 2559 // check size. 2560 super.getBaseline(width, height); 2561 if (ui != null) { 2562 return ui.getBaseline(this, width, height); 2563 } 2564 return -1; 2565 } 2566 2567 /** 2568 * Returns an enum indicating how the baseline of the component 2569 * changes as the size changes. This method is primarily meant for 2570 * layout managers and GUI builders. 2571 * <p> 2572 * This method calls into the <code>ComponentUI</code> method of 2573 * the same name. If this component does not have a 2574 * <code>ComponentUI</code> 2575 * <code>BaselineResizeBehavior.OTHER</code> will be 2576 * returned. Subclasses should 2577 * never return <code>null</code>; if the baseline can not be 2578 * calculated return <code>BaselineResizeBehavior.OTHER</code>. Callers 2579 * should first ask for the baseline using 2580 * <code>getBaseline</code> and if a value >= 0 is returned use 2581 * this method. It is acceptable for this method to return a 2582 * value other than <code>BaselineResizeBehavior.OTHER</code> even if 2583 * <code>getBaseline</code> returns a value less than 0. 2584 * 2585 * @see #getBaseline(int, int) 2586 * @since 1.6 2587 */ 2588 public BaselineResizeBehavior getBaselineResizeBehavior() { 2589 if (ui != null) { 2590 return ui.getBaselineResizeBehavior(this); 2591 } 2592 return BaselineResizeBehavior.OTHER; 2593 } 2594 2595 /** 2596 * In release 1.4, the focus subsystem was rearchitected. 2597 * For more information, see 2598 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html"> 2599 * How to Use the Focus Subsystem</a>, 2600 * a section in <em>The Java Tutorial</em>. 2601 * <p> 2602 * Requests focus on this <code>JComponent</code>'s 2603 * <code>FocusTraversalPolicy</code>'s default <code>Component</code>. 2604 * If this <code>JComponent</code> is a focus cycle root, then its 2605 * <code>FocusTraversalPolicy</code> is used. Otherwise, the 2606 * <code>FocusTraversalPolicy</code> of this <code>JComponent</code>'s 2607 * focus-cycle-root ancestor is used. 2608 * 2609 * @see java.awt.FocusTraversalPolicy#getDefaultComponent 2610 * @deprecated As of 1.4, replaced by 2611 * <code>FocusTraversalPolicy.getDefaultComponent(Container).requestFocus()</code> 2612 */ 2613 @Deprecated 2614 public boolean requestDefaultFocus() { 2615 Container nearestRoot = 2616 (isFocusCycleRoot()) ? this : getFocusCycleRootAncestor(); 2617 if (nearestRoot == null) { 2618 return false; 2619 } 2620 Component comp = nearestRoot.getFocusTraversalPolicy(). 2621 getDefaultComponent(nearestRoot); 2622 if (comp != null) { 2623 comp.requestFocus(); 2624 return true; 2625 } else { 2626 return false; 2627 } 2628 } 2629 2630 /** 2631 * Makes the component visible or invisible. 2632 * Overrides <code>Component.setVisible</code>. 2633 * 2634 * @param aFlag true to make the component visible; false to 2635 * make it invisible 2636 * 2637 * @beaninfo 2638 * attribute: visualUpdate true 2639 */ 2640 public void setVisible(boolean aFlag) { 2641 if (aFlag != isVisible()) { 2642 super.setVisible(aFlag); 2643 if (aFlag) { 2644 Container parent = getParent(); 2645 if (parent != null) { 2646 Rectangle r = getBounds(); 2647 parent.repaint(r.x, r.y, r.width, r.height); 2648 } 2649 revalidate(); 2650 } 2651 } 2652 } 2653 2654 /** 2655 * Sets whether or not this component is enabled. 2656 * A component that is enabled may respond to user input, 2657 * while a component that is not enabled cannot respond to 2658 * user input. Some components may alter their visual 2659 * representation when they are disabled in order to 2660 * provide feedback to the user that they cannot take input. 2661 * <p>Note: Disabling a component does not disable its children. 2662 * 2663 * <p>Note: Disabling a lightweight component does not prevent it from 2664 * receiving MouseEvents. 2665 * 2666 * @param enabled true if this component should be enabled, false otherwise 2667 * @see java.awt.Component#isEnabled 2668 * @see java.awt.Component#isLightweight 2669 * 2670 * @beaninfo 2671 * preferred: true 2672 * bound: true 2673 * attribute: visualUpdate true 2674 * description: The enabled state of the component. 2675 */ 2676 public void setEnabled(boolean enabled) { 2677 boolean oldEnabled = isEnabled(); 2678 super.setEnabled(enabled); 2679 firePropertyChange("enabled", oldEnabled, enabled); 2680 if (enabled != oldEnabled) { 2681 repaint(); 2682 } 2683 } 2684 2685 /** 2686 * Sets the foreground color of this component. It is up to the 2687 * look and feel to honor this property, some may choose to ignore 2688 * it. 2689 * 2690 * @param fg the desired foreground <code>Color</code> 2691 * @see java.awt.Component#getForeground 2692 * 2693 * @beaninfo 2694 * preferred: true 2695 * bound: true 2696 * attribute: visualUpdate true 2697 * description: The foreground color of the component. 2698 */ 2699 public void setForeground(Color fg) { 2700 Color oldFg = getForeground(); 2701 super.setForeground(fg); 2702 if ((oldFg != null) ? !oldFg.equals(fg) : ((fg != null) && !fg.equals(oldFg))) { 2703 // foreground already bound in AWT1.2 2704 repaint(); 2705 } 2706 } 2707 2708 /** 2709 * Sets the background color of this component. The background 2710 * color is used only if the component is opaque, and only 2711 * by subclasses of <code>JComponent</code> or 2712 * <code>ComponentUI</code> implementations. Direct subclasses of 2713 * <code>JComponent</code> must override 2714 * <code>paintComponent</code> to honor this property. 2715 * <p> 2716 * It is up to the look and feel to honor this property, some may 2717 * choose to ignore it. 2718 * 2719 * @param bg the desired background <code>Color</code> 2720 * @see java.awt.Component#getBackground 2721 * @see #setOpaque 2722 * 2723 * @beaninfo 2724 * preferred: true 2725 * bound: true 2726 * attribute: visualUpdate true 2727 * description: The background color of the component. 2728 */ 2729 public void setBackground(Color bg) { 2730 Color oldBg = getBackground(); 2731 super.setBackground(bg); 2732 if ((oldBg != null) ? !oldBg.equals(bg) : ((bg != null) && !bg.equals(oldBg))) { 2733 // background already bound in AWT1.2 2734 repaint(); 2735 } 2736 } 2737 2738 /** 2739 * Sets the font for this component. 2740 * 2741 * @param font the desired <code>Font</code> for this component 2742 * @see java.awt.Component#getFont 2743 * 2744 * @beaninfo 2745 * preferred: true 2746 * bound: true 2747 * attribute: visualUpdate true 2748 * description: The font for the component. 2749 */ 2750 public void setFont(Font font) { 2751 Font oldFont = getFont(); 2752 super.setFont(font); 2753 // font already bound in AWT1.2 2754 if (font != oldFont) { 2755 revalidate(); 2756 repaint(); 2757 } 2758 } 2759 2760 /** 2761 * Returns the default locale used to initialize each JComponent's 2762 * locale property upon creation. 2763 * 2764 * The default locale has "AppContext" scope so that applets (and 2765 * potentially multiple lightweight applications running in a single VM) 2766 * can have their own setting. An applet can safely alter its default 2767 * locale because it will have no affect on other applets (or the browser). 2768 * 2769 * @return the default <code>Locale</code>. 2770 * @see #setDefaultLocale 2771 * @see java.awt.Component#getLocale 2772 * @see #setLocale 2773 * @since 1.4 2774 */ 2775 static public Locale getDefaultLocale() { 2776 Locale l = (Locale) SwingUtilities.appContextGet(defaultLocale); 2777 if( l == null ) { 2778 //REMIND(bcb) choosing the default value is more complicated 2779 //than this. 2780 l = Locale.getDefault(); 2781 JComponent.setDefaultLocale( l ); 2782 } 2783 return l; 2784 } 2785 2786 2787 /** 2788 * Sets the default locale used to initialize each JComponent's locale 2789 * property upon creation. The initial value is the VM's default locale. 2790 * 2791 * The default locale has "AppContext" scope so that applets (and 2792 * potentially multiple lightweight applications running in a single VM) 2793 * can have their own setting. An applet can safely alter its default 2794 * locale because it will have no affect on other applets (or the browser). 2795 * 2796 * @param l the desired default <code>Locale</code> for new components. 2797 * @see #getDefaultLocale 2798 * @see java.awt.Component#getLocale 2799 * @see #setLocale 2800 * @since 1.4 2801 */ 2802 static public void setDefaultLocale( Locale l ) { 2803 SwingUtilities.appContextPut(defaultLocale, l); 2804 } 2805 2806 2807 /** 2808 * Processes any key events that the component itself 2809 * recognizes. This is called after the focus 2810 * manager and any interested listeners have been 2811 * given a chance to steal away the event. This 2812 * method is called only if the event has not 2813 * yet been consumed. This method is called prior 2814 * to the keyboard UI logic. 2815 * <p> 2816 * This method is implemented to do nothing. Subclasses would 2817 * normally override this method if they process some 2818 * key events themselves. If the event is processed, 2819 * it should be consumed. 2820 */ 2821 protected void processComponentKeyEvent(KeyEvent e) { 2822 } 2823 2824 /** Overrides <code>processKeyEvent</code> to process events. **/ 2825 protected void processKeyEvent(KeyEvent e) { 2826 boolean result; 2827 boolean shouldProcessKey; 2828 2829 // This gives the key event listeners a crack at the event 2830 super.processKeyEvent(e); 2831 2832 // give the component itself a crack at the event 2833 if (! e.isConsumed()) { 2834 processComponentKeyEvent(e); 2835 } 2836 2837 shouldProcessKey = KeyboardState.shouldProcess(e); 2838 2839 if(e.isConsumed()) { 2840 return; 2841 } 2842 2843 if (shouldProcessKey && processKeyBindings(e, e.getID() == 2844 KeyEvent.KEY_PRESSED)) { 2845 e.consume(); 2846 } 2847 } 2848 2849 /** 2850 * Invoked to process the key bindings for <code>ks</code> as the result 2851 * of the <code>KeyEvent</code> <code>e</code>. This obtains 2852 * the appropriate <code>InputMap</code>, 2853 * gets the binding, gets the action from the <code>ActionMap</code>, 2854 * and then (if the action is found and the component 2855 * is enabled) invokes <code>notifyAction</code> to notify the action. 2856 * 2857 * @param ks the <code>KeyStroke</code> queried 2858 * @param e the <code>KeyEvent</code> 2859 * @param condition one of the following values: 2860 * <ul> 2861 * <li>JComponent.WHEN_FOCUSED 2862 * <li>JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT 2863 * <li>JComponent.WHEN_IN_FOCUSED_WINDOW 2864 * </ul> 2865 * @param pressed true if the key is pressed 2866 * @return true if there was a binding to an action, and the action 2867 * was enabled 2868 * 2869 * @since 1.3 2870 */ 2871 protected boolean processKeyBinding(KeyStroke ks, KeyEvent e, 2872 int condition, boolean pressed) { 2873 InputMap map = getInputMap(condition, false); 2874 ActionMap am = getActionMap(false); 2875 2876 if(map != null && am != null && isEnabled()) { 2877 Object binding = map.get(ks); 2878 Action action = (binding == null) ? null : am.get(binding); 2879 if (action != null) { 2880 return SwingUtilities.notifyAction(action, ks, e, this, 2881 e.getModifiers()); 2882 } 2883 } 2884 return false; 2885 } 2886 2887 /** 2888 * This is invoked as the result of a <code>KeyEvent</code> 2889 * that was not consumed by the <code>FocusManager</code>, 2890 * <code>KeyListeners</code>, or the component. It will first try 2891 * <code>WHEN_FOCUSED</code> bindings, 2892 * then <code>WHEN_ANCESTOR_OF_FOCUSED_COMPONENT</code> bindings, 2893 * and finally <code>WHEN_IN_FOCUSED_WINDOW</code> bindings. 2894 * 2895 * @param e the unconsumed <code>KeyEvent</code> 2896 * @param pressed true if the key is pressed 2897 * @return true if there is a key binding for <code>e</code> 2898 */ 2899 boolean processKeyBindings(KeyEvent e, boolean pressed) { 2900 if (!SwingUtilities.isValidKeyEventForKeyBindings(e)) { 2901 return false; 2902 } 2903 // Get the KeyStroke 2904 // There may be two keystrokes associated with a low-level key event; 2905 // in this case a keystroke made of an extended key code has a priority. 2906 KeyStroke ks; 2907 KeyStroke ksE = null; 2908 2909 if (e.getID() == KeyEvent.KEY_TYPED) { 2910 ks = KeyStroke.getKeyStroke(e.getKeyChar()); 2911 } 2912 else { 2913 ks = KeyStroke.getKeyStroke(e.getKeyCode(),e.getModifiers(), 2914 (pressed ? false:true)); 2915 if (e.getKeyCode() != e.getExtendedKeyCode()) { 2916 ksE = KeyStroke.getKeyStroke(e.getExtendedKeyCode(),e.getModifiers(), 2917 (pressed ? false:true)); 2918 } 2919 } 2920 2921 // Do we have a key binding for e? 2922 // If we have a binding by an extended code, use it. 2923 // If not, check for regular code binding. 2924 if(ksE != null && processKeyBinding(ksE, e, WHEN_FOCUSED, pressed)) { 2925 return true; 2926 } 2927 if(processKeyBinding(ks, e, WHEN_FOCUSED, pressed)) 2928 return true; 2929 2930 /* We have no key binding. Let's try the path from our parent to the 2931 * window excluded. We store the path components so we can avoid 2932 * asking the same component twice. 2933 */ 2934 Container parent = this; 2935 while (parent != null && !(parent instanceof Window) && 2936 !(parent instanceof Applet)) { 2937 if(parent instanceof JComponent) { 2938 if(ksE != null && ((JComponent)parent).processKeyBinding(ksE, e, 2939 WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, pressed)) 2940 return true; 2941 if(((JComponent)parent).processKeyBinding(ks, e, 2942 WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, pressed)) 2943 return true; 2944 } 2945 // This is done so that the children of a JInternalFrame are 2946 // given precedence for WHEN_IN_FOCUSED_WINDOW bindings before 2947 // other components WHEN_IN_FOCUSED_WINDOW bindings. This also gives 2948 // more precedence to the WHEN_IN_FOCUSED_WINDOW bindings of the 2949 // JInternalFrame's children vs the 2950 // WHEN_ANCESTOR_OF_FOCUSED_COMPONENT bindings of the parents. 2951 // maybe generalize from JInternalFrame (like isFocusCycleRoot). 2952 if ((parent instanceof JInternalFrame) && 2953 JComponent.processKeyBindingsForAllComponents(e,parent,pressed)){ 2954 return true; 2955 } 2956 parent = parent.getParent(); 2957 } 2958 2959 /* No components between the focused component and the window is 2960 * actually interested by the key event. Let's try the other 2961 * JComponent in this window. 2962 */ 2963 if(parent != null) { 2964 return JComponent.processKeyBindingsForAllComponents(e,parent,pressed); 2965 } 2966 return false; 2967 } 2968 2969 static boolean processKeyBindingsForAllComponents(KeyEvent e, 2970 Container container, boolean pressed) { 2971 while (true) { 2972 if (KeyboardManager.getCurrentManager().fireKeyboardAction( 2973 e, pressed, container)) { 2974 return true; 2975 } 2976 if (container instanceof Popup.HeavyWeightWindow) { 2977 container = ((Window)container).getOwner(); 2978 } 2979 else { 2980 return false; 2981 } 2982 } 2983 } 2984 2985 /** 2986 * Registers the text to display in a tool tip. 2987 * The text displays when the cursor lingers over the component. 2988 * <p> 2989 * See <a href="http://java.sun.com/docs/books/tutorial/uiswing/components/tooltip.html">How to Use Tool Tips</a> 2990 * in <em>The Java Tutorial</em> 2991 * for further documentation. 2992 * 2993 * @param text the string to display; if the text is <code>null</code>, 2994 * the tool tip is turned off for this component 2995 * @see #TOOL_TIP_TEXT_KEY 2996 * @beaninfo 2997 * preferred: true 2998 * description: The text to display in a tool tip. 2999 */ 3000 public void setToolTipText(String text) { 3001 String oldText = getToolTipText(); 3002 putClientProperty(TOOL_TIP_TEXT_KEY, text); 3003 ToolTipManager toolTipManager = ToolTipManager.sharedInstance(); 3004 if (text != null) { 3005 if (oldText == null) { 3006 toolTipManager.registerComponent(this); 3007 } 3008 } else { 3009 toolTipManager.unregisterComponent(this); 3010 } 3011 } 3012 3013 /** 3014 * Returns the tooltip string that has been set with 3015 * <code>setToolTipText</code>. 3016 * 3017 * @return the text of the tool tip 3018 * @see #TOOL_TIP_TEXT_KEY 3019 */ 3020 public String getToolTipText() { 3021 return (String)getClientProperty(TOOL_TIP_TEXT_KEY); 3022 } 3023 3024 3025 /** 3026 * Returns the string to be used as the tooltip for <i>event</i>. 3027 * By default this returns any string set using 3028 * <code>setToolTipText</code>. If a component provides 3029 * more extensive API to support differing tooltips at different locations, 3030 * this method should be overridden. 3031 */ 3032 public String getToolTipText(MouseEvent event) { 3033 return getToolTipText(); 3034 } 3035 3036 /** 3037 * Returns the tooltip location in this component's coordinate system. 3038 * If <code>null</code> is returned, Swing will choose a location. 3039 * The default implementation returns <code>null</code>. 3040 * 3041 * @param event the <code>MouseEvent</code> that caused the 3042 * <code>ToolTipManager</code> to show the tooltip 3043 * @return always returns <code>null</code> 3044 */ 3045 public Point getToolTipLocation(MouseEvent event) { 3046 return null; 3047 } 3048 3049 /** 3050 * Returns the preferred location to display the popup menu in this 3051 * component's coordinate system. It is up to the look and feel to 3052 * honor this property, some may choose to ignore it. 3053 * If {@code null}, the look and feel will choose a suitable location. 3054 * 3055 * @param event the {@code MouseEvent} that triggered the popup to be 3056 * shown, or {@code null} if the popup is not being shown as the 3057 * result of a mouse event 3058 * @return location to display the {@code JPopupMenu}, or {@code null} 3059 * @since 1.5 3060 */ 3061 public Point getPopupLocation(MouseEvent event) { 3062 return null; 3063 } 3064 3065 3066 /** 3067 * Returns the instance of <code>JToolTip</code> that should be used 3068 * to display the tooltip. 3069 * Components typically would not override this method, 3070 * but it can be used to 3071 * cause different tooltips to be displayed differently. 3072 * 3073 * @return the <code>JToolTip</code> used to display this toolTip 3074 */ 3075 public JToolTip createToolTip() { 3076 JToolTip tip = new JToolTip(); 3077 tip.setComponent(this); 3078 return tip; 3079 } 3080 3081 /** 3082 * Forwards the <code>scrollRectToVisible()</code> message to the 3083 * <code>JComponent</code>'s parent. Components that can service 3084 * the request, such as <code>JViewport</code>, 3085 * override this method and perform the scrolling. 3086 * 3087 * @param aRect the visible <code>Rectangle</code> 3088 * @see JViewport 3089 */ 3090 public void scrollRectToVisible(Rectangle aRect) { 3091 Container parent; 3092 int dx = getX(), dy = getY(); 3093 3094 for (parent = getParent(); 3095 !(parent == null) && 3096 !(parent instanceof JComponent) && 3097 !(parent instanceof CellRendererPane); 3098 parent = parent.getParent()) { 3099 Rectangle bounds = parent.getBounds(); 3100 3101 dx += bounds.x; 3102 dy += bounds.y; 3103 } 3104 3105 if (!(parent == null) && !(parent instanceof CellRendererPane)) { 3106 aRect.x += dx; 3107 aRect.y += dy; 3108 3109 ((JComponent)parent).scrollRectToVisible(aRect); 3110 aRect.x -= dx; 3111 aRect.y -= dy; 3112 } 3113 } 3114 3115 /** 3116 * Sets the <code>autoscrolls</code> property. 3117 * If <code>true</code> mouse dragged events will be 3118 * synthetically generated when the mouse is dragged 3119 * outside of the component's bounds and mouse motion 3120 * has paused (while the button continues to be held 3121 * down). The synthetic events make it appear that the 3122 * drag gesture has resumed in the direction established when 3123 * the component's boundary was crossed. Components that 3124 * support autoscrolling must handle <code>mouseDragged</code> 3125 * events by calling <code>scrollRectToVisible</code> with a 3126 * rectangle that contains the mouse event's location. All of 3127 * the Swing components that support item selection and are 3128 * typically displayed in a <code>JScrollPane</code> 3129 * (<code>JTable</code>, <code>JList</code>, <code>JTree</code>, 3130 * <code>JTextArea</code>, and <code>JEditorPane</code>) 3131 * already handle mouse dragged events in this way. To enable 3132 * autoscrolling in any other component, add a mouse motion 3133 * listener that calls <code>scrollRectToVisible</code>. 3134 * For example, given a <code>JPanel</code>, <code>myPanel</code>: 3135 * <pre> 3136 * MouseMotionListener doScrollRectToVisible = new MouseMotionAdapter() { 3137 * public void mouseDragged(MouseEvent e) { 3138 * Rectangle r = new Rectangle(e.getX(), e.getY(), 1, 1); 3139 * ((JPanel)e.getSource()).scrollRectToVisible(r); 3140 * } 3141 * }; 3142 * myPanel.addMouseMotionListener(doScrollRectToVisible); 3143 * </pre> 3144 * The default value of the <code>autoScrolls</code> 3145 * property is <code>false</code>. 3146 * 3147 * @param autoscrolls if true, synthetic mouse dragged events 3148 * are generated when the mouse is dragged outside of a component's 3149 * bounds and the mouse button continues to be held down; otherwise 3150 * false 3151 * @see #getAutoscrolls 3152 * @see JViewport 3153 * @see JScrollPane 3154 * 3155 * @beaninfo 3156 * expert: true 3157 * description: Determines if this component automatically scrolls its contents when dragged. 3158 */ 3159 public void setAutoscrolls(boolean autoscrolls) { 3160 setFlag(AUTOSCROLLS_SET, true); 3161 if (this.autoscrolls != autoscrolls) { 3162 this.autoscrolls = autoscrolls; 3163 if (autoscrolls) { 3164 enableEvents(AWTEvent.MOUSE_EVENT_MASK); 3165 enableEvents(AWTEvent.MOUSE_MOTION_EVENT_MASK); 3166 } 3167 else { 3168 Autoscroller.stop(this); 3169 } 3170 } 3171 } 3172 3173 /** 3174 * Gets the <code>autoscrolls</code> property. 3175 * 3176 * @return the value of the <code>autoscrolls</code> property 3177 * @see JViewport 3178 * @see #setAutoscrolls 3179 */ 3180 public boolean getAutoscrolls() { 3181 return autoscrolls; 3182 } 3183 3184 /** 3185 * Sets the {@code TransferHandler}, which provides support for transfer 3186 * of data into and out of this component via cut/copy/paste and drag 3187 * and drop. This may be {@code null} if the component does not support 3188 * data transfer operations. 3189 * <p> 3190 * If the new {@code TransferHandler} is not {@code null}, this method 3191 * also installs a <b>new</b> {@code DropTarget} on the component to 3192 * activate drop handling through the {@code TransferHandler} and activate 3193 * any built-in support (such as calculating and displaying potential drop 3194 * locations). If you do not wish for this component to respond in any way 3195 * to drops, you can disable drop support entirely either by removing the 3196 * drop target ({@code setDropTarget(null)}) or by de-activating it 3197 * ({@code getDropTaget().setActive(false)}). 3198 * <p> 3199 * If the new {@code TransferHandler} is {@code null}, this method removes 3200 * the drop target. 3201 * <p> 3202 * Under two circumstances, this method does not modify the drop target: 3203 * First, if the existing drop target on this component was explicitly 3204 * set by the developer to a {@code non-null} value. Second, if the 3205 * system property {@code suppressSwingDropSupport} is {@code true}. The 3206 * default value for the system property is {@code false}. 3207 * <p> 3208 * Please see 3209 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/dnd.html"> 3210 * How to Use Drag and Drop and Data Transfer</a>, 3211 * a section in <em>The Java Tutorial</em>, for more information. 3212 * 3213 * @param newHandler the new {@code TransferHandler} 3214 * 3215 * @see TransferHandler 3216 * @see #getTransferHandler 3217 * @since 1.4 3218 * @beaninfo 3219 * bound: true 3220 * hidden: true 3221 * description: Mechanism for transfer of data to and from the component 3222 */ 3223 public void setTransferHandler(TransferHandler newHandler) { 3224 TransferHandler oldHandler = (TransferHandler)getClientProperty( 3225 JComponent_TRANSFER_HANDLER); 3226 putClientProperty(JComponent_TRANSFER_HANDLER, newHandler); 3227 3228 SwingUtilities.installSwingDropTargetAsNecessary(this, newHandler); 3229 firePropertyChange("transferHandler", oldHandler, newHandler); 3230 } 3231 3232 /** 3233 * Gets the <code>transferHandler</code> property. 3234 * 3235 * @return the value of the <code>transferHandler</code> property 3236 * 3237 * @see TransferHandler 3238 * @see #setTransferHandler 3239 * @since 1.4 3240 */ 3241 public TransferHandler getTransferHandler() { 3242 return (TransferHandler)getClientProperty(JComponent_TRANSFER_HANDLER); 3243 } 3244 3245 /** 3246 * Calculates a custom drop location for this type of component, 3247 * representing where a drop at the given point should insert data. 3248 * <code>null</code> is returned if this component doesn't calculate 3249 * custom drop locations. In this case, <code>TransferHandler</code> 3250 * will provide a default <code>DropLocation</code> containing just 3251 * the point. 3252 * 3253 * @param p the point to calculate a drop location for 3254 * @return the drop location, or <code>null</code> 3255 */ 3256 TransferHandler.DropLocation dropLocationForPoint(Point p) { 3257 return null; 3258 } 3259 3260 /** 3261 * Called to set or clear the drop location during a DnD operation. 3262 * In some cases, the component may need to use its internal selection 3263 * temporarily to indicate the drop location. To help facilitate this, 3264 * this method returns and accepts as a parameter a state object. 3265 * This state object can be used to store, and later restore, the selection 3266 * state. Whatever this method returns will be passed back to it in 3267 * future calls, as the state parameter. If it wants the DnD system to 3268 * continue storing the same state, it must pass it back every time. 3269 * Here's how this is used: 3270 * <p> 3271 * Let's say that on the first call to this method the component decides 3272 * to save some state (because it is about to use the selection to show 3273 * a drop index). It can return a state object to the caller encapsulating 3274 * any saved selection state. On a second call, let's say the drop location 3275 * is being changed to something else. The component doesn't need to 3276 * restore anything yet, so it simply passes back the same state object 3277 * to have the DnD system continue storing it. Finally, let's say this 3278 * method is messaged with <code>null</code>. This means DnD 3279 * is finished with this component for now, meaning it should restore 3280 * state. At this point, it can use the state parameter to restore 3281 * said state, and of course return <code>null</code> since there's 3282 * no longer anything to store. 3283 * 3284 * @param location the drop location (as calculated by 3285 * <code>dropLocationForPoint</code>) or <code>null</code> 3286 * if there's no longer a valid drop location 3287 * @param state the state object saved earlier for this component, 3288 * or <code>null</code> 3289 * @param forDrop whether or not the method is being called because an 3290 * actual drop occurred 3291 * @return any saved state for this component, or <code>null</code> if none 3292 */ 3293 Object setDropLocation(TransferHandler.DropLocation location, 3294 Object state, 3295 boolean forDrop) { 3296 3297 return null; 3298 } 3299 3300 /** 3301 * Called to indicate to this component that DnD is done. 3302 * Needed by <code>JTree</code>. 3303 */ 3304 void dndDone() { 3305 } 3306 3307 /** 3308 * Processes mouse events occurring on this component by 3309 * dispatching them to any registered 3310 * <code>MouseListener</code> objects, refer to 3311 * {@link java.awt.Component#processMouseEvent(MouseEvent)} 3312 * for a complete description of this method. 3313 * 3314 * @param e the mouse event 3315 * @see java.awt.Component#processMouseEvent 3316 * @since 1.5 3317 */ 3318 protected void processMouseEvent(MouseEvent e) { 3319 if (autoscrolls && e.getID() == MouseEvent.MOUSE_RELEASED) { 3320 Autoscroller.stop(this); 3321 } 3322 super.processMouseEvent(e); 3323 } 3324 3325 /** 3326 * Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED. 3327 * 3328 * @param e the <code>MouseEvent</code> 3329 * @see MouseEvent 3330 */ 3331 protected void processMouseMotionEvent(MouseEvent e) { 3332 boolean dispatch = true; 3333 if (autoscrolls && e.getID() == MouseEvent.MOUSE_DRAGGED) { 3334 // We don't want to do the drags when the mouse moves if we're 3335 // autoscrolling. It makes it feel spastic. 3336 dispatch = !Autoscroller.isRunning(this); 3337 Autoscroller.processMouseDragged(e); 3338 } 3339 if (dispatch) { 3340 super.processMouseMotionEvent(e); 3341 } 3342 } 3343 3344 // Inner classes can't get at this method from a super class 3345 void superProcessMouseMotionEvent(MouseEvent e) { 3346 super.processMouseMotionEvent(e); 3347 } 3348 3349 /** 3350 * This is invoked by the <code>RepaintManager</code> if 3351 * <code>createImage</code> is called on the component. 3352 * 3353 * @param newValue true if the double buffer image was created from this component 3354 */ 3355 void setCreatedDoubleBuffer(boolean newValue) { 3356 setFlag(CREATED_DOUBLE_BUFFER, newValue); 3357 } 3358 3359 /** 3360 * Returns true if the <code>RepaintManager</code> 3361 * created the double buffer image from the component. 3362 * 3363 * @return true if this component had a double buffer image, false otherwise 3364 */ 3365 boolean getCreatedDoubleBuffer() { 3366 return getFlag(CREATED_DOUBLE_BUFFER); 3367 } 3368 3369 /** 3370 * <code>ActionStandin</code> is used as a standin for 3371 * <code>ActionListeners</code> that are 3372 * added via <code>registerKeyboardAction</code>. 3373 */ 3374 final class ActionStandin implements Action { 3375 private final ActionListener actionListener; 3376 private final String command; 3377 // This will be non-null if actionListener is an Action. 3378 private final Action action; 3379 3380 ActionStandin(ActionListener actionListener, String command) { 3381 this.actionListener = actionListener; 3382 if (actionListener instanceof Action) { 3383 this.action = (Action)actionListener; 3384 } 3385 else { 3386 this.action = null; 3387 } 3388 this.command = command; 3389 } 3390 3391 public Object getValue(String key) { 3392 if (key != null) { 3393 if (key.equals(Action.ACTION_COMMAND_KEY)) { 3394 return command; 3395 } 3396 if (action != null) { 3397 return action.getValue(key); 3398 } 3399 if (key.equals(NAME)) { 3400 return "ActionStandin"; 3401 } 3402 } 3403 return null; 3404 } 3405 3406 public boolean isEnabled() { 3407 if (actionListener == null) { 3408 // This keeps the old semantics where 3409 // registerKeyboardAction(null) would essentialy remove 3410 // the binding. We don't remove the binding from the 3411 // InputMap as that would still allow parent InputMaps 3412 // bindings to be accessed. 3413 return false; 3414 } 3415 if (action == null) { 3416 return true; 3417 } 3418 return action.isEnabled(); 3419 } 3420 3421 public void actionPerformed(ActionEvent ae) { 3422 if (actionListener != null) { 3423 actionListener.actionPerformed(ae); 3424 } 3425 } 3426 3427 // We don't allow any values to be added. 3428 public void putValue(String key, Object value) {} 3429 3430 // Does nothing, our enabledness is determiend from our asociated 3431 // action. 3432 public void setEnabled(boolean b) { } 3433 3434 public void addPropertyChangeListener 3435 (PropertyChangeListener listener) {} 3436 public void removePropertyChangeListener 3437 (PropertyChangeListener listener) {} 3438 } 3439 3440 3441 // This class is used by the KeyboardState class to provide a single 3442 // instance that can be stored in the AppContext. 3443 static final class IntVector { 3444 int array[] = null; 3445 int count = 0; 3446 int capacity = 0; 3447 3448 int size() { 3449 return count; 3450 } 3451 3452 int elementAt(int index) { 3453 return array[index]; 3454 } 3455 3456 void addElement(int value) { 3457 if (count == capacity) { 3458 capacity = (capacity + 2) * 2; 3459 int[] newarray = new int[capacity]; 3460 if (count > 0) { 3461 System.arraycopy(array, 0, newarray, 0, count); 3462 } 3463 array = newarray; 3464 } 3465 array[count++] = value; 3466 } 3467 3468 void setElementAt(int value, int index) { 3469 array[index] = value; 3470 } 3471 } 3472 3473 @SuppressWarnings("serial") 3474 static class KeyboardState implements Serializable { 3475 private static final Object keyCodesKey = 3476 JComponent.KeyboardState.class; 3477 3478 // Get the array of key codes from the AppContext. 3479 static IntVector getKeyCodeArray() { 3480 IntVector iv = 3481 (IntVector)SwingUtilities.appContextGet(keyCodesKey); 3482 if (iv == null) { 3483 iv = new IntVector(); 3484 SwingUtilities.appContextPut(keyCodesKey, iv); 3485 } 3486 return iv; 3487 } 3488 3489 static void registerKeyPressed(int keyCode) { 3490 IntVector kca = getKeyCodeArray(); 3491 int count = kca.size(); 3492 int i; 3493 for(i=0;i<count;i++) { 3494 if(kca.elementAt(i) == -1){ 3495 kca.setElementAt(keyCode, i); 3496 return; 3497 } 3498 } 3499 kca.addElement(keyCode); 3500 } 3501 3502 static void registerKeyReleased(int keyCode) { 3503 IntVector kca = getKeyCodeArray(); 3504 int count = kca.size(); 3505 int i; 3506 for(i=0;i<count;i++) { 3507 if(kca.elementAt(i) == keyCode) { 3508 kca.setElementAt(-1, i); 3509 return; 3510 } 3511 } 3512 } 3513 3514 static boolean keyIsPressed(int keyCode) { 3515 IntVector kca = getKeyCodeArray(); 3516 int count = kca.size(); 3517 int i; 3518 for(i=0;i<count;i++) { 3519 if(kca.elementAt(i) == keyCode) { 3520 return true; 3521 } 3522 } 3523 return false; 3524 } 3525 3526 /** 3527 * Updates internal state of the KeyboardState and returns true 3528 * if the event should be processed further. 3529 */ 3530 static boolean shouldProcess(KeyEvent e) { 3531 switch (e.getID()) { 3532 case KeyEvent.KEY_PRESSED: 3533 if (!keyIsPressed(e.getKeyCode())) { 3534 registerKeyPressed(e.getKeyCode()); 3535 } 3536 return true; 3537 case KeyEvent.KEY_RELEASED: 3538 // We are forced to process VK_PRINTSCREEN separately because 3539 // the Windows doesn't generate the key pressed event for 3540 // printscreen and it block the processing of key release 3541 // event for printscreen. 3542 if (keyIsPressed(e.getKeyCode()) || e.getKeyCode()==KeyEvent.VK_PRINTSCREEN) { 3543 registerKeyReleased(e.getKeyCode()); 3544 return true; 3545 } 3546 return false; 3547 case KeyEvent.KEY_TYPED: 3548 return true; 3549 default: 3550 // Not a known KeyEvent type, bail. 3551 return false; 3552 } 3553 } 3554 } 3555 3556 static final sun.awt.RequestFocusController focusController = 3557 new sun.awt.RequestFocusController() { 3558 public boolean acceptRequestFocus(Component from, Component to, 3559 boolean temporary, boolean focusedWindowChangeAllowed, 3560 sun.awt.CausedFocusEvent.Cause cause) 3561 { 3562 if ((to == null) || !(to instanceof JComponent)) { 3563 return true; 3564 } 3565 3566 if ((from == null) || !(from instanceof JComponent)) { 3567 return true; 3568 } 3569 3570 JComponent target = (JComponent) to; 3571 if (!target.getVerifyInputWhenFocusTarget()) { 3572 return true; 3573 } 3574 3575 JComponent jFocusOwner = (JComponent)from; 3576 InputVerifier iv = jFocusOwner.getInputVerifier(); 3577 3578 if (iv == null) { 3579 return true; 3580 } else { 3581 Object currentSource = SwingUtilities.appContextGet( 3582 INPUT_VERIFIER_SOURCE_KEY); 3583 if (currentSource == jFocusOwner) { 3584 // We're currently calling into the InputVerifier 3585 // for this component, so allow the focus change. 3586 return true; 3587 } 3588 SwingUtilities.appContextPut(INPUT_VERIFIER_SOURCE_KEY, 3589 jFocusOwner); 3590 try { 3591 return iv.shouldYieldFocus(jFocusOwner); 3592 } finally { 3593 if (currentSource != null) { 3594 // We're already in the InputVerifier for 3595 // currentSource. By resetting the currentSource 3596 // we ensure that if the InputVerifier for 3597 // currentSource does a requestFocus, we don't 3598 // try and run the InputVerifier again. 3599 SwingUtilities.appContextPut( 3600 INPUT_VERIFIER_SOURCE_KEY, currentSource); 3601 } else { 3602 SwingUtilities.appContextRemove( 3603 INPUT_VERIFIER_SOURCE_KEY); 3604 } 3605 } 3606 } 3607 } 3608 }; 3609 3610 /* 3611 * --- Accessibility Support --- 3612 */ 3613 3614 /** 3615 * @deprecated As of JDK version 1.1, 3616 * replaced by <code>java.awt.Component.setEnabled(boolean)</code>. 3617 */ 3618 @Deprecated 3619 public void enable() { 3620 if (isEnabled() != true) { 3621 super.enable(); 3622 if (accessibleContext != null) { 3623 accessibleContext.firePropertyChange( 3624 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 3625 null, AccessibleState.ENABLED); 3626 } 3627 } 3628 } 3629 3630 /** 3631 * @deprecated As of JDK version 1.1, 3632 * replaced by <code>java.awt.Component.setEnabled(boolean)</code>. 3633 */ 3634 @Deprecated 3635 public void disable() { 3636 if (isEnabled() != false) { 3637 super.disable(); 3638 if (accessibleContext != null) { 3639 accessibleContext.firePropertyChange( 3640 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 3641 AccessibleState.ENABLED, null); 3642 } 3643 } 3644 } 3645 3646 /** 3647 * Inner class of JComponent used to provide default support for 3648 * accessibility. This class is not meant to be used directly by 3649 * application developers, but is instead meant only to be 3650 * subclassed by component developers. 3651 * <p> 3652 * <strong>Warning:</strong> 3653 * Serialized objects of this class will not be compatible with 3654 * future Swing releases. The current serialization support is 3655 * appropriate for short term storage or RMI between applications running 3656 * the same version of Swing. As of 1.4, support for long term storage 3657 * of all JavaBeans<sup><font size="-2">TM</font></sup> 3658 * has been added to the <code>java.beans</code> package. 3659 * Please see {@link java.beans.XMLEncoder}. 3660 */ 3661 public abstract class AccessibleJComponent extends AccessibleAWTContainer 3662 implements AccessibleExtendedComponent 3663 { 3664 /** 3665 * Though the class is abstract, this should be called by 3666 * all sub-classes. 3667 */ 3668 protected AccessibleJComponent() { 3669 super(); 3670 } 3671 3672 /** 3673 * Number of PropertyChangeListener objects registered. It's used 3674 * to add/remove ContainerListener and FocusListener to track 3675 * target JComponent's state 3676 */ 3677 private volatile transient int propertyListenersCount = 0; 3678 3679 /** 3680 * This field duplicates the one in java.awt.Component.AccessibleAWTComponent, 3681 * so it has been deprecated. 3682 */ 3683 @Deprecated 3684 protected FocusListener accessibleFocusHandler = null; 3685 3686 /** 3687 * Fire PropertyChange listener, if one is registered, 3688 * when children added/removed. 3689 */ 3690 protected class AccessibleContainerHandler 3691 implements ContainerListener { 3692 public void componentAdded(ContainerEvent e) { 3693 Component c = e.getChild(); 3694 if (c != null && c instanceof Accessible) { 3695 AccessibleJComponent.this.firePropertyChange( 3696 AccessibleContext.ACCESSIBLE_CHILD_PROPERTY, 3697 null, c.getAccessibleContext()); 3698 } 3699 } 3700 public void componentRemoved(ContainerEvent e) { 3701 Component c = e.getChild(); 3702 if (c != null && c instanceof Accessible) { 3703 AccessibleJComponent.this.firePropertyChange( 3704 AccessibleContext.ACCESSIBLE_CHILD_PROPERTY, 3705 c.getAccessibleContext(), null); 3706 } 3707 } 3708 } 3709 3710 /** 3711 * Fire PropertyChange listener, if one is registered, 3712 * when focus events happen 3713 * @since 1.3 3714 */ 3715 protected class AccessibleFocusHandler implements FocusListener { 3716 public void focusGained(FocusEvent event) { 3717 if (accessibleContext != null) { 3718 accessibleContext.firePropertyChange( 3719 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 3720 null, AccessibleState.FOCUSED); 3721 } 3722 } 3723 public void focusLost(FocusEvent event) { 3724 if (accessibleContext != null) { 3725 accessibleContext.firePropertyChange( 3726 AccessibleContext.ACCESSIBLE_STATE_PROPERTY, 3727 AccessibleState.FOCUSED, null); 3728 } 3729 } 3730 } // inner class AccessibleFocusHandler 3731 3732 3733 /** 3734 * Adds a PropertyChangeListener to the listener list. 3735 * 3736 * @param listener the PropertyChangeListener to be added 3737 */ 3738 public void addPropertyChangeListener(PropertyChangeListener listener) { 3739 if (accessibleFocusHandler == null) { 3740 accessibleFocusHandler = new AccessibleFocusHandler(); 3741 } 3742 if (accessibleContainerHandler == null) { 3743 accessibleContainerHandler = new AccessibleContainerHandler(); 3744 } 3745 if (propertyListenersCount++ == 0) { 3746 JComponent.this.addFocusListener(accessibleFocusHandler); 3747 JComponent.this.addContainerListener(accessibleContainerHandler); 3748 } 3749 super.addPropertyChangeListener(listener); 3750 } 3751 3752 /** 3753 * Removes a PropertyChangeListener from the listener list. 3754 * This removes a PropertyChangeListener that was registered 3755 * for all properties. 3756 * 3757 * @param listener the PropertyChangeListener to be removed 3758 */ 3759 public void removePropertyChangeListener(PropertyChangeListener listener) { 3760 if (--propertyListenersCount == 0) { 3761 JComponent.this.removeFocusListener(accessibleFocusHandler); 3762 JComponent.this.removeContainerListener(accessibleContainerHandler); 3763 } 3764 super.removePropertyChangeListener(listener); 3765 } 3766 3767 3768 3769 /** 3770 * Recursively search through the border hierarchy (if it exists) 3771 * for a TitledBorder with a non-null title. This does a depth 3772 * first search on first the inside borders then the outside borders. 3773 * The assumption is that titles make really pretty inside borders 3774 * but not very pretty outside borders in compound border situations. 3775 * It's rather arbitrary, but hopefully decent UI programmers will 3776 * not create multiple titled borders for the same component. 3777 */ 3778 protected String getBorderTitle(Border b) { 3779 String s; 3780 if (b instanceof TitledBorder) { 3781 return ((TitledBorder) b).getTitle(); 3782 } else if (b instanceof CompoundBorder) { 3783 s = getBorderTitle(((CompoundBorder) b).getInsideBorder()); 3784 if (s == null) { 3785 s = getBorderTitle(((CompoundBorder) b).getOutsideBorder()); 3786 } 3787 return s; 3788 } else { 3789 return null; 3790 } 3791 } 3792 3793 // AccessibleContext methods 3794 // 3795 /** 3796 * Gets the accessible name of this object. This should almost never 3797 * return java.awt.Component.getName(), as that generally isn't 3798 * a localized name, and doesn't have meaning for the user. If the 3799 * object is fundamentally a text object (such as a menu item), the 3800 * accessible name should be the text of the object (for example, 3801 * "save"). 3802 * If the object has a tooltip, the tooltip text may also be an 3803 * appropriate String to return. 3804 * 3805 * @return the localized name of the object -- can be null if this 3806 * object does not have a name 3807 * @see AccessibleContext#setAccessibleName 3808 */ 3809 public String getAccessibleName() { 3810 String name = accessibleName; 3811 3812 // fallback to the client name property 3813 // 3814 if (name == null) { 3815 name = (String)getClientProperty(AccessibleContext.ACCESSIBLE_NAME_PROPERTY); 3816 } 3817 3818 // fallback to the titled border if it exists 3819 // 3820 if (name == null) { 3821 name = getBorderTitle(getBorder()); 3822 } 3823 3824 // fallback to the label labeling us if it exists 3825 // 3826 if (name == null) { 3827 Object o = getClientProperty(JLabel.LABELED_BY_PROPERTY); 3828 if (o instanceof Accessible) { 3829 AccessibleContext ac = ((Accessible) o).getAccessibleContext(); 3830 if (ac != null) { 3831 name = ac.getAccessibleName(); 3832 } 3833 } 3834 } 3835 return name; 3836 } 3837 3838 /** 3839 * Gets the accessible description of this object. This should be 3840 * a concise, localized description of what this object is - what 3841 * is its meaning to the user. If the object has a tooltip, the 3842 * tooltip text may be an appropriate string to return, assuming 3843 * it contains a concise description of the object (instead of just 3844 * the name of the object - for example a "Save" icon on a toolbar that 3845 * had "save" as the tooltip text shouldn't return the tooltip 3846 * text as the description, but something like "Saves the current 3847 * text document" instead). 3848 * 3849 * @return the localized description of the object -- can be null if 3850 * this object does not have a description 3851 * @see AccessibleContext#setAccessibleDescription 3852 */ 3853 public String getAccessibleDescription() { 3854 String description = accessibleDescription; 3855 3856 // fallback to the client description property 3857 // 3858 if (description == null) { 3859 description = (String)getClientProperty(AccessibleContext.ACCESSIBLE_DESCRIPTION_PROPERTY); 3860 } 3861 3862 // fallback to the tool tip text if it exists 3863 // 3864 if (description == null) { 3865 try { 3866 description = getToolTipText(); 3867 } catch (Exception e) { 3868 // Just in case the subclass overrode the 3869 // getToolTipText method and actually 3870 // requires a MouseEvent. 3871 // [[[FIXME: WDW - we probably should require this 3872 // method to take a MouseEvent and just pass it on 3873 // to getToolTipText. The swing-feedback traffic 3874 // leads me to believe getToolTipText might change, 3875 // though, so I was hesitant to make this change at 3876 // this time.]]] 3877 } 3878 } 3879 3880 // fallback to the label labeling us if it exists 3881 // 3882 if (description == null) { 3883 Object o = getClientProperty(JLabel.LABELED_BY_PROPERTY); 3884 if (o instanceof Accessible) { 3885 AccessibleContext ac = ((Accessible) o).getAccessibleContext(); 3886 if (ac != null) { 3887 description = ac.getAccessibleDescription(); 3888 } 3889 } 3890 } 3891 3892 return description; 3893 } 3894 3895 /** 3896 * Gets the role of this object. 3897 * 3898 * @return an instance of AccessibleRole describing the role of the 3899 * object 3900 * @see AccessibleRole 3901 */ 3902 public AccessibleRole getAccessibleRole() { 3903 return AccessibleRole.SWING_COMPONENT; 3904 } 3905 3906 /** 3907 * Gets the state of this object. 3908 * 3909 * @return an instance of AccessibleStateSet containing the current 3910 * state set of the object 3911 * @see AccessibleState 3912 */ 3913 public AccessibleStateSet getAccessibleStateSet() { 3914 AccessibleStateSet states = super.getAccessibleStateSet(); 3915 if (JComponent.this.isOpaque()) { 3916 states.add(AccessibleState.OPAQUE); 3917 } 3918 return states; 3919 } 3920 3921 /** 3922 * Returns the number of accessible children in the object. If all 3923 * of the children of this object implement Accessible, than this 3924 * method should return the number of children of this object. 3925 * 3926 * @return the number of accessible children in the object. 3927 */ 3928 public int getAccessibleChildrenCount() { 3929 return super.getAccessibleChildrenCount(); 3930 } 3931 3932 /** 3933 * Returns the nth Accessible child of the object. 3934 * 3935 * @param i zero-based index of child 3936 * @return the nth Accessible child of the object 3937 */ 3938 public Accessible getAccessibleChild(int i) { 3939 return super.getAccessibleChild(i); 3940 } 3941 3942 // ----- AccessibleExtendedComponent 3943 3944 /** 3945 * Returns the AccessibleExtendedComponent 3946 * 3947 * @return the AccessibleExtendedComponent 3948 */ 3949 AccessibleExtendedComponent getAccessibleExtendedComponent() { 3950 return this; 3951 } 3952 3953 /** 3954 * Returns the tool tip text 3955 * 3956 * @return the tool tip text, if supported, of the object; 3957 * otherwise, null 3958 * @since 1.4 3959 */ 3960 public String getToolTipText() { 3961 return JComponent.this.getToolTipText(); 3962 } 3963 3964 /** 3965 * Returns the titled border text 3966 * 3967 * @return the titled border text, if supported, of the object; 3968 * otherwise, null 3969 * @since 1.4 3970 */ 3971 public String getTitledBorderText() { 3972 Border border = JComponent.this.getBorder(); 3973 if (border instanceof TitledBorder) { 3974 return ((TitledBorder)border).getTitle(); 3975 } else { 3976 return null; 3977 } 3978 } 3979 3980 /** 3981 * Returns key bindings associated with this object 3982 * 3983 * @return the key bindings, if supported, of the object; 3984 * otherwise, null 3985 * @see AccessibleKeyBinding 3986 * @since 1.4 3987 */ 3988 public AccessibleKeyBinding getAccessibleKeyBinding() { 3989 return null; 3990 } 3991 } // inner class AccessibleJComponent 3992 3993 3994 /** 3995 * Returns an <code>ArrayTable</code> used for 3996 * key/value "client properties" for this component. If the 3997 * <code>clientProperties</code> table doesn't exist, an empty one 3998 * will be created. 3999 * 4000 * @return an ArrayTable 4001 * @see #putClientProperty 4002 * @see #getClientProperty 4003 */ 4004 private ArrayTable getClientProperties() { 4005 if (clientProperties == null) { 4006 clientProperties = new ArrayTable(); 4007 } 4008 return clientProperties; 4009 } 4010 4011 4012 /** 4013 * Returns the value of the property with the specified key. Only 4014 * properties added with <code>putClientProperty</code> will return 4015 * a non-<code>null</code> value. 4016 * 4017 * @param key the being queried 4018 * @return the value of this property or <code>null</code> 4019 * @see #putClientProperty 4020 */ 4021 public final Object getClientProperty(Object key) { 4022 if (key == SwingUtilities2.AA_TEXT_PROPERTY_KEY) { 4023 return aaTextInfo; 4024 } else if (key == SwingUtilities2.COMPONENT_UI_PROPERTY_KEY) { 4025 return ui; 4026 } 4027 if(clientProperties == null) { 4028 return null; 4029 } else { 4030 synchronized(clientProperties) { 4031 return clientProperties.get(key); 4032 } 4033 } 4034 } 4035 4036 /** 4037 * Adds an arbitrary key/value "client property" to this component. 4038 * <p> 4039 * The <code>get/putClientProperty</code> methods provide access to 4040 * a small per-instance hashtable. Callers can use get/putClientProperty 4041 * to annotate components that were created by another module. 4042 * For example, a 4043 * layout manager might store per child constraints this way. For example: 4044 * <pre> 4045 * componentA.putClientProperty("to the left of", componentB); 4046 * </pre> 4047 * If value is <code>null</code> this method will remove the property. 4048 * Changes to client properties are reported with 4049 * <code>PropertyChange</code> events. 4050 * The name of the property (for the sake of PropertyChange 4051 * events) is <code>key.toString()</code>. 4052 * <p> 4053 * The <code>clientProperty</code> dictionary is not intended to 4054 * support large 4055 * scale extensions to JComponent nor should be it considered an 4056 * alternative to subclassing when designing a new component. 4057 * 4058 * @param key the new client property key 4059 * @param value the new client property value; if <code>null</code> 4060 * this method will remove the property 4061 * @see #getClientProperty 4062 * @see #addPropertyChangeListener 4063 */ 4064 public final void putClientProperty(Object key, Object value) { 4065 if (key == SwingUtilities2.AA_TEXT_PROPERTY_KEY) { 4066 aaTextInfo = value; 4067 return; 4068 } 4069 if (value == null && clientProperties == null) { 4070 // Both the value and ArrayTable are null, implying we don't 4071 // have to do anything. 4072 return; 4073 } 4074 ArrayTable clientProperties = getClientProperties(); 4075 Object oldValue; 4076 synchronized(clientProperties) { 4077 oldValue = clientProperties.get(key); 4078 if (value != null) { 4079 clientProperties.put(key, value); 4080 } else if (oldValue != null) { 4081 clientProperties.remove(key); 4082 } else { 4083 // old == new == null 4084 return; 4085 } 4086 } 4087 clientPropertyChanged(key, oldValue, value); 4088 firePropertyChange(key.toString(), oldValue, value); 4089 } 4090 4091 // Invoked from putClientProperty. This is provided for subclasses 4092 // in Swing. 4093 void clientPropertyChanged(Object key, Object oldValue, 4094 Object newValue) { 4095 } 4096 4097 4098 /* 4099 * Sets the property with the specified name to the specified value if 4100 * the property has not already been set by the client program. 4101 * This method is used primarily to set UI defaults for properties 4102 * with primitive types, where the values cannot be marked with 4103 * UIResource. 4104 * @see LookAndFeel#installProperty 4105 * @param propertyName String containing the name of the property 4106 * @param value Object containing the property value 4107 */ 4108 void setUIProperty(String propertyName, Object value) { 4109 if (propertyName == "opaque") { 4110 if (!getFlag(OPAQUE_SET)) { 4111 setOpaque(((Boolean)value).booleanValue()); 4112 setFlag(OPAQUE_SET, false); 4113 } 4114 } else if (propertyName == "autoscrolls") { 4115 if (!getFlag(AUTOSCROLLS_SET)) { 4116 setAutoscrolls(((Boolean)value).booleanValue()); 4117 setFlag(AUTOSCROLLS_SET, false); 4118 } 4119 } else if (propertyName == "focusTraversalKeysForward") { 4120 if (!getFlag(FOCUS_TRAVERSAL_KEYS_FORWARD_SET)) { 4121 super.setFocusTraversalKeys(KeyboardFocusManager. 4122 FORWARD_TRAVERSAL_KEYS, 4123 (Set<AWTKeyStroke>)value); 4124 } 4125 } else if (propertyName == "focusTraversalKeysBackward") { 4126 if (!getFlag(FOCUS_TRAVERSAL_KEYS_BACKWARD_SET)) { 4127 super.setFocusTraversalKeys(KeyboardFocusManager. 4128 BACKWARD_TRAVERSAL_KEYS, 4129 (Set<AWTKeyStroke>)value); 4130 } 4131 } else { 4132 throw new IllegalArgumentException("property \""+ 4133 propertyName+ "\" cannot be set using this method"); 4134 } 4135 } 4136 4137 4138 /** 4139 * Sets the focus traversal keys for a given traversal operation for this 4140 * Component. 4141 * Refer to 4142 * {@link java.awt.Component#setFocusTraversalKeys} 4143 * for a complete description of this method. 4144 * <p> 4145 * This method may throw a {@code ClassCastException} if any {@code Object} 4146 * in {@code keystrokes} is not an {@code AWTKeyStroke}. 4147 * 4148 * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, 4149 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or 4150 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS 4151 * @param keystrokes the Set of AWTKeyStroke for the specified operation 4152 * @see java.awt.KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS 4153 * @see java.awt.KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS 4154 * @see java.awt.KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS 4155 * @throws IllegalArgumentException if id is not one of 4156 * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, 4157 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or 4158 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, or if keystrokes 4159 * contains null, or if any keystroke represents a KEY_TYPED event, 4160 * or if any keystroke already maps to another focus traversal 4161 * operation for this Component 4162 * @since 1.5 4163 * @beaninfo 4164 * bound: true 4165 */ 4166 public void 4167 setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) 4168 { 4169 if (id == KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS) { 4170 setFlag(FOCUS_TRAVERSAL_KEYS_FORWARD_SET,true); 4171 } else if (id == KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS) { 4172 setFlag(FOCUS_TRAVERSAL_KEYS_BACKWARD_SET,true); 4173 } 4174 super.setFocusTraversalKeys(id,keystrokes); 4175 } 4176 4177 /* --- Transitional java.awt.Component Support --- 4178 * The methods and fields in this section will migrate to 4179 * java.awt.Component in the next JDK release. 4180 */ 4181 4182 /** 4183 * Returns true if this component is lightweight, that is, if it doesn't 4184 * have a native window system peer. 4185 * 4186 * @return true if this component is lightweight 4187 */ 4188 @SuppressWarnings("deprecation") 4189 public static boolean isLightweightComponent(Component c) { 4190 return c.getPeer() instanceof LightweightPeer; 4191 } 4192 4193 4194 /** 4195 * @deprecated As of JDK 5, 4196 * replaced by <code>Component.setBounds(int, int, int, int)</code>. 4197 * <p> 4198 * Moves and resizes this component. 4199 * 4200 * @param x the new horizontal location 4201 * @param y the new vertical location 4202 * @param w the new width 4203 * @param h the new height 4204 * @see java.awt.Component#setBounds 4205 */ 4206 @Deprecated 4207 public void reshape(int x, int y, int w, int h) { 4208 super.reshape(x, y, w, h); 4209 } 4210 4211 4212 /** 4213 * Stores the bounds of this component into "return value" 4214 * <code>rv</code> and returns <code>rv</code>. 4215 * If <code>rv</code> is <code>null</code> a new <code>Rectangle</code> 4216 * is allocated. This version of <code>getBounds</code> is useful 4217 * if the caller wants to avoid allocating a new <code>Rectangle</code> 4218 * object on the heap. 4219 * 4220 * @param rv the return value, modified to the component's bounds 4221 * @return <code>rv</code>; if <code>rv</code> is <code>null</code> 4222 * return a newly created <code>Rectangle</code> with this 4223 * component's bounds 4224 */ 4225 public Rectangle getBounds(Rectangle rv) { 4226 if (rv == null) { 4227 return new Rectangle(getX(), getY(), getWidth(), getHeight()); 4228 } 4229 else { 4230 rv.setBounds(getX(), getY(), getWidth(), getHeight()); 4231 return rv; 4232 } 4233 } 4234 4235 4236 /** 4237 * Stores the width/height of this component into "return value" 4238 * <code>rv</code> and returns <code>rv</code>. 4239 * If <code>rv</code> is <code>null</code> a new <code>Dimension</code> 4240 * object is allocated. This version of <code>getSize</code> 4241 * is useful if the caller wants to avoid allocating a new 4242 * <code>Dimension</code> object on the heap. 4243 * 4244 * @param rv the return value, modified to the component's size 4245 * @return <code>rv</code> 4246 */ 4247 public Dimension getSize(Dimension rv) { 4248 if (rv == null) { 4249 return new Dimension(getWidth(), getHeight()); 4250 } 4251 else { 4252 rv.setSize(getWidth(), getHeight()); 4253 return rv; 4254 } 4255 } 4256 4257 4258 /** 4259 * Stores the x,y origin of this component into "return value" 4260 * <code>rv</code> and returns <code>rv</code>. 4261 * If <code>rv</code> is <code>null</code> a new <code>Point</code> 4262 * is allocated. This version of <code>getLocation</code> is useful 4263 * if the caller wants to avoid allocating a new <code>Point</code> 4264 * object on the heap. 4265 * 4266 * @param rv the return value, modified to the component's location 4267 * @return <code>rv</code> 4268 */ 4269 public Point getLocation(Point rv) { 4270 if (rv == null) { 4271 return new Point(getX(), getY()); 4272 } 4273 else { 4274 rv.setLocation(getX(), getY()); 4275 return rv; 4276 } 4277 } 4278 4279 4280 /** 4281 * Returns the current x coordinate of the component's origin. 4282 * This method is preferable to writing 4283 * <code>component.getBounds().x</code>, or 4284 * <code>component.getLocation().x</code> because it doesn't cause any 4285 * heap allocations. 4286 * 4287 * @return the current x coordinate of the component's origin 4288 */ 4289 public int getX() { return super.getX(); } 4290 4291 4292 /** 4293 * Returns the current y coordinate of the component's origin. 4294 * This method is preferable to writing 4295 * <code>component.getBounds().y</code>, or 4296 * <code>component.getLocation().y</code> because it doesn't cause any 4297 * heap allocations. 4298 * 4299 * @return the current y coordinate of the component's origin 4300 */ 4301 public int getY() { return super.getY(); } 4302 4303 4304 /** 4305 * Returns the current width of this component. 4306 * This method is preferable to writing 4307 * <code>component.getBounds().width</code>, or 4308 * <code>component.getSize().width</code> because it doesn't cause any 4309 * heap allocations. 4310 * 4311 * @return the current width of this component 4312 */ 4313 public int getWidth() { return super.getWidth(); } 4314 4315 4316 /** 4317 * Returns the current height of this component. 4318 * This method is preferable to writing 4319 * <code>component.getBounds().height</code>, or 4320 * <code>component.getSize().height</code> because it doesn't cause any 4321 * heap allocations. 4322 * 4323 * @return the current height of this component 4324 */ 4325 public int getHeight() { return super.getHeight(); } 4326 4327 /** 4328 * Returns true if this component is completely opaque. 4329 * <p> 4330 * An opaque component paints every pixel within its 4331 * rectangular bounds. A non-opaque component paints only a subset of 4332 * its pixels or none at all, allowing the pixels underneath it to 4333 * "show through". Therefore, a component that does not fully paint 4334 * its pixels provides a degree of transparency. 4335 * <p> 4336 * Subclasses that guarantee to always completely paint their contents 4337 * should override this method and return true. 4338 * 4339 * @return true if this component is completely opaque 4340 * @see #setOpaque 4341 */ 4342 public boolean isOpaque() { 4343 return getFlag(IS_OPAQUE); 4344 } 4345 4346 /** 4347 * If true the component paints every pixel within its bounds. 4348 * Otherwise, the component may not paint some or all of its 4349 * pixels, allowing the underlying pixels to show through. 4350 * <p> 4351 * The default value of this property is false for <code>JComponent</code>. 4352 * However, the default value for this property on most standard 4353 * <code>JComponent</code> subclasses (such as <code>JButton</code> and 4354 * <code>JTree</code>) is look-and-feel dependent. 4355 * 4356 * @param isOpaque true if this component should be opaque 4357 * @see #isOpaque 4358 * @beaninfo 4359 * bound: true 4360 * expert: true 4361 * description: The component's opacity 4362 */ 4363 public void setOpaque(boolean isOpaque) { 4364 boolean oldValue = getFlag(IS_OPAQUE); 4365 setFlag(IS_OPAQUE, isOpaque); 4366 setFlag(OPAQUE_SET, true); 4367 firePropertyChange("opaque", oldValue, isOpaque); 4368 } 4369 4370 4371 /** 4372 * If the specified rectangle is completely obscured by any of this 4373 * component's opaque children then returns true. Only direct children 4374 * are considered, more distant descendants are ignored. A 4375 * <code>JComponent</code> is opaque if 4376 * <code>JComponent.isOpaque()</code> returns true, other lightweight 4377 * components are always considered transparent, and heavyweight components 4378 * are always considered opaque. 4379 * 4380 * @param x x value of specified rectangle 4381 * @param y y value of specified rectangle 4382 * @param width width of specified rectangle 4383 * @param height height of specified rectangle 4384 * @return true if the specified rectangle is obscured by an opaque child 4385 */ 4386 boolean rectangleIsObscured(int x,int y,int width,int height) 4387 { 4388 int numChildren = getComponentCount(); 4389 4390 for(int i = 0; i < numChildren; i++) { 4391 Component child = getComponent(i); 4392 int cx, cy, cw, ch; 4393 4394 cx = child.getX(); 4395 cy = child.getY(); 4396 cw = child.getWidth(); 4397 ch = child.getHeight(); 4398 4399 if (x >= cx && (x + width) <= (cx + cw) && 4400 y >= cy && (y + height) <= (cy + ch) && child.isVisible()) { 4401 4402 if(child instanceof JComponent) { 4403 // System.out.println("A) checking opaque: " + ((JComponent)child).isOpaque() + " " + child); 4404 // System.out.print("B) "); 4405 // Thread.dumpStack(); 4406 return child.isOpaque(); 4407 } else { 4408 /** Sometimes a heavy weight can have a bound larger than its peer size 4409 * so we should always draw under heavy weights 4410 */ 4411 return false; 4412 } 4413 } 4414 } 4415 4416 return false; 4417 } 4418 4419 4420 /** 4421 * Returns the <code>Component</code>'s "visible rect rectangle" - the 4422 * intersection of the visible rectangles for the component <code>c</code> 4423 * and all of its ancestors. The return value is stored in 4424 * <code>visibleRect</code>. 4425 * 4426 * @param c the component 4427 * @param visibleRect a <code>Rectangle</code> computed as the 4428 * intersection of all visible rectangles for the component 4429 * <code>c</code> and all of its ancestors -- this is the 4430 * return value for this method 4431 * @see #getVisibleRect 4432 */ 4433 static final void computeVisibleRect(Component c, Rectangle visibleRect) { 4434 Container p = c.getParent(); 4435 Rectangle bounds = c.getBounds(); 4436 4437 if (p == null || p instanceof Window || p instanceof Applet) { 4438 visibleRect.setBounds(0, 0, bounds.width, bounds.height); 4439 } else { 4440 computeVisibleRect(p, visibleRect); 4441 visibleRect.x -= bounds.x; 4442 visibleRect.y -= bounds.y; 4443 SwingUtilities.computeIntersection(0,0,bounds.width,bounds.height,visibleRect); 4444 } 4445 } 4446 4447 4448 /** 4449 * Returns the <code>Component</code>'s "visible rect rectangle" - the 4450 * intersection of the visible rectangles for this component 4451 * and all of its ancestors. The return value is stored in 4452 * <code>visibleRect</code>. 4453 * 4454 * @param visibleRect a <code>Rectangle</code> computed as the 4455 * intersection of all visible rectangles for this 4456 * component and all of its ancestors -- this is the return 4457 * value for this method 4458 * @see #getVisibleRect 4459 */ 4460 public void computeVisibleRect(Rectangle visibleRect) { 4461 computeVisibleRect(this, visibleRect); 4462 } 4463 4464 4465 /** 4466 * Returns the <code>Component</code>'s "visible rectangle" - the 4467 * intersection of this component's visible rectangle, 4468 * <code>new Rectangle(0, 0, getWidth(), getHeight())</code>, 4469 * and all of its ancestors' visible rectangles. 4470 * 4471 * @return the visible rectangle 4472 */ 4473 public Rectangle getVisibleRect() { 4474 Rectangle visibleRect = new Rectangle(); 4475 4476 computeVisibleRect(visibleRect); 4477 return visibleRect; 4478 } 4479 4480 /** 4481 * Support for reporting bound property changes for boolean properties. 4482 * This method can be called when a bound property has changed and it will 4483 * send the appropriate PropertyChangeEvent to any registered 4484 * PropertyChangeListeners. 4485 * 4486 * @param propertyName the property whose value has changed 4487 * @param oldValue the property's previous value 4488 * @param newValue the property's new value 4489 */ 4490 public void firePropertyChange(String propertyName, 4491 boolean oldValue, boolean newValue) { 4492 super.firePropertyChange(propertyName, oldValue, newValue); 4493 } 4494 4495 4496 /** 4497 * Support for reporting bound property changes for integer properties. 4498 * This method can be called when a bound property has changed and it will 4499 * send the appropriate PropertyChangeEvent to any registered 4500 * PropertyChangeListeners. 4501 * 4502 * @param propertyName the property whose value has changed 4503 * @param oldValue the property's previous value 4504 * @param newValue the property's new value 4505 */ 4506 public void firePropertyChange(String propertyName, 4507 int oldValue, int newValue) { 4508 super.firePropertyChange(propertyName, oldValue, newValue); 4509 } 4510 4511 // XXX This method is implemented as a workaround to a JLS issue with ambiguous 4512 // methods. This should be removed once 4758654 is resolved. 4513 public void firePropertyChange(String propertyName, char oldValue, char newValue) { 4514 super.firePropertyChange(propertyName, oldValue, newValue); 4515 } 4516 4517 /** 4518 * Supports reporting constrained property changes. 4519 * This method can be called when a constrained property has changed 4520 * and it will send the appropriate <code>PropertyChangeEvent</code> 4521 * to any registered <code>VetoableChangeListeners</code>. 4522 * 4523 * @param propertyName the name of the property that was listened on 4524 * @param oldValue the old value of the property 4525 * @param newValue the new value of the property 4526 * @exception java.beans.PropertyVetoException when the attempt to set the 4527 * property is vetoed by the component 4528 */ 4529 protected void fireVetoableChange(String propertyName, Object oldValue, Object newValue) 4530 throws java.beans.PropertyVetoException 4531 { 4532 if (vetoableChangeSupport == null) { 4533 return; 4534 } 4535 vetoableChangeSupport.fireVetoableChange(propertyName, oldValue, newValue); 4536 } 4537 4538 4539 /** 4540 * Adds a <code>VetoableChangeListener</code> to the listener list. 4541 * The listener is registered for all properties. 4542 * 4543 * @param listener the <code>VetoableChangeListener</code> to be added 4544 */ 4545 public synchronized void addVetoableChangeListener(VetoableChangeListener listener) { 4546 if (vetoableChangeSupport == null) { 4547 vetoableChangeSupport = new java.beans.VetoableChangeSupport(this); 4548 } 4549 vetoableChangeSupport.addVetoableChangeListener(listener); 4550 } 4551 4552 4553 /** 4554 * Removes a <code>VetoableChangeListener</code> from the listener list. 4555 * This removes a <code>VetoableChangeListener</code> that was registered 4556 * for all properties. 4557 * 4558 * @param listener the <code>VetoableChangeListener</code> to be removed 4559 */ 4560 public synchronized void removeVetoableChangeListener(VetoableChangeListener listener) { 4561 if (vetoableChangeSupport == null) { 4562 return; 4563 } 4564 vetoableChangeSupport.removeVetoableChangeListener(listener); 4565 } 4566 4567 4568 /** 4569 * Returns an array of all the vetoable change listeners 4570 * registered on this component. 4571 * 4572 * @return all of the component's <code>VetoableChangeListener</code>s 4573 * or an empty 4574 * array if no vetoable change listeners are currently registered 4575 * 4576 * @see #addVetoableChangeListener 4577 * @see #removeVetoableChangeListener 4578 * 4579 * @since 1.4 4580 */ 4581 public synchronized VetoableChangeListener[] getVetoableChangeListeners() { 4582 if (vetoableChangeSupport == null) { 4583 return new VetoableChangeListener[0]; 4584 } 4585 return vetoableChangeSupport.getVetoableChangeListeners(); 4586 } 4587 4588 4589 /** 4590 * Returns the top-level ancestor of this component (either the 4591 * containing <code>Window</code> or <code>Applet</code>), 4592 * or <code>null</code> if this component has not 4593 * been added to any container. 4594 * 4595 * @return the top-level <code>Container</code> that this component is in, 4596 * or <code>null</code> if not in any container 4597 */ 4598 public Container getTopLevelAncestor() { 4599 for(Container p = this; p != null; p = p.getParent()) { 4600 if(p instanceof Window || p instanceof Applet) { 4601 return p; 4602 } 4603 } 4604 return null; 4605 } 4606 4607 private AncestorNotifier getAncestorNotifier() { 4608 return (AncestorNotifier) 4609 getClientProperty(JComponent_ANCESTOR_NOTIFIER); 4610 } 4611 4612 /** 4613 * Registers <code>listener</code> so that it will receive 4614 * <code>AncestorEvents</code> when it or any of its ancestors 4615 * move or are made visible or invisible. 4616 * Events are also sent when the component or its ancestors are added 4617 * or removed from the containment hierarchy. 4618 * 4619 * @param listener the <code>AncestorListener</code> to register 4620 * @see AncestorEvent 4621 */ 4622 public void addAncestorListener(AncestorListener listener) { 4623 AncestorNotifier ancestorNotifier = getAncestorNotifier(); 4624 if (ancestorNotifier == null) { 4625 ancestorNotifier = new AncestorNotifier(this); 4626 putClientProperty(JComponent_ANCESTOR_NOTIFIER, 4627 ancestorNotifier); 4628 } 4629 ancestorNotifier.addAncestorListener(listener); 4630 } 4631 4632 /** 4633 * Unregisters <code>listener</code> so that it will no longer receive 4634 * <code>AncestorEvents</code>. 4635 * 4636 * @param listener the <code>AncestorListener</code> to be removed 4637 * @see #addAncestorListener 4638 */ 4639 public void removeAncestorListener(AncestorListener listener) { 4640 AncestorNotifier ancestorNotifier = getAncestorNotifier(); 4641 if (ancestorNotifier == null) { 4642 return; 4643 } 4644 ancestorNotifier.removeAncestorListener(listener); 4645 if (ancestorNotifier.listenerList.getListenerList().length == 0) { 4646 ancestorNotifier.removeAllListeners(); 4647 putClientProperty(JComponent_ANCESTOR_NOTIFIER, null); 4648 } 4649 } 4650 4651 /** 4652 * Returns an array of all the ancestor listeners 4653 * registered on this component. 4654 * 4655 * @return all of the component's <code>AncestorListener</code>s 4656 * or an empty 4657 * array if no ancestor listeners are currently registered 4658 * 4659 * @see #addAncestorListener 4660 * @see #removeAncestorListener 4661 * 4662 * @since 1.4 4663 */ 4664 public AncestorListener[] getAncestorListeners() { 4665 AncestorNotifier ancestorNotifier = getAncestorNotifier(); 4666 if (ancestorNotifier == null) { 4667 return new AncestorListener[0]; 4668 } 4669 return ancestorNotifier.getAncestorListeners(); 4670 } 4671 4672 /** 4673 * Returns an array of all the objects currently registered 4674 * as <code><em>Foo</em>Listener</code>s 4675 * upon this <code>JComponent</code>. 4676 * <code><em>Foo</em>Listener</code>s are registered using the 4677 * <code>add<em>Foo</em>Listener</code> method. 4678 * 4679 * <p> 4680 * 4681 * You can specify the <code>listenerType</code> argument 4682 * with a class literal, 4683 * such as 4684 * <code><em>Foo</em>Listener.class</code>. 4685 * For example, you can query a 4686 * <code>JComponent</code> <code>c</code> 4687 * for its mouse listeners with the following code: 4688 * <pre>MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));</pre> 4689 * If no such listeners exist, this method returns an empty array. 4690 * 4691 * @param listenerType the type of listeners requested; this parameter 4692 * should specify an interface that descends from 4693 * <code>java.util.EventListener</code> 4694 * @return an array of all objects registered as 4695 * <code><em>Foo</em>Listener</code>s on this component, 4696 * or an empty array if no such 4697 * listeners have been added 4698 * @exception ClassCastException if <code>listenerType</code> 4699 * doesn't specify a class or interface that implements 4700 * <code>java.util.EventListener</code> 4701 * 4702 * @since 1.3 4703 * 4704 * @see #getVetoableChangeListeners 4705 * @see #getAncestorListeners 4706 */ 4707 public <T extends EventListener> T[] getListeners(Class<T> listenerType) { 4708 T[] result; 4709 if (listenerType == AncestorListener.class) { 4710 // AncestorListeners are handled by the AncestorNotifier 4711 result = (T[])getAncestorListeners(); 4712 } 4713 else if (listenerType == VetoableChangeListener.class) { 4714 // VetoableChangeListeners are handled by VetoableChangeSupport 4715 result = (T[])getVetoableChangeListeners(); 4716 } 4717 else if (listenerType == PropertyChangeListener.class) { 4718 // PropertyChangeListeners are handled by PropertyChangeSupport 4719 result = (T[])getPropertyChangeListeners(); 4720 } 4721 else { 4722 result = listenerList.getListeners(listenerType); 4723 } 4724 4725 if (result.length == 0) { 4726 return super.getListeners(listenerType); 4727 } 4728 return result; 4729 } 4730 4731 /** 4732 * Notifies this component that it now has a parent component. 4733 * When this method is invoked, the chain of parent components is 4734 * set up with <code>KeyboardAction</code> event listeners. 4735 * This method is called by the toolkit internally and should 4736 * not be called directly by programs. 4737 * 4738 * @see #registerKeyboardAction 4739 */ 4740 public void addNotify() { 4741 super.addNotify(); 4742 firePropertyChange("ancestor", null, getParent()); 4743 4744 registerWithKeyboardManager(false); 4745 registerNextFocusableComponent(); 4746 } 4747 4748 4749 /** 4750 * Notifies this component that it no longer has a parent component. 4751 * When this method is invoked, any <code>KeyboardAction</code>s 4752 * set up in the the chain of parent components are removed. 4753 * This method is called by the toolkit internally and should 4754 * not be called directly by programs. 4755 * 4756 * @see #registerKeyboardAction 4757 */ 4758 public void removeNotify() { 4759 super.removeNotify(); 4760 // This isn't strictly correct. The event shouldn't be 4761 // fired until *after* the parent is set to null. But 4762 // we only get notified before that happens 4763 firePropertyChange("ancestor", getParent(), null); 4764 4765 unregisterWithKeyboardManager(); 4766 deregisterNextFocusableComponent(); 4767 4768 if (getCreatedDoubleBuffer()) { 4769 RepaintManager.currentManager(this).resetDoubleBuffer(); 4770 setCreatedDoubleBuffer(false); 4771 } 4772 if (autoscrolls) { 4773 Autoscroller.stop(this); 4774 } 4775 } 4776 4777 4778 /** 4779 * Adds the specified region to the dirty region list if the component 4780 * is showing. The component will be repainted after all of the 4781 * currently pending events have been dispatched. 4782 * 4783 * @param tm this parameter is not used 4784 * @param x the x value of the dirty region 4785 * @param y the y value of the dirty region 4786 * @param width the width of the dirty region 4787 * @param height the height of the dirty region 4788 * @see #isPaintingOrigin() 4789 * @see java.awt.Component#isShowing 4790 * @see RepaintManager#addDirtyRegion 4791 */ 4792 public void repaint(long tm, int x, int y, int width, int height) { 4793 RepaintManager.currentManager(this).addDirtyRegion(this, x, y, width, height); 4794 } 4795 4796 4797 /** 4798 * Adds the specified region to the dirty region list if the component 4799 * is showing. The component will be repainted after all of the 4800 * currently pending events have been dispatched. 4801 * 4802 * @param r a <code>Rectangle</code> containing the dirty region 4803 * @see #isPaintingOrigin() 4804 * @see java.awt.Component#isShowing 4805 * @see RepaintManager#addDirtyRegion 4806 */ 4807 public void repaint(Rectangle r) { 4808 repaint(0,r.x,r.y,r.width,r.height); 4809 } 4810 4811 4812 /** 4813 * Supports deferred automatic layout. 4814 * <p> 4815 * Calls <code>invalidate</code> and then adds this component's 4816 * <code>validateRoot</code> to a list of components that need to be 4817 * validated. Validation will occur after all currently pending 4818 * events have been dispatched. In other words after this method 4819 * is called, the first validateRoot (if any) found when walking 4820 * up the containment hierarchy of this component will be validated. 4821 * By default, <code>JRootPane</code>, <code>JScrollPane</code>, 4822 * and <code>JTextField</code> return true 4823 * from <code>isValidateRoot</code>. 4824 * <p> 4825 * This method will automatically be called on this component 4826 * when a property value changes such that size, location, or 4827 * internal layout of this component has been affected. This automatic 4828 * updating differs from the AWT because programs generally no 4829 * longer need to invoke <code>validate</code> to get the contents of the 4830 * GUI to update. 4831 * <p> 4832 * 4833 * @see java.awt.Component#invalidate 4834 * @see java.awt.Container#validate 4835 * @see #isValidateRoot 4836 * @see RepaintManager#addInvalidComponent 4837 */ 4838 public void revalidate() { 4839 if (getParent() == null) { 4840 // Note: We don't bother invalidating here as once added 4841 // to a valid parent invalidate will be invoked (addImpl 4842 // invokes addNotify which will invoke invalidate on the 4843 // new Component). Also, if we do add a check to isValid 4844 // here it can potentially be called before the constructor 4845 // which was causing some people grief. 4846 return; 4847 } 4848 if (SwingUtilities.isEventDispatchThread()) { 4849 invalidate(); 4850 RepaintManager.currentManager(this).addInvalidComponent(this); 4851 } 4852 else { 4853 // To avoid a flood of Runnables when constructing GUIs off 4854 // the EDT, a flag is maintained as to whether or not 4855 // a Runnable has been scheduled. 4856 synchronized(this) { 4857 if (getFlag(REVALIDATE_RUNNABLE_SCHEDULED)) { 4858 return; 4859 } 4860 setFlag(REVALIDATE_RUNNABLE_SCHEDULED, true); 4861 } 4862 Runnable callRevalidate = new Runnable() { 4863 public void run() { 4864 synchronized(JComponent.this) { 4865 setFlag(REVALIDATE_RUNNABLE_SCHEDULED, false); 4866 } 4867 revalidate(); 4868 } 4869 }; 4870 SwingUtilities.invokeLater(callRevalidate); 4871 } 4872 } 4873 4874 /** 4875 * If this method returns true, <code>revalidate</code> calls by 4876 * descendants of this component will cause the entire tree 4877 * beginning with this root to be validated. 4878 * Returns false by default. <code>JScrollPane</code> overrides 4879 * this method and returns true. 4880 * 4881 * @return always returns false 4882 * @see #revalidate 4883 * @see java.awt.Component#invalidate 4884 * @see java.awt.Container#validate 4885 * @see java.awt.Container#isValidateRoot 4886 */ 4887 @Override 4888 public boolean isValidateRoot() { 4889 return false; 4890 } 4891 4892 4893 /** 4894 * Returns true if this component tiles its children -- that is, if 4895 * it can guarantee that the children will not overlap. The 4896 * repainting system is substantially more efficient in this 4897 * common case. <code>JComponent</code> subclasses that can't make this 4898 * guarantee, such as <code>JLayeredPane</code>, 4899 * should override this method to return false. 4900 * 4901 * @return always returns true 4902 */ 4903 public boolean isOptimizedDrawingEnabled() { 4904 return true; 4905 } 4906 4907 /** 4908 * Returns {@code true} if a paint triggered on a child component should cause 4909 * painting to originate from this Component, or one of its ancestors. 4910 * <p/> 4911 * Calling {@link #repaint} or {@link #paintImmediately(int, int, int, int)} 4912 * on a Swing component will result in calling 4913 * the {@link JComponent#paintImmediately(int, int, int, int)} method of 4914 * the first ancestor which {@code isPaintingOrigin()} returns {@code true}, if there are any. 4915 * <p/> 4916 * {@code JComponent} subclasses that need to be painted when any of their 4917 * children are repainted should override this method to return {@code true}. 4918 * 4919 * @return always returns {@code false} 4920 * 4921 * @see #paintImmediately(int, int, int, int) 4922 */ 4923 protected boolean isPaintingOrigin() { 4924 return false; 4925 } 4926 4927 /** 4928 * Paints the specified region in this component and all of its 4929 * descendants that overlap the region, immediately. 4930 * <p> 4931 * It's rarely necessary to call this method. In most cases it's 4932 * more efficient to call repaint, which defers the actual painting 4933 * and can collapse redundant requests into a single paint call. 4934 * This method is useful if one needs to update the display while 4935 * the current event is being dispatched. 4936 * <p> 4937 * This method is to be overridden when the dirty region needs to be changed 4938 * for components that are painting origins. 4939 * 4940 * @param x the x value of the region to be painted 4941 * @param y the y value of the region to be painted 4942 * @param w the width of the region to be painted 4943 * @param h the height of the region to be painted 4944 * @see #repaint 4945 * @see #isPaintingOrigin() 4946 */ 4947 public void paintImmediately(int x,int y,int w, int h) { 4948 Component c = this; 4949 Component parent; 4950 4951 if(!isShowing()) { 4952 return; 4953 } 4954 4955 JComponent paintingOigin = SwingUtilities.getPaintingOrigin(this); 4956 if (paintingOigin != null) { 4957 Rectangle rectangle = SwingUtilities.convertRectangle( 4958 c, new Rectangle(x, y, w, h), paintingOigin); 4959 paintingOigin.paintImmediately(rectangle.x, rectangle.y, rectangle.width, rectangle.height); 4960 return; 4961 } 4962 4963 while(!c.isOpaque()) { 4964 parent = c.getParent(); 4965 if(parent != null) { 4966 x += c.getX(); 4967 y += c.getY(); 4968 c = parent; 4969 } else { 4970 break; 4971 } 4972 4973 if(!(c instanceof JComponent)) { 4974 break; 4975 } 4976 } 4977 if(c instanceof JComponent) { 4978 ((JComponent)c)._paintImmediately(x,y,w,h); 4979 } else { 4980 c.repaint(x,y,w,h); 4981 } 4982 } 4983 4984 /** 4985 * Paints the specified region now. 4986 * 4987 * @param r a <code>Rectangle</code> containing the region to be painted 4988 */ 4989 public void paintImmediately(Rectangle r) { 4990 paintImmediately(r.x,r.y,r.width,r.height); 4991 } 4992 4993 /** 4994 * Returns whether this component should be guaranteed to be on top. 4995 * For example, it would make no sense for <code>Menu</code>s to pop up 4996 * under another component, so they would always return true. 4997 * Most components will want to return false, hence that is the default. 4998 * 4999 * @return always returns false 5000 */ 5001 // package private 5002 boolean alwaysOnTop() { 5003 return false; 5004 } 5005 5006 void setPaintingChild(Component paintingChild) { 5007 this.paintingChild = paintingChild; 5008 } 5009 5010 void _paintImmediately(int x, int y, int w, int h) { 5011 Graphics g; 5012 Container c; 5013 Rectangle b; 5014 5015 int tmpX, tmpY, tmpWidth, tmpHeight; 5016 int offsetX=0,offsetY=0; 5017 5018 boolean hasBuffer = false; 5019 5020 JComponent bufferedComponent = null; 5021 JComponent paintingComponent = this; 5022 5023 RepaintManager repaintManager = RepaintManager.currentManager(this); 5024 // parent Container's up to Window or Applet. First container is 5025 // the direct parent. Note that in testing it was faster to 5026 // alloc a new Vector vs keeping a stack of them around, and gc 5027 // seemed to have a minimal effect on this. 5028 java.util.List<Component> path = new java.util.ArrayList<Component>(7); 5029 int pIndex = -1; 5030 int pCount = 0; 5031 5032 tmpX = tmpY = tmpWidth = tmpHeight = 0; 5033 5034 Rectangle paintImmediatelyClip = fetchRectangle(); 5035 paintImmediatelyClip.x = x; 5036 paintImmediatelyClip.y = y; 5037 paintImmediatelyClip.width = w; 5038 paintImmediatelyClip.height = h; 5039 5040 5041 // System.out.println("1) ************* in _paintImmediately for " + this); 5042 5043 boolean ontop = alwaysOnTop() && isOpaque(); 5044 if (ontop) { 5045 SwingUtilities.computeIntersection(0, 0, getWidth(), getHeight(), 5046 paintImmediatelyClip); 5047 if (paintImmediatelyClip.width == 0) { 5048 recycleRectangle(paintImmediatelyClip); 5049 return; 5050 } 5051 } 5052 Component child; 5053 for (c = this, child = null; 5054 c != null && !(c instanceof Window) && !(c instanceof Applet); 5055 child = c, c = c.getParent()) { 5056 JComponent jc = (c instanceof JComponent) ? (JComponent)c : 5057 null; 5058 path.add(c); 5059 if(!ontop && jc != null && !jc.isOptimizedDrawingEnabled()) { 5060 boolean resetPC; 5061 5062 // Children of c may overlap, three possible cases for the 5063 // painting region: 5064 // . Completely obscured by an opaque sibling, in which 5065 // case there is no need to paint. 5066 // . Partially obscured by a sibling: need to start 5067 // painting from c. 5068 // . Otherwise we aren't obscured and thus don't need to 5069 // start painting from parent. 5070 if (c != this) { 5071 if (jc.isPaintingOrigin()) { 5072 resetPC = true; 5073 } 5074 else { 5075 Component[] children = c.getComponents(); 5076 int i = 0; 5077 for (; i<children.length; i++) { 5078 if (children[i] == child) break; 5079 } 5080 switch (jc.getObscuredState(i, 5081 paintImmediatelyClip.x, 5082 paintImmediatelyClip.y, 5083 paintImmediatelyClip.width, 5084 paintImmediatelyClip.height)) { 5085 case NOT_OBSCURED: 5086 resetPC = false; 5087 break; 5088 case COMPLETELY_OBSCURED: 5089 recycleRectangle(paintImmediatelyClip); 5090 return; 5091 default: 5092 resetPC = true; 5093 break; 5094 } 5095 } 5096 } 5097 else { 5098 resetPC = false; 5099 } 5100 5101 if (resetPC) { 5102 // Get rid of any buffer since we draw from here and 5103 // we might draw something larger 5104 paintingComponent = jc; 5105 pIndex = pCount; 5106 offsetX = offsetY = 0; 5107 hasBuffer = false; 5108 } 5109 } 5110 pCount++; 5111 5112 // look to see if the parent (and therefor this component) 5113 // is double buffered 5114 if(repaintManager.isDoubleBufferingEnabled() && jc != null && 5115 jc.isDoubleBuffered()) { 5116 hasBuffer = true; 5117 bufferedComponent = jc; 5118 } 5119 5120 // if we aren't on top, include the parent's clip 5121 if (!ontop) { 5122 int bx = c.getX(); 5123 int by = c.getY(); 5124 tmpWidth = c.getWidth(); 5125 tmpHeight = c.getHeight(); 5126 SwingUtilities.computeIntersection(tmpX,tmpY,tmpWidth,tmpHeight,paintImmediatelyClip); 5127 paintImmediatelyClip.x += bx; 5128 paintImmediatelyClip.y += by; 5129 offsetX += bx; 5130 offsetY += by; 5131 } 5132 } 5133 5134 // If the clip width or height is negative, don't bother painting 5135 if(c == null || c.getPeer() == null || 5136 paintImmediatelyClip.width <= 0 || 5137 paintImmediatelyClip.height <= 0) { 5138 recycleRectangle(paintImmediatelyClip); 5139 return; 5140 } 5141 5142 paintingComponent.setFlag(IS_REPAINTING, true); 5143 5144 paintImmediatelyClip.x -= offsetX; 5145 paintImmediatelyClip.y -= offsetY; 5146 5147 // Notify the Components that are going to be painted of the 5148 // child component to paint to. 5149 if(paintingComponent != this) { 5150 Component comp; 5151 int i = pIndex; 5152 for(; i > 0 ; i--) { 5153 comp = path.get(i); 5154 if(comp instanceof JComponent) { 5155 ((JComponent)comp).setPaintingChild(path.get(i-1)); 5156 } 5157 } 5158 } 5159 try { 5160 if ((g = safelyGetGraphics(paintingComponent, c)) != null) { 5161 try { 5162 if (hasBuffer) { 5163 RepaintManager rm = RepaintManager.currentManager( 5164 bufferedComponent); 5165 rm.beginPaint(); 5166 try { 5167 rm.paint(paintingComponent, bufferedComponent, g, 5168 paintImmediatelyClip.x, 5169 paintImmediatelyClip.y, 5170 paintImmediatelyClip.width, 5171 paintImmediatelyClip.height); 5172 } finally { 5173 rm.endPaint(); 5174 } 5175 } else { 5176 g.setClip(paintImmediatelyClip.x, paintImmediatelyClip.y, 5177 paintImmediatelyClip.width, paintImmediatelyClip.height); 5178 paintingComponent.paint(g); 5179 } 5180 } finally { 5181 g.dispose(); 5182 } 5183 } 5184 } 5185 finally { 5186 // Reset the painting child for the parent components. 5187 if(paintingComponent != this) { 5188 Component comp; 5189 int i = pIndex; 5190 for(; i > 0 ; i--) { 5191 comp = path.get(i); 5192 if(comp instanceof JComponent) { 5193 ((JComponent)comp).setPaintingChild(null); 5194 } 5195 } 5196 } 5197 paintingComponent.setFlag(IS_REPAINTING, false); 5198 } 5199 recycleRectangle(paintImmediatelyClip); 5200 } 5201 5202 /** 5203 * Paints to the specified graphics. This does not set the clip and it 5204 * does not adjust the Graphics in anyway, callers must do that first. 5205 * This method is package-private for RepaintManager.PaintManager and 5206 * its subclasses to call, it is NOT intended for general use outside 5207 * of that. 5208 */ 5209 void paintToOffscreen(Graphics g, int x, int y, int w, int h, int maxX, 5210 int maxY) { 5211 try { 5212 setFlag(ANCESTOR_USING_BUFFER, true); 5213 if ((y + h) < maxY || (x + w) < maxX) { 5214 setFlag(IS_PAINTING_TILE, true); 5215 } 5216 if (getFlag(IS_REPAINTING)) { 5217 // Called from paintImmediately (RepaintManager) to fill 5218 // repaint request 5219 paint(g); 5220 } else { 5221 // Called from paint() (AWT) to repair damage 5222 if(!rectangleIsObscured(x, y, w, h)) { 5223 paintComponent(g); 5224 paintBorder(g); 5225 } 5226 paintChildren(g); 5227 } 5228 } finally { 5229 setFlag(ANCESTOR_USING_BUFFER, false); 5230 setFlag(IS_PAINTING_TILE, false); 5231 } 5232 } 5233 5234 /** 5235 * Returns whether or not the region of the specified component is 5236 * obscured by a sibling. 5237 * 5238 * @return NOT_OBSCURED if non of the siblings above the Component obscure 5239 * it, COMPLETELY_OBSCURED if one of the siblings completely 5240 * obscures the Component or PARTIALLY_OBSCURED if the Comonent is 5241 * only partially obscured. 5242 */ 5243 private int getObscuredState(int compIndex, int x, int y, int width, 5244 int height) { 5245 int retValue = NOT_OBSCURED; 5246 Rectangle tmpRect = fetchRectangle(); 5247 5248 for (int i = compIndex - 1 ; i >= 0 ; i--) { 5249 Component sibling = getComponent(i); 5250 if (!sibling.isVisible()) { 5251 continue; 5252 } 5253 Rectangle siblingRect; 5254 boolean opaque; 5255 if (sibling instanceof JComponent) { 5256 opaque = sibling.isOpaque(); 5257 if (!opaque) { 5258 if (retValue == PARTIALLY_OBSCURED) { 5259 continue; 5260 } 5261 } 5262 } 5263 else { 5264 opaque = true; 5265 } 5266 siblingRect = sibling.getBounds(tmpRect); 5267 if (opaque && x >= siblingRect.x && (x + width) <= 5268 (siblingRect.x + siblingRect.width) && 5269 y >= siblingRect.y && (y + height) <= 5270 (siblingRect.y + siblingRect.height)) { 5271 recycleRectangle(tmpRect); 5272 return COMPLETELY_OBSCURED; 5273 } 5274 else if (retValue == NOT_OBSCURED && 5275 !((x + width <= siblingRect.x) || 5276 (y + height <= siblingRect.y) || 5277 (x >= siblingRect.x + siblingRect.width) || 5278 (y >= siblingRect.y + siblingRect.height))) { 5279 retValue = PARTIALLY_OBSCURED; 5280 } 5281 } 5282 recycleRectangle(tmpRect); 5283 return retValue; 5284 } 5285 5286 /** 5287 * Returns true, which implies that before checking if a child should 5288 * be painted it is first check that the child is not obscured by another 5289 * sibling. This is only checked if <code>isOptimizedDrawingEnabled</code> 5290 * returns false. 5291 * 5292 * @return always returns true 5293 */ 5294 boolean checkIfChildObscuredBySibling() { 5295 return true; 5296 } 5297 5298 5299 private void setFlag(int aFlag, boolean aValue) { 5300 if(aValue) { 5301 flags |= (1 << aFlag); 5302 } else { 5303 flags &= ~(1 << aFlag); 5304 } 5305 } 5306 private boolean getFlag(int aFlag) { 5307 int mask = (1 << aFlag); 5308 return ((flags & mask) == mask); 5309 } 5310 // These functions must be static so that they can be called from 5311 // subclasses inside the package, but whose inheritance hierarhcy includes 5312 // classes outside of the package below JComponent (e.g., JTextArea). 5313 static void setWriteObjCounter(JComponent comp, byte count) { 5314 comp.flags = (comp.flags & ~(0xFF << WRITE_OBJ_COUNTER_FIRST)) | 5315 (count << WRITE_OBJ_COUNTER_FIRST); 5316 } 5317 static byte getWriteObjCounter(JComponent comp) { 5318 return (byte)((comp.flags >> WRITE_OBJ_COUNTER_FIRST) & 0xFF); 5319 } 5320 5321 /** Buffering **/ 5322 5323 /** 5324 * Sets whether this component should use a buffer to paint. 5325 * If set to true, all the drawing from this component will be done 5326 * in an offscreen painting buffer. The offscreen painting buffer will 5327 * the be copied onto the screen. 5328 * If a <code>Component</code> is buffered and one of its ancestor 5329 * is also buffered, the ancestor buffer will be used. 5330 * 5331 * @param aFlag if true, set this component to be double buffered 5332 */ 5333 public void setDoubleBuffered(boolean aFlag) { 5334 setFlag(IS_DOUBLE_BUFFERED,aFlag); 5335 } 5336 5337 /** 5338 * Returns whether this component should use a buffer to paint. 5339 * 5340 * @return true if this component is double buffered, otherwise false 5341 */ 5342 public boolean isDoubleBuffered() { 5343 return getFlag(IS_DOUBLE_BUFFERED); 5344 } 5345 5346 /** 5347 * Returns the <code>JRootPane</code> ancestor for this component. 5348 * 5349 * @return the <code>JRootPane</code> that contains this component, 5350 * or <code>null</code> if no <code>JRootPane</code> is found 5351 */ 5352 public JRootPane getRootPane() { 5353 return SwingUtilities.getRootPane(this); 5354 } 5355 5356 5357 /** Serialization **/ 5358 5359 /** 5360 * This is called from Component by way of reflection. Do NOT change 5361 * the name unless you change the code in Component as well. 5362 */ 5363 void compWriteObjectNotify() { 5364 byte count = JComponent.getWriteObjCounter(this); 5365 JComponent.setWriteObjCounter(this, (byte)(count + 1)); 5366 if (count != 0) { 5367 return; 5368 } 5369 5370 uninstallUIAndProperties(); 5371 5372 /* JTableHeader is in a separate package, which prevents it from 5373 * being able to override this package-private method the way the 5374 * other components can. We don't want to make this method protected 5375 * because it would introduce public-api for a less-than-desirable 5376 * serialization scheme, so we compromise with this 'instanceof' hack 5377 * for now. 5378 */ 5379 if (getToolTipText() != null || 5380 this instanceof javax.swing.table.JTableHeader) { 5381 ToolTipManager.sharedInstance().unregisterComponent(JComponent.this); 5382 } 5383 } 5384 5385 /** 5386 * This object is the <code>ObjectInputStream</code> callback 5387 * that's called after a complete graph of objects (including at least 5388 * one <code>JComponent</code>) has been read. 5389 * It sets the UI property of each Swing component 5390 * that was read to the current default with <code>updateUI</code>. 5391 * <p> 5392 * As each component is read in we keep track of the current set of 5393 * root components here, in the roots vector. Note that there's only one 5394 * <code>ReadObjectCallback</code> per <code>ObjectInputStream</code>, 5395 * they're stored in the static <code>readObjectCallbacks</code> 5396 * hashtable. 5397 * 5398 * @see java.io.ObjectInputStream#registerValidation 5399 * @see SwingUtilities#updateComponentTreeUI 5400 */ 5401 private class ReadObjectCallback implements ObjectInputValidation 5402 { 5403 private final Vector<JComponent> roots = new Vector<JComponent>(1); 5404 private final ObjectInputStream inputStream; 5405 5406 ReadObjectCallback(ObjectInputStream s) throws Exception { 5407 inputStream = s; 5408 s.registerValidation(this, 0); 5409 } 5410 5411 /** 5412 * This is the method that's called after the entire graph 5413 * of objects has been read in. It initializes 5414 * the UI property of all of the copmonents with 5415 * <code>SwingUtilities.updateComponentTreeUI</code>. 5416 */ 5417 public void validateObject() throws InvalidObjectException { 5418 try { 5419 for (JComponent root : roots) { 5420 SwingUtilities.updateComponentTreeUI(root); 5421 } 5422 } 5423 finally { 5424 readObjectCallbacks.remove(inputStream); 5425 } 5426 } 5427 5428 /** 5429 * If <code>c</code> isn't a descendant of a component we've already 5430 * seen, then add it to the roots <code>Vector</code>. 5431 * 5432 * @param c the <code>JComponent</code> to add 5433 */ 5434 private void registerComponent(JComponent c) 5435 { 5436 /* If the Component c is a descendant of one of the 5437 * existing roots (or it IS an existing root), we're done. 5438 */ 5439 for (JComponent root : roots) { 5440 for(Component p = c; p != null; p = p.getParent()) { 5441 if (p == root) { 5442 return; 5443 } 5444 } 5445 } 5446 5447 /* Otherwise: if Component c is an ancestor of any of the 5448 * existing roots then remove them and add c (the "new root") 5449 * to the roots vector. 5450 */ 5451 for(int i = 0; i < roots.size(); i++) { 5452 JComponent root = roots.elementAt(i); 5453 for(Component p = root.getParent(); p != null; p = p.getParent()) { 5454 if (p == c) { 5455 roots.removeElementAt(i--); // !! 5456 break; 5457 } 5458 } 5459 } 5460 5461 roots.addElement(c); 5462 } 5463 } 5464 5465 5466 /** 5467 * We use the <code>ObjectInputStream</code> "registerValidation" 5468 * callback to update the UI for the entire tree of components 5469 * after they've all been read in. 5470 * 5471 * @param s the <code>ObjectInputStream</code> from which to read 5472 */ 5473 private void readObject(ObjectInputStream s) 5474 throws IOException, ClassNotFoundException 5475 { 5476 s.defaultReadObject(); 5477 5478 /* If there's no ReadObjectCallback for this stream yet, that is, if 5479 * this is the first call to JComponent.readObject() for this 5480 * graph of objects, then create a callback and stash it 5481 * in the readObjectCallbacks table. Note that the ReadObjectCallback 5482 * constructor takes care of calling s.registerValidation(). 5483 */ 5484 ReadObjectCallback cb = readObjectCallbacks.get(s); 5485 if (cb == null) { 5486 try { 5487 readObjectCallbacks.put(s, cb = new ReadObjectCallback(s)); 5488 } 5489 catch (Exception e) { 5490 throw new IOException(e.toString()); 5491 } 5492 } 5493 cb.registerComponent(this); 5494 5495 // Read back the client properties. 5496 int cpCount = s.readInt(); 5497 if (cpCount > 0) { 5498 clientProperties = new ArrayTable(); 5499 for (int counter = 0; counter < cpCount; counter++) { 5500 clientProperties.put(s.readObject(), 5501 s.readObject()); 5502 } 5503 } 5504 if (getToolTipText() != null) { 5505 ToolTipManager.sharedInstance().registerComponent(this); 5506 } 5507 setWriteObjCounter(this, (byte)0); 5508 } 5509 5510 5511 /** 5512 * Before writing a <code>JComponent</code> to an 5513 * <code>ObjectOutputStream</code> we temporarily uninstall its UI. 5514 * This is tricky to do because we want to uninstall 5515 * the UI before any of the <code>JComponent</code>'s children 5516 * (or its <code>LayoutManager</code> etc.) are written, 5517 * and we don't want to restore the UI until the most derived 5518 * <code>JComponent</code> subclass has been been stored. 5519 * 5520 * @param s the <code>ObjectOutputStream</code> in which to write 5521 */ 5522 private void writeObject(ObjectOutputStream s) throws IOException { 5523 s.defaultWriteObject(); 5524 if (getUIClassID().equals(uiClassID)) { 5525 byte count = JComponent.getWriteObjCounter(this); 5526 JComponent.setWriteObjCounter(this, --count); 5527 if (count == 0 && ui != null) { 5528 ui.installUI(this); 5529 } 5530 } 5531 ArrayTable.writeArrayTable(s, clientProperties); 5532 } 5533 5534 5535 /** 5536 * Returns a string representation of this <code>JComponent</code>. 5537 * This method 5538 * is intended to be used only for debugging purposes, and the 5539 * content and format of the returned string may vary between 5540 * implementations. The returned string may be empty but may not 5541 * be <code>null</code>. 5542 * 5543 * @return a string representation of this <code>JComponent</code> 5544 */ 5545 protected String paramString() { 5546 String preferredSizeString = (isPreferredSizeSet() ? 5547 getPreferredSize().toString() : ""); 5548 String minimumSizeString = (isMinimumSizeSet() ? 5549 getMinimumSize().toString() : ""); 5550 String maximumSizeString = (isMaximumSizeSet() ? 5551 getMaximumSize().toString() : ""); 5552 String borderString = (border == null ? "" 5553 : (border == this ? "this" : border.toString())); 5554 5555 return super.paramString() + 5556 ",alignmentX=" + alignmentX + 5557 ",alignmentY=" + alignmentY + 5558 ",border=" + borderString + 5559 ",flags=" + flags + // should beef this up a bit 5560 ",maximumSize=" + maximumSizeString + 5561 ",minimumSize=" + minimumSizeString + 5562 ",preferredSize=" + preferredSizeString; 5563 } 5564 5565 /** 5566 * {@inheritDoc} 5567 */ 5568 @Override 5569 @Deprecated 5570 public void hide() { 5571 boolean showing = isShowing(); 5572 super.hide(); 5573 if (showing) { 5574 Container parent = getParent(); 5575 if (parent != null) { 5576 Rectangle r = getBounds(); 5577 parent.repaint(r.x, r.y, r.width, r.height); 5578 } 5579 revalidate(); 5580 } 5581 } 5582 5583 }