Component.java 142 KB
Newer Older
1
/* Component.java -- a graphics component
2
   Copyright (C) 1999, 2000, 2001, 2002, 2003 Free Software Foundation
3

4
This file is part of GNU Classpath.
5

6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */
37

38

39
package java.awt;
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

import java.awt.dnd.DropTarget;
import java.awt.event.ComponentEvent;
import java.awt.event.ComponentListener;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.HierarchyBoundsListener;
import java.awt.event.HierarchyEvent;
import java.awt.event.HierarchyListener;
import java.awt.event.KeyEvent;
import java.awt.event.KeyListener;
import java.awt.event.InputMethodEvent;
import java.awt.event.InputMethodListener;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.awt.event.MouseMotionListener;
import java.awt.event.MouseWheelListener;
import java.awt.event.MouseWheelEvent;
import java.awt.event.PaintEvent;
import java.awt.im.InputContext;
import java.awt.im.InputMethodRequests;
import java.awt.image.BufferStrategy;
import java.awt.image.ColorModel;
import java.awt.image.ImageObserver;
import java.awt.image.ImageProducer;
import java.awt.image.VolatileImage;
import java.awt.peer.ComponentPeer;
import java.awt.peer.LightweightPeer;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.io.ObjectInputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;
Bryce McKinlay committed
73 74
import java.io.PrintStream;
import java.io.PrintWriter;
75 76 77
import java.io.Serializable;
import java.lang.reflect.Array;
import java.util.Collections;
Bryce McKinlay committed
78
import java.util.EventListener;
79 80
import java.util.HashSet;
import java.util.Iterator;
Bryce McKinlay committed
81
import java.util.Locale;
82
import java.util.Set;
Bryce McKinlay committed
83
import java.util.Vector;
84 85 86 87 88 89
import javax.accessibility.Accessible;
import javax.accessibility.AccessibleComponent;
import javax.accessibility.AccessibleContext;
import javax.accessibility.AccessibleRole;
import javax.accessibility.AccessibleState;
import javax.accessibility.AccessibleStateSet;
90

91
/**
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
 * The root of all evil. All graphical representations are subclasses of this
 * giant class, which is designed for screen display and user interaction.
 * This class can be extended directly to build a lightweight component (one
 * not associated with a native window); lightweight components must reside
 * inside a heavyweight window.
 *
 * <p>This class is Serializable, which has some big implications. A user can
 * save the state of all graphical components in one VM, and reload them in
 * another. Note that this class will only save Serializable listeners, and
 * ignore the rest, without causing any serialization exceptions. However, by
 * making a listener serializable, and adding it to another element, you link
 * in that entire element to the state of this component. To get around this,
 * use the idiom shown in the example below - make listeners non-serializable
 * in inner classes, rather than using this object itself as the listener, if
 * external objects do not need to save the state of this object.
 *
 * <p><pre>
 * import java.awt.*;
 * import java.awt.event.*;
 * import java.io.Serializable;
 * class MyApp implements Serializable
 * {
 *   BigObjectThatShouldNotBeSerializedWithAButton bigOne;
 *   // Serializing aButton will not suck in an instance of MyApp, with its
 *   // accompanying field bigOne.
 *   Button aButton = new Button();
 *   class MyActionListener implements ActionListener
 *   {
 *     public void actionPerformed(ActionEvent e)
 *     {
 *       System.out.println("Hello There");
 *     }
 *   }
 *   MyApp()
 *   {
 *     aButton.addActionListener(new MyActionListener());
 *   }
 * }
 *
 * <p>Status: Incomplete. The event dispatch mechanism is implemented. All
 * other methods defined in the J2SE 1.3 API javadoc exist, but are mostly
 * incomplete or only stubs; except for methods relating to the Drag and
 * Drop, Input Method, and Accessibility frameworks: These methods are
 * present but commented out.
 *
 * @author original author unknown
 * @author Eric Blake <ebb9@email.byu.edu>
 * @since 1.0
 * @status still missing 1.4 support
 */
public abstract class Component
  implements ImageObserver, MenuContainer, Serializable
144
{
145 146 147 148 149 150 151 152 153
  // Word to the wise - this file is huge. Search for '\f' (^L) for logical
  // sectioning by fields, public API, private API, and nested classes.


  /**
   * Compatible with JDK 1.0+.
   */
  private static final long serialVersionUID = -7644114512714619750L;

154 155
  /**
   * Constant returned by the <code>getAlignmentY</code> method to indicate
156
   * that the component wishes to be aligned to the top relative to
157
   * other components.
158 159
   *
   * @see #getAlignmentY()
160
   */
161
  public static final float TOP_ALIGNMENT = 0;
162 163

  /**
164
   * Constant returned by the <code>getAlignmentY</code> and
165 166 167
   * <code>getAlignmentX</code> methods to indicate
   * that the component wishes to be aligned to the center relative to
   * other components.
168 169 170
   *
   * @see #getAlignmentX()
   * @see #getAlignmentY()
171
   */
172
  public static final float CENTER_ALIGNMENT = 0.5f;
173

174 175
  /**
   * Constant returned by the <code>getAlignmentY</code> method to indicate
176
   * that the component wishes to be aligned to the bottom relative to
177
   * other components.
178 179
   *
   * @see #getAlignmentY()
180
   */
181
  public static final float BOTTOM_ALIGNMENT = 1;
182 183 184 185 186

  /**
   * Constant returned by the <code>getAlignmentX</code> method to indicate
   * that the component wishes to be aligned to the right relative to
   * other components.
187 188
   *
   * @see #getAlignmentX()
189
   */
190
  public static final float RIGHT_ALIGNMENT = 1;
191 192 193 194 195

  /**
   * Constant returned by the <code>getAlignmentX</code> method to indicate
   * that the component wishes to be aligned to the left relative to
   * other components.
196 197 198 199 200 201 202 203 204 205
   *
   * @see #getAlignmentX()
   */
  public static final float LEFT_ALIGNMENT = 0;

  /**
   * Make the treelock a String so that it can easily be identified
   * in debug dumps. We clone the String in order to avoid a conflict in
   * the unlikely event that some other package uses exactly the same string
   * as a lock object.
206
   */
207
  static final Object treeLock = new String("AWT_TREE_LOCK");
208

209
  // Serialized fields from the serialization spec.
210

211 212 213 214 215 216
  /**
   * The x position of the component in the parent's coordinate system.
   *
   * @see #getLocation()
   * @serial the x position
   */
Bryce McKinlay committed
217
  int x;
218 219 220 221 222 223 224

  /**
   * The y position of the component in the parent's coordinate system.
   *
   * @see #getLocation()
   * @serial the y position
   */
Bryce McKinlay committed
225
  int y;
226 227 228 229 230 231 232

  /**
   * The component width.
   *
   * @see #getSize()
   * @serial the width
   */
Bryce McKinlay committed
233
  int width;
234 235 236 237 238 239 240

  /**
   * The component height.
   *
   * @see #getSize()
   * @serial the height
   */
Bryce McKinlay committed
241
  int height;
242 243 244 245 246 247 248 249

  /**
   * The foreground color for the component. This may be null.
   *
   * @see #getForeground()
   * @see #setForeground(Color)
   * @serial the foreground color
   */
Bryce McKinlay committed
250
  Color foreground;
251 252 253 254 255 256 257 258

  /**
   * The background color for the component. This may be null.
   *
   * @see #getBackground()
   * @see #setBackground(Color)
   * @serial the background color
   */
Bryce McKinlay committed
259
  Color background;
260 261 262 263 264 265 266 267

  /**
   * The default font used in the component. This may be null.
   *
   * @see #getFont()
   * @see #setFont(Font)
   * @serial the font
   */
Bryce McKinlay committed
268
  Font font;
269 270 271 272 273 274

  /**
   * The font in use by the peer, or null if there is no peer.
   *
   * @serial the peer's font
   */
Bryce McKinlay committed
275
  Font peerFont;
276 277 278 279 280 281 282 283

  /**
   * The cursor displayed when the pointer is over this component. This may
   * be null.
   *
   * @see #getCursor()
   * @see #setCursor(Cursor)
   */
Bryce McKinlay committed
284
  Cursor cursor;
285 286 287 288 289 290 291

  /**
   * The locale for the component.
   *
   * @see #getLocale()
   * @see #setLocale(Locale)
   */
Bryce McKinlay committed
292
  Locale locale;
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322

  /**
   * True if the object should ignore repaint events (usually because it is
   * not showing).
   *
   * @see #getIgnoreRepaint()
   * @see #setIgnoreRepaint(boolean)
   * @serial true to ignore repaints
   * @since 1.4
   */
  boolean ignoreRepaint;

  /**
   * True when the object is visible (although it is only showing if all
   * ancestors are likewise visible). For component, this defaults to true.
   *
   * @see #isVisible()
   * @see #setVisible(boolean)
   * @serial true if visible
   */
  boolean visible = true;

  /**
   * True if the object is enabled, meaning it can interact with the user.
   * For component, this defaults to true.
   *
   * @see #isEnabled()
   * @see #setEnabled(boolean)
   * @serial true if enabled
   */
323
  boolean enabled = true;
324 325 326 327 328 329 330 331 332 333

  /**
   * True if the object is valid. This is set to false any time a size
   * adjustment means the component need to be layed out again.
   *
   * @see #isValid()
   * @see #validate()
   * @see #invalidate()
   * @serial true if layout is valid
   */
Bryce McKinlay committed
334
  boolean valid;
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351

  /**
   * The DropTarget for drag-and-drop operations.
   *
   * @see #getDropTarget()
   * @see #setDropTarget(DropTarget)
   * @serial the drop target, or null
   * @since 1.2
   */
  DropTarget dropTarget;

  /**
   * The list of popup menus for this component.
   *
   * @see #add(PopupMenu)
   * @serial the list of popups
   */
Bryce McKinlay committed
352
  Vector popups;
353 354 355 356 357 358 359 360 361

  /**
   * The component's name. May be null, in which case a default name is
   * generated on the first use.
   *
   * @see #getName()
   * @see #setName(String)
   * @serial the name
   */
Bryce McKinlay committed
362
  String name;
363 364 365 366 367 368 369 370 371 372

  /**
   * True once the user has set the name. Note that the user may set the name
   * to null.
   *
   * @see #name
   * @see #getName()
   * @see #setName(String)
   * @serial true if the name has been explicitly set
   */
Bryce McKinlay committed
373
  boolean nameExplicitlySet;
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419

  /**
   * Indicates if the object can be focused. Defaults to true for components.
   *
   * @see #isFocusable()
   * @see #setFocusable(boolean)
   * @since 1.4
   */
  boolean focusable = true;

  /**
   * Tracks whether this component uses default focus traversal, or has a
   * different policy.
   *
   * @see #isFocusTraversableOverridden()
   * @since 1.4
   */
  int isFocusTraversableOverridden;

  /**
   * The focus traversal keys, if not inherited from the parent or default
   * keyboard manager. These sets will contain only AWTKeyStrokes that
   * represent press and release events to use as focus control.
   *
   * @see #getFocusTraversalKeys(int)
   * @see #setFocusTraversalKeys(int, Set)
   * @since 1.4
   */
  Set[] focusTraversalKeys;

  /**
   * True if focus traversal keys are enabled. This defaults to true for
   * Component. If this is true, keystrokes in focusTraversalKeys are trapped
   * and processed automatically rather than being passed on to the component.
   *
   * @see #getFocusTraversalKeysEnabled()
   * @see #setFocusTraversalKeysEnabled(boolean)
   * @since 1.4
   */
  boolean focusTraversalKeysEnabled = true;

  /**
   * Cached information on the minimum size. Should have been transient.
   *
   * @serial ignore
   */
Bryce McKinlay committed
420
  Dimension minSize;
421 422 423 424 425 426

  /**
   * Cached information on the preferred size. Should have been transient.
   *
   * @serial ignore
   */
Bryce McKinlay committed
427
  Dimension prefSize;
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457

  /**
   * Set to true if an event is to be handled by this component, false if
   * it is to be passed up the hierarcy.
   *
   * @see #dispatchEvent(AWTEvent)
   * @serial true to process event locally
   */
  boolean newEventsOnly;

  /**
   * Set by subclasses to enable event handling of particular events, and
   * left alone when modifying listeners. For component, this defaults to
   * enabling only input methods.
   *
   * @see #enableInputMethods(boolean)
   * @see AWTEvent
   * @serial the mask of events to process
   */
  long eventMask = AWTEvent.INPUT_ENABLED_EVENT_MASK;

  /**
   * Describes all registered PropertyChangeListeners.
   *
   * @see #addPropertyChangeListener(PropertyChangeListener)
   * @see #removePropertyChangeListener(PropertyChangeListener)
   * @see #firePropertyChange(String, Object, Object)
   * @serial the property change listeners
   * @since 1.2
   */
Bryce McKinlay committed
458
  PropertyChangeSupport changeSupport;
459 460 461 462 463 464

  /**
   * True if the component has been packed (layed out).
   *
   * @serial true if this is packed
   */
Bryce McKinlay committed
465 466
  boolean isPacked;

467 468 469 470 471 472 473 474
  /**
   * The serialization version for this class. Currently at version 4.
   *
   * XXX How do we handle prior versions?
   *
   * @serial the serialization version
   */
  int componentSerializedDataVersion = 4;
Bryce McKinlay committed
475

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
  /**
   * The accessible context associated with this component. This is only set
   * by subclasses.
   *
   * @see #getAccessibleContext()
   * @serial the accessibility context
   * @since 1.2
   */
  AccessibleContext accessibleContext;


  // Guess what - listeners are special cased in serialization. See
  // readObject and writeObject.

  /** Component listener chain. */
Bryce McKinlay committed
491
  transient ComponentListener componentListener;
492 493

  /** Focus listener chain. */
Bryce McKinlay committed
494
  transient FocusListener focusListener;
495 496

  /** Key listener chain. */
Bryce McKinlay committed
497
  transient KeyListener keyListener;
498 499

  /** Mouse listener chain. */
Bryce McKinlay committed
500
  transient MouseListener mouseListener;
501 502

  /** Mouse motion listener chain. */
Bryce McKinlay committed
503
  transient MouseMotionListener mouseMotionListener;
504 505 506 507 508 509 510 511 512 513 514 515 516

  /**
   * Mouse wheel listener chain.
   *
   * @since 1.4
   */
  transient MouseWheelListener mouseWheelListener;

  /**
   * Input method listener chain.
   *
   * @since 1.2
   */
Bryce McKinlay committed
517
  transient InputMethodListener inputMethodListener;
518 519 520 521 522 523

  /**
   * Hierarcy listener chain.
   *
   * @since 1.3
   */
Bryce McKinlay committed
524
  transient HierarchyListener hierarchyListener;
525 526 527 528 529 530

  /**
   * Hierarcy bounds listener chain.
   *
   * @since 1.3
   */
Bryce McKinlay committed
531 532
  transient HierarchyBoundsListener hierarchyBoundsListener;

533 534 535 536 537 538 539 540 541
  // Anything else is non-serializable, and should be declared "transient".

  /** The parent. */
  transient Container parent;

  /** The associated native peer. */
  transient ComponentPeer peer;

  /** The preferred component orientation. */
542 543
  transient ComponentOrientation orientation = ComponentOrientation.UNKNOWN;

544
  /**
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
   * The associated graphics configuration.
   *
   * @since 1.4
   */
  transient GraphicsConfiguration graphicsConfig;

  /**
   * The buffer strategy for repainting.
   *
   * @since 1.4
   */
  transient BufferStrategy bufferStrategy;


  // Public and protected API.

  /**
   * Default constructor for subclasses. When Component is extended directly,
   * it forms a lightweight component that must be hosted in an opaque native
   * container higher in the tree.
565
   */
Bryce McKinlay committed
566 567 568 569
  protected Component()
  {
  }

570 571 572
  /**
   * Returns the name of this component.
   *
573 574 575
   * @return the name of this component
   * @see #setName(String)
   * @since 1.1
576
   */
Bryce McKinlay committed
577 578
  public String getName()
  {
579
    if (name == null && ! nameExplicitlySet)
Bryce McKinlay committed
580 581 582
      name = generateName();
    return name;
  }
583 584 585 586

  /**
   * Sets the name of this component to the specified name.
   *
587 588 589
   * @param name the new name of this component
   * @see #getName()
   * @since 1.1
590
   */
Bryce McKinlay committed
591 592 593 594 595
  public void setName(String name)
  {
    nameExplicitlySet = true;
    this.name = name;
  }
596 597 598

  /**
   * Returns the parent of this component.
599 600
   *
   * @return the parent of this component
601
   */
Bryce McKinlay committed
602 603
  public Container getParent()
  {
604
    return parent;
605 606 607
  }

  /**
608 609
   * Returns the native windowing system peer for this component. Only the
   * platform specific implementation code should call this method.
610
   *
611 612 613
   * @return the peer for this component
   * @deprecated user programs should not directly manipulate peers; use
   *             {@link #isDisplayable()} instead
614 615
   */
  // Classpath's Gtk peers rely on this.
616
  public ComponentPeer getPeer()
Bryce McKinlay committed
617 618 619
  {
    return peer;
  }
620

621 622 623 624 625 626 627
  /**
   * Set the associated drag-and-drop target, which receives events when this
   * is enabled.
   *
   * @param dt the new drop target
   * @see #isEnabled()
   */
Bryce McKinlay committed
628 629 630 631
  public void setDropTarget(DropTarget dt)
  {
    this.dropTarget = dt;
  }
632 633 634 635 636 637

  /**
   * Gets the associated drag-and-drop target, if there is one.
   *
   * @return the drop target
   */
Bryce McKinlay committed
638 639 640 641
  public DropTarget getDropTarget()
  {
    return dropTarget;
  }
642 643 644 645 646 647 648 649

  /**
   * Returns the graphics configuration of this component, if there is one.
   * If it has not been set, it is inherited from the parent.
   *
   * @return the graphics configuration, or null
   * @since 1.3
   */
Bryce McKinlay committed
650 651
  public GraphicsConfiguration getGraphicsConfiguration()
  {
652 653 654
    return getGraphicsConfigurationImpl();
  }

655 656 657 658
  /**
   * Returns the object used for synchronization locks on this component
   * when performing tree and layout functions.
   *
659
   * @return the synchronization lock for this component
660
   */
Bryce McKinlay committed
661 662
  public final Object getTreeLock()
  {
663
    return treeLock;
Bryce McKinlay committed
664
  }
665

666
  /**
667 668
   * Returns the toolkit in use for this component. The toolkit is associated
   * with the frame this component belongs to.
669
   *
670
   * @return the toolkit for this component
671
   */
Bryce McKinlay committed
672 673
  public Toolkit getToolkit()
  {
674
    if (peer != null)
675
      {
676 677 678
        Toolkit tk = peer.getToolkit();
        if (tk != null)
          return tk;
679
      }
680
    if (parent != null)
681 682
      return parent.getToolkit();
    return Toolkit.getDefaultToolkit();
Bryce McKinlay committed
683
  }
684

685
  /**
686
   * Tests whether or not this component is valid. A invalid component needs
687 688
   * to have its layout redone.
   *
689 690 691
   * @return true if this component is valid
   * @see #validate()
   * @see #invalidate()
692
   */
Bryce McKinlay committed
693 694
  public boolean isValid()
  {
695
    return valid;
Bryce McKinlay committed
696
  }
697 698 699 700 701 702 703 704 705 706 707 708 709 710

  /**
   * Tests if the component is displayable. It must be connected to a native
   * screen resource, and all its ancestors must be displayable. A containment
   * hierarchy is made displayable when a window is packed or made visible.
   *
   * @return true if the component is displayable
   * @see Container#add(Component)
   * @see Container#remove(Component)
   * @see Window#pack()
   * @see Window#show()
   * @see Window#dispose()
   * @since 1.2
   */
Bryce McKinlay committed
711 712
  public boolean isDisplayable()
  {
713 714 715
    if (parent != null)
      return parent.isDisplayable();
    return false;
Bryce McKinlay committed
716
  }
717 718

  /**
719 720
   * Tests whether or not this component is visible. Except for top-level
   * frames, components are initially visible.
721
   *
722 723
   * @return true if the component is visible
   * @see #setVisible(boolean)
724
   */
Bryce McKinlay committed
725 726 727 728
  public boolean isVisible()
  {
    return visible;
  }
729 730 731

  /**
   * Tests whether or not this component is actually being shown on
732
   * the screen. This will be true if and only if it this component is
733 734
   * visible and its parent components are all visible.
   *
735 736
   * @return true if the component is showing on the screen
   * @see #setVisible(boolean)
737
   */
Bryce McKinlay committed
738 739
  public boolean isShowing()
  {
Tom Tromey committed
740
    if (! visible || peer == null)
741 742
      return false;

743
    return parent == null ? true : parent.isShowing();
Bryce McKinlay committed
744
  }
745 746

  /**
747 748
   * Tests whether or not this component is enabled. Components are enabled
   * by default, and must be enabled to receive user input or generate events.
749
   *
750 751
   * @return true if the component is enabled
   * @see #setEnabled(boolean)
752
   */
Bryce McKinlay committed
753 754 755 756
  public boolean isEnabled()
  {
    return enabled;
  }
757 758

  /**
759 760 761
   * Enables or disables this component. The component must be enabled to
   * receive events (except that lightweight components always receive mouse
   * events).
762
   *
763 764 765 766
   * @param enabled true to enable this component
   * @see #isEnabled()
   * @see #isLightweight()
   * @since 1.1
767
   */
Bryce McKinlay committed
768 769 770
  public void setEnabled(boolean b)
  {
    this.enabled = b;
771 772
    if (peer != null)
      peer.setEnabled(b);
Bryce McKinlay committed
773
  }
774 775 776 777

  /**
   * Enables this component.
   *
778
   * @deprecated use {@link #setEnabled(boolean)} instead
779
   */
Bryce McKinlay committed
780 781 782 783
  public void enable()
  {
    setEnabled(true);
  }
784 785 786 787

  /**
   * Enables or disables this component.
   *
788 789
   * @param enabled true to enable this component
   * @deprecated use {@link #setEnabled(boolean)} instead
790
   */
Bryce McKinlay committed
791 792 793 794
  public void enable(boolean b)
  {
    setEnabled(b);
  }
795 796 797 798

  /**
   * Disables this component.
   *
799
   * @deprecated use {@link #setEnabled(boolean)} instead
800
   */
Bryce McKinlay committed
801 802 803 804
  public void disable()
  {
    setEnabled(false);
  }
805

806 807 808 809 810 811 812 813
  /**
   * Checks if this image is painted to an offscreen image buffer that is
   * later copied to screen (double buffering reduces flicker). This version
   * returns false, so subclasses must override it if they provide double
   * buffering.
   *
   * @return true if this is double buffered; defaults to false
   */
Bryce McKinlay committed
814 815 816 817
  public boolean isDoubleBuffered()
  {
    return false;
  }
818

819 820 821 822 823 824 825 826 827
  /**
   * Enables or disables input method support for this component. By default,
   * components have this enabled. Input methods are given the opportunity
   * to process key events before this component and its listeners.
   *
   * @param enable true to enable input method processing
   * @see #processKeyEvent(KeyEvent)
   * @since 1.2
   */
Bryce McKinlay committed
828 829
  public void enableInputMethods(boolean enable)
  {
830 831
    // XXX Implement.
    throw new Error("not implemented");
Bryce McKinlay committed
832
  }
833 834

  /**
835 836
   * Makes this component visible or invisible. Note that it wtill might
   * not show the component, if a parent is invisible.
837
   *
838 839 840
   * @param visible true to make this component visible
   * @see #isVisible()
   * @since 1.1
841
   */
Bryce McKinlay committed
842 843
  public void setVisible(boolean b)
  {
844 845 846
    // Inspection by subclassing shows that Sun's implementation calls
    // show(boolean) which then calls show() or hide(). It is the show()
    // method that is overriden in subclasses like Window.
847 848 849 850
    if (b)
      show();
    else
      hide();
Bryce McKinlay committed
851
  }
852 853 854 855

  /**
   * Makes this component visible on the screen.
   *
856
   * @deprecated use {@link #setVisible(boolean)} instead
857
   */
Bryce McKinlay committed
858 859
  public void show()
  {
860 861 862
    if (peer != null)
      peer.setVisible(true);
    this.visible = true;
Bryce McKinlay committed
863
  }
864 865 866 867

  /**
   * Makes this component visible or invisible.
   *
868 869
   * @param visible true to make this component visible
   * @deprecated use {@link #setVisible(boolean)} instead
870
   */
Bryce McKinlay committed
871 872
  public void show(boolean b)
  {
873
    setVisible(b);
Bryce McKinlay committed
874
  }
875 876 877 878

  /**
   * Hides this component so that it is no longer shown on the screen.
   *
879
   * @deprecated use {@link #setVisible(boolean)} instead
880
   */
Bryce McKinlay committed
881 882
  public void hide()
  {
883 884 885
    if (peer != null)
      peer.setVisible(false);
    this.visible = false;
Bryce McKinlay committed
886
  }
887 888

  /**
889 890
   * Returns this component's foreground color. If not set, this is inherited
   * from the parent.
891
   *
892 893
   * @return this component's foreground color, or null
   * @see #setForeground(Color)
894
   */
Bryce McKinlay committed
895 896
  public Color getForeground()
  {
897 898
    if (foreground != null)
      return foreground;
899
    return parent == null ? null : parent.getForeground();
Bryce McKinlay committed
900
  }
901 902

  /**
903 904
   * Sets this component's foreground color to the specified color. This is a
   * bound property.
905
   *
906 907
   * @param c the new foreground color
   * @see #getForeground()
908
   */
Bryce McKinlay committed
909 910
  public void setForeground(Color c)
  {
911
    firePropertyChange("foreground", foreground, c);
912 913
    if (peer != null)
      peer.setForeground(c);
914 915 916 917 918 919 920 921 922 923 924 925 926
    foreground = c;
  }

  /**
   * Tests if the foreground was explicitly set, or just inherited from the
   * parent.
   *
   * @return true if the foreground has been set
   * @since 1.4
   */
  public boolean isForegroundSet()
  {
    return foreground != null;
Bryce McKinlay committed
927
  }
928

929
  /**
930 931
   * Returns this component's background color. If not set, this is inherited
   * from the parent.
932
   *
933 934
   * @return the background color of the component, or null
   * @see #setBackground(Color)
935
   */
Bryce McKinlay committed
936 937
  public Color getBackground()
  {
938 939
    if (background != null)
      return background;
940
    return parent == null ? null : parent.getBackground();
Bryce McKinlay committed
941
  }
942 943

  /**
944 945 946
   * Sets this component's background color to the specified color. The parts
   * of the component affected by the background color may by system dependent.
   * This is a bound property.
947
   *
948 949
   * @param c the new background color
   * @see #getBackground()
950
   */
Bryce McKinlay committed
951 952
  public void setBackground(Color c)
  {
953
    firePropertyChange("background", background, c);
954 955
    if (peer != null)
      peer.setBackground(c);
956 957 958 959 960 961 962 963 964 965 966 967 968
    background = c;
  }

  /**
   * Tests if the background was explicitly set, or just inherited from the
   * parent.
   *
   * @return true if the background has been set
   * @since 1.4
   */
  public boolean isBackgroundSet()
  {
    return background != null;
Bryce McKinlay committed
969
  }
970 971

  /**
972 973
   * Returns the font in use for this component. If not set, this is inherited
   * from the parent.
974
   *
975 976
   * @return the font for this component
   * @see #setFont(Font)
977
   */
Bryce McKinlay committed
978 979
  public Font getFont()
  {
980 981
    if (font != null)
      return font;
982
    return parent == null ? null : parent.getFont();
Bryce McKinlay committed
983
  }
984 985

  /**
986 987
   * Sets the font for this component to the specified font. This is a bound
   * property.
988
   *
989 990
   * @param font the new font for this component
   * @see #getFont()
991
   */
Bryce McKinlay committed
992 993
  public void setFont(Font f)
  {
994
    firePropertyChange("font", font, f);
995 996
    if (peer != null)
      peer.setFont(f);
997
    font = f;
Bryce McKinlay committed
998
  }
999

1000
  /**
1001
   * Tests if the font was explicitly set, or just inherited from the parent.
1002
   *
1003 1004
   * @return true if the font has been set
   * @since 1.4
1005
   */
1006
  public boolean isFontSet()
Bryce McKinlay committed
1007
  {
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
    return font != null;
  }

  /**
   * Returns the locale for this component. If this component does not
   * have a locale, the locale of the parent component is returned.
   *
   * @return the locale for this component
   * @throws IllegalComponentStateException if it has no locale or parent
   * @see setLocale(Locale)
   * @since 1.1
   */
  public Locale getLocale()
  {
    if (locale != null)
Bryce McKinlay committed
1023 1024 1025
      return locale;
    if (parent == null)
      throw new IllegalComponentStateException
1026
        ("Component has no parent: can't determine Locale");
Bryce McKinlay committed
1027 1028
    return parent.getLocale();
  }
1029 1030

  /**
1031 1032
   * Sets the locale for this component to the specified locale. This is a
   * bound property.
1033
   *
1034
   * @param locale the new locale for this component
1035
   */
1036
  public void setLocale(Locale l)
Bryce McKinlay committed
1037
  {
1038 1039 1040
    firePropertyChange("locale", locale, l);
    locale = l;
    // New writing/layout direction or more/less room for localized labels.
1041
    invalidate();
Bryce McKinlay committed
1042
  }
1043 1044 1045 1046

  /**
   * Returns the color model of the device this componet is displayed on.
   *
1047 1048
   * @return this object's color model
   * @see Toolkit#getColorModel()
1049
   */
Bryce McKinlay committed
1050 1051
  public ColorModel getColorModel()
  {
1052
    GraphicsConfiguration config = getGraphicsConfiguration();
1053 1054
    return config != null ? config.getColorModel()
      : getToolkit().getColorModel();
Bryce McKinlay committed
1055
  }
1056

1057 1058
  /**
   * Returns the location of this component's top left corner relative to
1059 1060
   * its parent component. This may be outdated, so for synchronous behavior,
   * you should use a component listner.
1061
   *
1062 1063 1064 1065
   * @return the location of this component
   * @see #setLocation(int, int)
   * @see #getLocationOnScreen()
   * @since 1.1
1066
   */
Bryce McKinlay committed
1067 1068 1069 1070
  public Point getLocation()
  {
    return new Point(x, y);
  }
1071

1072 1073 1074 1075
  /**
   * Returns the location of this component's top left corner in screen
   * coordinates.
   *
1076 1077
   * @return the location of this component in screen coordinates
   * @throws IllegalComponentStateException if the component is not showing
1078
   */
Bryce McKinlay committed
1079
  public Point getLocationOnScreen()
1080
  {
1081 1082
    if (! isShowing())
      throw new IllegalComponentStateException("component not showing");
Tom Tromey committed
1083
    // We know peer != null here.
1084
    return peer.getLocationOnScreen();
Bryce McKinlay committed
1085 1086
  }

1087 1088 1089 1090
  /**
   * Returns the location of this component's top left corner relative to
   * its parent component.
   *
1091 1092
   * @return the location of this component
   * @deprecated use {@link #getLocation()} instead
1093
   */
Bryce McKinlay committed
1094 1095 1096
  public Point location()
  {
    return getLocation();
1097 1098
  }

1099
  /**
1100 1101 1102
   * Moves this component to the specified location, relative to the parent's
   * coordinates. The coordinates are the new upper left corner of this
   * component.
1103
   *
1104 1105 1106 1107
   * @param x the new X coordinate of this component
   * @param y the new Y coordinate of this component
   * @see #getLocation()
   * @see #setBounds(int, int, int, int)
1108
   */
1109
  public void setLocation(int x, int y)
1110
  {
1111
    if (this.x == x && this.y == y)
1112 1113
      return;
    invalidate();
Bryce McKinlay committed
1114 1115
    this.x = x;
    this.y = y;
1116 1117 1118 1119
    if (peer != null)
      peer.setBounds(x, y, width, height);
  }

1120
  /**
1121 1122 1123
   * Moves this component to the specified location, relative to the parent's
   * coordinates. The coordinates are the new upper left corner of this
   * component.
1124
   *
1125 1126 1127
   * @param x the new X coordinate of this component
   * @param y the new Y coordinate of this component
   * @deprecated use {@link #setLocation(int, int)} instead
1128
   */
Bryce McKinlay committed
1129 1130
  public void move(int x, int y)
  {
1131
    setLocation(x, y);
Bryce McKinlay committed
1132
  }
1133 1134

  /**
1135 1136 1137
   * Moves this component to the specified location, relative to the parent's
   * coordinates. The coordinates are the new upper left corner of this
   * component.
1138
   *
1139 1140 1141 1142 1143
   * @param p new coordinates for this component
   * @throws NullPointerException if p is null
   * @see #getLocation()
   * @see #setBounds(int, int, int, int)
   * @since 1.1
1144
   */
Bryce McKinlay committed
1145 1146 1147 1148
  public void setLocation(Point p)
  {
    setLocation(p.x, p.y);
  }
1149 1150 1151 1152

  /**
   * Returns the size of this object.
   *
1153 1154 1155
   * @return the size of this object
   * @see #setSize(int, int)
   * @since 1.1
1156
   */
Bryce McKinlay committed
1157 1158 1159 1160
  public Dimension getSize()
  {
    return new Dimension(width, height);
  }
1161 1162 1163 1164

  /**
   * Returns the size of this object.
   *
1165 1166
   * @return the size of this object
   * @deprecated use {@link #getSize()} instead
1167
   */
Bryce McKinlay committed
1168 1169 1170 1171
  public Dimension size()
  {
    return getSize();
  }
1172 1173 1174

  /**
   * Sets the size of this component to the specified width and height.
1175 1176 1177 1178 1179
   *
   * @param width the new width of this component
   * @param height the new height of this component
   * @see #getSize()
   * @see #setBounds(int, int, int, int)
1180
   */
Bryce McKinlay committed
1181
  public void setSize(int width, int height)
1182
  {
1183
    if (this.width == width && this.height == height)
1184 1185
      return;
    invalidate();
Bryce McKinlay committed
1186 1187
    this.width = width;
    this.height = height;
1188
    if (peer != null)
Bryce McKinlay committed
1189 1190
      peer.setBounds(x, y, width, height);
  }
1191 1192 1193 1194

  /**
   * Sets the size of this component to the specified value.
   *
1195 1196 1197
   * @param width the new width of the component
   * @param height the new height of the component
   * @deprecated use {@link #setSize(int, int)} instead
1198
   */
Bryce McKinlay committed
1199 1200 1201 1202
  public void resize(int width, int height)
  {
    setSize(width, height);
  }
1203 1204 1205

  /**
   * Sets the size of this component to the specified value.
1206 1207 1208 1209 1210 1211
   *
   * @param d the new size of this component
   * @throws NullPointerException if d is null
   * @see #setSize(int, int)
   * @see #setBounds(int, int, int, int)
   * @since 1.1
1212
   */
Bryce McKinlay committed
1213 1214 1215
  public void setSize(Dimension d)
  {
    setSize(d.width, d.height);
1216 1217
  }

1218 1219 1220
  /**
   * Sets the size of this component to the specified value.
   *
1221 1222 1223
   * @param d the new size of this component
   * @throws NullPointerException if d is null
   * @deprecated use {@link #setSize(Dimension)} instead
1224
   */
Bryce McKinlay committed
1225
  public void resize(Dimension d)
1226
  {
Bryce McKinlay committed
1227
    setSize(d.width, d.height);
1228 1229
  }

1230
  /**
1231
   * Returns a bounding rectangle for this component. Note that the
1232 1233 1234
   * returned rectange is relative to this component's parent, not to
   * the screen.
   *
1235 1236 1237 1238
   * @return the bounding rectangle for this component
   * @see #setBounds(int, int, int, int)
   * @see #getLocation()
   * @see #getSize()
1239
   */
Bryce McKinlay committed
1240
  public Rectangle getBounds()
1241
  {
1242
    return new Rectangle(x, y, width, height);
1243 1244
  }

1245
  /**
1246
   * Returns a bounding rectangle for this component. Note that the
1247 1248 1249
   * returned rectange is relative to this component's parent, not to
   * the screen.
   *
1250 1251
   * @return the bounding rectangle for this component
   * @deprecated use {@link #getBounds()} instead
1252
   */
Bryce McKinlay committed
1253 1254 1255 1256
  public Rectangle bounds()
  {
    return getBounds();
  }
1257 1258

  /**
1259 1260
   * Sets the bounding rectangle for this component to the specified values.
   * Note that these coordinates are relative to the parent, not to the screen.
1261
   *
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
   * @param x the X coordinate of the upper left corner of the rectangle
   * @param y the Y coordinate of the upper left corner of the rectangle
   * @param w the width of the rectangle
   * @param h the height of the rectangle
   * @see #getBounds()
   * @see #setLocation(int, int)
   * @see #setLocation(Point)
   * @see #setSize(int, int)
   * @see #setSize(Dimension)
   * @since 1.1
1272
   */
Bryce McKinlay committed
1273 1274
  public void setBounds(int x, int y, int w, int h)
  {
1275
    if (this.x == x && this.y == y && width == w && height == h)
1276 1277
      return;
    invalidate();
Bryce McKinlay committed
1278 1279
    this.x = x;
    this.y = y;
1280 1281
    width = w;
    height = h;
Bryce McKinlay committed
1282 1283 1284
    if (peer != null)
      peer.setBounds(x, y, w, h);
  }
1285 1286

  /**
1287 1288
   * Sets the bounding rectangle for this component to the specified values.
   * Note that these coordinates are relative to the parent, not to the screen.
1289
   *
1290 1291 1292 1293 1294
   * @param x the X coordinate of the upper left corner of the rectangle
   * @param y the Y coordinate of the upper left corner of the rectangle
   * @param w the width of the rectangle
   * @param h the height of the rectangle
   * @deprecated use {@link #setBounds(int, int, int, int)} instead
1295
   */
Bryce McKinlay committed
1296 1297 1298 1299
  public void reshape(int x, int y, int width, int height)
  {
    setBounds(x, y, width, height);
  }
1300 1301 1302

  /**
   * Sets the bounding rectangle for this component to the specified
1303 1304
   * rectangle. Note that these coordinates are relative to the parent, not
   * to the screen.
1305
   *
1306 1307 1308 1309 1310 1311
   * @param r the new bounding rectangle
   * @throws NullPointerException if r is null
   * @see #getBounds()
   * @see #setLocation(Point)
   * @see #setSize(Dimension)
   * @since 1.1
1312
   */
Bryce McKinlay committed
1313
  public void setBounds(Rectangle r)
1314
  {
Bryce McKinlay committed
1315 1316
    setBounds(r.x, r.y, r.width, r.height);
  }
1317 1318 1319 1320 1321 1322 1323 1324

  /**
   * Gets the x coordinate of the upper left corner. This is more efficient
   * than getBounds().x or getLocation().x.
   *
   * @return the current x coordinate
   * @since 1.2
   */
Bryce McKinlay committed
1325
  public int getX()
Tom Tromey committed
1326 1327 1328
  {
    return x;
  }
1329 1330 1331 1332 1333 1334 1335 1336

  /**
   * Gets the y coordinate of the upper left corner. This is more efficient
   * than getBounds().y or getLocation().y.
   *
   * @return the current y coordinate
   * @since 1.2
   */
Bryce McKinlay committed
1337
  public int getY()
Tom Tromey committed
1338 1339 1340
  {
    return y;
  }
1341 1342 1343 1344 1345 1346 1347 1348

  /**
   * Gets the width of the component. This is more efficient than
   * getBounds().width or getSize().width.
   *
   * @return the current width
   * @since 1.2
   */
Bryce McKinlay committed
1349
  public int getWidth()
1350
  {
Bryce McKinlay committed
1351
    return width;
1352
  }
1353 1354 1355 1356 1357 1358 1359 1360

  /**
   * Gets the height of the component. This is more efficient than
   * getBounds().height or getSize().height.
   *
   * @return the current width
   * @since 1.2
   */
Bryce McKinlay committed
1361 1362 1363 1364
  public int getHeight()
  {
    return height;
  }
1365 1366 1367 1368 1369 1370 1371 1372

  /**
   * Returns the bounds of this component. This allows reuse of an existing
   * rectangle, if r is non-null.
   *
   * @param r the rectangle to use, or null
   * @return the bounds
   */
Bryce McKinlay committed
1373 1374
  public Rectangle getBounds(Rectangle r)
  {
1375 1376 1377 1378 1379 1380
    if (r == null)
      r = new Rectangle();
    r.x = x;
    r.y = y;
    r.width = width;
    r.height = height;
Bryce McKinlay committed
1381 1382
    return r;
  }
1383 1384 1385 1386 1387 1388 1389 1390

  /**
   * Returns the size of this component. This allows reuse of an existing
   * dimension, if d is non-null.
   *
   * @param d the dimension to use, or null
   * @return the size
   */
Bryce McKinlay committed
1391 1392
  public Dimension getSize(Dimension d)
  {
1393 1394 1395 1396
    if (d == null)
      d = new Dimension();
    d.width = width;
    d.height = height;
Bryce McKinlay committed
1397 1398
    return d;
  }
1399 1400 1401 1402 1403 1404 1405 1406

  /**
   * Returns the location of this component. This allows reuse of an existing
   * point, if p is non-null.
   *
   * @param p the point to use, or null
   * @return the location
   */
Bryce McKinlay committed
1407 1408
  public Point getLocation(Point p)
  {
1409 1410
    if (p == null)
      p = new Point();
Bryce McKinlay committed
1411 1412 1413 1414
    p.x = x;
    p.y = y;
    return p;
  }
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426

  /**
   * Tests if this component is opaque. All "heavyweight" (natively-drawn)
   * components are opaque. A component is opaque if it draws all pixels in
   * the bounds; a lightweight component is partially transparent if it lets
   * pixels underneath show through. Subclasses that guarantee that all pixels
   * will be drawn should override this.
   *
   * @return true if this is opaque
   * @see #isLightweight()
   * @since 1.2
   */
Bryce McKinlay committed
1427 1428
  public boolean isOpaque()
  {
1429
    return ! isLightweight();
Bryce McKinlay committed
1430
  }
1431 1432 1433 1434 1435

  /**
   * Return whether the component is lightweight. That means the component has
   * no native peer, but is displayable. This applies to subclasses of
   * Component not in this package, such as javax.swing.
1436
   *
1437 1438
   * @return true if the component has a lightweight peer
   * @see #isDisplayable()
1439
   * @since 1.2
1440
   */
Bryce McKinlay committed
1441 1442
  public boolean isLightweight()
  {
1443
    return peer instanceof LightweightPeer;
Bryce McKinlay committed
1444
  }
1445 1446 1447 1448

  /**
   * Returns the component's preferred size.
   *
1449 1450 1451
   * @return the component's preferred size
   * @see #getMinimumSize()
   * @see LayoutManager
1452
   */
Bryce McKinlay committed
1453
  public Dimension getPreferredSize()
1454
  {
1455
    if (prefSize == null)
1456 1457 1458 1459
      if (peer == null)
	return new Dimension(width, height);
      else 
        prefSize = peer.getPreferredSize();
1460
    return prefSize;
1461 1462
  }

1463 1464 1465
  /**
   * Returns the component's preferred size.
   *
1466 1467
   * @return the component's preferred size
   * @deprecated use {@link #getPreferredSize()} instead
1468
   */
Bryce McKinlay committed
1469
  public Dimension preferredSize()
1470
  {
Bryce McKinlay committed
1471 1472
    return getPreferredSize();
  }
1473 1474 1475 1476

  /**
   * Returns the component's minimum size.
   *
1477 1478 1479
   * @return the component's minimum size
   * @see #getPreferredSize()
   * @see LayoutManager
1480
   */
Bryce McKinlay committed
1481 1482
  public Dimension getMinimumSize()
  {
1483 1484 1485 1486
    if (minSize == null)
      minSize = (peer != null ? peer.getMinimumSize()
                 : new Dimension(width, height));
    return minSize;
1487 1488
  }

1489 1490 1491
  /**
   * Returns the component's minimum size.
   *
1492 1493
   * @return the component's minimum size
   * @deprecated use {@link #getMinimumSize()} instead
1494
   */
Bryce McKinlay committed
1495 1496 1497 1498
  public Dimension minimumSize()
  {
    return getMinimumSize();
  }
Tom Tromey committed
1499

1500 1501 1502
  /**
   * Returns the component's maximum size.
   *
1503 1504 1505 1506
   * @return the component's maximum size
   * @see #getMinimumSize()
   * @see #getPreferredSize()
   * @see LayoutManager
1507
   */
Bryce McKinlay committed
1508 1509
  public Dimension getMaximumSize()
  {
1510
    return new Dimension(Integer.MAX_VALUE, Integer.MAX_VALUE);
Bryce McKinlay committed
1511
  }
Tom Tromey committed
1512

1513
  /**
1514 1515 1516
   * Returns the preferred horizontal alignment of this component. The value
   * returned will be between {@link #LEFT_ALIGNMENT} and
   * {@link #RIGHT_ALIGNMENT}, inclusive.
1517
   *
1518
   * @return the preferred horizontal alignment of this component
1519
   */
Bryce McKinlay committed
1520 1521
  public float getAlignmentX()
  {
Tom Tromey committed
1522
    return CENTER_ALIGNMENT;
Bryce McKinlay committed
1523
  }
Tom Tromey committed
1524

1525
  /**
1526 1527 1528
   * Returns the preferred vertical alignment of this component. The value
   * returned will be between {@link #TOP_ALIGNMENT} and
   * {@link #BOTTOM_ALIGNMENT}, inclusive.
1529
   *
1530
   * @return the preferred vertical alignment of this component
1531
   */
Bryce McKinlay committed
1532 1533
  public float getAlignmentY()
  {
Tom Tromey committed
1534
    return CENTER_ALIGNMENT;
Bryce McKinlay committed
1535
  }
Tom Tromey committed
1536

1537
  /**
1538
   * Calls the layout manager to re-layout the component. This is called
1539
   * during validation of a container in most cases.
1540 1541 1542
   *
   * @see #validate()
   * @see LayoutManager
1543
   */
Bryce McKinlay committed
1544 1545
  public void doLayout()
  {
1546
    // nothing to do unless we're a container
Bryce McKinlay committed
1547
  }
1548 1549

  /**
1550
   * Calls the layout manager to re-layout the component. This is called
1551 1552
   * during validation of a container in most cases.
   *
1553
   * @deprecated use {@link #doLayout()} instead
1554
   */
Bryce McKinlay committed
1555 1556 1557 1558
  public void layout()
  {
    doLayout();
  }
1559 1560

  /**
1561 1562 1563 1564 1565 1566 1567
   * Called to ensure that the layout for this component is valid. This is
   * usually called on containers.
   *
   * @see #invalidate()
   * @see #doLayout()
   * @see LayoutManager
   * @see Container#validate()
1568
   */
Bryce McKinlay committed
1569 1570
  public void validate()
  {
1571
    valid = true;
Bryce McKinlay committed
1572
  }
1573 1574

  /**
1575 1576 1577
   * Invalidates this component and all of its parent components. This will
   * cause them to have their layout redone. This is called frequently, so
   * make it fast.
1578
   */
Bryce McKinlay committed
1579 1580
  public void invalidate()
  {
1581
    valid = false;
1582 1583 1584 1585
    prefSize = null;
    minSize = null;
    if (parent != null && parent.valid)
      parent.invalidate();
Bryce McKinlay committed
1586
  }
Tom Tromey committed
1587

1588
  /**
1589
   * Returns a graphics object for this component. Returns <code>null</code>
1590 1591
   * if this component is not currently displayed on the screen.
   *
1592 1593
   * @return a graphics object for this component
   * @see #paint(Graphics)
1594
   */
Bryce McKinlay committed
1595 1596
  public Graphics getGraphics()
  {
1597 1598
    if (peer != null)
      {
1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
        Graphics gfx = peer.getGraphics();
        if (gfx != null)
          return gfx;
        // create graphics for lightweight:
        Container parent = getParent();
        if (parent != null)
          {
            gfx = parent.getGraphics();
            Rectangle bounds = getBounds();
            gfx.setClip(bounds);
            gfx.translate(bounds.x, bounds.y);
            return gfx;
          }
1612
      }
Bryce McKinlay committed
1613 1614
    return null;
  }
1615 1616 1617 1618

  /**
   * Returns the font metrics for the specified font in this component.
   *
1619 1620 1621 1622 1623
   * @param font the font to retrieve metrics for
   * @return the font metrics for the specified font
   * @throws NullPointerException if font is null
   * @see #getFont()
   * @see Toolkit#getFontMetrics(Font)
1624
   */
Bryce McKinlay committed
1625 1626
  public FontMetrics getFontMetrics(Font font)
  {
1627 1628
    return peer == null ? getToolkit().getFontMetrics(font)
      : peer.getFontMetrics(font);
Bryce McKinlay committed
1629
  }
Tom Tromey committed
1630

1631
  /**
1632 1633 1634 1635
   * Sets the cursor for this component to the specified cursor. The cursor
   * is displayed when the point is contained by the component, and the
   * component is visible, displayable, and enabled. This is inherited by
   * subcomponents unless they set their own cursor.
1636
   *
1637 1638 1639 1640 1641 1642
   * @param cursor the new cursor for this component
   * @see #isEnabled()
   * @see #isShowing()
   * @see #getCursor()
   * @see #contains(int, int)
   * @see Toolkit#createCustomCursor(Image, Point, String)
1643
   */
Bryce McKinlay committed
1644 1645 1646
  public void setCursor(Cursor cursor)
  {
    this.cursor = cursor;
Tom Tromey committed
1647
    if (peer != null)
1648
      peer.setCursor(cursor);
Bryce McKinlay committed
1649
  }
Tom Tromey committed
1650

1651
  /**
1652 1653
   * Returns the cursor for this component. If not set, this is inherited
   * from the parent, or from Cursor.getDefaultCursor().
1654
   *
1655
   * @return the cursor for this component
1656
   */
Bryce McKinlay committed
1657 1658
  public Cursor getCursor()
  {
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
    if (cursor != null)
      return cursor;
    return parent != null ? parent.getCursor() : Cursor.getDefaultCursor();
  }

  /**
   * Tests if the cursor was explicitly set, or just inherited from the parent.
   *
   * @return true if the cursor has been set
   * @since 1.4
   */
  public boolean isCursorSet()
  {
    return cursor != null;
Bryce McKinlay committed
1673
  }
1674 1675

  /**
1676 1677 1678 1679 1680 1681
   * Paints this component on the screen. The clipping region in the graphics
   * context will indicate the region that requires painting. This is called
   * whenever the component first shows, or needs to be repaired because
   * something was temporarily drawn on top. It is not necessary for
   * subclasses to call <code>super.paint(g)</code>. Components with no area
   * are not painted.
1682
   *
1683 1684
   * @param g the graphics context for this paint job
   * @see #update(Graphics)
1685
   */
Bryce McKinlay committed
1686
  public void paint(Graphics g)
1687
  {
Bryce McKinlay committed
1688
  }
1689 1690

  /**
1691 1692 1693 1694 1695 1696 1697
   * Updates this component. This is called in response to
   * <code>repaint</code>. This method fills the component with the
   * background color, then sets the foreground color of the specified
   * graphics context to the foreground color of this component and calls
   * the <code>paint()</code> method. The coordinates of the graphics are
   * relative to this component. Subclasses should call either
   * <code>super.update(g)</code> or <code>paint(g)</code>.
1698
   *
1699 1700 1701
   * @param graphics the graphics context for this update
   * @see #paint(Graphics)
   * @see #repaint()
1702
   */
Bryce McKinlay committed
1703 1704
  public void update(Graphics g)
  {
1705
    paint(g);
Bryce McKinlay committed
1706
  }
1707 1708 1709 1710

  /**
   * Paints this entire component, including any sub-components.
   *
1711 1712
   * @param graphics the graphics context for this paint job
   * @see #paint(Graphics)
1713
   */
Bryce McKinlay committed
1714
  public void paintAll(Graphics g)
1715 1716
  {
    if (! visible)
1717 1718 1719 1720
      return;
    if (peer != null)
      peer.paint(g);
    paint(g);
Bryce McKinlay committed
1721
  }
1722 1723

  /**
1724
   * Repaint this entire component. The <code>update()</code> method
1725
   * on this component will be called as soon as possible.
1726 1727 1728
   *
   * @see #update(Graphics)
   * @see #repaint(long, int, int, int, int)
1729
   */
Bryce McKinlay committed
1730 1731
  public void repaint()
  {
1732
    repaint(0, 0, 0, width, height);
Bryce McKinlay committed
1733
  }
1734 1735

  /**
1736 1737 1738
   * Repaint this entire component. The <code>update()</code> method on this
   * component will be called in approximate the specified number of
   * milliseconds.
1739
   *
1740 1741 1742
   * @param tm milliseconds before this component should be repainted
   * @see #paint(Graphics)
   * @see #repaint(long, int, int, int, int)
1743
   */
Bryce McKinlay committed
1744 1745
  public void repaint(long tm)
  {
1746
    repaint(tm, 0, 0, width, height);
Bryce McKinlay committed
1747
  }
1748 1749

  /**
1750 1751 1752
   * Repaints the specified rectangular region within this component. The
   * <code>update</code> method on this component will be called as soon as
   * possible. The coordinates are relative to this component.
1753
   *
1754 1755 1756 1757 1758 1759
   * @param x the X coordinate of the upper left of the region to repaint
   * @param y the Y coordinate of the upper left of the region to repaint
   * @param w the width of the region to repaint
   * @param h the height of the region to repaint
   * @see #update(Graphics)
   * @see #repaint(long, int, int, int, int)
1760
   */
1761
  public void repaint(int x, int y, int w, int h)
Bryce McKinlay committed
1762
  {
1763
    repaint(0, x, y, w, h);
Bryce McKinlay committed
1764
  }
1765 1766

  /**
1767 1768 1769 1770
   * Repaints the specified rectangular region within this component. The
   * <code>update</code> method on this component will be called in
   * approximately the specified number of milliseconds. The coordinates
   * are relative to this component.
1771
   *
1772 1773 1774 1775 1776 1777
   * @param tm milliseconds before this component should be repainted
   * @param x the X coordinate of the upper left of the region to repaint
   * @param y the Y coordinate of the upper left of the region to repaint
   * @param w the width of the region to repaint
   * @param h the height of the region to repaint
   * @see #update(Graphics)
1778
   */
Bryce McKinlay committed
1779
  public void repaint(long tm, int x, int y, int width, int height)
1780
  {
1781
    // Handle lightweight repainting by forwarding to native parent
1782
    if (isLightweight() && parent != null)
1783
      {
1784 1785
        if (parent != null)
          parent.repaint(tm, x + getX(), y + getY(), width, height);
1786
      }
1787
    else if (peer != null)
1788
      peer.repaint(tm, x, y, width, height);
Bryce McKinlay committed
1789
  }
Tom Tromey committed
1790

1791
  /**
1792 1793 1794
   * Prints this component. This method is provided so that printing can be
   * done in a different manner from painting. However, the implementation
   * in this class simply calls the <code>paint()</code> method.
1795
   *
1796 1797
   * @param graphics the graphics context of the print device
   * @see #paint(Graphics)
1798
   */
Bryce McKinlay committed
1799 1800
  public void print(Graphics g)
  {
1801
    paint(g);
Bryce McKinlay committed
1802
  }
Tom Tromey committed
1803

1804
  /**
1805
   * Prints this component, including all sub-components. This method is
1806
   * provided so that printing can be done in a different manner from
1807 1808
   * painting. However, the implementation in this class simply calls the
   * <code>paintAll()</code> method.
1809
   *
1810 1811
   * @param graphics the graphics context of the print device
   * @see #paintAll(Graphics)
1812
   */
Bryce McKinlay committed
1813 1814
  public void printAll(Graphics g)
  {
1815
    paintAll(g);
Bryce McKinlay committed
1816
  }
Tom Tromey committed
1817

1818
  /**
1819 1820 1821 1822 1823 1824
   * Called when an image has changed so that this component is repainted.
   * This incrementally draws an image as more bits are available, when
   * possible. Incremental drawing is enabled if the system property
   * <code>awt.image.incrementalDraw</code> is not present or is true, in which
   * case the redraw rate is set to 100ms or the value of the system property
   * <code>awt.image.redrawrate</code>.
1825
   *
1826
   * <p>The coordinate system used depends on the particular flags.
1827
   *
1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
   * @param image the image that has been updated
   * @param flags tlags as specified in <code>ImageObserver</code>
   * @param x the X coordinate
   * @param y the Y coordinate
   * @param w the width
   * @param h the height
   * @return true if the image has been fully loaded
   * @see ImageObserver
   * @see Graphics#drawImage(Image, int, int, Color, ImageObserver)
   * @see Graphics#drawImage(Image, int, int, ImageObserver)
   * @see Graphics#drawImage(Image, int, int, int, int, Color, ImageObserver)
   * @see Graphics#drawImage(Image, int, int, int, int, ImageObserver)
   * @see ImageObserver#update(Image, int, int, int, int, int)
1841
   */
1842
  public boolean imageUpdate(Image img, int flags, int x, int y, int w, int h)
Bryce McKinlay committed
1843
  {
1844 1845
    // XXX Implement.
    throw new Error("not implemented");
Bryce McKinlay committed
1846
  }
Tom Tromey committed
1847

1848 1849 1850
  /**
   * Creates an image from the specified producer.
   *
1851 1852
   * @param producer the image procedure to create the image from
   * @return the resulting image
1853
   */
Bryce McKinlay committed
1854 1855
  public Image createImage(ImageProducer producer)
  {
1856
    // XXX What if peer or producer is null?
1857
    return peer.createImage(producer);
Bryce McKinlay committed
1858
  }
Tom Tromey committed
1859

1860 1861
  /**
   * Creates an image with the specified width and height for use in
1862
   * double buffering. Headless environments do not support images.
1863
   *
1864 1865 1866
   * @param width the width of the image
   * @param height the height of the image
   * @return the requested image, or null if it is not supported
1867
   */
Bryce McKinlay committed
1868 1869
  public Image createImage(int width, int height)
  {
1870 1871 1872 1873
    if (GraphicsEnvironment.isHeadless())
      return null;
    GraphicsConfiguration config = getGraphicsConfiguration();
    return config == null ? null : config.createCompatibleImage(width, height);
Bryce McKinlay committed
1874
  }
Tom Tromey committed
1875

1876
  /**
1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
   * Creates an image with the specified width and height for use in
   * double buffering. Headless environments do not support images.
   *
   * @param width the width of the image
   * @param height the height of the image
   * @return the requested image, or null if it is not supported
   * @since 1.4
   */
  public VolatileImage createVolatileImage(int width, int height)
  {
    if (GraphicsEnvironment.isHeadless())
      return null;
    GraphicsConfiguration config = getGraphicsConfiguration();
    return config == null ? null
      : config.createCompatibleVolatileImage(width, height);
  }

  /**
   * Creates an image with the specified width and height for use in
   * double buffering. Headless environments do not support images. The image
   * will support the specified capabilities.
1898
   *
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
   * @param width the width of the image
   * @param height the height of the image
   * @param caps the requested capabilities
   * @return the requested image, or null if it is not supported
   * @throws AWTException if a buffer with the capabilities cannot be created
   * @since 1.4
   */
  public VolatileImage createVolatileImage(int width, int height,
                                           ImageCapabilities caps)
    throws AWTException
  {
    if (GraphicsEnvironment.isHeadless())
      return null;
    GraphicsConfiguration config = getGraphicsConfiguration();
    return config == null ? null
      : config.createCompatibleVolatileImage(width, height, caps);
  }

  /**
   * Prepares the specified image for rendering on this component.
1919
   *
1920 1921 1922 1923
   * @param image the image to prepare for rendering
   * @param observer the observer to notify of image preparation status
   * @return true if the image is already fully prepared
   * @throws NullPointerException if image is null
1924
   */
Bryce McKinlay committed
1925 1926
  public boolean prepareImage(Image image, ImageObserver observer)
  {
1927 1928
    return prepareImage(image, image.getWidth(observer),
                        image.getHeight(observer), observer);
Bryce McKinlay committed
1929
  }
Tom Tromey committed
1930

1931 1932 1933 1934
  /**
   * Prepares the specified image for rendering on this component at the
   * specified scaled width and height
   *
1935 1936 1937 1938 1939
   * @param image the image to prepare for rendering
   * @param width the scaled width of the image
   * @param height the scaled height of the image
   * @param observer the observer to notify of image preparation status
   * @return true if the image is already fully prepared
1940 1941
   */
  public boolean prepareImage(Image image, int width, int height,
1942
                              ImageObserver observer)
Bryce McKinlay committed
1943
  {
1944
    return peer.prepareImage(image, width, height, observer);
Bryce McKinlay committed
1945
  }
1946

1947 1948 1949 1950
  /**
   * Returns the status of the loading of the specified image. The value
   * returned will be those flags defined in <code>ImageObserver</code>.
   *
1951 1952 1953 1954 1955 1956
   * @param image the image to check on
   * @param observer the observer to notify of image loading progress
   * @return the image observer flags indicating the status of the load
   * @see #prepareImage(Image, int, int, ImageObserver)
   * @see #Toolkit#checkImage(Image, int, int, ImageObserver)
   * @throws NullPointerException if image is null
1957
   */
Bryce McKinlay committed
1958 1959
  public int checkImage(Image image, ImageObserver observer)
  {
1960 1961
    return checkImage(image, image.getWidth(observer),
                      image.getHeight(observer), observer);
Bryce McKinlay committed
1962
  }
Tom Tromey committed
1963

1964 1965 1966 1967
  /**
   * Returns the status of the loading of the specified image. The value
   * returned will be those flags defined in <code>ImageObserver</code>.
   *
1968 1969 1970 1971 1972 1973 1974
   * @param image the image to check on
   * @param width the scaled image width
   * @param height the scaled image height
   * @param observer the observer to notify of image loading progress
   * @return the image observer flags indicating the status of the load
   * @see #prepareImage(Image, int, int, ImageObserver)
   * @see #Toolkit#checkImage(Image, int, int, ImageObserver)
1975
   */
1976 1977
  public int checkImage(Image image, int width, int height,
                        ImageObserver observer)
Bryce McKinlay committed
1978
  {
Tom Tromey committed
1979
    if (peer != null)
1980 1981
      return peer.checkImage(image, width, height, observer);
    return getToolkit().checkImage(image, width, height, observer);
Bryce McKinlay committed
1982
  }
Tom Tromey committed
1983

1984
  /**
1985 1986 1987 1988
   * Sets whether paint messages delivered by the operating system should be
   * ignored. This does not affect messages from AWT, except for those
   * triggered by OS messages. Setting this to true can allow faster
   * performance in full-screen mode or page-flipping.
1989
   *
1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002
   * @param ignoreRepaint the new setting for ignoring repaint events
   * @see #getIgnoreRepaint()
   * @see BufferStrategy
   * @see GraphicsDevice.setFullScreenWindow(Window)
   * @since 1.4
   */
  public void setIgnoreRepaint(boolean ignoreRepaint)
  {
    this.ignoreRepaint = ignoreRepaint;
  }

  /**
   * Test whether paint events from the operating system are ignored.
2003
   *
2004 2005 2006
   * @return the status of ignoring paint events
   * @see #setIgnoreRepaint(boolean)
   * @since 1.4
2007
   */
2008
  public boolean getIgnoreRepaint()
Bryce McKinlay committed
2009
  {
2010
    return ignoreRepaint;
Bryce McKinlay committed
2011
  }
Tom Tromey committed
2012

2013 2014
  /**
   * Tests whether or not the specified point is contained within this
2015
   * component. Coordinates are relative to this component.
2016
   *
2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029
   * @param x the X coordinate of the point to test
   * @param y the Y coordinate of the point to test
   * @return true if the point is within this component
   * @see #getComponentAt(int, int)
   */
  public boolean contains(int x, int y)
  {
    return x >= 0 && y >= 0 && x < width && y < height;
  }

  /**
   * Tests whether or not the specified point is contained within this
   * component. Coordinates are relative to this component.
2030
   *
2031 2032 2033 2034
   * @param x the X coordinate of the point to test
   * @param y the Y coordinate of the point to test
   * @return true if the point is within this component
   * @deprecated use {@link #contains(int, int)} instead
2035
   */
Bryce McKinlay committed
2036 2037
  public boolean inside(int x, int y)
  {
2038
    return contains(x, y);
Bryce McKinlay committed
2039
  }
Tom Tromey committed
2040

2041 2042
  /**
   * Tests whether or not the specified point is contained within this
2043
   * component. Coordinates are relative to this component.
2044
   *
2045 2046 2047 2048 2049
   * @param p the point to test
   * @return true if the point is within this component
   * @throws NullPointerException if p is null
   * @see #getComponentAt(Point)
   * @since 1.1
2050
   */
Bryce McKinlay committed
2051 2052 2053 2054
  public boolean contains(Point p)
  {
    return contains(p.x, p.y);
  }
Tom Tromey committed
2055

2056
  /**
2057
   * Returns the component occupying the position (x,y). This will either
2058 2059 2060
   * be this component, an immediate child component, or <code>null</code>
   * if neither of the first two occupies the specified location.
   *
2061 2062 2063 2064
   * @param x the X coordinate to search for components at
   * @param y the Y coordinate to search for components at
   * @return the component at the specified location, or null
   * @see #contains(int, int)
2065
   */
Bryce McKinlay committed
2066 2067
  public Component getComponentAt(int x, int y)
  {
2068
    return contains(x, y) ? this : null;
Bryce McKinlay committed
2069
  }
Tom Tromey committed
2070

2071
  /**
2072
   * Returns the component occupying the position (x,y). This will either
2073 2074 2075
   * be this component, an immediate child component, or <code>null</code>
   * if neither of the first two occupies the specified location.
   *
2076 2077 2078 2079
   * @param x the X coordinate to search for components at
   * @param y the Y coordinate to search for components at
   * @return the component at the specified location, or null
   * @deprecated use {@link #getComponentAt(int, int)} instead
2080
   */
Bryce McKinlay committed
2081 2082 2083 2084
  public Component locate(int x, int y)
  {
    return getComponentAt(x, y);
  }
Tom Tromey committed
2085

2086
  /**
2087
   * Returns the component occupying the position (x,y). This will either
2088 2089 2090
   * be this component, an immediate child component, or <code>null</code>
   * if neither of the first two occupies the specified location.
   *
2091 2092 2093 2094 2095
   * @param p the point to search for components at
   * @return the component at the specified location, or null
   * @throws NullPointerException if p is null
   * @see #contains(Point)
   * @since 1.1
2096
   */
Bryce McKinlay committed
2097 2098 2099 2100
  public Component getComponentAt(Point p)
  {
    return getComponentAt(p.x, p.y);
  }
Tom Tromey committed
2101

2102 2103 2104
  /**
   * AWT 1.0 event dispatcher.
   *
2105 2106
   * @param e the event to dispatch
   * @deprecated use {@link #dispatchEvent(AWTEvent)} instead
2107
   */
Bryce McKinlay committed
2108 2109
  public void deliverEvent(Event e)
  {
2110
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
2111
  }
Tom Tromey committed
2112

2113 2114 2115 2116 2117 2118 2119 2120 2121
  /**
   * Forwards AWT events to processEvent() if:<ul>
   * <li>Events have been enabled for this type of event via
   * <code>enableEvents()</code></li>,
   * <li>There is at least one registered listener for this type of event</li>
   * </ul>
   *
   * @param e the event to dispatch
   */
Bryce McKinlay committed
2122 2123
  public final void dispatchEvent(AWTEvent e)
  {
2124 2125
    // Some subclasses in the AWT package need to override this behavior,
    // hence the use of dispatchEventImpl().
Bryce McKinlay committed
2126
    dispatchEventImpl(e);
2127
    if (peer != null && ! e.consumed)
2128
      peer.handleEvent(e);
Bryce McKinlay committed
2129
  }
Tom Tromey committed
2130

2131 2132 2133
  /**
   * AWT 1.0 event dispatcher.
   *
2134 2135 2136
   * @param e the event to dispatch
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #dispatchEvent(AWTEvent)} instead
2137
   */
Bryce McKinlay committed
2138 2139
  public boolean postEvent(Event e)
  {
2140
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
2141 2142
    return false;
  }
2143 2144

  /**
2145 2146 2147
   * Adds the specified listener to this component. This is harmless if the
   * listener is null, but if the listener has already been registered, it
   * will now be registered twice.
2148
   *
2149 2150 2151 2152 2153
   * @param listener the new listener to add
   * @see ComponentEvent
   * @see #removeComponentListener(ComponentListener)
   * @see #getComponentListeners()
   * @since 1.1
2154
   */
Bryce McKinlay committed
2155 2156 2157 2158 2159 2160
  public synchronized void addComponentListener(ComponentListener l)
  {
    componentListener = AWTEventMulticaster.add(componentListener, l);
    if (componentListener != null)
      enableEvents(AWTEvent.COMPONENT_EVENT_MASK);
  }
2161 2162

  /**
2163 2164
   * Removes the specified listener from the component. This is harmless if
   * the listener was not previously registered.
2165
   *
2166 2167 2168 2169 2170
   * @param listener the listener to remove
   * @see ComponentEvent
   * @see #addComponentListener(ComponentListener)
   * @see #getComponentListeners()
   * @since 1.1
2171
   */
Bryce McKinlay committed
2172 2173 2174 2175
  public synchronized void removeComponentListener(ComponentListener l)
  {
    componentListener = AWTEventMulticaster.remove(componentListener, l);
  }
2176 2177

  /**
2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
   * Returns an array of all specified listeners registered on this component.
   *
   * @return an array of listeners
   * @see #addComponentListener(ComponentListener)
   * @see #removeComponentListener(ComponentListener)
   * @since 1.4
   */
  public synchronized ComponentListener[] getComponentListeners()
  {
    return (ComponentListener[])
      AWTEventMulticaster.getListeners(componentListener,
                                       ComponentListener.class);
  }

  /**
   * Adds the specified listener to this component. This is harmless if the
   * listener is null, but if the listener has already been registered, it
   * will now be registered twice.
2196
   *
2197 2198 2199 2200 2201
   * @param listener the new listener to add
   * @see FocusEvent
   * @see #removeFocusListener(FocusListener)
   * @see #getFocusListeners()
   * @since 1.1
2202
   */
Bryce McKinlay committed
2203 2204 2205 2206
  public synchronized void addFocusListener(FocusListener l)
  {
    focusListener = AWTEventMulticaster.add(focusListener, l);
    if (focusListener != null)
2207
      enableEvents(AWTEvent.FOCUS_EVENT_MASK);
Bryce McKinlay committed
2208
  }
2209 2210

  /**
2211 2212
   * Removes the specified listener from the component. This is harmless if
   * the listener was not previously registered.
2213
   *
2214 2215 2216 2217 2218
   * @param listener the listener to remove
   * @see FocusEvent
   * @see #addFocusListener(FocusListener)
   * @see #getFocusListeners()
   * @since 1.1
2219
   */
Bryce McKinlay committed
2220 2221 2222 2223
  public synchronized void removeFocusListener(FocusListener l)
  {
    focusListener = AWTEventMulticaster.remove(focusListener, l);
  }
2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249

  /**
   * Returns an array of all specified listeners registered on this component.
   *
   * @return an array of listeners
   * @see #addFocusListener(FocusListener)
   * @see #removeFocusListener(FocusListener)
   * @since 1.4
   */
  public synchronized FocusListener[] getFocusListeners()
  {
    return (FocusListener[])
      AWTEventMulticaster.getListeners(focusListener, FocusListener.class);
  }

  /**
   * Adds the specified listener to this component. This is harmless if the
   * listener is null, but if the listener has already been registered, it
   * will now be registered twice.
   *
   * @param listener the new listener to add
   * @see HierarchyEvent
   * @see #removeHierarchyListener(HierarchyListener)
   * @see #getHierarchyListeners()
   * @since 1.3
   */
Bryce McKinlay committed
2250 2251 2252 2253
  public synchronized void addHierarchyListener(HierarchyListener l)
  {
    hierarchyListener = AWTEventMulticaster.add(hierarchyListener, l);
    if (hierarchyListener != null)
2254
      enableEvents(AWTEvent.HIERARCHY_EVENT_MASK);
Bryce McKinlay committed
2255
  }
2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266

  /**
   * Removes the specified listener from the component. This is harmless if
   * the listener was not previously registered.
   *
   * @param listener the listener to remove
   * @see HierarchyEvent
   * @see #addHierarchyListener(HierarchyListener)
   * @see #getHierarchyListeners()
   * @since 1.3
   */
Bryce McKinlay committed
2267 2268 2269 2270 2271
  public synchronized void removeHierarchyListener(HierarchyListener l)
  {
    hierarchyListener = AWTEventMulticaster.remove(hierarchyListener, l);
  }

2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
  /**
   * Returns an array of all specified listeners registered on this component.
   *
   * @return an array of listeners
   * @see #addHierarchyListener(HierarchyListener)
   * @see #removeHierarchyListener(HierarchyListener)
   * @since 1.4
   */
  public synchronized HierarchyListener[] getHierarchyListeners()
  {
    return (HierarchyListener[])
      AWTEventMulticaster.getListeners(hierarchyListener,
                                       HierarchyListener.class);
  }

  /**
   * Adds the specified listener to this component. This is harmless if the
   * listener is null, but if the listener has already been registered, it
   * will now be registered twice.
   *
   * @param listener the new listener to add
   * @see HierarchyEvent
   * @see #removeHierarchyBoundsListener(HierarchyBoundsListener)
   * @see #getHierarchyBoundsListeners()
   * @since 1.3
   */
  public synchronized void
    addHierarchyBoundsListener(HierarchyBoundsListener l)
Bryce McKinlay committed
2300
  {
2301
    hierarchyBoundsListener =
Bryce McKinlay committed
2302 2303
      AWTEventMulticaster.add(hierarchyBoundsListener, l);
    if (hierarchyBoundsListener != null)
2304
      enableEvents(AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK);
Bryce McKinlay committed
2305 2306
  }

2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
  /**
   * Removes the specified listener from the component. This is harmless if
   * the listener was not previously registered.
   *
   * @param listener the listener to remove
   * @see HierarchyEvent
   * @see #addHierarchyBoundsListener(HierarchyBoundsListener)
   * @see #getHierarchyBoundsListeners()
   * @since 1.3
   */
  public synchronized void
Bryce McKinlay committed
2318 2319
    removeHierarchyBoundsListener(HierarchyBoundsListener l)
  {
2320
    hierarchyBoundsListener =
Bryce McKinlay committed
2321 2322 2323
      AWTEventMulticaster.remove(hierarchyBoundsListener, l);
  }

2324
  /**
2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
   * Returns an array of all specified listeners registered on this component.
   *
   * @return an array of listeners
   * @see #addHierarchyBoundsListener(HierarchyBoundsListener)
   * @see #removeHierarchyBoundsListener(HierarchyBoundsListener)
   * @since 1.4
   */
  public synchronized HierarchyBoundsListener[] getHierarchyBoundsListeners()
  {
    return (HierarchyBoundsListener[])
      AWTEventMulticaster.getListeners(hierarchyBoundsListener,
                                       HierarchyBoundsListener.class);
  }

  /**
   * Adds the specified listener to this component. This is harmless if the
   * listener is null, but if the listener has already been registered, it
   * will now be registered twice.
2343
   *
2344 2345 2346 2347 2348
   * @param listener the new listener to add
   * @see KeyEvent
   * @see #removeKeyListener(KeyListener)
   * @see #getKeyListeners()
   * @since 1.1
2349
   */
Bryce McKinlay committed
2350 2351 2352 2353
  public synchronized void addKeyListener(KeyListener l)
  {
    keyListener = AWTEventMulticaster.add(keyListener, l);
    if (keyListener != null)
2354
      enableEvents(AWTEvent.KEY_EVENT_MASK);
Bryce McKinlay committed
2355 2356
  }

2357
  /**
2358 2359
   * Removes the specified listener from the component. This is harmless if
   * the listener was not previously registered.
2360
   *
2361 2362 2363 2364 2365
   * @param listener the listener to remove
   * @see KeyEvent
   * @see #addKeyListener(KeyListener)
   * @see #getKeyListeners()
   * @since 1.1
2366
   */
Bryce McKinlay committed
2367 2368 2369 2370
  public synchronized void removeKeyListener(KeyListener l)
  {
    keyListener = AWTEventMulticaster.remove(keyListener, l);
  }
2371

2372
  /**
2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389
   * Returns an array of all specified listeners registered on this component.
   *
   * @return an array of listeners
   * @see #addKeyListener(KeyListener)
   * @see #removeKeyListener(KeyListener)
   * @since 1.4
   */
  public synchronized KeyListener[] getKeyListeners()
  {
    return (KeyListener[])
      AWTEventMulticaster.getListeners(keyListener, KeyListener.class);
  }

  /**
   * Adds the specified listener to this component. This is harmless if the
   * listener is null, but if the listener has already been registered, it
   * will now be registered twice.
2390
   *
2391 2392 2393 2394 2395
   * @param listener the new listener to add
   * @see MouseEvent
   * @see #removeMouseListener(MouseListener)
   * @see #getMouseListeners()
   * @since 1.1
2396
   */
Bryce McKinlay committed
2397 2398 2399 2400
  public synchronized void addMouseListener(MouseListener l)
  {
    mouseListener = AWTEventMulticaster.add(mouseListener, l);
    if (mouseListener != null)
2401
      enableEvents(AWTEvent.MOUSE_EVENT_MASK);
Bryce McKinlay committed
2402 2403
  }

2404
  /**
2405 2406
   * Removes the specified listener from the component. This is harmless if
   * the listener was not previously registered.
2407
   *
2408 2409 2410 2411 2412
   * @param listener the listener to remove
   * @see MouseEvent
   * @see #addMouseListener(MouseListener)
   * @see #getMouseListeners()
   * @since 1.1
2413
   */
Bryce McKinlay committed
2414 2415
  public synchronized void removeMouseListener(MouseListener l)
  {
2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430
    mouseListener = AWTEventMulticaster.remove(mouseListener, l);
  }

  /**
   * Returns an array of all specified listeners registered on this component.
   *
   * @return an array of listeners
   * @see #addMouseListener(MouseListener)
   * @see #removeMouseListener(MouseListener)
   * @since 1.4
   */
  public synchronized MouseListener[] getMouseListeners()
  {
    return (MouseListener[])
      AWTEventMulticaster.getListeners(mouseListener, MouseListener.class);
Bryce McKinlay committed
2431 2432
  }

2433
  /**
2434 2435 2436
   * Adds the specified listener to this component. This is harmless if the
   * listener is null, but if the listener has already been registered, it
   * will now be registered twice.
2437
   *
2438 2439 2440 2441 2442
   * @param listener the new listener to add
   * @see MouseEvent
   * @see #removeMouseMotionListener(MouseMotionListener)
   * @see #getMouseMotionListeners()
   * @since 1.1
2443
   */
Bryce McKinlay committed
2444 2445 2446 2447
  public synchronized void addMouseMotionListener(MouseMotionListener l)
  {
    mouseMotionListener = AWTEventMulticaster.add(mouseMotionListener, l);
    if (mouseMotionListener != null)
2448
      enableEvents(AWTEvent.MOUSE_EVENT_MASK);
Bryce McKinlay committed
2449 2450
  }

2451
  /**
2452 2453
   * Removes the specified listener from the component. This is harmless if
   * the listener was not previously registered.
2454
   *
2455 2456 2457 2458 2459
   * @param listener the listener to remove
   * @see MouseEvent
   * @see #addMouseMotionListener(MouseMotionListener)
   * @see #getMouseMotionListeners()
   * @since 1.1
2460
   */
Bryce McKinlay committed
2461 2462 2463 2464 2465
  public synchronized void removeMouseMotionListener(MouseMotionListener l)
  {
    mouseMotionListener = AWTEventMulticaster.remove(mouseMotionListener, l);
  }

2466 2467 2468 2469 2470 2471 2472 2473 2474
  /**
   * Returns an array of all specified listeners registered on this component.
   *
   * @return an array of listeners
   * @see #addMouseMotionListener(MouseMotionListener)
   * @see #removeMouseMotionListener(MouseMotionListener)
   * @since 1.4
   */
  public synchronized MouseMotionListener[] getMouseMotionListeners()
Bryce McKinlay committed
2475
  {
2476 2477 2478
    return (MouseMotionListener[])
      AWTEventMulticaster.getListeners(mouseMotionListener,
                                       MouseMotionListener.class);
Bryce McKinlay committed
2479 2480
  }

2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493
  /**
   * Adds the specified listener to this component. This is harmless if the
   * listener is null, but if the listener has already been registered, it
   * will now be registered twice.
   *
   * @param listener the new listener to add
   * @see MouseEvent
   * @see MouseWheelEvent
   * @see #removeMouseWheelListener(MouseWheelListener)
   * @see #getMouseWheelListeners()
   * @since 1.4
   */
  public synchronized void addMouseWheelListener(MouseWheelListener l)
Bryce McKinlay committed
2494
  {
2495 2496 2497
    mouseWheelListener = AWTEventMulticaster.add(mouseWheelListener, l);
    if (mouseWheelListener != null)
      enableEvents(AWTEvent.MOUSE_WHEEL_EVENT_MASK);
Bryce McKinlay committed
2498
  }
Tom Tromey committed
2499

2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511
  /**
   * Removes the specified listener from the component. This is harmless if
   * the listener was not previously registered.
   *
   * @param listener the listener to remove
   * @see MouseEvent
   * @see MouseWheelEvent
   * @see #addMouseWheelListener(MouseWheelListener)
   * @see #getMouseWheelListeners()
   * @since 1.4
   */
  public synchronized void removeMouseWheelListener(MouseWheelListener l)
Bryce McKinlay committed
2512
  {
2513
    mouseWheelListener = AWTEventMulticaster.remove(mouseWheelListener, l);
Bryce McKinlay committed
2514 2515
  }

2516
  /**
2517
   * Returns an array of all specified listeners registered on this component.
2518
   *
2519 2520 2521 2522
   * @return an array of listeners
   * @see #addMouseWheelListener(MouseWheelListener)
   * @see #removeMouseWheelListener(MouseWheelListener)
   * @since 1.4
2523
   */
2524
  public synchronized MouseWheelListener[] getMouseWheelListeners()
Bryce McKinlay committed
2525
  {
2526 2527 2528
    return (MouseWheelListener[])
      AWTEventMulticaster.getListeners(mouseWheelListener,
                                       MouseWheelListener.class);
Bryce McKinlay committed
2529
  }
Tom Tromey committed
2530

2531
  /**
2532 2533 2534
   * Adds the specified listener to this component. This is harmless if the
   * listener is null, but if the listener has already been registered, it
   * will now be registered twice.
2535
   *
2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684
   * @param listener the new listener to add
   * @see InputMethodEvent
   * @see #removeInputMethodListener(InputMethodListener)
   * @see #getInputMethodListeners()
   * @see #getInputMethodRequests()
   * @since 1.2
   */
  public synchronized void addInputMethodListener(InputMethodListener l)
  {
    inputMethodListener = AWTEventMulticaster.add(inputMethodListener, l);
    if (inputMethodListener != null)
      enableEvents(AWTEvent.INPUT_METHOD_EVENT_MASK);
  }

  /**
   * Removes the specified listener from the component. This is harmless if
   * the listener was not previously registered.
   *
   * @param listener the listener to remove
   * @see InputMethodEvent
   * @see #addInputMethodListener(InputMethodListener)
   * @see #getInputMethodRequests()
   * @since 1.2
   */
  public synchronized void removeInputMethodListener(InputMethodListener l)
  {
    inputMethodListener = AWTEventMulticaster.remove(inputMethodListener, l);
  }

  /**
   * Returns an array of all specified listeners registered on this component.
   *
   * @return an array of listeners
   * @see #addInputMethodListener(InputMethodListener)
   * @see #removeInputMethodListener(InputMethodListener)
   * @since 1.4
   */
  public synchronized InputMethodListener[] getInputMethodListeners()
  {
    return (InputMethodListener[])
      AWTEventMulticaster.getListeners(inputMethodListener,
                                       InputMethodListener.class);
  }

  /**
   * Returns all registered EventListers of the given listenerType.
   *
   * @param listenerType the class of listeners to filter
   * @return an array of registered listeners
   * @see #getComponentListeners()
   * @see #getFocusListeners()
   * @see #getHierarchyListeners()
   * @see #getHierarchyBoundsListeners()
   * @see #getKeyListeners()
   * @see #getMouseListeners()
   * @see #getMouseMotionListeners()
   * @see #getMouseWheelListeners()
   * @see #getInputMethodListeners()
   * @see #getPropertyChangeListeners()
   * @since 1.3
   */
  public EventListener[] getListeners(Class listenerType)
  {
    if (listenerType == ComponentListener.class)
      return getComponentListeners();
    if (listenerType == FocusListener.class)
      return getFocusListeners();
    if (listenerType == HierarchyListener.class)
      return getHierarchyListeners();
    if (listenerType == HierarchyBoundsListener.class)
      return getHierarchyBoundsListeners();
    if (listenerType == KeyListener.class)
      return getKeyListeners();
    if (listenerType == MouseListener.class)
      return getMouseListeners();
    if (listenerType == MouseMotionListener.class)
      return getMouseMotionListeners();
    if (listenerType == MouseWheelListener.class)
      return getMouseWheelListeners();
    if (listenerType == InputMethodListener.class)
      return getInputMethodListeners();
    if (listenerType == PropertyChangeListener.class)
      return getPropertyChangeListeners();
    return (EventListener[]) Array.newInstance(listenerType, 0);
  }

  /**
   * Returns the input method request handler, for subclasses which support
   * on-the-spot text input. By default, input methods are handled by AWT,
   * and this returns null.
   *
   * @return the input method handler, null by default
   * @since 1.2
   */
  public InputMethodRequests getInputMethodRequests()
  {
    return null;
  }

  /**
   * Gets the input context of this component, which is inherited from the
   * parent unless this is overridden.
   *
   * @return the text input context
   * @since 1.2
   */
  public InputContext getInputContext()
  {
    return parent == null ? null : parent.getInputContext();
  }

  /**
   * Enables the specified events. The events to enable are specified
   * by OR-ing together the desired masks from <code>AWTEvent</code>.
   *
   * <p>Events are enabled by default when a listener is attached to the
   * component for that event type. This method can be used by subclasses
   * to ensure the delivery of a specified event regardless of whether
   * or not a listener is attached.
   *
   * @param eventsToEnable the desired events to enable
   * @see #processEvent(AWTEvent)
   * @see #disableEvents(long)
   * @see AWTEvent
   * @since 1.1
   */
  protected final void enableEvents(long eventsToEnable)
  {
    eventMask |= eventsToEnable;
    // TODO: Unlike Sun's implementation, I think we should try and
    // enable/disable events at the peer (gtk/X) level. This will avoid
    // clogging the event pipeline with useless mousemove events that
    // we arn't interested in, etc. This will involve extending the peer
    // interface, but thats okay because the peer interfaces have been
    // deprecated for a long time, and no longer feature in the
    // API specification at all.
    if (isLightweight() && parent != null)
      parent.enableEvents(eventsToEnable);
    else if (peer != null)
      peer.setEventMask(eventMask);
  }

  /**
   * Disables the specified events. The events to disable are specified
   * by OR-ing together the desired masks from <code>AWTEvent</code>.
   *
   * @param eventsToDisable the desired events to disable
   * @see #enableEvents(long)
   * @since 1.1
2685
   */
Bryce McKinlay committed
2686 2687 2688 2689 2690
  protected final void disableEvents(long eventsToDisable)
  {
    eventMask &= ~eventsToDisable;
    // forward new event mask to peer?
  }
Tom Tromey committed
2691

2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702
  /**
   * This is called by the EventQueue if two events with the same event id
   * and owner component are queued. Returns a new combined event, or null if
   * no combining is done. The coelesced events are currently mouse moves
   * (intermediate ones are discarded) and paint events (a merged paint is
   * created in place of the two events).
   *
   * @param existingEvent the event on the queue
   * @param newEvent the new event that might be entered on the queue
   * @return null if both events are kept, or the replacement coelesced event
   */
Bryce McKinlay committed
2703 2704
  protected AWTEvent coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)
  {
2705
    switch (existingEvent.id)
Bryce McKinlay committed
2706
      {
2707 2708
      case MouseEvent.MOUSE_MOVED:
      case MouseEvent.MOUSE_DRAGGED:
2709 2710
        // Just drop the old (intermediate) event and return the new one.
        return newEvent;
2711 2712
      case PaintEvent.PAINT:
      case PaintEvent.UPDATE:
2713 2714 2715 2716
        return coalescePaintEvents((PaintEvent) existingEvent,
                                   (PaintEvent) newEvent);
      default:
        return null;
Bryce McKinlay committed
2717
      }
2718 2719
  }

2720
  /**
2721
   * Processes the specified event. In this class, this method simply
2722
   * calls one of the more specific event handlers.
2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734
   *
   * @param event the event to process
   * @throws NullPointerException if e is null
   * @see #processComponentEvent(ComponentEvent)
   * @see #processFocusEvent(FocusEvent)
   * @see #processKeyEvent(KeyEvent)
   * @see #processMouseEvent(MouseEvent)
   * @see #processMouseMotionEvent(MouseEvent)
   * @see #processInputMethodEvent(InputMethodEvent)
   * @see #processHierarchyEvent(HierarchyEvent)
   * @see #processMouseWheelEvent(MouseWheelEvent)
   * @since 1.1
2735
   */
Bryce McKinlay committed
2736 2737
  protected void processEvent(AWTEvent e)
  {
2738 2739 2740 2741 2742 2743
    /* Note: the order of these if statements are
       important. Subclasses must be checked first. Eg. MouseEvent
       must be checked before ComponentEvent, since a MouseEvent
       object is also an instance of a ComponentEvent. */

    if (e instanceof FocusEvent)
Bryce McKinlay committed
2744
      processFocusEvent((FocusEvent) e);
2745 2746
    else if (e instanceof PaintEvent)
      processPaintEvent((PaintEvent) e);
2747 2748
    else if (e instanceof MouseWheelEvent)
      processMouseWheelEvent((MouseWheelEvent) e);
Bryce McKinlay committed
2749 2750
    else if (e instanceof MouseEvent)
      {
2751 2752 2753 2754 2755
        if (e.id == MouseEvent.MOUSE_MOVED
            || e.id == MouseEvent.MOUSE_DRAGGED)
          processMouseMotionEvent((MouseEvent) e);
        else
          processMouseEvent((MouseEvent) e);
Bryce McKinlay committed
2756
      }
2757 2758
    else if (e instanceof KeyEvent)
      processKeyEvent((KeyEvent) e);
Bryce McKinlay committed
2759 2760
    else if (e instanceof InputMethodEvent)
      processInputMethodEvent((InputMethodEvent) e);
2761 2762
    else if (e instanceof ComponentEvent)
      processComponentEvent((ComponentEvent) e);
Bryce McKinlay committed
2763 2764 2765
    else if (e instanceof HierarchyEvent)
      {
        if (e.id == HierarchyEvent.HIERARCHY_CHANGED)
2766 2767 2768
          processHierarchyEvent((HierarchyEvent) e);
        else
          processHierarchyBoundsEvent((HierarchyEvent) e);
Bryce McKinlay committed
2769 2770
      }
  }
2771 2772 2773

  /**
   * Called when a component event is dispatched and component events are
2774
   * enabled. This method passes the event along to any listeners
2775 2776
   * that are attached.
   *
2777 2778 2779 2780 2781 2782
   * @param event the <code>ComponentEvent</code> to process
   * @throws NullPointerException if e is null
   * @see ComponentListener
   * @see #addComponentListener(ComponentListener)
   * @see #enableEvents(long)
   * @since 1.1
2783
   */
Bryce McKinlay committed
2784 2785 2786 2787 2788 2789
  protected void processComponentEvent(ComponentEvent e)
  {
    if (componentListener == null)
      return;
    switch (e.id)
      {
2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801
      case ComponentEvent.COMPONENT_HIDDEN:
        componentListener.componentHidden(e);
        break;
      case ComponentEvent.COMPONENT_MOVED:
        componentListener.componentMoved(e);
        break;
      case ComponentEvent.COMPONENT_RESIZED:
        componentListener.componentResized(e);
        break;
      case ComponentEvent.COMPONENT_SHOWN:
        componentListener.componentShown(e);
        break;
Bryce McKinlay committed
2802 2803
      }
  }
2804 2805 2806

  /**
   * Called when a focus event is dispatched and component events are
2807
   * enabled. This method passes the event along to any listeners
2808 2809
   * that are attached.
   *
2810 2811 2812 2813 2814 2815
   * @param event the <code>FocusEvent</code> to process
   * @throws NullPointerException if e is null
   * @see FocusListener
   * @see #addFocusListener(FocusListener)
   * @see #enableEvents(long)
   * @since 1.1
2816
   */
Bryce McKinlay committed
2817 2818 2819 2820 2821 2822 2823
  protected void processFocusEvent(FocusEvent e)
  {
    if (focusListener == null)
      return;
    switch (e.id)
      {
        case FocusEvent.FOCUS_GAINED:
2824 2825
          focusListener.focusGained(e);
        break;
Bryce McKinlay committed
2826
        case FocusEvent.FOCUS_LOST:
2827 2828 2829
          focusListener.focusLost(e);
        break;
      }
Bryce McKinlay committed
2830
  }
2831 2832 2833

  /**
   * Called when a key event is dispatched and component events are
2834
   * enabled. This method passes the event along to any listeners
2835 2836
   * that are attached.
   *
2837 2838 2839 2840 2841 2842
   * @param event the <code>KeyEvent</code> to process
   * @throws NullPointerException if e is null
   * @see KeyListener
   * @see #addKeyListener(KeyListener)
   * @see #enableEvents(long)
   * @since 1.1
2843
   */
Bryce McKinlay committed
2844 2845 2846 2847 2848 2849
  protected void processKeyEvent(KeyEvent e)
  {
    if (keyListener == null)
      return;
    switch (e.id)
      {
2850 2851 2852 2853 2854 2855 2856 2857 2858
        case KeyEvent.KEY_PRESSED:
          keyListener.keyPressed(e);
        break;
        case KeyEvent.KEY_RELEASED:
          keyListener.keyReleased(e);
        break;
        case KeyEvent.KEY_TYPED:
          keyListener.keyTyped(e);
        break;
Bryce McKinlay committed
2859 2860
      }
  }
2861 2862 2863

  /**
   * Called when a regular mouse event is dispatched and component events are
2864
   * enabled. This method passes the event along to any listeners
2865 2866
   * that are attached.
   *
2867 2868 2869 2870 2871 2872
   * @param event the <code>MouseEvent</code> to process
   * @throws NullPointerException if e is null
   * @see MouseListener
   * @see #addMouseListener(MouseListener)
   * @see #enableEvents(long)
   * @since 1.1
2873
   */
Bryce McKinlay committed
2874 2875 2876 2877 2878 2879
  protected void processMouseEvent(MouseEvent e)
  {
    if (mouseListener == null)
      return;
    switch (e.id)
      {
2880 2881 2882
        case MouseEvent.MOUSE_CLICKED:
          mouseListener.mouseClicked(e);
        break;
Bryce McKinlay committed
2883
        case MouseEvent.MOUSE_ENTERED:
2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894
          mouseListener.mouseEntered(e);
        break;
        case MouseEvent.MOUSE_EXITED:
          mouseListener.mouseExited(e);
        break;
        case MouseEvent.MOUSE_PRESSED:
          mouseListener.mousePressed(e);
        break;
        case MouseEvent.MOUSE_RELEASED:
          mouseListener.mouseReleased(e);
        break;
Bryce McKinlay committed
2895 2896 2897
      }
  }

2898 2899
  /**
   * Called when a mouse motion event is dispatched and component events are
2900
   * enabled. This method passes the event along to any listeners
2901 2902
   * that are attached.
   *
2903 2904 2905 2906 2907 2908
   * @param event the <code>MouseMotionEvent</code> to process
   * @throws NullPointerException if e is null
   * @see MouseMotionListener
   * @see #addMouseMotionListener(MouseMotionListener)
   * @see #enableEvents(long)
   * @since 1.1
2909
   */
Bryce McKinlay committed
2910 2911 2912 2913 2914 2915
  protected void processMouseMotionEvent(MouseEvent e)
  {
    if (mouseMotionListener == null)
      return;
    switch (e.id)
      {
2916 2917 2918
        case MouseEvent.MOUSE_DRAGGED:
          mouseMotionListener.mouseDragged(e);
        break;
Bryce McKinlay committed
2919
        case MouseEvent.MOUSE_MOVED:
2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941
          mouseMotionListener.mouseMoved(e);
        break;
      }
  }

  /**
   * Called when a mouse wheel event is dispatched and component events are
   * enabled. This method passes the event along to any listeners that are
   * attached.
   *
   * @param event the <code>MouseWheelEvent</code> to process
   * @throws NullPointerException if e is null
   * @see MouseWheelListener
   * @see #addMouseWheelListener(MouseWheelListener)
   * @see #enableEvents(long)
   * @since 1.4
   */
  protected void processMouseWheelEvent(MouseWheelEvent e)
  {
    if (mouseWheelListener != null
        && e.id == MouseEvent.MOUSE_WHEEL)
      mouseWheelListener.mouseWheelMoved(e);
Bryce McKinlay committed
2942
  }
2943

2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955
  /**
   * Called when an input method event is dispatched and component events are
   * enabled. This method passes the event along to any listeners that are
   * attached.
   *
   * @param event the <code>InputMethodEvent</code> to process
   * @throws NullPointerException if e is null
   * @see InputMethodListener
   * @see #addInputMethodListener(InputMethodListener)
   * @see #enableEvents(long)
   * @since 1.2
   */
Bryce McKinlay committed
2956 2957 2958 2959 2960 2961
  protected void processInputMethodEvent(InputMethodEvent e)
  {
    if (inputMethodListener == null)
      return;
    switch (e.id)
      {
2962
        case InputMethodEvent.CARET_POSITION_CHANGED:
Bryce McKinlay committed
2963
          inputMethodListener.caretPositionChanged(e);
2964 2965
        break;
        case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED:
Bryce McKinlay committed
2966
          inputMethodListener.inputMethodTextChanged(e);
2967 2968
        break;
      }
Bryce McKinlay committed
2969
  }
2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982

  /**
   * Called when a hierarchy change event is dispatched and component events
   * are enabled. This method passes the event along to any listeners that are
   * attached.
   *
   * @param event the <code>HierarchyEvent</code> to process
   * @throws NullPointerException if e is null
   * @see HierarchyListener
   * @see #addHierarchyListener(HierarchyListener)
   * @see #enableEvents(long)
   * @since 1.3
   */
Bryce McKinlay committed
2983 2984 2985 2986 2987 2988 2989
  protected void processHierarchyEvent(HierarchyEvent e)
  {
    if (hierarchyListener == null)
      return;
    if (e.id == HierarchyEvent.HIERARCHY_CHANGED)
      hierarchyListener.hierarchyChanged(e);
  }
2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002

  /**
   * Called when a hierarchy bounds event is dispatched and component events
   * are enabled. This method passes the event along to any listeners that are
   * attached.
   *
   * @param event the <code>HierarchyEvent</code> to process
   * @throws NullPointerException if e is null
   * @see HierarchyBoundsListener
   * @see #addHierarchyBoundsListener(HierarchyBoundsListener)
   * @see #enableEvents(long)
   * @since 1.3
   */
Bryce McKinlay committed
3003 3004 3005 3006 3007 3008 3009
  protected void processHierarchyBoundsEvent(HierarchyEvent e)
  {
    if (hierarchyBoundsListener == null)
      return;
    switch (e.id)
      {
        case HierarchyEvent.ANCESTOR_MOVED:
3010 3011 3012 3013 3014
          hierarchyBoundsListener.ancestorMoved(e);
        break;
        case HierarchyEvent.ANCESTOR_RESIZED:
          hierarchyBoundsListener.ancestorResized(e);
        break;
3015 3016
      }
  }
3017 3018 3019 3020

  /**
   * AWT 1.0 event processor.
   *
3021 3022 3023
   * @param evt the event to handle
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processEvent(AWTEvent)} instead
3024
   */
Bryce McKinlay committed
3025 3026
  public boolean handleEvent(Event evt)
  {
3027
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3028 3029
    return false;
  }
3030 3031 3032 3033

  /**
   * AWT 1.0 mouse event.
   *
3034 3035 3036 3037 3038
   * @param evt the event to handle
   * @param x the x coordinate, ignored
   * @param y the y coordinate, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processMouseEvent(MouseEvent)} instead
3039
   */
Bryce McKinlay committed
3040 3041
  public boolean mouseDown(Event evt, int x, int y)
  {
3042
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3043 3044
    return false;
  }
3045

3046 3047 3048
  /**
   * AWT 1.0 mouse event.
   *
3049 3050 3051 3052 3053
   * @param evt the event to handle
   * @param x the x coordinate, ignored
   * @param y the y coordinate, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processMouseMotionEvent(MouseEvent)} instead
3054
   */
Bryce McKinlay committed
3055 3056
  public boolean mouseDrag(Event evt, int x, int y)
  {
3057
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3058 3059 3060
    return false;
  }

3061 3062 3063
  /**
   * AWT 1.0 mouse event.
   *
3064 3065 3066 3067 3068
   * @param evt the event to handle
   * @param x the x coordinate, ignored
   * @param y the y coordinate, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processMouseEvent(MouseEvent)} instead
3069
   */
Bryce McKinlay committed
3070 3071
  public boolean mouseUp(Event evt, int x, int y)
  {
3072
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3073 3074 3075
    return false;
  }

3076 3077 3078
  /**
   * AWT 1.0 mouse event.
   *
3079 3080 3081 3082 3083
   * @param evt the event to handle
   * @param x the x coordinate, ignored
   * @param y the y coordinate, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processMouseMotionEvent(MouseEvent)} instead
3084
   */
Bryce McKinlay committed
3085 3086
  public boolean mouseMove(Event evt, int x, int y)
  {
3087
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3088 3089 3090
    return false;
  }

3091 3092 3093
  /**
   * AWT 1.0 mouse event.
   *
3094 3095 3096 3097 3098
   * @param evt the event to handle
   * @param x the x coordinate, ignored
   * @param y the y coordinate, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processMouseEvent(MouseEvent)} instead
3099
   */
Bryce McKinlay committed
3100 3101
  public boolean mouseEnter(Event evt, int x, int y)
  {
3102
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3103 3104 3105
    return false;
  }

3106 3107 3108
  /**
   * AWT 1.0 mouse event.
   *
3109 3110 3111 3112 3113
   * @param evt the event to handle
   * @param x the x coordinate, ignored
   * @param y the y coordinate, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processMouseEvent(MouseEvent)} instead
3114
   */
Bryce McKinlay committed
3115 3116
  public boolean mouseExit(Event evt, int x, int y)
  {
3117
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3118 3119 3120
    return false;
  }

3121 3122 3123
  /**
   * AWT 1.0 key press event.
   *
3124 3125 3126 3127
   * @param evt the event to handle
   * @param key the key pressed, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processKeyEvent(KeyEvent)} instead
3128
   */
Bryce McKinlay committed
3129 3130
  public boolean keyDown(Event evt, int key)
  {
3131
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3132 3133 3134
    return false;
  }

3135 3136 3137
  /**
   * AWT 1.0 key press event.
   *
3138 3139 3140 3141
   * @param evt the event to handle
   * @param key the key pressed, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processKeyEvent(KeyEvent)} instead
3142
   */
Bryce McKinlay committed
3143 3144
  public boolean keyUp(Event evt, int key)
  {
3145
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3146 3147 3148
    return false;
  }

3149 3150 3151
  /**
   * AWT 1.0 action event processor.
   *
3152 3153 3154 3155 3156
   * @param evt the event to handle
   * @param what the object acted on, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated in classes which support actions, use
   *             <code>processActionEvent(ActionEvent)</code> instead
3157
   */
Bryce McKinlay committed
3158 3159
  public boolean action(Event evt, Object what)
  {
3160
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3161 3162 3163
    return false;
  }

3164 3165
  /**
   * Called to inform this component it has been added to a container.
3166
   * A native peer - if any - is created at this time. This method is
3167 3168
   * called automatically by the AWT system and should not be called by
   * user level code.
3169 3170 3171
   *
   * @see #isDisplayable()
   * @see #removeNotify()
3172
   */
Bryce McKinlay committed
3173 3174
  public void addNotify()
  {
3175 3176
    if (peer == null)
      peer = getToolkit().createComponent(this);
3177 3178 3179 3180 3181 3182 3183 3184
    /* Now that all the children has gotten their peers, we should
       have the event mask needed for this component and its
       lightweight subcomponents. */
    peer.setEventMask(eventMask);
    /* We do not invalidate here, but rather leave that job up to
       the peer. For efficiency, the peer can choose not to
       invalidate if it is happy with the current dimensions,
       etc. */
Bryce McKinlay committed
3185
  }
3186

3187 3188
  /**
   * Called to inform this component is has been removed from its
3189
   * container. Its native peer - if any - is destroyed at this time.
3190 3191
   * This method is called automatically by the AWT system and should
   * not be called by user level code.
3192 3193 3194
   *
   * @see #isDisplayable()
   * @see #addNotify()
3195
   */
Bryce McKinlay committed
3196
  public void removeNotify()
3197
  {
3198 3199 3200
    if (peer != null)
      peer.dispose();
    peer = null;
Bryce McKinlay committed
3201
  }
3202 3203 3204 3205 3206 3207 3208 3209 3210

  /**
   * AWT 1.0 focus event.
   *
   * @param evt the event to handle
   * @param what the Object focused, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processFocusEvent(FocusEvent)} instead
   */
Bryce McKinlay committed
3211 3212
  public boolean gotFocus(Event evt, Object what)
  {
3213
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3214 3215
    return false;
  }
3216 3217 3218 3219 3220 3221 3222 3223 3224

  /**
   * AWT 1.0 focus event.
   *
   * @param evt the event to handle
   * @param what the Object focused, ignored
   * @return false: since the method was deprecated, the return has no meaning
   * @deprecated use {@link #processFocusEvent(FocusEvent)} instead
   */
Bryce McKinlay committed
3225 3226
  public boolean lostFocus(Event evt, Object what)
  {
3227
    // XXX Add backward compatibility handling.
Bryce McKinlay committed
3228 3229 3230
    return false;
  }

3231
  /**
3232 3233
   * Tests whether or not this component is in the group that can be
   * traversed using the keyboard traversal mechanism (such as the TAB key).
3234
   *
3235 3236 3237 3238
   * @return true if the component is traversed via the TAB key
   * @see #setFocusable(boolean)
   * @since 1.1
   * @deprecated use {@link #isFocusable()} instead
3239
   */
Bryce McKinlay committed
3240 3241
  public boolean isFocusTraversable()
  {
3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253
    return enabled && visible && (peer == null || peer.isFocusTraversable());
  }

  /**
   * Tests if this component can receive focus.
   *
   * @return true if this component can receive focus
   * @since 1.4
   */
  public boolean isFocusable()
  {
    return focusable;
Bryce McKinlay committed
3254
  }
Tom Tromey committed
3255

3256
  /**
3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452
   * Specify whether this component can receive focus.
   *
   * @param focusable the new focusable status
   * @since 1.4
   */
  public void setFocusable(boolean focusable)
  {
    firePropertyChange("focusable", this.focusable, focusable);
    this.focusable = focusable;
  }

  /**
   * Sets the focus traversal keys for a given type of focus events. Normally,
   * the default values should match the operating system's native choices. To
   * disable a given traversal, use <code>Collections.EMPTY_SET</code>. The
   * event dispatcher will consume PRESSED, RELEASED, and TYPED events for the
   * specified key, although focus can only transfer on PRESSED or RELEASED.
   *
   * <p>The defauts are:
   * <table>
   *   <th><td>Identifier</td><td>Meaning</td><td>Default</td></th>
   *   <tr><td>KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS</td>
   *     <td>Normal forward traversal</td>
   *     <td>TAB on KEY_PRESSED, Ctrl-TAB on KEY_PRESSED</td></tr>
   *   <tr><td>KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS</td>
   *     <td>Normal backward traversal</td>
   *     <td>Shift-TAB on KEY_PRESSED, Ctrl-Shift-TAB on KEY_PRESSED</td></tr>
   *   <tr><td>KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS</td>
   *     <td>Go up a traversal cycle</td><td>None</td></tr>
   * </table>
   *
   * <p>Specifying null allows inheritance from the parent, or from the current
   * KeyboardFocusManager default set. If not null, the set must contain only
   * AWTKeyStrokes that are not already focus keys and are not KEY_TYPED
   * events.
   *
   * @param id one of FORWARD_TRAVERSAL_KEYS, BACKWARD_TRAVERSAL_KEYS, or
   *        UP_CYCLE_TRAVERSAL_KEYS
   * @param keystrokes a set of keys, or null
   * @throws IllegalArgumentException if id or keystrokes is invalid
   * @see #getFocusTraversalKeys(int)
   * @see KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS
   * @see KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS
   * @see KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS
   * @since 1.4
   */
  public void setFocusTraversalKeys(int id, Set keystrokes)
  {
    if (keystrokes == null)
      throw new IllegalArgumentException();
    Set sa;
    Set sb;
    String name;
    switch (id)
      {
      case KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS:
        sa = getFocusTraversalKeys
          (KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS);
        sb = getFocusTraversalKeys
          (KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS);
        name = "forwardFocusTraversalKeys";
        break;
      case KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS:
        sa = getFocusTraversalKeys
          (KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS);
        sb = getFocusTraversalKeys
          (KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS);
        name = "backwardFocusTraversalKeys";
        break;
      case KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS:
        sa = getFocusTraversalKeys
          (KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS);
        sb = getFocusTraversalKeys
          (KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS);
        name = "upCycleFocusTraversalKeys";
        break;
      default:
        throw new IllegalArgumentException();
      }
    int i = keystrokes.size();
    Iterator iter = keystrokes.iterator();
    while (--i >= 0)
      {
        Object o = iter.next();
        if (! (o instanceof AWTKeyStroke)
            || sa.contains(o) || sb.contains(o)
            || ((AWTKeyStroke) o).keyCode == KeyEvent.VK_UNDEFINED)
          throw new IllegalArgumentException();
      }
    if (focusTraversalKeys == null)
      focusTraversalKeys = new Set[3];
    keystrokes = Collections.unmodifiableSet(new HashSet(keystrokes));
    firePropertyChange(name, focusTraversalKeys[id], keystrokes);
    focusTraversalKeys[id] = keystrokes;
  }

  /**
   * Returns the set of keys for a given focus traversal action, as defined
   * in <code>setFocusTraversalKeys</code>. If not set, this is inherited from
   * the parent component, which may have gotten it from the
   * KeyboardFocusManager.
   *
   * @param id one of FORWARD_TRAVERSAL_KEYS, BACKWARD_TRAVERSAL_KEYS, or
   *        UP_CYCLE_TRAVERSAL_KEYS
   * @throws IllegalArgumentException if id is invalid
   * @see #setFocusTraversalKeys(int, Set)
   * @see KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS
   * @see KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS
   * @see KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS
   * @since 1.4
   */
  public Set getFocusTraversalKeys(int id)
  {
    if (id < KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS
        || id > KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS)
      throw new IllegalArgumentException();
    Set s = null;
    if (focusTraversalKeys != null)
      s = focusTraversalKeys[id];
    if (s == null && parent != null)
      s = parent.getFocusTraversalKeys(id);
    return s == null ? (KeyboardFocusManager.getCurrentKeyboardFocusManager()
                        .getDefaultFocusTraversalKeys(id)) : s;
  }

  /**
   * Tests whether the focus traversal keys for a given action are explicitly
   * set or inherited.
   *
   * @param id one of FORWARD_TRAVERSAL_KEYS, BACKWARD_TRAVERSAL_KEYS, or
   *        UP_CYCLE_TRAVERSAL_KEYS
   * @return true if that set is explicitly specified
   * @throws IllegalArgumentException if id is invalid
   * @see #getFocusTraversalKeys(int)
   * @see KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS
   * @see KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS
   * @see KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS
   * @since 1.4
   */
  public boolean areFocusTraversalKeysSet(int id)
  {
    if (id < KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS
        || id > KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS)
      throw new IllegalArgumentException();
    return focusTraversalKeys != null && focusTraversalKeys[id] != null;
  }

  /**
   * Sets whether focus traversal keys are enabled, which consumes traversal
   * keys and performs the focus event automatically.
   *
   * @param focusTraversalKeysEnabled the new value of the flag
   * @see #getFocusTraversalKeysEnabled()
   * @see #setFocusTraversalKeys(int, Set)
   * @see #getFocusTraversalKeys(int)
   * @since 1.4
   */
  public void setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled)
  {
    firePropertyChange("focusTraversalKeysEnabled",
                       this.focusTraversalKeysEnabled,
                       focusTraversalKeysEnabled);
    this.focusTraversalKeysEnabled = focusTraversalKeysEnabled;
  }

  /**
   * Tests whether focus traversal keys are enabled. If they are, then focus
   * traversal keys are consumed and focus events performed automatically,
   * without the component seeing the keystrokes.
   *
   * @return true if focus traversal is enabled
   * @see #setFocusTraversalKeysEnabled(boolean)
   * @see #setFocusTraversalKeys(int, Set)
   * @see #getFocusTraversalKeys(int)
   * @since 1.4
   */
  public boolean getFocusTraversalKeysEnabled()
  {
    return focusTraversalKeysEnabled;
  }

  /**
   * Requests that this component be given focus. A <code>FOCUS_GAINED</code>
   * event will be fired if and only if this request is successful. To be
   * successful, the component must be displayable, visible, and focusable,
   * and the top-level Window must be able to receive focus. Thus, this
   * request may fail, or be delayed until the window receives focus. It is
   * recommended that <code>requestFocusInWindow</code> be used where
   * possible to be more platform-independent.
   *
   * @see #requestFocusInWindow()
   * @see FocusEvent
   * @see #addFocusListener(FocusListener)
   * @see #isFocusable()
   * @see #isDisplayable()
   * @see KeyboardFocusManager#clearGlobalFocusOwner()
3453
   */
Bryce McKinlay committed
3454 3455
  public void requestFocus()
  {
3456
    // If there's no peer then this component can't get the focus. We
Tom Tromey committed
3457 3458
    // treat it as a silent rejection of the request.
    if (peer != null)
3459
      peer.requestFocus();
Bryce McKinlay committed
3460
  }
Tom Tromey committed
3461

3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488
  /**
   * Requests that this component be given focus. A <code>FOCUS_GAINED</code>
   * event will be fired if and only if this request is successful. To be
   * successful, the component must be displayable, visible, and focusable,
   * and the top-level Window must be able to receive focus. Thus, this
   * request may fail, or be delayed until the window receives focus. It is
   * recommended that <code>requestFocusInWindow</code> be used where
   * possible to be more platform-independent.
   *
   * <p>If the return value is false, the request is guaranteed to fail. If
   * it is true, it will likely succeed unless the action is vetoed or
   * something in the native windowing system intervenes. The temporary flag,
   * and thus this method in general, is not designed for public use; rather
   * it is a hook for lightweight components to notify their container in
   * an attempt to reduce the amount of repainting necessary.
   *
   * @param temporary true if the focus request is temporary
   * @return true if the request has a chance of success
   * @see #requestFocusInWindow()
   * @see FocusEvent
   * @see #addFocusListener(FocusListener)
   * @see #isFocusable()
   * @see #isDisplayable()
   * @see KeyboardFocusManager#clearGlobalFocusOwner()
   * @since 1.4
   */
  protected boolean requestFocus(boolean temporary)
Tom Tromey committed
3489
  {
3490 3491 3492
    // XXX Implement correctly.
    requestFocus();
    return true;
Tom Tromey committed
3493 3494
  }

3495
  /**
3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561
   * Requests that this component be given focus, if it resides in the
   * top-level window which already has focus. A <code>FOCUS_GAINED</code>
   * event will be fired if and only if this request is successful. To be
   * successful, the component must be displayable, visible, and focusable,
   * and the top-level Window must be focused.
   *
   * <p>If the return value is false, the request is guaranteed to fail. If
   * it is true, it will likely succeed unless the action is vetoed or
   * something in the native windowing system intervenes. The temporary flag,
   * and thus this method in general, is not designed for public use; rather
   * it is a hook for lightweight components to notify their container in
   * an attempt to reduce the amount of repainting necessary.
   *
   * @return true if the request has a chance of success
   * @see #requestFocus()
   * @see FocusEvent
   * @see #addFocusListener(FocusListener)
   * @see #isFocusable()
   * @see #isDisplayable()
   * @see KeyboardFocusManager#clearGlobalFocusOwner()
   * @since 1.4
   */
  public boolean requestFocusInWindow()
  {
    // XXX Implement correctly.
    requestFocus();
    return true;
  }

  /**
   * Requests that this component be given focus, if it resides in the
   * top-level window which already has focus. A <code>FOCUS_GAINED</code>
   * event will be fired if and only if this request is successful. To be
   * successful, the component must be displayable, visible, and focusable,
   * and the top-level Window must be focused.
   *
   * <p>If the return value is false, the request is guaranteed to fail. If
   * it is true, it will likely succeed unless the action is vetoed or
   * something in the native windowing system intervenes. The temporary flag,
   * and thus this method in general, is not designed for public use; rather
   * it is a hook for lightweight components to notify their container in
   * an attempt to reduce the amount of repainting necessary.
   *
   * @param temporary true if the focus request is temporary
   * @return true if the request has a chance of success
   * @see #requestFocus()
   * @see FocusEvent
   * @see #addFocusListener(FocusListener)
   * @see #isFocusable()
   * @see #isDisplayable()
   * @see KeyboardFocusManager#clearGlobalFocusOwner()
   * @since 1.4
   */
  protected boolean requestFocusInWindow(boolean temporary)
  {
    // XXX Implement correctly.
    requestFocus();
    return true;
  }

  /**
   * Transfers focus to the next component in the focus traversal order, as
   * though this were the current focus owner.
   *
   * @see #requestFocus()
   * @since 1.1
3562
   */
Bryce McKinlay committed
3563 3564
  public void transferFocus()
  {
Tom Tromey committed
3565 3566
    Component next;
    if (parent == null)
3567
      next = findNextFocusComponent(null);
Tom Tromey committed
3568
    else
3569
      next = parent.findNextFocusComponent(this);
Tom Tromey committed
3570
    if (next != null && next != this)
3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598
      next.requestFocus();
  }

  /**
   * Returns the root container that owns the focus cycle where this component
   * resides. A focus cycle root is in two cycles, one as the ancestor, and
   * one as the focusable element; this call always returns the ancestor.
   *
   * @return the ancestor container that owns the focus cycle
   * @since 1.4
   */
  public Container getFocusCycleRootAncestor()
  {
    // XXX Implement.
    throw new Error("not implemented");
  }

  /**
   * Tests if the container is the ancestor of the focus cycle that this
   * component belongs to.
   *
   * @param c the container to test
   * @return true if c is the focus cycle root
   * @since 1.4
   */
  public boolean isFocusCycleRoot(Container c)
  {
    return c == getFocusCycleRootAncestor();
Bryce McKinlay committed
3599
  }
Tom Tromey committed
3600

3601 3602 3603
  /**
   * AWT 1.0 focus event processor.
   *
3604
   * @deprecated use {@link #transferFocus()} instead
3605
   */
Bryce McKinlay committed
3606 3607 3608 3609
  public void nextFocus()
  {
    transferFocus();
  }
Tom Tromey committed
3610

3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645
  /**
   * Transfers focus to the previous component in the focus traversal order, as
   * though this were the current focus owner.
   *
   * @see #requestFocus()
   * @since 1.4
   */
  public void transferFocusBackward()
  {
    // XXX Implement.
    throw new Error("not implemented");
  }

  /**
   * Transfers focus to the focus cycle root of this component. However, if
   * this is a Window, the default focus owner in the window in the current
   * focus cycle is focused instead.
   *
   * @see #requestFocus()
   * @see #isFocusCycleRoot()
   * @since 1.4
   */
  public void transferFocusUpCycle()
  {
    // XXX Implement.
    throw new Error("not implemented");
  }

  /**
   * Tests if this component is the focus owner. Use {@link #isFocusOwner()}
   * instead.
   *
   * @return true if this component owns focus
   * @since 1.2
   */
Bryce McKinlay committed
3646 3647
  public boolean hasFocus()
  {
3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660
    return isFocusOwner();
  }

  /**
   * Tests if this component is the focus owner.
   *
   * @return true if this component owns focus
   * @since 1.4
   */
  public boolean isFocusOwner()
  {
    // XXX Implement.
    throw new Error("not implemented");
Bryce McKinlay committed
3661
  }
Tom Tromey committed
3662

3663 3664 3665
  /**
   * Adds the specified popup menu to this component.
   *
3666 3667 3668
   * @param menu the popup menu to be added
   * @see #remove(MenuComponent)
   * @since 1.1
3669
   */
Bryce McKinlay committed
3670 3671 3672 3673
  public synchronized void add(PopupMenu popup)
  {
    if (popups == null)
      popups = new Vector();
3674
    popups.add(popup);
Bryce McKinlay committed
3675
  }
Tom Tromey committed
3676

3677 3678 3679
  /**
   * Removes the specified popup menu from this component.
   *
3680 3681 3682
   * @param menu the popup menu to remove
   * @see #add(PopupMenu)
   * @since 1.1
3683
   */
Bryce McKinlay committed
3684 3685
  public synchronized void remove(MenuComponent popup)
  {
3686 3687
    if (popups != null)
      popups.remove(popup);
Bryce McKinlay committed
3688
  }
Tom Tromey committed
3689

3690
  /**
3691 3692
   * Returns a debugging string representing this component. The string may
   * be empty but not null.
3693
   *
3694
   * @return a string representing this component
3695
   */
Bryce McKinlay committed
3696 3697
  protected String paramString()
  {
3698 3699 3700
    StringBuffer param = new StringBuffer();
    String name = getName();
    if (name != null)
3701 3702 3703 3704
      param.append(name).append(",");
    param.append(width).append("x").append(height).append("+").append(x)
      .append("+").append(y);
    if (! isValid())
3705
      param.append(",invalid");
3706
    if (! isVisible())
3707
      param.append(",invisible");
3708
    if (! isEnabled())
3709
      param.append(",disabled");
3710
    if (! isOpaque())
3711 3712 3713 3714
      param.append(",translucent");
    if (isDoubleBuffered())
      param.append(",doublebuffered");
    return param.toString();
Bryce McKinlay committed
3715
  }
Tom Tromey committed
3716

3717
  /**
3718 3719
   * Returns a string representation of this component. This is implemented
   * as <code>getClass().getName() + '[' + paramString() + ']'</code>.
3720
   *
3721
   * @return a string representation of this component
3722
   */
Bryce McKinlay committed
3723 3724
  public String toString()
  {
3725
    return getClass().getName() + '[' + paramString() + ']';
Bryce McKinlay committed
3726
  }
Tom Tromey committed
3727

3728
  /**
3729 3730 3731
   * Prints a listing of this component to <code>System.out</code>.
   *
   * @see #list(PrintStream)
3732
   */
3733
  public void list()
Bryce McKinlay committed
3734
  {
3735
    list(System.out, 0);
Bryce McKinlay committed
3736
  }
Tom Tromey committed
3737

3738 3739 3740
  /**
   * Prints a listing of this component to the specified print stream.
   *
3741
   * @param stream the <code>PrintStream</code> to print to
3742
   */
3743
  public void list(PrintStream out)
Bryce McKinlay committed
3744
  {
3745
    list(out, 0);
Bryce McKinlay committed
3746
  }
Tom Tromey committed
3747

3748 3749 3750 3751
  /**
   * Prints a listing of this component to the specified print stream,
   * starting at the specified indentation point.
   *
3752 3753
   * @param stream the <code>PrintStream</code> to print to
   * @param indent the indentation point
3754
   */
3755
  public void list(PrintStream out, int indent)
Bryce McKinlay committed
3756
  {
Tom Tromey committed
3757
    for (int i = 0; i < indent; ++i)
3758 3759
      out.print(' ');
    out.println(toString());
Bryce McKinlay committed
3760
  }
Tom Tromey committed
3761

3762 3763 3764
  /**
   * Prints a listing of this component to the specified print writer.
   *
3765 3766
   * @param writer the <code>PrintWrinter</code> to print to
   * @since 1.1
3767
   */
3768
  public void list(PrintWriter out)
Bryce McKinlay committed
3769
  {
3770
    list(out, 0);
Bryce McKinlay committed
3771
  }
Tom Tromey committed
3772

3773 3774 3775 3776
  /**
   * Prints a listing of this component to the specified print writer,
   * starting at the specified indentation point.
   *
3777 3778 3779
   * @param writer the <code>PrintWriter</code> to print to
   * @param indent the indentation point
   * @since 1.1
3780
   */
3781
  public void list(PrintWriter out, int indent)
Bryce McKinlay committed
3782
  {
Tom Tromey committed
3783
    for (int i = 0; i < indent; ++i)
3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813
      out.print(' ');
    out.println(toString());
  }

  /**
   * Adds the specified property listener to this component. This is harmless
   * if the listener is null, but if the listener has already been registered,
   * it will now be registered twice. The property listener ignores inherited
   * properties. Recognized properties include:<br>
   * <ul>
   * <li>the font (<code>"font"</code>)</li>
   * <li>the background color (<code>"background"</code>)</li>
   * <li>the foreground color (<code>"foreground"</code>)</li>
   * <li>the focusability (<code>"focusable"</code>)</li>
   * <li>the focus key traversal enabled state
   *     (<code>"focusTraversalKeysEnabled"</code>)</li>
   * <li>the set of forward traversal keys
   *     (<code>"forwardFocusTraversalKeys"</code>)</li>
   * <li>the set of backward traversal keys
   *     (<code>"backwardFocusTraversalKeys"</code>)</li>
   * <li>the set of up-cycle traversal keys
   *     (<code>"upCycleFocusTraversalKeys"</code>)</li>
   * </ul>
   *
   * @param listener the new listener to add
   * @see #removePropertyChangeListener(PropertyChangeListener)
   * @see #getPropertyChangeListeners()
   * @see #addPropertyChangeListener(String, PropertyChangeListener)
   * @since 1.1
   */
Bryce McKinlay committed
3814 3815
  public void addPropertyChangeListener(PropertyChangeListener listener)
  {
3816 3817 3818
    if (changeSupport == null)
      changeSupport = new PropertyChangeSupport(this);
    changeSupport.addPropertyChangeListener(listener);
Bryce McKinlay committed
3819
  }
Tom Tromey committed
3820

3821 3822 3823 3824 3825 3826 3827 3828 3829 3830
  /**
   * Removes the specified property listener from the component. This is
   * harmless if the listener was not previously registered.
   *
   * @param listener the listener to remove
   * @see #addPropertyChangeListener(PropertyChangeListener)
   * @see #getPropertyChangeListeners()
   * @see #removePropertyChangeListener(String, PropertyChangeListener)
   * @since 1.1
   */
Bryce McKinlay committed
3831 3832
  public void removePropertyChangeListener(PropertyChangeListener listener)
  {
3833
    if (changeSupport != null)
3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849
      changeSupport.removePropertyChangeListener(listener);
  }

  /**
   * Returns an array of all specified listeners registered on this component.
   *
   * @return an array of listeners
   * @see #addPropertyChangeListener(PropertyChangeListener)
   * @see #removePropertyChangeListener(PropertyChangeListener)
   * @see #getPropertyChangeListeners(String)
   * @since 1.4
   */
  public PropertyChangeListener[] getPropertyChangeListeners()
  {
    return changeSupport == null ? new PropertyChangeListener[0]
      : changeSupport.getPropertyChangeListeners();
Bryce McKinlay committed
3850
  }
Tom Tromey committed
3851

3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879
  /**
   * Adds the specified property listener to this component. This is harmless
   * if the listener is null, but if the listener has already been registered,
   * it will now be registered twice. The property listener ignores inherited
   * properties. The listener is keyed to a single property. Recognized
   * properties include:<br>
   * <ul>
   * <li>the font (<code>"font"</code>)</li>
   * <li>the background color (<code>"background"</code>)</li>
   * <li>the foreground color (<code>"foreground"</code>)</li>
   * <li>the focusability (<code>"focusable"</code>)</li>
   * <li>the focus key traversal enabled state
   *     (<code>"focusTraversalKeysEnabled"</code>)</li>
   * <li>the set of forward traversal keys
   *     (<code>"forwardFocusTraversalKeys"</code>)</li>
p   * <li>the set of backward traversal keys
   *     (<code>"backwardFocusTraversalKeys"</code>)</li>
   * <li>the set of up-cycle traversal keys
   *     (<code>"upCycleFocusTraversalKeys"</code>)</li>
   * </ul>
   *
   * @param propertyName the property name to filter on
   * @param listener the new listener to add
   * @see #removePropertyChangeListener(String, PropertyChangeListener)
   * @see #getPropertyChangeListeners(String)
   * @see #addPropertyChangeListener(PropertyChangeListener)
   * @since 1.1
   */
Bryce McKinlay committed
3880
  public void addPropertyChangeListener(String propertyName,
3881
                                        PropertyChangeListener listener)
Bryce McKinlay committed
3882
  {
3883 3884
    if (changeSupport == null)
      changeSupport = new PropertyChangeSupport(this);
3885
    changeSupport.addPropertyChangeListener(propertyName, listener);
Bryce McKinlay committed
3886
  }
Tom Tromey committed
3887

3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899
  /**
   * Removes the specified property listener on a particular property from
   * the component. This is harmless if the listener was not previously
   * registered.
   *
   * @param propertyName the property name to filter on
   * @param listener the listener to remove
   * @see #addPropertyChangeListener(String, PropertyChangeListener)
   * @see #getPropertyChangeListeners(String)
   * @see #removePropertyChangeListener(PropertyChangeListener)
   * @since 1.1
   */
Bryce McKinlay committed
3900 3901 3902
  public void removePropertyChangeListener(String propertyName,
                                           PropertyChangeListener listener)
  {
3903 3904
    if (changeSupport != null)
      changeSupport.removePropertyChangeListener(propertyName, listener);
Bryce McKinlay committed
3905
  }
Tom Tromey committed
3906

3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930
  /**
   * Returns an array of all specified listeners on the named property that
   * are registered on this component.
   *
   * @return an array of listeners
   * @see #addPropertyChangeListener(String, PropertyChangeListener)
   * @see #removePropertyChangeListener(String, PropertyChangeListener)
   * @see #getPropertyChangeListeners()
   * @since 1.4
   */
  public PropertyChangeListener[] getPropertyChangeListeners(String property)
  {
    return changeSupport == null ? new PropertyChangeListener[0]
      : changeSupport.getPropertyChangeListeners(property);
  }

  /**
   * Report a change in a bound property to any registered property listeners.
   *
   * @param propertyName the property that changed
   * @param oldValue the old property value
   * @param newValue the new property value
   */
  protected void firePropertyChange(String propertyName, Object oldValue,
Bryce McKinlay committed
3931 3932
                                    Object newValue)
  {
3933
    if (changeSupport != null)
3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962
      changeSupport.firePropertyChange(propertyName, oldValue, newValue);
  }

  /**
   * Report a change in a bound property to any registered property listeners.
   *
   * @param propertyName the property that changed
   * @param oldValue the old property value
   * @param newValue the new property value
   */
  protected void firePropertyChange(String propertyName, boolean oldValue,
                                    boolean newValue)
  {
    if (changeSupport != null)
      changeSupport.firePropertyChange(propertyName, oldValue, newValue);
  }

  /**
   * Report a change in a bound property to any registered property listeners.
   *
   * @param propertyName the property that changed
   * @param oldValue the old property value
   * @param newValue the new property value
   */
  protected void firePropertyChange(String propertyName, int oldValue,
                                    int newValue)
  {
    if (changeSupport != null)
      changeSupport.firePropertyChange(propertyName, oldValue, newValue);
Bryce McKinlay committed
3963
  }
Tom Tromey committed
3964

3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975
  /**
   * Sets the text layout orientation of this component. New components default
   * to UNKNOWN (which behaves like LEFT_TO_RIGHT). This method affects only
   * the current component, while
   * {@link #applyComponentOrientation(ComponentOrientation)} affects the
   * entire hierarchy.
   *
   * @param o the new orientation
   * @throws NullPointerException if o is null
   * @see #getComponentOrientation()
   */
Bryce McKinlay committed
3976 3977
  public void setComponentOrientation(ComponentOrientation o)
  {
3978 3979
    if (o == null)
      throw new NullPointerException();
3980
    orientation = o;
Bryce McKinlay committed
3981
  }
3982

3983 3984 3985 3986 3987 3988
  /**
   * Determines the text layout orientation used by this component.
   *
   * @return the component orientation
   * @see #setComponentOrientation(ComponentOrientation)
   */
Bryce McKinlay committed
3989 3990
  public ComponentOrientation getComponentOrientation()
  {
3991
    return orientation;
Bryce McKinlay committed
3992
  }
3993

3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018
  /**
   * Sets the text layout orientation of this component. New components default
   * to UNKNOWN (which behaves like LEFT_TO_RIGHT). This method affects the
   * entire hierarchy, while
   * {@link #setComponentOrientation(ComponentOrientation)} affects only the
   * current component.
   *
   * @param o the new orientation
   * @throws NullPointerException if o is null
   * @see #getComponentOrientation()
   * @since 1.4
   */
  public void applyComponentOrientation(ComponentOrientation o)
  {
    setComponentOrientation(o);
  }

  /**
   * Returns the accessibility framework context of this class. Component is
   * not accessible, so the default implementation returns null. Subclasses
   * must override this behavior, and return an appropriate subclass of
   * {@link AccessibleAWTComponent}.
   *
   * @return the accessibility context
   */
Bryce McKinlay committed
4019 4020
  public AccessibleContext getAccessibleContext()
  {
4021
    return null;
Bryce McKinlay committed
4022
  }
4023

4024 4025

  // Helper methods; some are package visible for use by subclasses.
4026

4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062
  /**
   * Subclasses should override this to return unique component names like
   * "menuitem0".
   *
   * @return the generated name for this component
   */
  String generateName()
  {
    // Component is abstract.
    return null;
  }

  /**
   * Sets the peer for this component.
   *
   * @param peer the new peer
   */
  final void setPeer(ComponentPeer peer)
  {
    this.peer = peer;
  }

  /**
   * Implementation method that allows classes such as Canvas and Window to
   * override the graphics configuration without violating the published API.
   *
   * @return the graphics configuration
   */
  GraphicsConfiguration getGraphicsConfigurationImpl()
  {
    if (peer != null)
      {
        GraphicsConfiguration config = peer.getGraphicsConfiguration();
        if (config != null)
          return config;
      }
4063

4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077
    if (parent != null)
      return parent.getGraphicsConfiguration();

    return null;
  }

  /**
   * Implementation of dispatchEvent. Allows trusted package classes to
   * dispatch additional events first.
   *
   * @param e the event to dispatch
   */
  void dispatchEventImpl(AWTEvent e)
  {
4078
    if (eventTypeEnabled (e.id))
4079 4080 4081 4082
      processEvent(e);
  }

  /**
4083
   * Tells whether or not an event type is enabled.
4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133
   */
  boolean eventTypeEnabled (int type)
  {
    if (type > AWTEvent.RESERVED_ID_MAX)
      return true;

    switch (type)
      {
      case ComponentEvent.COMPONENT_HIDDEN:
      case ComponentEvent.COMPONENT_MOVED:
      case ComponentEvent.COMPONENT_RESIZED:
      case ComponentEvent.COMPONENT_SHOWN:
        return (componentListener != null
                || (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0);

      case KeyEvent.KEY_PRESSED:
      case KeyEvent.KEY_RELEASED:
      case KeyEvent.KEY_TYPED:
        return (keyListener != null
                || (eventMask & AWTEvent.KEY_EVENT_MASK) != 0);

      case MouseEvent.MOUSE_CLICKED:
      case MouseEvent.MOUSE_ENTERED:
      case MouseEvent.MOUSE_EXITED:
      case MouseEvent.MOUSE_PRESSED:
      case MouseEvent.MOUSE_RELEASED:
        return (mouseListener != null
                || mouseMotionListener != null
                || (eventMask & AWTEvent.MOUSE_EVENT_MASK) != 0);
        
      case FocusEvent.FOCUS_GAINED:
      case FocusEvent.FOCUS_LOST:
        return (focusListener != null
                || (eventMask & AWTEvent.FOCUS_EVENT_MASK) != 0);

      case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED:
      case InputMethodEvent.CARET_POSITION_CHANGED:
        return (inputMethodListener != null
                || (eventMask & AWTEvent.INPUT_METHOD_EVENT_MASK) != 0);
        
      case PaintEvent.PAINT:
      case PaintEvent.UPDATE:
        return (eventMask & AWTEvent.PAINT_EVENT_MASK) != 0;
        
      default:
        return false;
      }
  }

  /**
4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193
   * Coalesce paint events. Current heuristic is: Merge if the union of
   * areas is less than twice that of the sum of the areas. The X server
   * tend to create a lot of paint events that are adjacent but not
   * overlapping.
   *
   * <pre>
   * +------+
   * |      +-----+  ...will be merged
   * |      |     |
   * |      |     |
   * +------+     |
   *        +-----+
   *
   * +---------------+--+
   * |               |  |  ...will not be merged
   * +---------------+  |
   *                 |  |
   *                 |  |
   *                 |  |
   *                 |  |
   *                 |  |
   *                 +--+
   * </pre>
   *
   * @param queuedEvent the first paint event
   * @param newEvent the second paint event
   * @return the combined paint event, or null
   */
  private PaintEvent coalescePaintEvents(PaintEvent queuedEvent,
                                         PaintEvent newEvent)
  {
    Rectangle r1 = queuedEvent.getUpdateRect();
    Rectangle r2 = newEvent.getUpdateRect();
    Rectangle union = r1.union(r2);

    int r1a = r1.width * r1.height;
    int r2a = r2.width * r2.height;
    int ua  = union.width * union.height;

    if (ua > (r1a+r2a)*2)
      return null;
    /* The 2 factor should maybe be reconsidered. Perhaps 3/2
       would be better? */

    newEvent.setUpdateRect(union);
    return newEvent;
  }

  /**
   * Does the work for a paint event.
   *
   * @param event the event to process
   */
  private void processPaintEvent(PaintEvent event)
  {
    // Can't do graphics without peer
    if (peer == null)
      return;

    Graphics gfx = getGraphics();
4194
    try
4195
      {
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213
	Shape clip = event.getUpdateRect();
	gfx.setClip(clip);

	switch (event.id)
	  {
	  case PaintEvent.PAINT:
	    paint(gfx);
	    break;
	  case PaintEvent.UPDATE:
	    update(gfx);
	    break;
	  default:
	    throw new IllegalArgumentException("unknown paint event");
	  }
      }
    finally
      {
	gfx.dispose();
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993
      }
  }

  /**
   * This method is used to implement transferFocus(). CHILD is the child
   * making the request. This is overridden by Container; when called for an
   * ordinary component there is no child and so we always return null.
   *
   * @param child the component making the request
   * @return the next component to focus on
   */
  Component findNextFocusComponent(Component child)
  {
    return null;
  }

  /**
   * Deserializes this component. This regenerates all serializable listeners
   * which were registered originally.
   *
   * @param s the stream to read from
   * @throws ClassNotFoundException if deserialization fails
   * @throws IOException if the stream fails
   */
  private void readObject(ObjectInputStream s)
    throws ClassNotFoundException, IOException
  {
    s.defaultReadObject();
    String key = (String) s.readObject();
    while (key != null)
      {
        Object listener = s.readObject();
        if ("componentL".equals(key))
          addComponentListener((ComponentListener) listener);
        else if ("focusL".equals(key))
          addFocusListener((FocusListener) listener);
        else if ("keyL".equals(key))
          addKeyListener((KeyListener) listener);
        else if ("mouseL".equals(key))
          addMouseListener((MouseListener) listener);
        else if ("mouseMotionL".equals(key))
          addMouseMotionListener((MouseMotionListener) listener);
        else if ("inputMethodL".equals(key))
          addInputMethodListener((InputMethodListener) listener);
        else if ("hierarchyL".equals(key))
          addHierarchyListener((HierarchyListener) listener);
        else if ("hierarchyBoundsL".equals(key))
          addHierarchyBoundsListener((HierarchyBoundsListener) listener);
        else if ("mouseWheelL".equals(key))
          addMouseWheelListener((MouseWheelListener) listener);
        key = (String) s.readObject();
      }
  }

  /**
   * Serializes this component. This ignores all listeners which do not
   * implement Serializable, but includes those that do.
   *
   * @param s the stream to write to
   * @throws IOException if the stream fails
   */
  private void writeObject(ObjectOutputStream s) throws IOException
  {
    s.defaultWriteObject();
    AWTEventMulticaster.save(s, "componentL", componentListener);
    AWTEventMulticaster.save(s, "focusL", focusListener);
    AWTEventMulticaster.save(s, "keyL", keyListener);
    AWTEventMulticaster.save(s, "mouseL", mouseListener);
    AWTEventMulticaster.save(s, "mouseMotionL", mouseMotionListener);
    AWTEventMulticaster.save(s, "inputMethodL", inputMethodListener);
    AWTEventMulticaster.save(s, "hierarchyL", hierarchyListener);
    AWTEventMulticaster.save(s, "hierarchyBoundsL", hierarchyBoundsListener);
    AWTEventMulticaster.save(s, "mouseWheelL", mouseWheelListener);
    s.writeObject(null);
  }


  // Nested classes.

  /**
   * This class provides accessibility support for subclasses of container.
   *
   * @author Eric Blake <ebb9@email.byu.edu>
   * @since 1.3
   * @status updated to 1.4
   */
  protected abstract class AccessibleAWTComponent extends AccessibleContext
    implements Serializable, AccessibleComponent
  {
    /**
     * Compatible with JDK 1.3+.
     */
    private static final long serialVersionUID = 642321655757800191L;

    /**
     * Converts show/hide events to PropertyChange events, and is registered
     * as a component listener on this component.
     *
     * @serial the component handler
     */
    protected ComponentListener accessibleAWTComponentHandler
      = new AccessibleAWTComponentHandler();

    /**
     * Converts focus events to PropertyChange events, and is registered
     * as a focus listener on this component.
     *
     * @serial the focus handler
     */
    protected FocusListener accessibleAWTFocusHandler
      = new AccessibleAWTFocusHandler();

    /**
     * The default constructor.
     */
    protected AccessibleAWTComponent()
    {
      Component.this.addComponentListener(accessibleAWTComponentHandler);
      Component.this.addFocusListener(accessibleAWTFocusHandler);
    }

    /**
     * Adds a global property change listener to the accessible component.
     *
     * @param l the listener to add
     * @see #ACCESSIBLE_NAME_PROPERTY
     * @see #ACCESSIBLE_DESCRIPTION_PROPERTY
     * @see #ACCESSIBLE_STATE_PROPERTY
     * @see #ACCESSIBLE_VALUE_PROPERTY
     * @see #ACCESSIBLE_SELECTION_PROPERTY
     * @see #ACCESSIBLE_TEXT_PROPERTY
     * @see #ACCESSIBLE_VISIBLE_DATA_PROPERTY
     */
    public void addPropertyChangeListener(PropertyChangeListener l)
    {
      Component.this.addPropertyChangeListener(l);
      super.addPropertyChangeListener(l);
    }

    /**
     * Removes a global property change listener from this accessible
     * component.
     *
     * @param l the listener to remove
     */
    public void removePropertyChangeListener(PropertyChangeListener l)
    {
      Component.this.removePropertyChangeListener(l);
      super.removePropertyChangeListener(l);
    }

    /**
     * Returns the accessible name of this component. It is almost always
     * wrong to return getName(), since it is not localized. In fact, for
     * things like buttons, this should be the text of the button, not the
     * name of the object. The tooltip text might also be appropriate.
     *
     * @return the name
     * @see #setAccessibleName(String)
     */
    public String getAccessibleName()
    {
      return accessibleName == null ? getName() : accessibleName;
    }

    /**
     * Returns a brief description of this accessible context. This should
     * be localized.
     *
     * @return a description of this component
     * @see #setAccessibleDescription(String)
     */
    public String getAccessibleDescription()
    {
      return accessibleDescription;
    }

    /**
     * Returns the role of this component.
     *
     * @return the accessible role
     */
    public AccessibleRole getAccessibleRole()
    {
      return AccessibleRole.AWT_COMPONENT;
    }

    /**
     * Returns a state set describing this component's state.
     *
     * @return a new state set
     * @see AccessibleState
     */
    public AccessibleStateSet getAccessibleStateSet()
    {
      AccessibleStateSet s = new AccessibleStateSet();
      if (Component.this.isEnabled())
        s.add(AccessibleState.ENABLED);
      if (isFocusable())
        s.add(AccessibleState.FOCUSABLE);
      if (isFocusOwner())
        s.add(AccessibleState.FOCUSED);
      if (isOpaque())
        s.add(AccessibleState.OPAQUE);
      if (Component.this.isShowing())
        s.add(AccessibleState.SHOWING);
      if (Component.this.isVisible())
        s.add(AccessibleState.VISIBLE);
      return s;
    }

    /**
     * Returns the parent of this component, if it is accessible.
     *
     * @return the accessible parent
     */
    public Accessible getAccessibleParent()
    {
      if (accessibleParent == null)
        {
          Container parent = getParent();
          accessibleParent = parent instanceof Accessible
            ? (Accessible) parent : null;
        }
      return accessibleParent;
    }

    /**
     * Returns the index of this component in its accessible parent.
     *
     * @return the index, or -1 if the parent is not accessible
     * @see #getAccessibleParent()
     */
    public int getAccessibleIndexInParent()
    {
      if (getAccessibleParent() == null)
        return -1;
      AccessibleContext context
        = ((Component) accessibleParent).getAccessibleContext();
      if (context == null)
        return -1;
      for (int i = context.getAccessibleChildrenCount(); --i >= 0; )
        if (context.getAccessibleChild(i) == Component.this)
          return i;
      return -1;
    }

    /**
     * Returns the number of children of this component which implement
     * Accessible. Subclasses must override this if they can have children.
     *
     * @return the number of accessible children, default 0
     */
    public int getAccessibleChildrenCount()
    {
      return 0;
    }

    /**
     * Returns the ith accessible child. Subclasses must override this if
     * they can have children.
     *
     * @return the ith accessible child, or null
     * @see #getAccessibleChildrenCount()
     */
    public Accessible getAccessibleChild(int i)
    {
      return null;
    }

    /**
     * Returns the locale of this component.
     *
     * @return the locale
     * @throws IllegalComponentStateException if the locale is unknown
     */
    public Locale getLocale()
    {
      return Component.this.getLocale();
    }

    /**
     * Returns this, since it is an accessible component.
     *
     * @return the accessible component
     */
    public AccessibleComponent getAccessibleComponent()
    {
      return this;
    }

    /**
     * Gets the background color.
     *
     * @return the background color
     * @see #setBackground(Color)
     */
    public Color getBackground()
    {
      return Component.this.getBackground();
    }

    /**
     * Sets the background color.
     *
     * @param c the background color
     * @see #getBackground()
     * @see #isOpaque()
     */
    public void setBackground(Color c)
    {
      Component.this.setBackground(c);
    }

    /**
     * Gets the foreground color.
     *
     * @return the foreground color
     * @see #setForeground(Color)
     */
    public Color getForeground()
    {
      return Component.this.getForeground();
    }

    /**
     * Sets the foreground color.
     *
     * @param c the foreground color
     * @see #getForeground()
     */
    public void setForeground(Color c)
    {
      Component.this.setForeground(c);
    }

    /**
     * Gets the cursor.
     *
     * @return the cursor
     * @see #setCursor(Cursor)
     */
    public Cursor getCursor()
    {
      return Component.this.getCursor();
    }

    /**
     * Sets the cursor.
     *
     * @param cursor the cursor
     * @see #getCursor()
     */
    public void setCursor(Cursor cursor)
    {
      Component.this.setCursor(cursor);
    }

    /**
     * Gets the font.
     *
     * @return the font
     * @see #setFont(Font)
     */
    public Font getFont()
    {
      return Component.this.getFont();
    }

    /**
     * Sets the font.
     *
     * @param f the font
     * @see #getFont()
     */
    public void setFont(Font f)
    {
      Component.this.setFont(f);
    }

    /**
     * Gets the font metrics for a font.
     *
     * @param f the font to look up
     * @return its metrics
     * @throws NullPointerException if f is null
     * @see #getFont()
     */
    public FontMetrics getFontMetrics(Font f)
    {
      return Component.this.getFontMetrics(f);
    }

    /**
     * Tests if the component is enabled.
     *
     * @return true if the component is enabled
     * @see #setEnabled(boolean)
     * @see #getAccessibleStateSet()
     * @see AccessibleState#ENABLED
     */
    public boolean isEnabled()
    {
      return Component.this.isEnabled();
    }

    /**
     * Set whether the component is enabled.
     *
     * @param b the new enabled status
     * @see #isEnabled()
     */
    public void setEnabled(boolean b)
    {
      Component.this.setEnabled(b);
    }

    /**
     * Test whether the component is visible (not necesarily showing).
     *
     * @return true if it is visible
     * @see #setVisible(boolean)
     * @see #getAccessibleStateSet()
     * @see AccessibleState#VISIBLE
     */
    public boolean isVisible()
    {
      return Component.this.isVisible();
    }

    /**
     * Sets the visibility of this component.
     *
     * @param b the desired visibility
     * @see #isVisible()
     */
    public void setVisible(boolean b)
    {
      Component.this.setVisible(b);
    }

    /**
     * Tests if the component is showing.
     *
     * @return true if this is showing
     */
    public boolean isShowing()
    {
      return Component.this.isShowing();
    }

    /**
     * Tests if the point is contained in this component.
     *
     * @param p the point to check
     * @return true if it is contained
     * @throws NullPointerException if p is null
     */
    public boolean contains(Point p)
    {
      return Component.this.contains(p.x, p.y);
    }

    /**
     * Returns the location of this object on the screen, or null if it is
     * not showing.
     *
     * @return the location relative to screen coordinates, if showing
     * @see #getBounds()
     * @see #getLocation()
     */
    public Point getLocationOnScreen()
    {
      return Component.this.isShowing() ? Component.this.getLocationOnScreen()
        : null;
    }

    /**
     * Returns the location of this object relative to its parent's coordinate
     * system, or null if it is not showing.
     *
     * @return the location
     * @see #getBounds()
     * @see #getLocationOnScreen()
     */
    public Point getLocation()
    {
      return Component.this.isShowing() ? Component.this.getLocation() : null;
    }

    /**
     * Sets the location of this relative to its parent's coordinate system.
     *
     * @param p the location
     * @throws NullPointerException if p is null
     * @see #getLocation()
     */
    public void setLocation(Point p)
    {
      Component.this.setLocation(p.x, p.y);
    }

    /**
     * Gets the bounds of this component, or null if it is not on screen.
     *
     * @return the bounds
     * @see #contains(Point)
     * @see #setBounds(Rectangle)
     */
    public Rectangle getBounds()
    {
      return Component.this.isShowing() ? Component.this.getBounds() : null;
    }

    /**
     * Sets the bounds of this component.
     *
     * @param r the bounds
     * @throws NullPointerException if r is null
     * @see #getBounds()
     */
    public void setBounds(Rectangle r)
    {
      Component.this.setBounds(r.x, r.y, r.width, r.height);
    }

    /**
     * Gets the size of this component, or null if it is not showing.
     *
     * @return the size
     * @see #setSize(Dimension)
     */
    public Dimension getSize()
    {
      return Component.this.isShowing() ? Component.this.getSize() : null;
    }

    /**
     * Sets the size of this component.
     *
     * @param d the size
     * @throws NullPointerException if d is null
     * @see #getSize()
     */
    public void setSize(Dimension d)
    {
      Component.this.setSize(d.width, d.height);
    }

    /**
     * Returns the Accessible child at a point relative to the coordinate
     * system of this component, if one exists, or null. Since components
     * have no children, subclasses must override this to get anything besides
     * null.
     *
     * @param p the point to check
     * @return the accessible child at that point
     * @throws NullPointerException if p is null
     */
    public Accessible getAccessibleAt(Point p)
    {
      return null;
    }

    /**
     * Tests whether this component can accept focus.
     *
     * @return true if this is focus traversable
     * @see #getAccessibleStateSet()
     * @see AccessibleState#FOCUSABLE
     * @see AccessibleState#FOCUSED
     */
    public boolean isFocusTraversable()
    {
      return Component.this.isFocusTraversable();
    }

    /**
     * Requests focus for this component.
     *
     * @see #isFocusTraversable()
     */
    public void requestFocus()
    {
      Component.this.requestFocus();
    }

    /**
     * Adds a focus listener.
     *
     * @param l the listener to add
     */
    public void addFocusListener(FocusListener l)
    {
      Component.this.addFocusListener(l);
    }

    /**
     * Removes a focus listener.
     *
     * @param l the listener to remove
     */
    public void removeFocusListener(FocusListener l)
    {
      Component.this.removeFocusListener(l);
    }

    /**
     * Converts component changes into property changes.
     *
     * @author Eric Blake <ebb9@email.byu.edu>
     * @since 1.3
     * @status updated to 1.4
     */
    protected class AccessibleAWTComponentHandler implements ComponentListener
    {
      /**
       * Default constructor.
       */
      protected AccessibleAWTComponentHandler()
      {
      }

      /**
       * Convert a component hidden to a property change.
       *
       * @param e the event to convert
       */
      public void componentHidden(ComponentEvent e)
      {
        AccessibleAWTComponent.this.firePropertyChange
          (ACCESSIBLE_STATE_PROPERTY, AccessibleState.VISIBLE, null);
      }

      /**
       * Convert a component shown to a property change.
       *
       * @param e the event to convert
       */
      public void componentShown(ComponentEvent e)
      {
        AccessibleAWTComponent.this.firePropertyChange
          (ACCESSIBLE_STATE_PROPERTY, null, AccessibleState.VISIBLE);
      }

      /**
       * Moving a component does not affect properties.
       *
       * @param e ignored
       */
      public void componentMoved(ComponentEvent e)
      {
      }

      /**
       * Resizing a component does not affect properties.
       *
       * @param e ignored
       */
      public void componentResized(ComponentEvent e)
      {
      }
    } // class AccessibleAWTComponentHandler

    /**
     * Converts focus changes into property changes.
     *
     * @author Eric Blake <ebb9@email.byu.edu>
     * @since 1.3
     * @status updated to 1.4
     */
    protected class AccessibleAWTFocusHandler implements FocusListener
    {
      /**
       * Default constructor.
       */
      protected AccessibleAWTFocusHandler()
      {
      }

      /**
       * Convert a focus gained to a property change.
       *
       * @param e the event to convert
       */
      public void focusGained(FocusEvent e)
      {
        AccessibleAWTComponent.this.firePropertyChange
          (ACCESSIBLE_STATE_PROPERTY, null, AccessibleState.FOCUSED);
      }

      /**
       * Convert a focus lost to a property change.
       *
       * @param e the event to convert
       */
      public void focusLost(FocusEvent e)
      {
        AccessibleAWTComponent.this.firePropertyChange
          (ACCESSIBLE_STATE_PROPERTY, AccessibleState.FOCUSED, null);
      }
    } // class AccessibleAWTComponentHandler
  } // class AccessibleAWTComponent

  /**
   * This class provides support for blitting offscreen surfaces.
   *
   * @author Eric Blake <ebb9@email.byu.edu>
   * @since 1.4
   * @XXX Shell class, to allow compilation. This needs documentation and
   * correct implementation.
   */
  protected class BltBufferStrategy extends BufferStrategy
  {
    protected BufferCapabilities caps;
    protected VolatileImage[] backBuffers;
    protected boolean validatedContents;
    protected int width;
    protected int height;
    protected BltBufferStrategy(int num, BufferCapabilities caps)
    {
      this.caps = caps;
      createBackBuffers(num);
    }
    protected void createBackBuffers(int num)
    {
      backBuffers = new VolatileImage[num];
    }
    public BufferCapabilities getCapabilities()
    {
      return caps;
    }
    public Graphics getDrawGraphics() { return null; }
    public void show() {}
    protected void revalidate() {}
    public boolean contentsLost() { return false; }
    public boolean contentsRestored() { return false; }
  } // class BltBufferStrategy

  /**
   * This class provides support for flipping component buffers. It is only
   * designed for use by Canvas and Window.
   *
   * @author Eric Blake <ebb9@email.byu.edu>
   * @since 1.4
   * @XXX Shell class, to allow compilation. This needs documentation and
   * correct implementation.
   */
  protected class FlipBufferStrategy extends BufferStrategy
  {
    protected int numBuffers;
    protected BufferCapabilities caps;
    protected Image drawBuffer;
    protected VolatileImage drawVBuffer;
    protected boolean validatedContents;
    protected FlipBufferStrategy(int num, BufferCapabilities caps)
      throws AWTException
    {
      this.caps = caps;
      createBuffers(num, caps);
    }
    protected void createBuffers(int num, BufferCapabilities caps)
      throws AWTException {}
    protected Image getBackBuffer()
    {
      return drawBuffer;
    }
    protected void flip(BufferCapabilities.FlipContents flipAction) {}
    protected void destroyBuffers() {}
    public BufferCapabilities getCapabilities()
    {
      return caps;
    }
    public Graphics getDrawGraphics() { return null; }
    protected void revalidate() {}
    public boolean contentsLost() { return false; }
    public boolean contentsRestored() { return false; }
    public void show() {}
  } // class FlipBufferStrategy
} // class Component