- /*
- * @(#)Component.java 1.387 04/06/18
- *
- * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
- * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- */
- package java.awt;
-
- import java.io.PrintStream;
- import java.io.PrintWriter;
- import java.util.Vector;
- import java.util.Locale;
- import java.util.EventListener;
- import java.util.Iterator;
- import java.util.HashSet;
- import java.util.Set;
- import java.util.Collections;
- import java.awt.peer.ComponentPeer;
- import java.awt.peer.ContainerPeer;
- import java.awt.peer.LightweightPeer;
- import java.awt.image.BufferStrategy;
- import java.awt.image.ImageObserver;
- import java.awt.image.ImageProducer;
- import java.awt.image.ColorModel;
- import java.awt.image.VolatileImage;
- import java.awt.event.*;
- import java.awt.datatransfer.Transferable;
- import java.awt.dnd.DnDConstants;
- import java.awt.dnd.DragSource;
- import java.awt.dnd.DragSourceContext;
- import java.awt.dnd.DragSourceListener;
- import java.awt.dnd.InvalidDnDOperationException;
- import java.io.Serializable;
- import java.io.ObjectOutputStream;
- import java.io.ObjectInputStream;
- import java.io.IOException;
- import java.beans.PropertyChangeListener;
- import java.beans.PropertyChangeSupport;
- import java.awt.event.InputMethodListener;
- import java.awt.event.InputMethodEvent;
- import java.awt.im.InputContext;
- import java.awt.im.InputMethodRequests;
- import java.awt.dnd.DropTarget;
- import java.lang.reflect.InvocationTargetException;
- import java.lang.reflect.Method;
- import javax.accessibility.*;
- import java.awt.GraphicsConfiguration;
- import java.security.AccessController;
- import java.security.PrivilegedAction;
- import javax.accessibility.*;
-
- import java.util.logging.*;
-
- import sun.security.action.GetPropertyAction;
- import sun.awt.AppContext;
- import sun.awt.SunToolkit;
- import sun.awt.ConstrainableGraphics;
- import sun.awt.DebugHelper;
- import sun.awt.WindowClosingListener;
- import sun.awt.WindowClosingSupport;
- import sun.awt.GlobalCursorManager;
- import sun.awt.dnd.SunDropTargetEvent;
- import sun.awt.im.CompositionArea;
-
- /**
- * A <em>component</em> is an object having a graphical representation
- * that can be displayed on the screen and that can interact with the
- * user. Examples of components are the buttons, checkboxes, and scrollbars
- * of a typical graphical user interface. <p>
- * The <code>Component</code> class is the abstract superclass of
- * the nonmenu-related Abstract Window Toolkit components. Class
- * <code>Component</code> can also be extended directly to create a
- * lightweight component. A lightweight component is a component that is
- * not associated with a native opaque window.
- * <p>
- * <h3>Serialization</h3>
- * It is important to note that only AWT listeners which conform
- * to the <code>Serializable</code> protocol will be saved when
- * the object is stored. If an AWT object has listeners that
- * aren't marked serializable, they will be dropped at
- * <code>writeObject</code> time. Developers will need, as always,
- * to consider the implications of making an object serializable.
- * One situation to watch out for is this:
- * <pre>
- * import java.awt.*;
- * import java.awt.event.*;
- * import java.io.Serializable;
- *
- * class MyApp implements ActionListener, Serializable
- * {
- * BigObjectThatShouldNotBeSerializedWithAButton bigOne;
- * Button aButton = new Button();
- *
- * MyApp()
- * {
- * // Oops, now aButton has a listener with a reference
- * // to bigOne!
- * aButton.addActionListener(this);
- * }
- *
- * public void actionPerformed(ActionEvent e)
- * {
- * System.out.println("Hello There");
- * }
- * }
- * </pre>
- * In this example, serializing <code>aButton</code> by itself
- * will cause <code>MyApp</code> and everything it refers to
- * to be serialized as well. The problem is that the listener
- * is serializable by coincidence, not by design. To separate
- * the decisions about <code>MyApp</code> and the
- * <code>ActionListener</code> being serializable one can use a
- * nested class, as in the following example:
- * <pre>
- * import java.awt.*;
- * import java.awt.event.*;
- * import java.io.Serializable;
- *
- * class MyApp java.io.Serializable
- * {
- * BigObjectThatShouldNotBeSerializedWithAButton bigOne;
- * Button aButton = new Button();
- *
- * class MyActionListener implements ActionListener
- * {
- * public void actionPerformed(ActionEvent e)
- * {
- * System.out.println("Hello There");
- * }
- * }
- *
- * MyApp()
- * {
- * aButton.addActionListener(new MyActionListener());
- * }
- * }
- * </pre>
- * <p>
- * <b>Note</b>: For more information on the paint mechanisms utilitized
- * by AWT and Swing, including information on how to write the most
- * efficient painting code, see
- * <a href="http://java.sun.com/products/jfc/tsc/articles/painting/index.html">Painting in AWT and Swing</a>.
- * <p>
- * For details on the focus subsystem, see
- * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html">
- * How to Use the Focus Subsystem</a>,
- * a section in <em>The Java Tutorial</em>, and the
- * <a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
- * for more information.
- *
- * @version 1.387, 06/18/04
- * @author Arthur van Hoff
- * @author Sami Shaio
- */
- public abstract class Component implements ImageObserver, MenuContainer,
- Serializable
- {
-
- private static final Logger focusLog = Logger.getLogger("java.awt.focus.Component");
- private static final Logger log = Logger.getLogger("java.awt.Component");
- /**
- * The peer of the component. The peer implements the component's
- * behavior. The peer is set when the <code>Component</code> is
- * added to a container that also is a peer.
- * @see #addNotify
- * @see #removeNotify
- */
- transient ComponentPeer peer;
-
- /**
- * The parent of the object. It may be <code>null</code>
- * for top-level components.
- * @see #getParent
- */
- transient Container parent;
-
- /**
- * The <code>AppContext</code> of the component. Applets/Plugin may
- * change the AppContext.
- */
- transient AppContext appContext;
-
- /**
- * The x position of the component in the parent's coordinate system.
- *
- * @serial
- * @see #getLocation
- */
- int x;
-
- /**
- * The y position of the component in the parent's coordinate system.
- *
- * @serial
- * @see #getLocation
- */
- int y;
-
- /**
- * The width of the component.
- *
- * @serial
- * @see #getSize
- */
- int width;
-
- /**
- * The height of the component.
- *
- * @serial
- * @see #getSize
- */
- int height;
-
- /**
- * The foreground color for this component.
- * <code>foreground</code> can be <code>null</code>.
- *
- * @serial
- * @see #getForeground
- * @see #setForeground
- */
- Color foreground;
-
- /**
- * The background color for this component.
- * <code>background</code> can be <code>null</code>.
- *
- * @serial
- * @see #getBackground
- * @see #setBackground
- */
- Color background;
-
- /**
- * The font used by this component.
- * The <code>font</code> can be <code>null</code>.
- *
- * @serial
- * @see #getFont
- * @see #setFont
- */
- Font font;
-
- /**
- * The font which the peer is currently using.
- * (<code>null</code> if no peer exists.)
- */
- Font peerFont;
-
- /**
- * The cursor displayed when pointer is over this component.
- * This value can be <code>null</code>.
- *
- * @serial
- * @see #getCursor
- * @see #setCursor
- */
- Cursor cursor;
-
- /**
- * The locale for the component.
- *
- * @serial
- * @see #getLocale
- * @see #setLocale
- */
- Locale locale;
-
- /**
- * A reference to a <code>GraphicsConfiguration</code> object
- * used to describe the characteristics of a graphics
- * destination.
- * This value can be <code>null</code>.
- *
- * @since 1.3
- * @serial
- * @see GraphicsConfiguration
- * @see #getGraphicsConfiguration
- */
- transient GraphicsConfiguration graphicsConfig = null;
-
- /**
- * A reference to a <code>BufferStrategy</code> object
- * used to manipulate the buffers on this component.
- *
- * @since 1.4
- * @see java.awt.image.BufferStrategy
- * @see #getBufferStrategy()
- */
- transient BufferStrategy bufferStrategy = null;
-
- /**
- * True when the object should ignore all repaint events.
- *
- * @since 1.4
- * @serial
- * @see #setIgnoreRepaint
- * @see #getIgnoreRepaint
- */
- boolean ignoreRepaint = false;
-
- /**
- * True when the object is visible. An object that is not
- * visible is not drawn on the screen.
- *
- * @serial
- * @see #isVisible
- * @see #setVisible
- */
- boolean visible = true;
-
- /**
- * True when the object is enabled. An object that is not
- * enabled does not interact with the user.
- *
- * @serial
- * @see #isEnabled
- * @see #setEnabled
- */
- boolean enabled = true;
-
- /**
- * True when the object is valid. An invalid object needs to
- * be layed out. This flag is set to false when the object
- * size is changed.
- *
- * @serial
- * @see #isValid
- * @see #validate
- * @see #invalidate
- */
- boolean valid = false;
-
- /**
- * The <code>DropTarget</code> associated with this component.
- *
- * @since 1.2
- * @serial
- * @see #setDropTarget
- * @see #getDropTarget
- */
- DropTarget dropTarget;
-
- /**
- * @serial
- * @see #add
- */
- Vector popups;
-
- /**
- * A component's name.
- * This field can be <code>null</code>.
- *
- * @serial
- * @see #getName
- * @see #setName(String)
- */
- private String name;
-
- /**
- * A bool to determine whether the name has
- * been set explicitly. <code>nameExplicitlySet</code> will
- * be false if the name has not been set and
- * true if it has.
- *
- * @serial
- * @see #getName
- * @see #setName(String)
- */
- private boolean nameExplicitlySet = false;
-
- /**
- * Indicates whether this Component can be focused.
- *
- * @serial
- * @see #setFocusable
- * @see #isFocusable
- * @since 1.4
- */
- private boolean focusable = true;
-
- private static final int FOCUS_TRAVERSABLE_UNKNOWN = 0;
- private static final int FOCUS_TRAVERSABLE_DEFAULT = 1;
- private static final int FOCUS_TRAVERSABLE_SET = 2;
-
- /**
- * Tracks whether this Component is relying on default focus travesability.
- *
- * @serial
- * @since 1.4
- */
- private int isFocusTraversableOverridden = FOCUS_TRAVERSABLE_UNKNOWN;
-
- /**
- * The focus traversal keys. These keys will generate focus traversal
- * behavior for Components for which focus traversal keys are enabled. If a
- * value of null is specified for a traversal key, this Component inherits
- * that traversal key from its parent. If all ancestors of this Component
- * have null specified for that traversal key, then the current
- * KeyboardFocusManager's default traversal key is used.
- *
- * @serial
- * @see #setFocusTraversalKeys
- * @see #getFocusTraversalKeys
- * @since 1.4
- */
- Set[] focusTraversalKeys;
-
- private static final String[] focusTraversalKeyPropertyNames = {
- "forwardFocusTraversalKeys",
- "backwardFocusTraversalKeys",
- "upCycleFocusTraversalKeys",
- "downCycleFocusTraversalKeys"
- };
-
- /**
- * Indicates whether focus traversal keys are enabled for this Component.
- * Components for which focus traversal keys are disabled receive key
- * events for focus traversal keys. Components for which focus traversal
- * keys are enabled do not see these events; instead, the events are
- * automatically converted to traversal operations.
- *
- * @serial
- * @see #setFocusTraversalKeysEnabled
- * @see #getFocusTraversalKeysEnabled
- * @since 1.4
- */
- private boolean focusTraversalKeysEnabled = true;
-
- /**
- * The locking object for AWT component-tree and layout operations.
- *
- * @see #getTreeLock
- */
- static final Object LOCK = new AWTTreeLock();
- static class AWTTreeLock {}
-
- /**
- * Minimum size.
- * (This field perhaps should have been transient).
- *
- * @serial
- */
- Dimension minSize;
-
- /**
- * Whether or not setMinimumSize has been invoked with a non-null value.
- */
- boolean minSizeSet;
-
- /**
- * Preferred size.
- * (This field perhaps should have been transient).
- *
- * @serial
- */
- Dimension prefSize;
-
- /**
- * Whether or not setPreferredSize has been invoked with a non-null value.
- */
- boolean prefSizeSet;
-
- /**
- * Maximum size
- *
- * @serial
- */
- Dimension maxSize;
-
- /**
- * Whether or not setMaximumSize has been invoked with a non-null value.
- */
- boolean maxSizeSet;
-
- /**
- * The orientation for this component.
- * @see #getComponentOrientation
- * @see #setComponentOrientation
- */
- transient ComponentOrientation componentOrientation
- = ComponentOrientation.UNKNOWN;
-
- /**
- * <code>newEventsOnly</code> will be true if the event is
- * one of the event types enabled for the component.
- * It will then allow for normal processing to
- * continue. If it is false the event is passed
- * to the component's parent and up the ancestor
- * tree until the event has been consumed.
- *
- * @serial
- * @see #dispatchEvent
- */
- boolean newEventsOnly = false;
- transient ComponentListener componentListener;
- transient FocusListener focusListener;
- transient HierarchyListener hierarchyListener;
- transient HierarchyBoundsListener hierarchyBoundsListener;
- transient KeyListener keyListener;
- transient MouseListener mouseListener;
- transient MouseMotionListener mouseMotionListener;
- transient MouseWheelListener mouseWheelListener;
- transient InputMethodListener inputMethodListener;
-
- transient RuntimeException windowClosingException = null;
-
- /** Internal, constants for serialization */
- final static String actionListenerK = "actionL";
- final static String adjustmentListenerK = "adjustmentL";
- final static String componentListenerK = "componentL";
- final static String containerListenerK = "containerL";
- final static String focusListenerK = "focusL";
- final static String itemListenerK = "itemL";
- final static String keyListenerK = "keyL";
- final static String mouseListenerK = "mouseL";
- final static String mouseMotionListenerK = "mouseMotionL";
- final static String mouseWheelListenerK = "mouseWheelL";
- final static String textListenerK = "textL";
- final static String ownedWindowK = "ownedL";
- final static String windowListenerK = "windowL";
- final static String inputMethodListenerK = "inputMethodL";
- final static String hierarchyListenerK = "hierarchyL";
- final static String hierarchyBoundsListenerK = "hierarchyBoundsL";
- final static String windowStateListenerK = "windowStateL";
- final static String windowFocusListenerK = "windowFocusL";
-
- /**
- * The <code>eventMask</code> is ONLY set by subclasses via
- * <code>enableEvents</code>.
- * The mask should NOT be set when listeners are registered
- * so that we can distinguish the difference between when
- * listeners request events and subclasses request them.
- * One bit is used to indicate whether input methods are
- * enabled; this bit is set by <code>enableInputMethods</code> and is
- * on by default.
- *
- * @serial
- * @see #enableInputMethods
- * @see AWTEvent
- */
- long eventMask = AWTEvent.INPUT_METHODS_ENABLED_MASK;
-
- private static final DebugHelper dbg = DebugHelper.create(Component.class);
-
- /**
- * Static properties for incremental drawing.
- * @see #imageUpdate
- */
- static boolean isInc;
- static int incRate;
- static {
- /* ensure that the necessary native libraries are loaded */
- Toolkit.loadLibraries();
- /* initialize JNI field and method ids */
- if (!GraphicsEnvironment.isHeadless()) {
- initIDs();
- }
-
- String s = (String) java.security.AccessController.doPrivileged(
- new GetPropertyAction("awt.image.incrementaldraw"));
- isInc = (s == null || s.equals("true"));
-
- s = (String) java.security.AccessController.doPrivileged(
- new GetPropertyAction("awt.image.redrawrate"));
- incRate = (s != null) ? Integer.parseInt(s) : 100;
- }
-
- /**
- * Ease-of-use constant for <code>getAlignmentY()</code>.
- * Specifies an alignment to the top of the component.
- * @see #getAlignmentY
- */
- public static final float TOP_ALIGNMENT = 0.0f;
-
- /**
- * Ease-of-use constant for <code>getAlignmentY</code> and
- * <code>getAlignmentX</code>. Specifies an alignment to
- * the center of the component
- * @see #getAlignmentX
- * @see #getAlignmentY
- */
- public static final float CENTER_ALIGNMENT = 0.5f;
-
- /**
- * Ease-of-use constant for <code>getAlignmentY</code>.
- * Specifies an alignment to the bottom of the component.
- * @see #getAlignmentY
- */
- public static final float BOTTOM_ALIGNMENT = 1.0f;
-
- /**
- * Ease-of-use constant for <code>getAlignmentX</code>.
- * Specifies an alignment to the left side of the component.
- * @see #getAlignmentX
- */
- public static final float LEFT_ALIGNMENT = 0.0f;
-
- /**
- * Ease-of-use constant for <code>getAlignmentX</code>.
- * Specifies an alignment to the right side of the component.
- * @see #getAlignmentX
- */
- public static final float RIGHT_ALIGNMENT = 1.0f;
-
- /*
- * JDK 1.1 serialVersionUID
- */
- private static final long serialVersionUID = -7644114512714619750L;
-
- /**
- * If any <code>PropertyChangeListeners</code> have been registered,
- * the <code>changeSupport</code> field describes them.
- *
- * @serial
- * @since 1.2
- * @see #addPropertyChangeListener
- * @see #removePropertyChangeListener
- * @see #firePropertyChange
- */
- private PropertyChangeSupport changeSupport;
-
- boolean isPacked = false;
-
- /**
- * This object is used as a key for internal hashtables.
- */
- transient private Object privateKey = new Object();
-
- /**
- * Pseudoparameter for direct Geometry API (setLocation, setBounds setSize
- * to signal setBounds what's changing. Should be used under TreeLock.
- * This is only needed due to the inability to change the cross-calling
- * order of public and deprecated methods.
- */
- private int boundsOp = ComponentPeer.DEFAULT_OPERATION;
-
- /**
- * Should only be used in subclass getBounds to check that part of bounds
- * is actualy changing
- */
- int getBoundsOp() {
- assert Thread.holdsLock(getTreeLock());
- return boundsOp;
- }
-
- void setBoundsOp(int op) {
- assert Thread.holdsLock(getTreeLock());
- if (op == ComponentPeer.RESET_OPERATION) {
- boundsOp = ComponentPeer.DEFAULT_OPERATION;
- } else
- if (boundsOp == ComponentPeer.DEFAULT_OPERATION) {
- boundsOp = op;
- }
- }
-
- /**
- * Constructs a new component. Class <code>Component</code> can be
- * extended directly to create a lightweight component that does not
- * utilize an opaque native window. A lightweight component must be
- * hosted by a native container somewhere higher up in the component
- * tree (for example, by a <code>Frame</code> object).
- */
- protected Component() {
- appContext = AppContext.getAppContext();
- }
-
- void initializeFocusTraversalKeys() {
- focusTraversalKeys = new Set[3];
- }
-
- /**
- * Constructs a name for this component. Called by <code>getName</code>
- * when the name is <code>null</code>.
- */
- String constructComponentName() {
- return null; // For strict compliance with prior platform versions, a Component
- // that doesn't set its name should return null from
- // getName()
- }
-
- /**
- * Gets the name of the component.
- * @return this component's name
- * @see #setName
- * @since JDK1.1
- */
- public String getName() {
- if (name == null && !nameExplicitlySet) {
- synchronized(this) {
- if (name == null && !nameExplicitlySet)
- name = constructComponentName();
- }
- }
- return name;
- }
-
- /**
- * Sets the name of the component to the specified string.
- * @param name the string that is to be this
- * component's name
- * @see #getName
- * @since JDK1.1
- */
- public void setName(String name) {
- String oldName;
- synchronized(this) {
- oldName = this.name;
- this.name = name;
- nameExplicitlySet = true;
- }
- firePropertyChange("name", oldName, name);
- }
-
- /**
- * Gets the parent of this component.
- * @return the parent container of this component
- * @since JDK1.0
- */
- public Container getParent() {
- return getParent_NoClientCode();
- }
-
- // NOTE: This method may be called by privileged threads.
- // This functionality is implemented in a package-private method
- // to insure that it cannot be overridden by client subclasses.
- // DO NOT INVOKE CLIENT CODE ON THIS THREAD!
- final Container getParent_NoClientCode() {
- return parent;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * programs should not directly manipulate peers;
- * replaced by <code>boolean isDisplayable()</code>.
- */
- @Deprecated
- public ComponentPeer getPeer() {
- return peer;
- }
-
- /**
- * Associate a <code>DropTarget</code> with this component.
- * The <code>Component</code> will receive drops only if it
- * is enabled.
- *
- * @see #isEnabled
- * @param dt The DropTarget
- */
-
- public synchronized void setDropTarget(DropTarget dt) {
- if (dt == dropTarget || (dropTarget != null && dropTarget.equals(dt)))
- return;
-
- DropTarget old;
-
- if ((old = dropTarget) != null) {
- if (peer != null) dropTarget.removeNotify(peer);
-
- DropTarget t = dropTarget;
-
- dropTarget = null;
-
- try {
- t.setComponent(null);
- } catch (IllegalArgumentException iae) {
- // ignore it.
- }
- }
-
- // if we have a new one, and we have a peer, add it!
-
- if ((dropTarget = dt) != null) {
- try {
- dropTarget.setComponent(this);
- if (peer != null) dropTarget.addNotify(peer);
- } catch (IllegalArgumentException iae) {
- if (old != null) {
- try {
- old.setComponent(this);
- if (peer != null) dropTarget.addNotify(peer);
- } catch (IllegalArgumentException iae1) {
- // ignore it!
- }
- }
- }
- }
- }
-
- /**
- * Gets the <code>DropTarget</code> associated with this
- * <code>Component</code>.
- */
-
- public synchronized DropTarget getDropTarget() { return dropTarget; }
-
- /**
- * Gets the <code>GraphicsConfiguration</code> associated with this
- * <code>Component</code>.
- * If the <code>Component</code> has not been assigned a specific
- * <code>GraphicsConfiguration</code>,
- * the <code>GraphicsConfiguration</code> of the
- * <code>Component</code> object's top-level container is
- * returned.
- * If the <code>Component</code> has been created, but not yet added
- * to a <code>Container</code>, this method returns <code>null</code>.
- *
- * @return the <code>GraphicsConfiguration</code> used by this
- * <code>Component</code> or <code>null</code>
- * @since 1.3
- */
- public GraphicsConfiguration getGraphicsConfiguration() {
- synchronized(getTreeLock()) {
- if (graphicsConfig != null) {
- return graphicsConfig;
- } else if (getParent() != null) {
- return getParent().getGraphicsConfiguration();
- } else {
- return null;
- }
- }
- }
-
- /**
- * Resets this <code>Component</code>'s
- * <code>GraphicsConfiguration</code> back to a default
- * value. For most componenets, this is <code>null</code>.
- * Called from the Toolkit thread, so NO CLIENT CODE.
- */
- void resetGC() {
- synchronized(getTreeLock()) {
- graphicsConfig = null;
- }
- }
-
- /*
- * Not called on Component, but needed for Canvas and Window
- */
- void setGCFromPeer() {
- synchronized(getTreeLock()) {
- if (peer != null) { // can't imagine how this will be false,
- // but just in case
- graphicsConfig = peer.getGraphicsConfiguration();
- } else {
- graphicsConfig = null;
- }
- }
- }
-
- /**
- * Checks that this component's <code>GraphicsDevice</code>
- * <code>idString</code> matches the string argument.
- */
- void checkGD(String stringID) {
- if (graphicsConfig != null) {
- if (!graphicsConfig.getDevice().getIDstring().equals(stringID)) {
- throw new IllegalArgumentException(
- "adding a container to a container on a different GraphicsDevice");
- }
- }
- }
-
- /**
- * Gets this component's locking object (the object that owns the thread
- * sychronization monitor) for AWT component-tree and layout
- * operations.
- * @return this component's locking object
- */
- public final Object getTreeLock() {
- return LOCK;
- }
-
- /**
- * Gets the toolkit of this component. Note that
- * the frame that contains a component controls which
- * toolkit is used by that component. Therefore if the component
- * is moved from one frame to another, the toolkit it uses may change.
- * @return the toolkit of this component
- * @since JDK1.0
- */
- public Toolkit getToolkit() {
- return getToolkitImpl();
- }
-
- /*
- * This is called by the native code, so client code can't
- * be called on the toolkit thread.
- */
- final Toolkit getToolkitImpl() {
- ComponentPeer peer = this.peer;
- if ((peer != null) && ! (peer instanceof LightweightPeer)){
- return peer.getToolkit();
- }
- Container parent = this.parent;
- if (parent != null) {
- return parent.getToolkitImpl();
- }
- return Toolkit.getDefaultToolkit();
- }
-
- /**
- * Determines whether this component is valid. A component is valid
- * when it is correctly sized and positioned within its parent
- * container and all its children are also valid.
- * In order to account for peers' size requirements, components are invalidated
- * before they are first shown on the screen. By the time the parent container
- * is fully realized, all its components will be valid.
- * @return <code>true</code> if the component is valid, <code>false</code>
- * otherwise
- * @see #validate
- * @see #invalidate
- * @since JDK1.0
- */
- public boolean isValid() {
- return (peer != null) && valid;
- }
-
- /**
- * Determines whether this component is displayable. A component is
- * displayable when it is connected to a native screen resource.
- * <p>
- * A component is made displayable either when it is added to
- * a displayable containment hierarchy or when its containment
- * hierarchy is made displayable.
- * A containment hierarchy is made displayable when its ancestor
- * window is either packed or made visible.
- * <p>
- * A component is made undisplayable either when it is removed from
- * a displayable containment hierarchy or when its containment hierarchy
- * is made undisplayable. A containment hierarchy is made
- * undisplayable when its ancestor window is disposed.
- *
- * @return <code>true</code> if the component is displayable,
- * <code>false</code> otherwise
- * @see Container#add(Component)
- * @see Window#pack
- * @see Window#show
- * @see Container#remove(Component)
- * @see Window#dispose
- * @since 1.2
- */
- public boolean isDisplayable() {
- return getPeer() != null;
- }
-
- /**
- * Determines whether this component should be visible when its
- * parent is visible. Components are
- * initially visible, with the exception of top level components such
- * as <code>Frame</code> objects.
- * @return <code>true</code> if the component is visible,
- * <code>false</code> otherwise
- * @see #setVisible
- * @since JDK1.0
- */
- public boolean isVisible() {
- return visible;
- }
-
- /**
- * Determines whether this component will be displayed on the screen
- * if it's displayable.
- * @return <code>true</code> if the component and all of its ancestors
- * are visible, <code>false</code> otherwise
- */
- boolean isRecursivelyVisible() {
- return visible && (parent == null || parent.isRecursivelyVisible());
- }
-
- /**
- * Translates absolute coordinates into coordinates in the coordinate
- * space of this component.
- */
- Point pointRelativeToComponent(Point absolute) {
- Point compCoords = getLocationOnScreen();
- return new Point(absolute.x - compCoords.x,
- absolute.y - compCoords.y);
- }
-
- /**
- * Assuming that mouse location is stored in PointerInfo passed
- * to this method, it finds a Component that is in the same
- * Window as this Component and is located under the mouse pointer.
- * If no such Component exists, null is returned.
- * NOTE: this method should be called under the protection of
- * tree lock, as it is done in Component.getMousePosition() and
- * Container.getMousePosition(boolean).
- */
- Component findUnderMouseInWindow(PointerInfo pi) {
- if (!isShowing()) {
- return null;
- }
- Window win = getContainingWindow();
- if (!Toolkit.getDefaultToolkit().getMouseInfoPeer().isWindowUnderMouse(win)) {
- return null;
- }
- final boolean INCLUDE_DISABLED = true;
- Point relativeToWindow = win.pointRelativeToComponent(pi.getLocation());
- Component inTheSameWindow = win.findComponentAt(relativeToWindow.x,
- relativeToWindow.y,
- INCLUDE_DISABLED);
- return inTheSameWindow;
- }
-
- /**
- * Returns the position of the mouse pointer in this <code>Component</code>'s
- * coordinate space if the <code>Component</code> is directly under the mouse
- * pointer, otherwise returns <code>null</code>.
- * If the <code>Component</code> is not showing on the screen, this method
- * returns <code>null</code> even if the mouse pointer is above the area
- * where the <code>Component</code> would be displayed.
- * If the <code>Component</code> is partially or fully obscured by other
- * <code>Component</code>s or native windows, this method returns a non-null
- * value only if the mouse pointer is located above the unobscured part of the
- * <code>Component</code>.
- * <p>
- * For <code>Container</code>s it returns a non-null value if the mouse is
- * above the <code>Container</code> itself or above any of its descendants.
- * Use {@link Container#getMousePosition(boolean)} if you need to exclude children.
- * <p>
- * Sometimes the exact mouse coordinates are not important, and the only thing
- * that matters is whether a specific <code>Component</code> is under the mouse
- * pointer. If the return value of this method is <code>null</code>, mouse
- * pointer is not directly above the <code>Component</code>.
- *
- * @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true
- * @see #isShowing
- * @see Container#getMousePosition
- * @return mouse coordinates relative to this <code>Component</code>, or null
- * @since 1.5
- */
- public Point getMousePosition() throws HeadlessException {
- if (GraphicsEnvironment.isHeadless()) {
- throw new HeadlessException();
- }
-
- PointerInfo pi = (PointerInfo)java.security.AccessController.doPrivileged(
- new java.security.PrivilegedAction() {
- public Object run() {
- return MouseInfo.getPointerInfo();
- }
- }
- );
-
- synchronized (getTreeLock()) {
- Component inTheSameWindow = findUnderMouseInWindow(pi);
- if (!isSameOrAncestorOf(inTheSameWindow, true)) {
- return null;
- }
- return pointRelativeToComponent(pi.getLocation());
- }
- }
-
- /**
- * Overridden in Container. Must be called under TreeLock.
- */
- boolean isSameOrAncestorOf(Component comp, boolean allowChildren) {
- return comp == this;
- }
-
- /**
- * Determines whether this component is showing on screen. This means
- * that the component must be visible, and it must be in a container
- * that is visible and showing.
- * @return <code>true</code> if the component is showing,
- * <code>false</code> otherwise
- * @see #setVisible
- * @since JDK1.0
- */
- public boolean isShowing() {
- if (visible && (peer != null)) {
- Container parent = this.parent;
- return (parent == null) || parent.isShowing();
- }
- return false;
- }
-
- /**
- * Determines whether this component is enabled. An enabled component
- * can respond to user input and generate events. Components are
- * enabled initially by default. A component may be enabled or disabled by
- * calling its <code>setEnabled</code> method.
- * @return <code>true</code> if the component is enabled,
- * <code>false</code> otherwise
- * @see #setEnabled
- * @since JDK1.0
- */
- public boolean isEnabled() {
- return isEnabledImpl();
- }
-
- /*
- * This is called by the native code, so client code can't
- * be called on the toolkit thread.
- */
- final boolean isEnabledImpl() {
- return enabled;
- }
-
- /**
- * Enables or disables this component, depending on the value of the
- * parameter <code>b</code>. An enabled component can respond to user
- * input and generate events. Components are enabled initially by default.
- *
- * <p>Note: Disabling a lightweight component does not prevent it from
- * receiving MouseEvents.
- *
- * @param b If <code>true</code>, this component is
- * enabled; otherwise this component is disabled
- * @see #isEnabled
- * @see #isLightweight
- * @since JDK1.1
- */
- public void setEnabled(boolean b) {
- enable(b);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setEnabled(boolean)</code>.
- */
- @Deprecated
- public void enable() {
- if (!enabled) {
- synchronized (getTreeLock()) {
- enabled = true;
- ComponentPeer peer = this.peer;
- if (peer != null) {
- peer.enable();
- if (visible) {
- updateCursorImmediately();
- }
- }
- }
- if (accessibleContext != null) {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- null, AccessibleState.ENABLED);
- }
- }
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setEnabled(boolean)</code>.
- */
- @Deprecated
- public void enable(boolean b) {
- if (b) {
- enable();
- } else {
- disable();
- }
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setEnabled(boolean)</code>.
- */
- @Deprecated
- public void disable() {
- if (enabled) {
- KeyboardFocusManager.clearMostRecentFocusOwner(this);
- synchronized (getTreeLock()) {
- enabled = false;
- if (isFocusOwner()) {
- // Don't clear the global focus owner. If transferFocus
- // fails, we want the focus to stay on the disabled
- // Component so that keyboard traversal, et. al. still
- // makes sense to the user.
- autoTransferFocus(false);
- }
- ComponentPeer peer = this.peer;
- if (peer != null) {
- peer.disable();
- if (visible) {
- updateCursorImmediately();
- }
- }
- }
- if (accessibleContext != null) {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- null, AccessibleState.ENABLED);
- }
- }
- }
-
- /**
- * Returns true if this component is painted to an offscreen image
- * ("buffer") that's copied to the screen later. Component
- * subclasses that support double buffering should override this
- * method to return true if double buffering is enabled.
- *
- * @return false by default
- */
- public boolean isDoubleBuffered() {
- return false;
- }
-
- /**
- * Enables or disables input method support for this component. If input
- * method support is enabled and the component also processes key events,
- * incoming events are offered to
- * the current input method and will only be processed by the component or
- * dispatched to its listeners if the input method does not consume them.
- * By default, input method support is enabled.
- *
- * @param enable true to enable, false to disable
- * @see #processKeyEvent
- * @since 1.2
- */
- public void enableInputMethods(boolean enable) {
- if (enable) {
- if ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0)
- return;
-
- // If this component already has focus, then activate the
- // input method by dispatching a synthesized focus gained
- // event.
- if (isFocusOwner()) {
- InputContext inputContext = getInputContext();
- if (inputContext != null) {
- FocusEvent focusGainedEvent =
- new FocusEvent(this, FocusEvent.FOCUS_GAINED);
- inputContext.dispatchEvent(focusGainedEvent);
- }
- }
-
- eventMask |= AWTEvent.INPUT_METHODS_ENABLED_MASK;
- } else {
- if ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) {
- InputContext inputContext = getInputContext();
- if (inputContext != null) {
- inputContext.endComposition();
- inputContext.removeNotify(this);
- }
- }
- eventMask &= ~AWTEvent.INPUT_METHODS_ENABLED_MASK;
- }
- }
-
- /**
- * Shows or hides this component depending on the value of parameter
- * <code>b</code>.
- * @param b if <code>true</code>, shows this component;
- * otherwise, hides this component
- * @see #isVisible
- * @since JDK1.1
- */
- public void setVisible(boolean b) {
- show(b);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setVisible(boolean)</code>.
- */
- @Deprecated
- public void show() {
- if (!visible) {
- synchronized (getTreeLock()) {
- visible = true;
- ComponentPeer peer = this.peer;
- if (peer != null) {
- peer.show();
- createHierarchyEvents(HierarchyEvent.HIERARCHY_CHANGED,
- this, parent,
- HierarchyEvent.SHOWING_CHANGED,
- Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK));
- if (peer instanceof LightweightPeer) {
- repaint();
- }
- updateCursorImmediately();
- }
-
- if (componentListener != null ||
- (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 ||
- Toolkit.enabledOnToolkit(AWTEvent.COMPONENT_EVENT_MASK)) {
- ComponentEvent e = new ComponentEvent(this,
- ComponentEvent.COMPONENT_SHOWN);
- Toolkit.getEventQueue().postEvent(e);
- }
- }
- Container parent = this.parent;
- if (parent != null) {
- parent.invalidate();
- }
- }
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setVisible(boolean)</code>.
- */
- @Deprecated
- public void show(boolean b) {
- if (b) {
- show();
- } else {
- hide();
- }
- }
-
- boolean containsFocus() {
- return isFocusOwner();
- }
-
- void clearMostRecentFocusOwnerOnHide() {
- KeyboardFocusManager.clearMostRecentFocusOwner(this);
- }
-
- void clearCurrentFocusCycleRootOnHide() {
- /* do nothing */
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setVisible(boolean)</code>.
- */
- @Deprecated
- public void hide() {
- isPacked = false;
-
- if (visible) {
- clearCurrentFocusCycleRootOnHide();
- clearMostRecentFocusOwnerOnHide();
- synchronized (getTreeLock()) {
- visible = false;
- if (containsFocus()) {
- autoTransferFocus(true);
- }
- ComponentPeer peer = this.peer;
- if (peer != null) {
- peer.hide();
- createHierarchyEvents(HierarchyEvent.HIERARCHY_CHANGED,
- this, parent,
- HierarchyEvent.SHOWING_CHANGED,
- Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK));
- if (peer instanceof LightweightPeer) {
- repaint();
- }
- updateCursorImmediately();
- }
- if (componentListener != null ||
- (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 ||
- Toolkit.enabledOnToolkit(AWTEvent.COMPONENT_EVENT_MASK)) {
- ComponentEvent e = new ComponentEvent(this,
- ComponentEvent.COMPONENT_HIDDEN);
- Toolkit.getEventQueue().postEvent(e);
- }
- }
- Container parent = this.parent;
- if (parent != null) {
- parent.invalidate();
- }
- }
- }
-
- /**
- * Gets the foreground color of this component.
- * @return this component's foreground color; if this component does
- * not have a foreground color, the foreground color of its parent
- * is returned
- * @see #setForeground
- * @since JDK1.0
- * @beaninfo
- * bound: true
- */
- public Color getForeground() {
- Color foreground = this.foreground;
- if (foreground != null) {
- return foreground;
- }
- Container parent = this.parent;
- return (parent != null) ? parent.getForeground() : null;
- }
-
- /**
- * Sets the foreground color of this component.
- * @param c the color to become this component's
- * foreground color; if this parameter is <code>null</code>
- * then this component will inherit
- * the foreground color of its parent
- * @see #getForeground
- * @since JDK1.0
- */
- public void setForeground(Color c) {
- Color oldColor = foreground;
- ComponentPeer peer = this.peer;
- foreground = c;
- if (peer != null) {
- c = getForeground();
- if (c != null) {
- peer.setForeground(c);
- }
- }
- // This is a bound property, so report the change to
- // any registered listeners. (Cheap if there are none.)
- firePropertyChange("foreground", oldColor, c);
- }
-
- /**
- * Returns whether the foreground color has been explicitly set for this
- * Component. If this method returns <code>false</code>, this Component is
- * inheriting its foreground color from an ancestor.
- *
- * @return <code>true</code> if the foreground color has been explicitly
- * set for this Component; <code>false</code> otherwise.
- * @since 1.4
- */
- public boolean isForegroundSet() {
- return (foreground != null);
- }
-
- /**
- * Gets the background color of this component.
- * @return this component's background color; if this component does
- * not have a background color,
- * the background color of its parent is returned
- * @see #setBackground
- * @since JDK1.0
- */
- public Color getBackground() {
- Color background = this.background;
- if (background != null) {
- return background;
- }
- Container parent = this.parent;
- return (parent != null) ? parent.getBackground() : null;
- }
-
- /**
- * Sets the background color of this component.
- * <p>
- * The background color affects each component differently and the
- * parts of the component that are affected by the background color
- * may differ between operating systems.
- *
- * @param c the color to become this component's color;
- * if this parameter is <code>null</code>, then this
- * component will inherit the background color of its parent
- * @see #getBackground
- * @since JDK1.0
- * @beaninfo
- * bound: true
- */
- public void setBackground(Color c) {
- Color oldColor = background;
- ComponentPeer peer = this.peer;
- background = c;
- if (peer != null) {
- c = getBackground();
- if (c != null) {
- peer.setBackground(c);
- }
- }
- // This is a bound property, so report the change to
- // any registered listeners. (Cheap if there are none.)
- firePropertyChange("background", oldColor, c);
- }
-
- /**
- * Returns whether the background color has been explicitly set for this
- * Component. If this method returns <code>false</code>, this Component is
- * inheriting its background color from an ancestor.
- *
- * @return <code>true</code> if the background color has been explicitly
- * set for this Component; <code>false</code> otherwise.
- * @since 1.4
- */
- public boolean isBackgroundSet() {
- return (background != null);
- }
-
- /**
- * Gets the font of this component.
- * @return this component's font; if a font has not been set
- * for this component, the font of its parent is returned
- * @see #setFont
- * @since JDK1.0
- */
- public Font getFont() {
- return getFont_NoClientCode();
- }
-
- // NOTE: This method may be called by privileged threads.
- // This functionality is implemented in a package-private method
- // to insure that it cannot be overridden by client subclasses.
- // DO NOT INVOKE CLIENT CODE ON THIS THREAD!
- final Font getFont_NoClientCode() {
- Font font = this.font;
- if (font != null) {
- return font;
- }
- Container parent = this.parent;
- return (parent != null) ? parent.getFont_NoClientCode() : null;
- }
-
- /**
- * Sets the font of this component.
- * @param f the font to become this component's font;
- * if this parameter is <code>null</code> then this
- * component will inherit the font of its parent
- * @see #getFont
- * @since JDK1.0
- * @beaninfo
- * bound: true
- */
- public void setFont(Font f) {
- Font oldFont, newFont;
- synchronized(getTreeLock()) {
- synchronized (this) {
- oldFont = font;
- newFont = font = f;
- }
- ComponentPeer peer = this.peer;
- if (peer != null) {
- f = getFont();
- if (f != null) {
- peer.setFont(f);
- peerFont = f;
- }
- }
- }
- // This is a bound property, so report the change to
- // any registered listeners. (Cheap if there are none.)
- firePropertyChange("font", oldFont, newFont);
-
- // This could change the preferred size of the Component.
- if (valid) {
- invalidate();
- }
- }
-
- /**
- * Returns whether the font has been explicitly set for this Component. If
- * this method returns <code>false</code>, this Component is inheriting its
- * font from an ancestor.
- *
- * @return <code>true</code> if the font has been explicitly set for this
- * Component; <code>false</code> otherwise.
- * @since 1.4
- */
- public boolean isFontSet() {
- return (font != null);
- }
-
- /**
- * Gets the locale of this component.
- * @return this component's locale; if this component does not
- * have a locale, the locale of its parent is returned
- * @see #setLocale
- * @exception IllegalComponentStateException if the <code>Component</code>
- * does not have its own locale and has not yet been added to
- * a containment hierarchy such that the locale can be determined
- * from the containing parent
- * @since JDK1.1
- */
- public Locale getLocale() {
- Locale locale = this.locale;
- if (locale != null) {
- return locale;
- }
- Container parent = this.parent;
-
- if (parent == null) {
- throw new IllegalComponentStateException("This component must have a parent in order to determine its locale");
- } else {
- return parent.getLocale();
- }
- }
-
- /**
- * Sets the locale of this component. This is a bound property.
- * @param l the locale to become this component's locale
- * @see #getLocale
- * @since JDK1.1
- */
- public void setLocale(Locale l) {
- Locale oldValue = locale;
- locale = l;
-
- // This is a bound property, so report the change to
- // any registered listeners. (Cheap if there are none.)
- firePropertyChange("locale", oldValue, l);
-
- // This could change the preferred size of the Component.
- if (valid) {
- invalidate();
- }
- }
-
- /**
- * Gets the instance of <code>ColorModel</code> used to display
- * the component on the output device.
- * @return the color model used by this component
- * @see java.awt.image.ColorModel
- * @see java.awt.peer.ComponentPeer#getColorModel()
- * @see Toolkit#getColorModel()
- * @since JDK1.0
- */
- public ColorModel getColorModel() {
- ComponentPeer peer = this.peer;
- if ((peer != null) && ! (peer instanceof LightweightPeer)) {
- return peer.getColorModel();
- } else if (GraphicsEnvironment.isHeadless()) {
- return ColorModel.getRGBdefault();
- } // else
- return getToolkit().getColorModel();
- }
-
- /**
- * Gets the location of this component in the form of a
- * point specifying the component's top-left corner.
- * The location will be relative to the parent's coordinate space.
- * <p>
- * Due to the asynchronous nature of native event handling, this
- * method can return outdated values (for instance, after several calls
- * of <code>setLocation()</code> in rapid succession). For this
- * reason, the recommended method of obtaining a component's position is
- * within <code>java.awt.event.ComponentListener.componentMoved()</code>,
- * which is called after the operating system has finished moving the
- * component.
- * </p>
- * @return an instance of <code>Point</code> representing
- * the top-left corner of the component's bounds in
- * the coordinate space of the component's parent
- * @see #setLocation
- * @see #getLocationOnScreen
- * @since JDK1.1
- */
- public Point getLocation() {
- return location();
- }
-
- /**
- * Gets the location of this component in the form of a point
- * specifying the component's top-left corner in the screen's
- * coordinate space.
- * @return an instance of <code>Point</code> representing
- * the top-left corner of the component's bounds in the
- * coordinate space of the screen
- * @throws <code>IllegalComponentStateException</code> if the
- * component is not showing on the screen
- * @see #setLocation
- * @see #getLocation
- */
- public Point getLocationOnScreen() {
- synchronized (getTreeLock()) {
- return getLocationOnScreen_NoTreeLock();
- }
- }
-
- /*
- * a package private version of getLocationOnScreen
- * used by GlobalCursormanager to update cursor
- */
- final Point getLocationOnScreen_NoTreeLock() {
-
- if (peer != null && isShowing()) {
- if (peer instanceof LightweightPeer) {
- // lightweight component location needs to be translated
- // relative to a native component.
- Container host = getNativeContainer();
- Point pt = host.peer.getLocationOnScreen();
- for(Component c = this; c != host; c = c.getParent()) {
- pt.x += c.x;
- pt.y += c.y;
- }
- return pt;
- } else {
- Point pt = peer.getLocationOnScreen();
- return pt;
- }
- } else {
- throw new IllegalComponentStateException("component must be showing on the screen to determine its location");
- }
- }
-
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>getLocation()</code>.
- */
- @Deprecated
- public Point location() {
- return new Point(x, y);
- }
-
- /**
- * Moves this component to a new location. The top-left corner of
- * the new location is specified by the <code>x</code> and <code>y</code>
- * parameters in the coordinate space of this component's parent.
- * @param x the <i>x</i>-coordinate of the new location's
- * top-left corner in the parent's coordinate space
- * @param y the <i>y</i>-coordinate of the new location's
- * top-left corner in the parent's coordinate space
- * @see #getLocation
- * @see #setBounds
- * @since JDK1.1
- */
- public void setLocation(int x, int y) {
- move(x, y);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setLocation(int, int)</code>.
- */
- @Deprecated
- public void move(int x, int y) {
- synchronized(getTreeLock()) {
- setBoundsOp(ComponentPeer.SET_LOCATION);
- setBounds(x, y, width, height);
- }
- }
-
- /**
- * Moves this component to a new location. The top-left corner of
- * the new location is specified by point <code>p</code>. Point
- * <code>p</code> is given in the parent's coordinate space.
- * @param p the point defining the top-left corner
- * of the new location, given in the coordinate space of this
- * component's parent
- * @see #getLocation
- * @see #setBounds
- * @since JDK1.1
- */
- public void setLocation(Point p) {
- setLocation(p.x, p.y);
- }
-
- /**
- * Returns the size of this component in the form of a
- * <code>Dimension</code> object. The <code>height</code>
- * field of the <code>Dimension</code> object contains
- * this component's height, and the <code>width</code>
- * field of the <code>Dimension</code> object contains
- * this component's width.
- * @return a <code>Dimension</code> object that indicates the
- * size of this component
- * @see #setSize
- * @since JDK1.1
- */
- public Dimension getSize() {
- return size();
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>getSize()</code>.
- */
- @Deprecated
- public Dimension size() {
- return new Dimension(width, height);
- }
-
- /**
- * Resizes this component so that it has width <code>width</code>
- * and height <code>height</code>.
- * @param width the new width of this component in pixels
- * @param height the new height of this component in pixels
- * @see #getSize
- * @see #setBounds
- * @since JDK1.1
- */
- public void setSize(int width, int height) {
- resize(width, height);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setSize(int, int)</code>.
- */
- @Deprecated
- public void resize(int width, int height) {
- synchronized(getTreeLock()) {
- setBoundsOp(ComponentPeer.SET_SIZE);
- setBounds(x, y, width, height);
- }
- }
-
- /**
- * Resizes this component so that it has width <code>d.width</code>
- * and height <code>d.height</code>.
- * @param d the dimension specifying the new size
- * of this component
- * @see #setSize
- * @see #setBounds
- * @since JDK1.1
- */
- public void setSize(Dimension d) {
- resize(d);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setSize(Dimension)</code>.
- */
- @Deprecated
- public void resize(Dimension d) {
- setSize(d.width, d.height);
- }
-
- /**
- * Gets the bounds of this component in the form of a
- * <code>Rectangle</code> object. The bounds specify this
- * component's width, height, and location relative to
- * its parent.
- * @return a rectangle indicating this component's bounds
- * @see #setBounds
- * @see #getLocation
- * @see #getSize
- */
- public Rectangle getBounds() {
- return bounds();
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>getBounds()</code>.
- */
- @Deprecated
- public Rectangle bounds() {
- return new Rectangle(x, y, width, height);
- }
-
- /**
- * Moves and resizes this component. The new location of the top-left
- * corner is specified by <code>x</code> and <code>y</code>, and the
- * new size is specified by <code>width</code> and <code>height</code>.
- * @param x the new <i>x</i>-coordinate of this component
- * @param y the new <i>y</i>-coordinate of this component
- * @param width the new <code>width</code> of this component
- * @param height the new <code>height</code> of this
- * component
- * @see #getBounds
- * @see #setLocation(int, int)
- * @see #setLocation(Point)
- * @see #setSize(int, int)
- * @see #setSize(Dimension)
- * @since JDK1.1
- */
- public void setBounds(int x, int y, int width, int height) {
- reshape(x, y, width, height);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>setBounds(int, int, int, int)</code>.
- */
- @Deprecated
- public void reshape(int x, int y, int width, int height) {
- synchronized (getTreeLock()) {
- try {
- setBoundsOp(ComponentPeer.SET_BOUNDS);
- boolean resized = (this.width != width) || (this.height != height);
- boolean moved = (this.x != x) || (this.y != y);
- if (!resized && !moved) {
- return;
- }
- int oldX = this.x;
- int oldY = this.y;
- int oldWidth = this.width;
- int oldHeight = this.height;
- this.x = x;
- this.y = y;
- this.width = width;
- this.height = height;
-
- if (resized) {
- isPacked = false;
- }
-
- if (peer != null) {
- // LightwightPeer is an empty stub so can skip peer.reshape
- if (!(peer instanceof LightweightPeer)) {
- reshapeNativePeer(x, y, width, height, getBoundsOp());
- // Check peer actualy changed coordinates
- resized = (oldWidth != this.width) || (oldHeight != this.height);
- moved = (oldX != this.x) || (oldY != this.y);
- }
-
- if (resized) {
- invalidate();
- }
- if (parent != null && parent.valid) {
- parent.invalidate();
- }
- }
- notifyNewBounds(resized, moved);
- repaintParentIfNeeded(oldX, oldY, oldWidth, oldHeight);
- } finally {
- setBoundsOp(ComponentPeer.RESET_OPERATION);
- }
- }
- }
-
- private void repaintParentIfNeeded(int oldX, int oldY, int oldWidth,
- int oldHeight)
- {
- if (parent != null && peer instanceof LightweightPeer && isShowing()) {
- // Have the parent redraw the area this component occupied.
- parent.repaint(oldX, oldY, oldWidth, oldHeight);
- // Have the parent redraw the area this component *now* occupies.
- repaint();
- }
- }
-
- private void reshapeNativePeer(int x, int y, int width, int height, int op) {
- // native peer might be offset by more than direct
- // parent since parent might be lightweight.
- int nativeX = x;
- int nativeY = y;
- for (Component c = parent;
- (c != null) && (c.peer instanceof LightweightPeer);
- c = c.parent)
- {
- nativeX += c.x;
- nativeY += c.y;
- }
- peer.setBounds(nativeX, nativeY, width, height, op);
- }
-
-
- private void notifyNewBounds(boolean resized, boolean moved) {
- if (componentListener != null
- || (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0
- || Toolkit.enabledOnToolkit(AWTEvent.COMPONENT_EVENT_MASK))
- {
- if (resized) {
- ComponentEvent e = new ComponentEvent(this,
- ComponentEvent.COMPONENT_RESIZED);
- Toolkit.getEventQueue().postEvent(e);
- }
- if (moved) {
- ComponentEvent e = new ComponentEvent(this,
- ComponentEvent.COMPONENT_MOVED);
- Toolkit.getEventQueue().postEvent(e);
- }
- } else
- // Swing optimization. JComponent extends Container
- if (this instanceof Container && ((Container)this).ncomponents > 0) {
- boolean enabledOnToolkit =
- Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK);
- // Container.dispatchEventImpl will create
- // HierarchyEvents
- if (resized) {
- ((Container)this).createChildHierarchyEvents(
- HierarchyEvent.ANCESTOR_RESIZED, 0, enabledOnToolkit);
- }
- if (moved) {
- ((Container)this).createChildHierarchyEvents(
- HierarchyEvent.ANCESTOR_MOVED, 0, enabledOnToolkit);
- }
- }
- }
-
- /**
- * Moves and resizes this component to conform to the new
- * bounding rectangle <code>r</code>. This component's new
- * position is specified by <code>r.x</code> and <code>r.y</code>,
- * and its new size is specified by <code>r.width</code> and
- * <code>r.height</code>
- * @param r the new bounding rectangle for this component
- * @see #getBounds
- * @see #setLocation(int, int)
- * @see #setLocation(Point)
- * @see #setSize(int, int)
- * @see #setSize(Dimension)
- * @since JDK1.1
- */
- public void setBounds(Rectangle r) {
- setBounds(r.x, r.y, r.width, r.height);
- }
-
-
- /**
- * Returns the current x coordinate of the components origin.
- * This method is preferable to writing
- * <code>component.getBounds().x</code>,
- * or <code>component.getLocation().x</code> because it doesn't
- * cause any heap allocations.
- *
- * @return the current x coordinate of the components origin
- * @since 1.2
- */
- public int getX() {
- return x;
- }
-
-
- /**
- * Returns the current y coordinate of the components origin.
- * This method is preferable to writing
- * <code>component.getBounds().y</code>,
- * or <code>component.getLocation().y</code> because it
- * doesn't cause any heap allocations.
- *
- * @return the current y coordinate of the components origin
- * @since 1.2
- */
- public int getY() {
- return y;
- }
-
-
- /**
- * Returns the current width of this component.
- * This method is preferable to writing
- * <code>component.getBounds().width</code>,
- * or <code>component.getSize().width</code> because it
- * doesn't cause any heap allocations.
- *
- * @return the current width of this component
- * @since 1.2
- */
- public int getWidth() {
- return width;
- }
-
-
- /**
- * Returns the current height of this component.
- * This method is preferable to writing
- * <code>component.getBounds().height</code.,
- * or <code>component.getSize().height</code> because it
- * doesn't cause any heap allocations.
- *
- * @return the current height of this component
- * @since 1.2
- */
- public int getHeight() {
- return height;
- }
-
- /**
- * Stores the bounds of this component into "return value" <b>rv</b> and
- * return <b>rv</b>. If rv is <code>null</code> a new
- * <code>Rectangle</code> is allocated.
- * This version of <code>getBounds</code> is useful if the caller
- * wants to avoid allocating a new <code>Rectangle</code> object
- * on the heap.
- *
- * @param rv the return value, modified to the components bounds
- * @return rv
- */
- public Rectangle getBounds(Rectangle rv) {
- if (rv == null) {
- return new Rectangle(getX(), getY(), getWidth(), getHeight());
- }
- else {
- rv.setBounds(getX(), getY(), getWidth(), getHeight());
- return rv;
- }
- }
-
- /**
- * Stores the width/height of this component into "return value" <b>rv</b>
- * and return <b>rv</b>. If rv is <code>null</code> a new
- * <code>Dimension</code> object is allocated. This version of
- * <code>getSize</code> is useful if the caller wants to avoid
- * allocating a new <code>Dimension</code> object on the heap.
- *
- * @param rv the return value, modified to the components size
- * @return rv
- */
- public Dimension getSize(Dimension rv) {
- if (rv == null) {
- return new Dimension(getWidth(), getHeight());
- }
- else {
- rv.setSize(getWidth(), getHeight());
- return rv;
- }
- }
-
- /**
- * Stores the x,y origin of this component into "return value" <b>rv</b>
- * and return <b>rv</b>. If rv is <code>null</code> a new
- * <code>Point</code> is allocated.
- * This version of <code>getLocation</code> is useful if the
- * caller wants to avoid allocating a new <code>Point</code>
- * object on the heap.
- *
- * @param rv the return value, modified to the components location
- * @return rv
- */
- public Point getLocation(Point rv) {
- if (rv == null) {
- return new Point(getX(), getY());
- }
- else {
- rv.setLocation(getX(), getY());
- return rv;
- }
- }
-
- /**
- * Returns true if this component is completely opaque, returns
- * false by default.
- * <p>
- * An opaque component paints every pixel within its
- * rectangular region. A non-opaque component paints only some of
- * its pixels, allowing the pixels underneath it to "show through".
- * A component that does not fully paint its pixels therefore
- * provides a degree of transparency. Only lightweight
- * components can be transparent.
- * <p>
- * Subclasses that guarantee to always completely paint their
- * contents should override this method and return true. All
- * of the "heavyweight" AWT components are opaque.
- *
- * @return true if this component is completely opaque
- * @see #isLightweight
- * @since 1.2
- */
- public boolean isOpaque() {
- if (getPeer() == null) {
- return false;
- }
- else {
- return !isLightweight();
- }
- }
-
-
- /**
- * A lightweight component doesn't have a native toolkit peer.
- * Subclasses of <code>Component</code> and <code>Container</code>,
- * other than the ones defined in this package like <code>Button</code>
- * or <code>Scrollbar</code>, are lightweight.
- * All of the Swing components are lightweights.
- * <p>
- * This method will always return <code>false</code> if this component
- * is not displayable because it is impossible to determine the
- * weight of an undisplayable component.
- *
- * @return true if this component has a lightweight peer; false if
- * it has a native peer or no peer
- * @see #isDisplayable
- * @since 1.2
- */
- public boolean isLightweight() {
- return getPeer() instanceof LightweightPeer;
- }
-
-
- /**
- * Sets the preferred size of this component to a constant
- * value. Subsequent calls to <code>getPreferredSize</code> will always
- * return this value. Setting the preferred size to <code>null</code>
- * restores the default behavior.
- *
- * @param preferredSize The new preferred size, or null
- * @see #getPreferredSize
- * @see #isPreferredSizeSet
- * @since 1.5
- */
- public void setPreferredSize(Dimension preferredSize) {
- Dimension old;
- // If the preferred size was set, use it as the old value, otherwise
- // use null to indicate we didn't previously have a set preferred
- // size.
- if (prefSizeSet) {
- old = this.prefSize;
- }
- else {
- old = null;
- }
- this.prefSize = preferredSize;
- prefSizeSet = (preferredSize != null);
- firePropertyChange("preferredSize", old, preferredSize);
- }
-
-
- /**
- * Returns true if the preferred size has been set to a
- * non-<code>null</code> value otherwise returns false.
- *
- * @return true if <code>setPreferredSize</code> has been invoked
- * with a non-null value.
- * @since 1.5
- */
- public boolean isPreferredSizeSet() {
- return prefSizeSet;
- }
-
-
- /**
- * Gets the preferred size of this component.
- * @return a dimension object indicating this component's preferred size
- * @see #getMinimumSize
- * @see LayoutManager
- */
- public Dimension getPreferredSize() {
- return preferredSize();
- }
-
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>getPreferredSize()</code>.
- */
- @Deprecated
- public Dimension preferredSize() {
- /* Avoid grabbing the lock if a reasonable cached size value
- * is available.
- */
- Dimension dim = prefSize;
- if (dim == null || !(isPreferredSizeSet() || isValid())) {
- synchronized (getTreeLock()) {
- prefSize = (peer != null) ?
- peer.preferredSize() :
- getMinimumSize();
- dim = prefSize;
- }
- }
- return new Dimension(dim);
- }
-
- /**
- * Sets the minimum size of this component to a constant
- * value. Subsequent calls to <code>getMinimumSize</code> will always
- * return this value. Setting the minimum size to <code>null</code>
- * restores the default behavior.
- *
- * @param minimumSize the new minimum size of this component
- * @see #getMinimumSize
- * @see #isMinimumSizeSet
- * @since 1.5
- */
- public void setMinimumSize(Dimension minimumSize) {
- Dimension old;
- // If the minimum size was set, use it as the old value, otherwise
- // use null to indicate we didn't previously have a set minimum
- // size.
- if (minSizeSet) {
- old = this.minSize;
- }
- else {
- old = null;
- }
- this.minSize = minimumSize;
- minSizeSet = (minimumSize != null);
- firePropertyChange("minimumSize", old, minimumSize);
- }
-
- /**
- * Returns whether or not <code>setMinimumSize</code> has been
- * invoked with a non-null value.
- *
- * @return true if <code>setMinimumSize</code> has been invoked with a
- * non-null value.
- * @since 1.5
- */
- public boolean isMinimumSizeSet() {
- return minSizeSet;
- }
-
- /**
- * Gets the mininimum size of this component.
- * @return a dimension object indicating this component's minimum size
- * @see #getPreferredSize
- * @see LayoutManager
- */
- public Dimension getMinimumSize() {
- return minimumSize();
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>getMinimumSize()</code>.
- */
- @Deprecated
- public Dimension minimumSize() {
- /* Avoid grabbing the lock if a reasonable cached size value
- * is available.
- */
- Dimension dim = minSize;
- if (dim == null || !(isMinimumSizeSet() || isValid())) {
- synchronized (getTreeLock()) {
- minSize = (peer != null) ?
- peer.minimumSize() :
- size();
- dim = minSize;
- }
- }
- return new Dimension(dim);
- }
-
- /**
- * Sets the maximum size of this component to a constant
- * value. Subsequent calls to <code>getMaximumSize</code> will always
- * return this value. Setting the maximum size to <code>null</code>
- * restores the default behavior.
- *
- * @param maximumSize a <code>Dimension</code> containing the
- * desired maximum allowable size
- * @see #getMaximumSize
- * @see #isMaximumSizeSet
- * @since 1.5
- */
- public void setMaximumSize(Dimension maximumSize) {
- // If the maximum size was set, use it as the old value, otherwise
- // use null to indicate we didn't previously have a set maximum
- // size.
- Dimension old;
- if (maxSizeSet) {
- old = this.maxSize;
- }
- else {
- old = null;
- }
- this.maxSize = maximumSize;
- maxSizeSet = (maximumSize != null);
- firePropertyChange("maximumSize", old, maximumSize);
- }
-
- /**
- * Returns true if the maximum size has been set to a non-<code>null</code>
- * value otherwise returns false.
- *
- * @return true if <code>maximumSize</code> is non-<code>null</code>,
- * false otherwise
- * @since 1.5
- */
- public boolean isMaximumSizeSet() {
- return maxSizeSet;
- }
-
- /**
- * Gets the maximum size of this component.
- * @return a dimension object indicating this component's maximum size
- * @see #getMinimumSize
- * @see #getPreferredSize
- * @see LayoutManager
- */
- public Dimension getMaximumSize() {
- if (isMaximumSizeSet()) {
- return new Dimension(maxSize);
- }
- return new Dimension(Short.MAX_VALUE, Short.MAX_VALUE);
- }
-
- /**
- * Returns the alignment along the x axis. This specifies how
- * the component would like to be aligned relative to other
- * components. The value should be a number between 0 and 1
- * where 0 represents alignment along the origin, 1 is aligned
- * the furthest away from the origin, 0.5 is centered, etc.
- */
- public float getAlignmentX() {
- return CENTER_ALIGNMENT;
- }
-
- /**
- * Returns the alignment along the y axis. This specifies how
- * the component would like to be aligned relative to other
- * components. The value should be a number between 0 and 1
- * where 0 represents alignment along the origin, 1 is aligned
- * the furthest away from the origin, 0.5 is centered, etc.
- */
- public float getAlignmentY() {
- return CENTER_ALIGNMENT;
- }
-
- /**
- * Prompts the layout manager to lay out this component. This is
- * usually called when the component (more specifically, container)
- * is validated.
- * @see #validate
- * @see LayoutManager
- */
- public void doLayout() {
- layout();
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>doLayout()</code>.
- */
- @Deprecated
- public void layout() {
- }
-
- /**
- * Ensures that this component has a valid layout. This method is
- * primarily intended to operate on instances of <code>Container</code>.
- * @see #invalidate
- * @see #doLayout()
- * @see LayoutManager
- * @see Container#validate
- * @since JDK1.0
- */
- public void validate() {
- if (!valid) {
- synchronized (getTreeLock()) {
- ComponentPeer peer = this.peer;
- if (!valid && peer != null) {
- Font newfont = getFont();
- Font oldfont = peerFont;
- if (newfont != oldfont && (oldfont == null
- || !oldfont.equals(newfont))) {
- peer.setFont(newfont);
- peerFont = newfont;
- }
- peer.layout();
- }
- }
- valid = true;
- }
- }
-
- /**
- * Invalidates this component. This component and all parents
- * above it are marked as needing to be laid out. This method can
- * be called often, so it needs to execute quickly.
- * @see #validate
- * @see #doLayout
- * @see LayoutManager
- * @since JDK1.0
- */
- public void invalidate() {
- synchronized (getTreeLock()) {
- /* Nullify cached layout and size information.
- * For efficiency, propagate invalidate() upwards only if
- * some other component hasn't already done so first.
- */
- valid = false;
- if (!isPreferredSizeSet()) {
- prefSize = null;
- }
- if (!isMinimumSizeSet()) {
- minSize = null;
- }
- if (!isMaximumSizeSet()) {
- maxSize = null;
- }
- if (parent != null && parent.valid) {
- parent.invalidate();
- }
- }
- }
-
- /**
- * Creates a graphics context for this component. This method will
- * return <code>null</code> if this component is currently not
- * displayable.
- * @return a graphics context for this component, or <code>null</code>
- * if it has none
- * @see #paint
- * @since JDK1.0
- */
- public Graphics getGraphics() {
- if (peer instanceof LightweightPeer) {
- // This is for a lightweight component, need to
- // translate coordinate spaces and clip relative
- // to the parent.
- if (parent == null) return null;
- Graphics g = parent.getGraphics();
- if (g == null) return null;
- if (g instanceof ConstrainableGraphics) {
- ((ConstrainableGraphics) g).constrain(x, y, width, height);
- } else {
- g.translate(x,y);
- g.setClip(0, 0, width, height);
- }
- g.setFont(getFont());
- return g;
- } else {
- ComponentPeer peer = this.peer;
- return (peer != null) ? peer.getGraphics() : null;
- }
- }
-
- /** saves an internal cache of FontMetrics for better performance **/
-
- static java.util.Hashtable metrics = new java.util.Hashtable();
- /**
- * Gets the font metrics for the specified font.
- * @param font the font for which font metrics is to be
- * obtained
- * @return the font metrics for <code>font</code>
- * @see #getFont
- * @see #getPeer
- * @see java.awt.peer.ComponentPeer#getFontMetrics(Font)
- * @see Toolkit#getFontMetrics(Font)
- * @since JDK1.0
- */
- public FontMetrics getFontMetrics(Font font) {
- FontMetrics result = (FontMetrics) metrics.get(font);
- if (result != null) {
- return result;
- }
- // REMIND: PlatformFont flag should be obsolete soon...
- if (sun.font.FontManager.usePlatformFontMetrics()) {
- if (peer != null &&
- !(peer instanceof LightweightPeer)) {
- result = peer.getFontMetrics(font);
- metrics.put(font, result);
- return result;
- }
- }
- if (parent != null) {
- // These are the lines that cost the big dollars. Calling
- // parent.getGraphics triggers the construcion (at great
- // expense) of a new Graphics object that is then quickly
- // discarded. - Graham
- Graphics g = parent.getGraphics();
- if (g != null) {
- try {
- result = g.getFontMetrics(font);
- metrics.put(font, result);
- return result;
- } finally {
- g.dispose();
- }
- }
- }
-
- result = getToolkit().getFontMetrics(font);
- metrics.put(font, result);
- return result;
- }
-
- /**
- * Sets the cursor image to the specified cursor. This cursor
- * image is displayed when the <code>contains</code> method for
- * this component returns true for the current cursor location, and
- * this Component is visible, displayable, and enabled. Setting the
- * cursor of a <code>Container</code> causes that cursor to be displayed
- * within all of the container's subcomponents, except for those
- * that have a non-<code>null</code> cursor.
- *
- * @param cursor One of the constants defined
- * by the <code>Cursor</code> class;
- * if this parameter is <code>null</code>
- * then this component will inherit
- * the cursor of its parent
- * @see #isEnabled
- * @see #isShowing
- * @see #getCursor
- * @see #contains
- * @see Toolkit#createCustomCursor
- * @see Cursor
- * @since JDK1.1
- */
- public void setCursor(Cursor cursor) {
- this.cursor = cursor;
- updateCursorImmediately();
- }
-
- /**
- * Updates the cursor. May not be invoked from the native
- * message pump.
- */
- final void updateCursorImmediately() {
- if (peer instanceof LightweightPeer) {
- Container nativeContainer = getNativeContainer();
-
- if (nativeContainer == null) return;
-
- ComponentPeer cPeer = nativeContainer.getPeer();
-
- if (cPeer != null) {
- cPeer.updateCursorImmediately();
- }
- } else if (peer != null) {
- peer.updateCursorImmediately();
- }
- }
-
- /**
- * Gets the cursor set in the component. If the component does
- * not have a cursor set, the cursor of its parent is returned.
- * If no cursor is set in the entire hierarchy,
- * <code>Cursor.DEFAULT_CURSOR</code> is returned.
- * @see #setCursor
- * @since JDK1.1
- */
- public Cursor getCursor() {
- Cursor cursor = this.cursor;
- if (cursor != null) {
- return cursor;
- }
- Container parent = this.parent;
- if (parent != null) {
- return parent.getCursor();
- } else {
- return Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR);
- }
- }
-
- /**
- * Returns whether the cursor has been explicitly set for this Component.
- * If this method returns <code>false</code>, this Component is inheriting
- * its cursor from an ancestor.
- *
- * @return <code>true</code> if the cursor has been explicitly set for this
- * Component; <code>false</code> otherwise.
- * @since 1.4
- */
- public boolean isCursorSet() {
- return (cursor != null);
- }
-
- /**
- * Paints this component.
- * <p>
- * This method is called when the contents of the component should
- * be painted; such as when the component is first being shown or
- * is damaged and in need of repair. The clip rectangle in the
- * <code>Graphics</code> parameter is set to the area
- * which needs to be painted.
- * Subclasses of <code>Component</code> that override this
- * method need not call <code>super.paint(g)</code>.
- * <p>
- * For performance reasons, <code>Component</code>s with zero width
- * or height aren't considered to need painting when they are first shown,
- * and also aren't considered to need repair.
- * <p>
- * <b>Note</b>: For more information on the paint mechanisms utilitized
- * by AWT and Swing, including information on how to write the most
- * efficient painting code, see
- * <a href="http://java.sun.com/products/jfc/tsc/articles/painting/index.html">Painting in AWT and Swing</a>.
- *
- * @param g the graphics context to use for painting
- * @see #update
- * @since JDK1.0
- */
- public void paint(Graphics g) {
- }
-
- /**
- * Updates this component.
- * <p>
- * If this component is not a lightweight component, the
- * AWT calls the <code>update</code> method in response to
- * a call to <code>repaint</code>. You can assume that
- * the background is not cleared.
- * <p>
- * The <code>update</code> method of <code>Component</code>
- * calls this component's <code>paint</code> method to redraw
- * this component. This method is commonly overridden by subclasses
- * which need to do additional work in response to a call to
- * <code>repaint</code>.
- * Subclasses of Component that override this method should either
- * call <code>super.update(g)</code>, or call <code>paint(g)</code>
- * directly from their <code>update</code> method.
- * <p>
- * The origin of the graphics context, its
- * (<code>0</code>, <code>0</code>) coordinate point, is the
- * top-left corner of this component. The clipping region of the
- * graphics context is the bounding rectangle of this component.
- *
- * <p>
- * <b>Note</b>: For more information on the paint mechanisms utilitized
- * by AWT and Swing, including information on how to write the most
- * efficient painting code, see
- * <a href="http://java.sun.com/products/jfc/tsc/articles/painting/index.html">Painting in AWT and Swing</a>.
- *
- * @param g the specified context to use for updating
- * @see #paint
- * @see #repaint()
- * @since JDK1.0
- */
- public void update(Graphics g) {
- paint(g);
- }
-
- /**
- * Paints this component and all of its subcomponents.
- * <p>
- * The origin of the graphics context, its
- * (<code>0</code>, <code>0</code>) coordinate point, is the
- * top-left corner of this component. The clipping region of the
- * graphics context is the bounding rectangle of this component.
- *
- * @param g the graphics context to use for painting
- * @see #paint
- * @since JDK1.0
- */
- public void paintAll(Graphics g) {
- if (isShowing()) {
- GraphicsCallback.PeerPaintCallback.getInstance().
- runOneComponent(this, new Rectangle(0, 0, width, height),
- g, g.getClip(),
- GraphicsCallback.LIGHTWEIGHTS |
- GraphicsCallback.HEAVYWEIGHTS);
- }
- }
-
- /**
- * Simulates the peer callbacks into java.awt for painting of
- * lightweight Components.
- * @param g the graphics context to use for painting
- * @see #paintAll
- */
- void lightweightPaint(Graphics g) {
- paint(g);
- }
-
- /**
- * Paints all the heavyweight subcomponents.
- */
- void paintHeavyweightComponents(Graphics g) {
- }
-
- /**
- * Repaints this component.
- * <p>
- * If this component is a lightweight component, this method
- * causes a call to this component's <code>paint</code>
- * method as soon as possible. Otherwise, this method causes
- * a call to this component's <code>update</code> method as soon
- * as possible.
- * <p>
- * <b>Note</b>: For more information on the paint mechanisms utilitized
- * by AWT and Swing, including information on how to write the most
- * efficient painting code, see
- * <a href="http://java.sun.com/products/jfc/tsc/articles/painting/index.html">Painting in AWT and Swing</a>.
-
- *
- * @see #update(Graphics)
- * @since JDK1.0
- */
- public void repaint() {
- repaint(0, 0, 0, width, height);
- }
-
- /**
- * Repaints the component. If this component is a lightweight
- * component, this results in a call to <code>paint</code>
- * within <code>tm</code> milliseconds.
- * <p>
- * <b>Note</b>: For more information on the paint mechanisms utilitized
- * by AWT and Swing, including information on how to write the most
- * efficient painting code, see
- * <a href="http://java.sun.com/products/jfc/tsc/articles/painting/index.html">Painting in AWT and Swing</a>.
- *
- * @param tm maximum time in milliseconds before update
- * @see #paint
- * @see #update(Graphics)
- * @since JDK1.0
- */
- public void repaint(long tm) {
- repaint(tm, 0, 0, width, height);
- }
-
- /**
- * Repaints the specified rectangle of this component.
- * <p>
- * If this component is a lightweight component, this method
- * causes a call to this component's <code>paint</code> method
- * as soon as possible. Otherwise, this method causes a call to
- * this component's <code>update</code> method as soon as possible.
- * <p>
- * <b>Note</b>: For more information on the paint mechanisms utilitized
- * by AWT and Swing, including information on how to write the most
- * efficient painting code, see
- * <a href="http://java.sun.com/products/jfc/tsc/articles/painting/index.html">Painting in AWT and Swing</a>.
- *
- * @param x the <i>x</i> coordinate
- * @param y the <i>y</i> coordinate
- * @param width the width
- * @param height the height
- * @see #update(Graphics)
- * @since JDK1.0
- */
- public void repaint(int x, int y, int width, int height) {
- repaint(0, x, y, width, height);
- }
-
- /**
- * Repaints the specified rectangle of this component within
- * <code>tm</code> milliseconds.
- * <p>
- * If this component is a lightweight component, this method causes
- * a call to this component's <code>paint</code> method.
- * Otherwise, this method causes a call to this component's
- * <code>update</code> method.
- * <p>
- * <b>Note</b>: For more information on the paint mechanisms utilitized
- * by AWT and Swing, including information on how to write the most
- * efficient painting code, see
- * <a href="http://java.sun.com/products/jfc/tsc/articles/painting/index.html">Painting in AWT and Swing</a>.
- *
- * @param tm maximum time in milliseconds before update
- * @param x the <i>x</i> coordinate
- * @param y the <i>y</i> coordinate
- * @param width the width
- * @param height the height
- * @see #update(Graphics)
- * @since JDK1.0
- */
- public void repaint(long tm, int x, int y, int width, int height) {
- if (this.peer instanceof LightweightPeer) {
- // Needs to be translated to parent coordinates since
- // a parent native container provides the actual repaint
- // services. Additionally, the request is restricted to
- // the bounds of the component.
- if (parent != null) {
- int px = this.x + ((x < 0) ? 0 : x);
- int py = this.y + ((y < 0) ? 0 : y);
- int pwidth = (width > this.width) ? this.width : width;
- int pheight = (height > this.height) ? this.height : height;
- parent.repaint(tm, px, py, pwidth, pheight);
- }
- } else {
- if (isVisible() && (this.peer != null) &&
- (width > 0) && (height > 0)) {
- PaintEvent e = new PaintEvent(this, PaintEvent.UPDATE,
- new Rectangle(x, y, width, height));
- Toolkit.getEventQueue().postEvent(e);
- }
- }
- }
-
- /**
- * Prints this component. Applications should override this method
- * for components that must do special processing before being
- * printed or should be printed differently than they are painted.
- * <p>
- * The default implementation of this method calls the
- * <code>paint</code> method.
- * <p>
- * The origin of the graphics context, its
- * (<code>0</code>, <code>0</code>) coordinate point, is the
- * top-left corner of this component. The clipping region of the
- * graphics context is the bounding rectangle of this component.
- * @param g the graphics context to use for printing
- * @see #paint(Graphics)
- * @since JDK1.0
- */
- public void print(Graphics g) {
- paint(g);
- }
-
- /**
- * Prints this component and all of its subcomponents.
- * <p>
- * The origin of the graphics context, its
- * (<code>0</code>, <code>0</code>) coordinate point, is the
- * top-left corner of this component. The clipping region of the
- * graphics context is the bounding rectangle of this component.
- * @param g the graphics context to use for printing
- * @see #print(Graphics)
- * @since JDK1.0
- */
- public void printAll(Graphics g) {
- if (isShowing()) {
- GraphicsCallback.PeerPrintCallback.getInstance().
- runOneComponent(this, new Rectangle(0, 0, width, height),
- g, g.getClip(),
- GraphicsCallback.LIGHTWEIGHTS |
- GraphicsCallback.HEAVYWEIGHTS);
- }
- }
-
- /**
- * Simulates the peer callbacks into java.awt for printing of
- * lightweight Components.
- * @param g the graphics context to use for printing
- * @see #printAll
- */
- void lightweightPrint(Graphics g) {
- print(g);
- }
-
- /**
- * Prints all the heavyweight subcomponents.
- */
- void printHeavyweightComponents(Graphics g) {
- }
-
- /**
- * Repaints the component when the image has changed.
- * This <code>imageUpdate</code> method of an <code>ImageObserver</code>
- * is called when more information about an
- * image which had been previously requested using an asynchronous
- * routine such as the <code>drawImage</code> method of
- * <code>Graphics</code> becomes available.
- * See the definition of <code>imageUpdate</code> for
- * more information on this method and its arguments.
- * <p>
- * The <code>imageUpdate</code> method of <code>Component</code>
- * incrementally draws an image on the component as more of the bits
- * of the image are available.
- * <p>
- * If the system property <code>awt.image.incrementaldraw</code>
- * is missing or has the value <code>true</code>, the image is
- * incrementally drawn. If the system property has any other value,
- * then the image is not drawn until it has been completely loaded.
- * <p>
- * Also, if incremental drawing is in effect, the value of the
- * system property <code>awt.image.redrawrate</code> is interpreted
- * as an integer to give the maximum redraw rate, in milliseconds. If
- * the system property is missing or cannot be interpreted as an
- * integer, the redraw rate is once every 100ms.
- * <p>
- * The interpretation of the <code>x</code>, <code>y</code>,
- * <code>width</code>, and <code>height</code> arguments depends on
- * the value of the <code>infoflags</code> argument.
- *
- * @param img the image being observed
- * @param infoflags see <code>imageUpdate</code> for more information
- * @param x the <i>x</i> coordinate
- * @param y the <i>y</i> coordinate
- * @param w the width
- * @param h the height
- * @return <code>false</code> if the infoflags indicate that the
- * image is completely loaded; <code>true</code> otherwise.
- *
- * @see java.awt.image.ImageObserver
- * @see Graphics#drawImage(Image, int, int, Color, java.awt.image.ImageObserver)
- * @see Graphics#drawImage(Image, int, int, java.awt.image.ImageObserver)
- * @see Graphics#drawImage(Image, int, int, int, int, Color, java.awt.image.ImageObserver)
- * @see Graphics#drawImage(Image, int, int, int, int, java.awt.image.ImageObserver)
- * @see java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
- * @since JDK1.0
- */
- public boolean imageUpdate(Image img, int infoflags,
- int x, int y, int w, int h) {
- int rate = -1;
- if ((infoflags & (FRAMEBITS|ALLBITS)) != 0) {
- rate = 0;
- } else if ((infoflags & SOMEBITS) != 0) {
- if (isInc) {
- rate = incRate;
- if (rate < 0) {
- rate = 0;
- }
- }
- }
- if (rate >= 0) {
- repaint(rate, 0, 0, width, height);
- }
- return (infoflags & (ALLBITS|ABORT)) == 0;
- }
-
- /**
- * Creates an image from the specified image producer.
- * @param producer the image producer
- * @return the image produced
- * @since JDK1.0
- */
- public Image createImage(ImageProducer producer) {
- ComponentPeer peer = this.peer;
- if ((peer != null) && ! (peer instanceof LightweightPeer)) {
- return peer.createImage(producer);
- }
- return getToolkit().createImage(producer);
- }
-
- /**
- * Creates an off-screen drawable image
- * to be used for double buffering.
- * @param width the specified width
- * @param height the specified height
- * @return an off-screen drawable image, which can be used for double
- * buffering. The return value may be <code>null</code> if the
- * component is not displayable. This will always happen if
- * <code>GraphicsEnvironment.isHeadless()</code> returns
- * <code>true</code>.
- * @see #isDisplayable
- * @see GraphicsEnvironment#isHeadless
- * @since JDK1.0
- */
- public Image createImage(int width, int height) {
- ComponentPeer peer = this.peer;
- if (peer instanceof LightweightPeer) {
- if (parent != null) { return parent.createImage(width, height); }
- else { return null;}
- } else {
- return (peer != null) ? peer.createImage(width, height) : null;
- }
- }
-
- /**
- * Creates a volatile off-screen drawable image
- * to be used for double buffering.
- * @param width the specified width.
- * @param height the specified height.
- * @return an off-screen drawable image, which can be used for double
- * buffering. The return value may be <code>null</code> if the
- * component is not displayable. This will always happen if
- * <code>GraphicsEnvironment.isHeadless()</code> returns
- * <code>true</code>.
- * @see java.awt.image.VolatileImage
- * @see #isDisplayable
- * @see GraphicsEnvironment#isHeadless
- * @since 1.4
- */
- public VolatileImage createVolatileImage(int width, int height) {
- ComponentPeer peer = this.peer;
- if (peer instanceof LightweightPeer) {
- if (parent != null) {
- return parent.createVolatileImage(width, height);
- }
- else { return null;}
- } else {
- return (peer != null) ?
- peer.createVolatileImage(width, height) : null;
- }
- }
-
- /**
- * Creates a volatile off-screen drawable image, with the given capabilities.
- * The contents of this image may be lost at any time due
- * to operating system issues, so the image must be managed
- * via the <code>VolatileImage</code> interface.
- * @param width the specified width.
- * @param height the specified height.
- * @param caps the image capabilities
- * @exception AWTException if an image with the specified capabilities cannot
- * be created
- * @return a VolatileImage object, which can be used
- * to manage surface contents loss and capabilities.
- * @see java.awt.image.VolatileImage
- * @since 1.4
- */
- public VolatileImage createVolatileImage(int width, int height,
- ImageCapabilities caps) throws AWTException {
- // REMIND : check caps
- return createVolatileImage(width, height);
- }
-
- /**
- * Prepares an image for rendering on this component. The image
- * data is downloaded asynchronously in another thread and the
- * appropriate screen representation of the image is generated.
- * @param image the <code>Image</code> for which to
- * prepare a screen representation
- * @param observer the <code>ImageObserver</code> object
- * to be notified as the image is being prepared
- * @return <code>true</code> if the image has already been fully
- * prepared; <code>false</code> otherwise
- * @since JDK1.0
- */
- public boolean prepareImage(Image image, ImageObserver observer) {
- return prepareImage(image, -1, -1, observer);
- }
-
- /**
- * Prepares an image for rendering on this component at the
- * specified width and height.
- * <p>
- * The image data is downloaded asynchronously in another thread,
- * and an appropriately scaled screen representation of the image is
- * generated.
- * @param image the instance of <code>Image</code>
- * for which to prepare a screen representation
- * @param width the width of the desired screen representation
- * @param height the height of the desired screen representation
- * @param observer the <code>ImageObserver</code> object
- * to be notified as the image is being prepared
- * @return <code>true</code> if the image has already been fully
- * prepared; <code>false</code> otherwise
- * @see java.awt.image.ImageObserver
- * @since JDK1.0
- */
- public boolean prepareImage(Image image, int width, int height,
- ImageObserver observer) {
- ComponentPeer peer = this.peer;
- if (peer instanceof LightweightPeer) {
- return (parent != null)
- ? parent.prepareImage(image, width, height, observer)
- : getToolkit().prepareImage(image, width, height, observer);
- } else {
- return (peer != null)
- ? peer.prepareImage(image, width, height, observer)
- : getToolkit().prepareImage(image, width, height, observer);
- }
- }
-
- /**
- * Returns the status of the construction of a screen representation
- * of the specified image.
- * <p>
- * This method does not cause the image to begin loading. An
- * application must use the <code>prepareImage</code> method
- * to force the loading of an image.
- * <p>
- * Information on the flags returned by this method can be found
- * with the discussion of the <code>ImageObserver</code> interface.
- * @param image the <code>Image</code> object whose status
- * is being checked
- * @param observer the <code>ImageObserver</code>
- * object to be notified as the image is being prepared
- * @return the bitwise inclusive <b>OR</b> of
- * <code>ImageObserver</code> flags indicating what
- * information about the image is currently available
- * @see #prepareImage(Image, int, int, java.awt.image.ImageObserver)
- * @see Toolkit#checkImage(Image, int, int, java.awt.image.ImageObserver)
- * @see java.awt.image.ImageObserver
- * @since JDK1.0
- */
- public int checkImage(Image image, ImageObserver observer) {
- return checkImage(image, -1, -1, observer);
- }
-
- /**
- * Returns the status of the construction of a screen representation
- * of the specified image.
- * <p>
- * This method does not cause the image to begin loading. An
- * application must use the <code>prepareImage</code> method
- * to force the loading of an image.
- * <p>
- * The <code>checkImage</code> method of <code>Component</code>
- * calls its peer's <code>checkImage</code> method to calculate
- * the flags. If this component does not yet have a peer, the
- * component's toolkit's <code>checkImage</code> method is called
- * instead.
- * <p>
- * Information on the flags returned by this method can be found
- * with the discussion of the <code>ImageObserver</code> interface.
- * @param image the <code>Image</code> object whose status
- * is being checked
- * @param width the width of the scaled version
- * whose status is to be checked
- * @param height the height of the scaled version
- * whose status is to be checked
- * @param observer the <code>ImageObserver</code> object
- * to be notified as the image is being prepared
- * @return the bitwise inclusive <b>OR</b> of
- * <code>ImageObserver</code> flags indicating what
- * information about the image is currently available
- * @see #prepareImage(Image, int, int, java.awt.image.ImageObserver)
- * @see Toolkit#checkImage(Image, int, int, java.awt.image.ImageObserver)
- * @see java.awt.image.ImageObserver
- * @since JDK1.0
- */
- public int checkImage(Image image, int width, int height,
- ImageObserver observer) {
- ComponentPeer peer = this.peer;
- if (peer instanceof LightweightPeer) {
- return (parent != null)
- ? parent.checkImage(image, width, height, observer)
- : getToolkit().checkImage(image, width, height, observer);
- } else {
- return (peer != null)
- ? peer.checkImage(image, width, height, observer)
- : getToolkit().checkImage(image, width, height, observer);
- }
- }
-
- /**
- * Creates a new strategy for multi-buffering on this component.
- * Multi-buffering is useful for rendering performance. This method
- * attempts to create the best strategy available with the number of
- * buffers supplied. It will always create a <code>BufferStrategy</code>
- * with that number of buffers.
- * A page-flipping strategy is attempted first, then a blitting strategy
- * using accelerated buffers. Finally, an unaccelerated blitting
- * strategy is used.
- * <p>
- * Each time this method is called,
- * the existing buffer strategy for this component is discarded.
- * @param numBuffers number of buffers to create, including the front buffer
- * @exception IllegalArgumentException if numBuffers is less than 1.
- * @exception IllegalStateException if the component is not displayable
- * @see #isDisplayable
- * @see #getBufferStrategy()
- * @since 1.4
- */
- void createBufferStrategy(int numBuffers) {
- BufferCapabilities bufferCaps;
- if (numBuffers > 1) {
- // Try to create a page-flipping strategy
- bufferCaps = new BufferCapabilities(
- new ImageCapabilities(true), new ImageCapabilities(true),
- BufferCapabilities.FlipContents.UNDEFINED);
- try {
- createBufferStrategy(numBuffers, bufferCaps);
- return; // Success
- } catch (AWTException e) {
- // Failed
- }
- }
- // Try a blitting (but still accelerated) strategy
- bufferCaps = new BufferCapabilities(
- new ImageCapabilities(true), new ImageCapabilities(true), null);
- try {
- createBufferStrategy(numBuffers, bufferCaps);
- return; // Success
- } catch (AWTException e) {
- // Failed
- }
- // Try an unaccelerated blitting strategy
- bufferCaps = new BufferCapabilities(
- new ImageCapabilities(false), new ImageCapabilities(false), null);
- try {
- createBufferStrategy(numBuffers, bufferCaps);
- return; // Success
- } catch (AWTException e) {
- // Failed
- }
- // Code should never reach here (an unaccelerated blitting
- // strategy should always work)
- throw new InternalError("Could not create a buffer strategy");
- }
-
- /**
- * Creates a new strategy for multi-buffering on this component with the
- * required buffer capabilities. This is useful, for example, if only
- * accelerated memory or page flipping is desired (as specified by the
- * buffer capabilities).
- * <p>
- * Each time this method
- * is called, the existing buffer strategy for this component is discarded.
- * @param numBuffers number of buffers to create
- * @param caps the required capabilities for creating the buffer strategy;
- * cannot be <code>null</code>
- * @exception AWTException if the capabilities supplied could not be
- * supported or met; this may happen, for example, if there is not enough
- * accelerated memory currently available, or if page flipping is specified
- * but not possible.
- * @exception IllegalArgumentException if numBuffers is less than 1, or if
- * caps is <code>null</code>
- * @see #getBufferStrategy()
- * @since 1.4
- */
- void createBufferStrategy(int numBuffers,
- BufferCapabilities caps) throws AWTException {
- // Check arguments
- if (numBuffers < 1) {
- throw new IllegalArgumentException(
- "Number of buffers must be at least 1");
- }
- if (caps == null) {
- throw new IllegalArgumentException("No capabilities specified");
- }
- // Destroy old buffers
- if (bufferStrategy instanceof FlipBufferStrategy) {
- ((FlipBufferStrategy)bufferStrategy).destroyBuffers();
- }
- if (numBuffers == 1) {
- bufferStrategy = new SingleBufferStrategy(caps);
- } else {
- // assert numBuffers > 1;
- if (caps.isPageFlipping()) {
- bufferStrategy = new FlipBufferStrategy(numBuffers, caps);
- } else {
- bufferStrategy = new BltBufferStrategy(numBuffers, caps);
- }
- }
- }
-
- /**
- * @return the buffer strategy used by this component
- * @see Window#createBufferStrategy
- * @see Canvas#createBufferStrategy
- * @since 1.4
- */
- BufferStrategy getBufferStrategy() {
- if (bufferStrategy == null) {
- createBufferStrategy(1);
- }
- return bufferStrategy;
- }
-
- /**
- * @return the back buffer currently used by this component's
- * BufferStrategy. If there is no BufferStrategy or no
- * back buffer, this method returns null.
- */
- Image getBackBuffer() {
- if (bufferStrategy != null) {
- if (bufferStrategy instanceof BltBufferStrategy) {
- BltBufferStrategy bltBS = (BltBufferStrategy)bufferStrategy;
- return bltBS.getBackBuffer();
- } else if (bufferStrategy instanceof FlipBufferStrategy) {
- FlipBufferStrategy flipBS = (FlipBufferStrategy)bufferStrategy;
- return flipBS.getBackBuffer();
- }
- }
- return null;
- }
-
- /**
- * Inner class for flipping buffers on a component. That component must
- * be a <code>Canvas</code> or <code>Window</code>.
- * @see Canvas
- * @see Window
- * @see java.awt.image.BufferStrategy
- * @author Michael Martak
- * @since 1.4
- */
- protected class FlipBufferStrategy extends BufferStrategy {
- /**
- * The number of buffers
- */
- protected int numBuffers; // = 0
- /**
- * The buffering capabilities
- */
- protected BufferCapabilities caps; // = null
- /**
- * The drawing buffer
- */
- protected Image drawBuffer; // = null
- /**
- * The drawing buffer as a volatile image
- */
- protected VolatileImage drawVBuffer; // = null
- /**
- * Whether or not the drawing buffer has been recently restored from
- * a lost state.
- */
- protected boolean validatedContents; // = false
-
- /**
- * Creates a new flipping buffer strategy for this component.
- * The component must be a <code>Canvas</code> or <code>Window</code>.
- * @see Canvas
- * @see Window
- * @param numBuffers the number of buffers
- * @param caps the capabilities of the buffers
- * @exception AWTException if the capabilities supplied could not be
- * supported or met
- * @exception ClassCastException if the component is not a canvas or
- * window.
- */
- protected FlipBufferStrategy(int numBuffers, BufferCapabilities caps)
- throws AWTException {
- if (!(Component.this instanceof Window) &&
- !(Component.this instanceof Canvas)) {
- throw new ClassCastException(
- "Component must be a Canvas or Window");
- }
- this.numBuffers = numBuffers;
- this.caps = caps;
- createBuffers(numBuffers, caps);
- }
-
- /**
- * Creates one or more complex, flipping buffers with the given
- * capabilities.
- * @param numBuffers number of buffers to create; must be greater than
- * one
- * @param caps the capabilities of the buffers.
- * <code>BufferCapabilities.isPageFlipping</code> must be
- * <code>true</code>.
- * @exception AWTException if the capabilities supplied could not be
- * supported or met
- * @exception IllegalStateException if the component has no peer
- * @exception IllegalArgumentException if numBuffers is less than two,
- * or if <code>BufferCapabilities.isPageFlipping</code> is not
- * <code>true</code>.
- * @see java.awt.BufferCapabilities#isPageFlipping()
- */
- protected void createBuffers(int numBuffers, BufferCapabilities caps)
- throws AWTException {
- if (numBuffers < 2) {
- throw new IllegalArgumentException(
- "Number of buffers cannot be less than two");
- } else if (peer == null) {
- throw new IllegalStateException(
- "Component must have a valid peer");
- } else if (caps == null || !caps.isPageFlipping()) {
- throw new IllegalArgumentException(
- "Page flipping capabilities must be specified");
- } else {
- peer.createBuffers(numBuffers, caps);
- }
- }
-
- /**
- * @return direct access to the back buffer, as an image.
- * @exception IllegalStateException if the buffers have not yet
- * been created
- */
- protected Image getBackBuffer() {
- if (peer != null) {
- Image drawBuffer = peer.getBackBuffer();
- if (drawBuffer instanceof VolatileImage) {
- drawVBuffer = (VolatileImage)drawBuffer;
- }
- revalidate();
- return drawBuffer;
- } else {
- throw new IllegalStateException(
- "Component must have a valid peer");
- }
- }
-
- /**
- * Flipping moves the contents of the back buffer to the front buffer,
- * either by copying or by moving the video pointer.
- * @param flipAction an integer value describing the flipping action
- * for the contents of the back buffer. This should be one of the
- * values of the <code>BufferCapabilities.FlipContents</code>
- * property.
- * @exception IllegalStateException if the buffers have not yet
- * been created
- * @see java.awt.BufferCapabilities#getFlipContents()
- */
- protected void flip(BufferCapabilities.FlipContents flipAction) {
- if (peer != null) {
- peer.flip(flipAction);
- } else {
- throw new IllegalStateException(
- "Component must have a valid peer");
- }
- }
-
- /**
- * Destroys the buffers created through this object
- */
- protected void destroyBuffers() {
- if (peer != null) {
- peer.destroyBuffers();
- } else {
- throw new IllegalStateException(
- "Component must have a valid peer");
- }
- }
-
- /**
- * @return the buffering capabilities of this strategy
- */
- public BufferCapabilities getCapabilities() {
- return caps;
- }
-
- /**
- * @return the graphics on the drawing buffer. This method may not
- * be synchronized for performance reasons; use of this method by multiple
- * threads should be handled at the application level. Disposal of the
- * graphics object must be handled by the application.
- */
- public Graphics getDrawGraphics() {
- if (drawBuffer == null) {
- // Set up drawing buffer
- drawBuffer = getBackBuffer();
- if (drawBuffer instanceof VolatileImage) {
- drawVBuffer = (VolatileImage)drawBuffer;
- }
- }
- revalidate();
- return drawBuffer.getGraphics();
- }
-
- /**
- * Restore the drawing buffer if it has been lost
- */
- protected void revalidate() {
- // REMIND: this whole validation mechanism needs to be re-examined
- // for correctness. Currently, the value of validatedContents
- // may be changed and overwritten before the user has a chance to
- // see that there was any restoration to the surface. Also, we
- // need to handle the IMAGE_INCOMPATIBLE case.
- if (drawVBuffer != null) {
- validatedContents = (drawVBuffer.validate(
- getGraphicsConfiguration()) == VolatileImage.IMAGE_RESTORED);
- } else {
- validatedContents = false;
- }
- }
-
- /**
- * @return whether the drawing buffer was lost since the last call to
- * <code>getDrawGraphics</code>
- */
- public boolean contentsLost() {
- if (drawVBuffer == null) {
- return false;
- }
- return drawVBuffer.contentsLost();
- }
-
- /**
- * @return whether the drawing buffer was recently restored from a lost
- * state and reinitialized to the default background color (white)
- */
- public boolean contentsRestored() {
- return validatedContents;
- }
-
- /**
- * Makes the next available buffer visible by either blitting or
- * flipping.
- */
- public void show() {
- flip(caps.getFlipContents());
- }
-
- } // Inner class FlipBufferStrategy
-
- /**
- * Inner class for blitting offscreen surfaces to a component.
- *
- * @author Michael Martak
- * @since 1.4
- */
- protected class BltBufferStrategy extends BufferStrategy {
-
- /**
- * The buffering capabilities
- */
- protected BufferCapabilities caps; // = null
- /**
- * The back buffers
- */
- protected VolatileImage[] backBuffers; // = null
- /**
- * Whether or not the drawing buffer has been recently restored from
- * a lost state.
- */
- protected boolean validatedContents; // = false
- /**
- * Size of the back buffers
- */
- protected int width;
- protected int height;
-
- /**
- * Creates a new blt buffer strategy around a component
- * @param numBuffers the component to use as the front buffer
- * @param caps the capabilities of the buffers
- */
- protected BltBufferStrategy(int numBuffers, BufferCapabilities caps) {
- this.caps = caps;
- createBackBuffers(numBuffers - 1);
- }
-
- /**
- * Creates the back buffers
- */
- protected void createBackBuffers(int numBuffers) {
- if (numBuffers == 0) {
- backBuffers = null;
- } else {
- width = getWidth();
- height = getHeight();
- backBuffers = new VolatileImage[numBuffers];
- for (int i = 0; i < numBuffers; i++) {
- backBuffers[i] = createVolatileImage(width, height);
- }
- }
- }
-
- /**
- * @return the buffering capabilities of this strategy
- */
- public BufferCapabilities getCapabilities() {
- return caps;
- }
-
- /**
- * @return the draw graphics
- */
- public Graphics getDrawGraphics() {
- revalidate();
- Image backBuffer = getBackBuffer();
- if (backBuffer == null) {
- return getGraphics();
- }
- return backBuffer.getGraphics();
- }
-
- /**
- * @return direct access to the back buffer, as an image.
- * If there is no back buffer, returns null.
- */
- Image getBackBuffer() {
- if (backBuffers != null) {
- return backBuffers[backBuffers.length - 1];
- } else {
- return null;
- }
- }
-
- /**
- * Makes the next available buffer visible.
- */
- public void show() {
- if (backBuffers == null) {
- return;
- }
-
- Graphics g = getGraphics();
- try {
- for (int i = 0; i < backBuffers.length; i++) {
- g.drawImage(backBuffers[i], 0, 0, Component.this);
- g.dispose();
- g = null;
- g = backBuffers[i].getGraphics();
- }
- } finally {
- if (g != null) {
- g.dispose();
- }
- }
- }
-
- /**
- * Restore the drawing buffer if it has been lost
- */
- protected void revalidate() {
- if (backBuffers == null) {
- validatedContents = false;
- } else if (getWidth() != width || getHeight() != height) {
- createBackBuffers(backBuffers.length);
- validatedContents = true;
- } else {
- validatedContents =
- (backBuffers[backBuffers.length - 1].validate(
- getGraphicsConfiguration())
- == VolatileImage.IMAGE_RESTORED);
- // REMIND : handle IMAGE_INCOMPATIBLE
- }
- }
-
- /**
- * @return whether the drawing buffer was lost since the last call to
- * <code>getDrawGraphics</code>
- */
- public boolean contentsLost() {
- if (width < getWidth() || height < getHeight()) {
- return true;
- } else {
- return backBuffers[backBuffers.length - 1].contentsLost();
- }
- }
-
- /**
- * @return whether the drawing buffer was recently restored from a lost
- * state and reinitialized to the default background color (white)
- */
- public boolean contentsRestored() {
- return validatedContents;
- }
-
- } // Inner class BltBufferStrategy
-
- /**
- * Inner class for flipping buffers on a component. That component must
- * be a <code>Canvas</code> or <code>Window</code>.
- * @see Canvas
- * @see Window
- * @see java.awt.image.BufferStrategy
- * @author Michael Martak
- * @since 1.4
- */
- private class SingleBufferStrategy extends BufferStrategy {
-
- private BufferCapabilities caps;
-
- public SingleBufferStrategy(BufferCapabilities caps) {
- this.caps = caps;
- }
- public BufferCapabilities getCapabilities() {
- return caps;
- }
- public Graphics getDrawGraphics() {
- return getGraphics();
- }
- public boolean contentsLost() {
- // return peer.getSurfaceData().contentsLost();
- return false;
- }
- public boolean contentsRestored() {
- // return peer.getSurfaceData().validate();
- return false;
- }
- public void show() {
- // Do nothing; could repaint
- }
- } // Inner class SingleBufferStrategy
-
- /**
- * Sets whether or not paint messages received from the operating system
- * should be ignored. This does not affect paint events generated in
- * software by the AWT, unless they are an immediate response to an
- * OS-level paint message.
- * <p>
- * This is useful, for example, if running under full-screen mode and
- * better performance is desired, or if page-flipping is used as the
- * buffer strategy.
- *
- * @since 1.4
- * @see #getIgnoreRepaint
- * @see Canvas#createBufferStrategy
- * @see Window#createBufferStrategy
- * @see java.awt.image.BufferStrategy
- * @see GraphicsDevice#setFullScreenWindow
- */
- public void setIgnoreRepaint(boolean ignoreRepaint) {
- this.ignoreRepaint = ignoreRepaint;
- }
-
- /**
- * @return whether or not paint messages received from the operating system
- * should be ignored.
- *
- * @since 1.4
- * @see #setIgnoreRepaint
- */
- public boolean getIgnoreRepaint() {
- return ignoreRepaint;
- }
-
- /**
- * Checks whether this component "contains" the specified point,
- * where <code>x</code> and <code>y</code> are defined to be
- * relative to the coordinate system of this component.
- * @param x the <i>x</i> coordinate of the point
- * @param y the <i>y</i> coordinate of the point
- * @see #getComponentAt(int, int)
- * @since JDK1.1
- */
- public boolean contains(int x, int y) {
- return inside(x, y);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by contains(int, int).
- */
- @Deprecated
- public boolean inside(int x, int y) {
- return (x >= 0) && (x < width) && (y >= 0) && (y < height);
- }
-
- /**
- * Checks whether this component "contains" the specified point,
- * where the point's <i>x</i> and <i>y</i> coordinates are defined
- * to be relative to the coordinate system of this component.
- * @param p the point
- * @see #getComponentAt(Point)
- * @since JDK1.1
- */
- public boolean contains(Point p) {
- return contains(p.x, p.y);
- }
-
- /**
- * Determines if this component or one of its immediate
- * subcomponents contains the (<i>x</i>, <i>y</i>) location,
- * and if so, returns the containing component. This method only
- * looks one level deep. If the point (<i>x</i>, <i>y</i>) is
- * inside a subcomponent that itself has subcomponents, it does not
- * go looking down the subcomponent tree.
- * <p>
- * The <code>locate</code> method of <code>Component</code> simply
- * returns the component itself if the (<i>x</i>, <i>y</i>)
- * coordinate location is inside its bounding box, and <code>null</code>
- * otherwise.
- * @param x the <i>x</i> coordinate
- * @param y the <i>y</i> coordinate
- * @return the component or subcomponent that contains the
- * (<i>x</i>, <i>y</i>) location;
- * <code>null</code> if the location
- * is outside this component
- * @see #contains(int, int)
- * @since JDK1.0
- */
- public Component getComponentAt(int x, int y) {
- return locate(x, y);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by getComponentAt(int, int).
- */
- @Deprecated
- public Component locate(int x, int y) {
- return contains(x, y) ? this : null;
- }
-
- /**
- * Returns the component or subcomponent that contains the
- * specified point.
- * @param p the point
- * @see java.awt.Component#contains
- * @since JDK1.1
- */
- public Component getComponentAt(Point p) {
- return getComponentAt(p.x, p.y);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by <code>dispatchEvent(AWTEvent e)</code>.
- */
- @Deprecated
- public void deliverEvent(Event e) {
- postEvent(e);
- }
-
- /**
- * Dispatches an event to this component or one of its sub components.
- * Calls <code>processEvent</code> before returning for 1.1-style
- * events which have been enabled for the <code>Component</code>.
- * @param e the event
- */
- public final void dispatchEvent(AWTEvent e) {
- dispatchEventImpl(e);
- }
-
- void dispatchEventImpl(AWTEvent e) {
- int id = e.getID();
-
- // Check that this component belongs to this app-context
- AppContext compContext = appContext;
- if (compContext != null && !compContext.equals(AppContext.getAppContext())) {
- log.fine("Event " + e + " is being dispatched on the wrong AppContext");
- }
-
- /*
- * 0. Set timestamp and modifiers of current event.
- */
- EventQueue.setCurrentEventAndMostRecentTime(e);
-
- /*
- * 1. Pre-dispatchers. Do any necessary retargeting/reordering here
- * before we notify AWTEventListeners.
- */
-
- if (e instanceof SunDropTargetEvent) {
- ((SunDropTargetEvent)e).dispatch();
- return;
- }
-
- if (!e.focusManagerIsDispatching) {
- // Invoke the private focus retargeting method which provides
- // lightweight Component support
- if (e.isPosted) {
- e = KeyboardFocusManager.retargetFocusEvent(e);
- e.isPosted = true;
- }
-
- // Now, with the event properly targeted to a lightweight
- // descendant if necessary, invoke the public focus retargeting
- // and dispatching function
- if (KeyboardFocusManager.getCurrentKeyboardFocusManager().
- dispatchEvent(e))
- {
- return;
- }
- }
- if (e instanceof FocusEvent && focusLog.isLoggable(Level.FINE)) {
- focusLog.fine("" + e);
- }
- // MouseWheel may need to be retargeted here so that
- // AWTEventListener sees the event go to the correct
- // Component. If the MouseWheelEvent needs to go to an ancestor,
- // the event is dispatched to the ancestor, and dispatching here
- // stops.
- if (id == MouseEvent.MOUSE_WHEEL &&
- (!eventTypeEnabled(id)) &&
- (peer != null && !peer.handlesWheelScrolling()) &&
- (dispatchMouseWheelToAncestor((MouseWheelEvent)e)))
- {
- return;
- }
-
- /*
- * 2. Allow the Toolkit to pass this to AWTEventListeners.
- */
- Toolkit toolkit = Toolkit.getDefaultToolkit();
- toolkit.notifyAWTEventListeners(e);
-
-
- /*
- * 3. If no one has consumed a key event, allow the
- * KeyboardFocusManager to process it.
- */
- if (!e.isConsumed()) {
- if (e instanceof java.awt.event.KeyEvent) {
- KeyboardFocusManager.getCurrentKeyboardFocusManager().
- processKeyEvent(this, (KeyEvent)e);
- if (e.isConsumed()) {
- return;
- }
- }
- }
-
- /*
- * 4. Allow input methods to process the event
- */
- if (areInputMethodsEnabled()
- && (
- // We need to pass on InputMethodEvents since some host
- // input method adapters send them through the Java
- // event queue instead of directly to the component,
- // and the input context also handles the Java composition window
- ((e instanceof InputMethodEvent) && !(this instanceof CompositionArea))
- ||
- // Otherwise, we only pass on input and focus events, because
- // a) input methods shouldn't know about semantic or component-level events
- // b) passing on the events takes time
- // c) isConsumed() is always true for semantic events.
- (e instanceof InputEvent) || (e instanceof FocusEvent))) {
- InputContext inputContext = getInputContext();
- if (inputContext != null) {
- inputContext.dispatchEvent(e);
- if (e.isConsumed()) {
- if (e instanceof FocusEvent && focusLog.isLoggable(Level.FINER)) {
- focusLog.finer("3579: Skipping " + e);
- }
- return;
- }
- }
- }
-
- /*
- * 5. Pre-process any special events before delivery
- */
- switch(id) {
- // Handling of the PAINT and UPDATE events is now done in the
- // peer's handleEvent() method so the background can be cleared
- // selectively for non-native components on Windows only.
- // - Fred.Ecks@Eng.sun.com, 5-8-98
-
- case KeyEvent.KEY_PRESSED:
- case KeyEvent.KEY_RELEASED:
- Container p = (Container)((this instanceof Container) ? this : parent);
- if (p != null) {
- p.preProcessKeyEvent((KeyEvent)e);
- if (e.isConsumed()) {
- return;
- }
- }
- break;
-
- case WindowEvent.WINDOW_CLOSING:
- if (toolkit instanceof WindowClosingListener) {
- windowClosingException = ((WindowClosingListener)
- toolkit).windowClosingNotify((WindowEvent)e);
- if (checkWindowClosingException()) {
- return;
- }
- }
- break;
-
- default:
- break;
- }
-
- /*
- * 6. Deliver event for normal processing
- */
- if (newEventsOnly) {
- // Filtering needs to really be moved to happen at a lower
- // level in order to get maximum performance gain; it is
- // here temporarily to ensure the API spec is honored.
- //
- if (eventEnabled(e)) {
- processEvent(e);
- }
- } else if (id == MouseEvent.MOUSE_WHEEL) {
- // newEventsOnly will be false for a listenerless ScrollPane, but
- // MouseWheelEvents still need to be dispatched to it so scrolling
- // can be done.
- autoProcessMouseWheel((MouseWheelEvent)e);
- } else if (!(e instanceof MouseEvent && !postsOldMouseEvents())) {
- //
- // backward compatibility
- //
- Event olde = e.convertToOld();
- if (olde != null) {
- int key = olde.key;
- int modifiers = olde.modifiers;
-
- postEvent(olde);
- if (olde.isConsumed()) {
- e.consume();
- }
- // if target changed key or modifier values, copy them
- // back to original event
- //
- switch(olde.id) {
- case Event.KEY_PRESS:
- case Event.KEY_RELEASE:
- case Event.KEY_ACTION:
- case Event.KEY_ACTION_RELEASE:
- if (olde.key != key) {
- ((KeyEvent)e).setKeyChar(olde.getKeyEventChar());
- }
- if (olde.modifiers != modifiers) {
- ((KeyEvent)e).setModifiers(olde.modifiers);
- }
- break;
- default:
- break;
- }
- }
- }
-
- /*
- * 8. Special handling for 4061116 : Hook for browser to close modal
- * dialogs.
- */
- if (id == WindowEvent.WINDOW_CLOSING && !e.isConsumed()) {
- if (toolkit instanceof WindowClosingListener) {
- windowClosingException =
- ((WindowClosingListener)toolkit).
- windowClosingDelivered((WindowEvent)e);
- if (checkWindowClosingException()) {
- return;
- }
- }
- }
-
- /*
- * 9. Allow the peer to process the event.
- * Except KeyEvents, they will be processed by peer after
- * all KeyEventPostProcessors
- * (see DefaultKeyboardFocusManager.dispatchKeyEvent())
- */
- if (!(e instanceof KeyEvent)) {
- ComponentPeer tpeer = peer;
- if (e instanceof FocusEvent && (tpeer == null || tpeer instanceof LightweightPeer)) {
- // if focus owner is lightweight then its native container
- // processes event
- Component source = (Component)e.getSource();
- if (source != null) {
- Container target = source.getNativeContainer();
- if (target != null) {
- tpeer = target.getPeer();
- }
- }
- }
- if (tpeer != null) {
- tpeer.handleEvent(e);
- }
- }
- } // dispatchEventImpl()
-
- /*
- * If newEventsOnly is false, method is called so that ScrollPane can
- * override it and handle common-case mouse wheel scrolling. NOP
- * for Component.
- */
- void autoProcessMouseWheel(MouseWheelEvent e) {}
-
- /*
- * Dispatch given MouseWheelEvent to the first ancestor for which
- * MouseWheelEvents are enabled.
- *
- * Returns whether or not event was dispatched to an ancestor
- */
- boolean dispatchMouseWheelToAncestor(MouseWheelEvent e) {
- int newX, newY;
- newX = e.getX() + getX(); // Coordinates take into account at least
- newY = e.getY() + getY(); // the cursor's position relative to this
- // Component (e.getX()), and this Component's
- // position relative to its parent.
- MouseWheelEvent newMWE;
-
- if (dbg.on) {
- dbg.println("Component.dispatchMouseWheelToAncestor");
- dbg.println("orig event src is of " + e.getSource().getClass());
- }
-
- /* parent field for Window refers to the owning Window.
- * MouseWheelEvents should NOT be propagated into owning Windows
- */
- synchronized (getTreeLock()) {
- Container anc = getParent();
- while (anc != null && !anc.eventEnabled(e)) {
- // fix coordinates to be relative to new event source
- newX += anc.getX();
- newY += anc.getY();
-
- if (!(anc instanceof Window)) {
- anc = anc.getParent();
- }
- else {
- break;
- }
- }
-
- if (dbg.on) dbg.println("new event src is " + anc.getClass());
-
- if (anc != null && anc.eventEnabled(e)) {
- // Change event to be from new source, with new x,y
- // For now, just create a new event - yucky
-
- newMWE = new MouseWheelEvent(anc, // new source
- e.getID(),
- e.getWhen(),
- e.getModifiers(),
- newX, // x relative to new source
- newY, // y relative to new source
- e.getClickCount(),
- e.isPopupTrigger(),
- e.getScrollType(),
- e.getScrollAmount(),
- e.getWheelRotation());
- ((AWTEvent)e).copyPrivateDataInto(newMWE);
- anc.dispatchEventImpl(newMWE);
- }
- }
- return true;
- }
-
- boolean checkWindowClosingException() {
- if (windowClosingException != null) {
- if (this instanceof Dialog) {
- ((Dialog)this).interruptBlocking();
- } else {
- windowClosingException.fillInStackTrace();
- windowClosingException.printStackTrace();
- windowClosingException = null;
- }
- return true;
- }
- return false;
- }
-
- boolean areInputMethodsEnabled() {
- // in 1.2, we assume input method support is required for all
- // components that handle key events, but components can turn off
- // input methods by calling enableInputMethods(false).
- return ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) &&
- ((eventMask & AWTEvent.KEY_EVENT_MASK) != 0 || keyListener != null);
- }
-
- // REMIND: remove when filtering is handled at lower level
- boolean eventEnabled(AWTEvent e) {
- return eventTypeEnabled(e.id);
- }
-
- boolean eventTypeEnabled(int type) {
- switch(type) {
- case ComponentEvent.COMPONENT_MOVED:
- case ComponentEvent.COMPONENT_RESIZED:
- case ComponentEvent.COMPONENT_SHOWN:
- case ComponentEvent.COMPONENT_HIDDEN:
- if ((eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 ||
- componentListener != null) {
- return true;
- }
- break;
- case FocusEvent.FOCUS_GAINED:
- case FocusEvent.FOCUS_LOST:
- if ((eventMask & AWTEvent.FOCUS_EVENT_MASK) != 0 ||
- focusListener != null) {
- return true;
- }
- break;
- case KeyEvent.KEY_PRESSED:
- case KeyEvent.KEY_RELEASED:
- case KeyEvent.KEY_TYPED:
- if ((eventMask & AWTEvent.KEY_EVENT_MASK) != 0 ||
- keyListener != null) {
- return true;
- }
- break;
- case MouseEvent.MOUSE_PRESSED:
- case MouseEvent.MOUSE_RELEASED:
- case MouseEvent.MOUSE_ENTERED:
- case MouseEvent.MOUSE_EXITED:
- case MouseEvent.MOUSE_CLICKED:
- if ((eventMask & AWTEvent.MOUSE_EVENT_MASK) != 0 ||
- mouseListener != null) {
- return true;
- }
- break;
- case MouseEvent.MOUSE_MOVED:
- case MouseEvent.MOUSE_DRAGGED:
- if ((eventMask & AWTEvent.MOUSE_MOTION_EVENT_MASK) != 0 ||
- mouseMotionListener != null) {
- return true;
- }
- break;
- case MouseEvent.MOUSE_WHEEL:
- if ((eventMask & AWTEvent.MOUSE_WHEEL_EVENT_MASK) != 0 ||
- mouseWheelListener != null) {
- return true;
- }
- break;
- case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED:
- case InputMethodEvent.CARET_POSITION_CHANGED:
- if ((eventMask & AWTEvent.INPUT_METHOD_EVENT_MASK) != 0 ||
- inputMethodListener != null) {
- return true;
- }
- break;
- case HierarchyEvent.HIERARCHY_CHANGED:
- if ((eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 ||
- hierarchyListener != null) {
- return true;
- }
- break;
- case HierarchyEvent.ANCESTOR_MOVED:
- case HierarchyEvent.ANCESTOR_RESIZED:
- if ((eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 ||
- hierarchyBoundsListener != null) {
- return true;
- }
- break;
- case ActionEvent.ACTION_PERFORMED:
- if ((eventMask & AWTEvent.ACTION_EVENT_MASK) != 0) {
- return true;
- }
- break;
- case TextEvent.TEXT_VALUE_CHANGED:
- if ((eventMask & AWTEvent.TEXT_EVENT_MASK) != 0) {
- return true;
- }
- break;
- case ItemEvent.ITEM_STATE_CHANGED:
- if ((eventMask & AWTEvent.ITEM_EVENT_MASK) != 0) {
- return true;
- }
- break;
- case AdjustmentEvent.ADJUSTMENT_VALUE_CHANGED:
- if ((eventMask & AWTEvent.ADJUSTMENT_EVENT_MASK) != 0) {
- return true;
- }
- break;
- default:
- break;
- }
- //
- // Always pass on events defined by external programs.
- //
- if (type > AWTEvent.RESERVED_ID_MAX) {
- return true;
- }
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by dispatchEvent(AWTEvent).
- */
- @Deprecated
- public boolean postEvent(Event e) {
- ComponentPeer peer = this.peer;
-
- if (handleEvent(e)) {
- e.consume();
- return true;
- }
-
- Component parent = this.parent;
- int eventx = e.x;
- int eventy = e.y;
- if (parent != null) {
- e.translate(x, y);
- if (parent.postEvent(e)) {
- e.consume();
- return true;
- }
- // restore coords
- e.x = eventx;
- e.y = eventy;
- }
- return false;
- }
-
- // Event source interfaces
-
- /**
- * Adds the specified component listener to receive component events from
- * this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the component listener
- * @see java.awt.event.ComponentEvent
- * @see java.awt.event.ComponentListener
- * @see #removeComponentListener
- * @see #getComponentListeners
- * @since JDK1.1
- */
- public synchronized void addComponentListener(ComponentListener l) {
- if (l == null) {
- return;
- }
- componentListener = AWTEventMulticaster.add(componentListener, l);
- newEventsOnly = true;
- }
-
- /**
- * Removes the specified component listener so that it no longer
- * receives component events from this component. This method performs
- * no function, nor does it throw an exception, if the listener
- * specified by the argument was not previously added to this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- * @param l the component listener
- * @see java.awt.event.ComponentEvent
- * @see java.awt.event.ComponentListener
- * @see #addComponentListener
- * @see #getComponentListeners
- * @since JDK1.1
- */
- public synchronized void removeComponentListener(ComponentListener l) {
- if (l == null) {
- return;
- }
- componentListener = AWTEventMulticaster.remove(componentListener, l);
- }
-
- /**
- * Returns an array of all the component listeners
- * registered on this component.
- *
- * @return all of this comonent's <code>ComponentListener</code>s
- * or an empty array if no component
- * listeners are currently registered
- *
- * @see #addComponentListener
- * @see #removeComponentListener
- * @since 1.4
- */
- public synchronized ComponentListener[] getComponentListeners() {
- return (ComponentListener[]) (getListeners(ComponentListener.class));
- }
-
- /**
- * Adds the specified focus listener to receive focus events from
- * this component when this component gains input focus.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the focus listener
- * @see java.awt.event.FocusEvent
- * @see java.awt.event.FocusListener
- * @see #removeFocusListener
- * @see #getFocusListeners
- * @since JDK1.1
- */
- public synchronized void addFocusListener(FocusListener l) {
- if (l == null) {
- return;
- }
- focusListener = AWTEventMulticaster.add(focusListener, l);
- newEventsOnly = true;
-
- // if this is a lightweight component, enable focus events
- // in the native container.
- if (peer instanceof LightweightPeer) {
- parent.proxyEnableEvents(AWTEvent.FOCUS_EVENT_MASK);
- }
- }
-
- /**
- * Removes the specified focus listener so that it no longer
- * receives focus events from this component. This method performs
- * no function, nor does it throw an exception, if the listener
- * specified by the argument was not previously added to this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the focus listener
- * @see java.awt.event.FocusEvent
- * @see java.awt.event.FocusListener
- * @see #addFocusListener
- * @see #getFocusListeners
- * @since JDK1.1
- */
- public synchronized void removeFocusListener(FocusListener l) {
- if (l == null) {
- return;
- }
- focusListener = AWTEventMulticaster.remove(focusListener, l);
- }
-
- /**
- * Returns an array of all the focus listeners
- * registered on this component.
- *
- * @return all of this component's <code>FocusListener</code>s
- * or an empty array if no component
- * listeners are currently registered
- *
- * @see #addFocusListener
- * @see #removeFocusListener
- * @since 1.4
- */
- public synchronized FocusListener[] getFocusListeners() {
- return (FocusListener[]) (getListeners(FocusListener.class));
- }
-
- /**
- * Adds the specified hierarchy listener to receive hierarchy changed
- * events from this component when the hierarchy to which this container
- * belongs changes.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the hierarchy listener
- * @see java.awt.event.HierarchyEvent
- * @see java.awt.event.HierarchyListener
- * @see #removeHierarchyListener
- * @see #getHierarchyListeners
- * @since 1.3
- */
- public void addHierarchyListener(HierarchyListener l) {
- if (l == null) {
- return;
- }
- boolean notifyAncestors;
- synchronized (this) {
- notifyAncestors =
- (hierarchyListener == null &&
- (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) == 0);
- hierarchyListener = AWTEventMulticaster.add(hierarchyListener, l);
- notifyAncestors = (notifyAncestors && hierarchyListener != null);
- newEventsOnly = true;
- }
- if (notifyAncestors) {
- synchronized (getTreeLock()) {
- adjustListeningChildrenOnParent(AWTEvent.HIERARCHY_EVENT_MASK,
- 1);
- }
- }
- }
-
- /**
- * Removes the specified hierarchy listener so that it no longer
- * receives hierarchy changed events from this component. This method
- * performs no function, nor does it throw an exception, if the listener
- * specified by the argument was not previously added to this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the hierarchy listener
- * @see java.awt.event.HierarchyEvent
- * @see java.awt.event.HierarchyListener
- * @see #addHierarchyListener
- * @see #getHierarchyListeners
- * @since 1.3
- */
- public void removeHierarchyListener(HierarchyListener l) {
- if (l == null) {
- return;
- }
- boolean notifyAncestors;
- synchronized (this) {
- notifyAncestors =
- (hierarchyListener != null &&
- (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) == 0);
- hierarchyListener =
- AWTEventMulticaster.remove(hierarchyListener, l);
- notifyAncestors = (notifyAncestors && hierarchyListener == null);
- }
- if (notifyAncestors) {
- synchronized (getTreeLock()) {
- adjustListeningChildrenOnParent(AWTEvent.HIERARCHY_EVENT_MASK,
- -1);
- }
- }
- }
-
- /**
- * Returns an array of all the hierarchy listeners
- * registered on this component.
- *
- * @return all of this component's <code>HierarchyListener</code>s
- * or an empty array if no hierarchy
- * listeners are currently registered
- *
- * @see #addHierarchyListener
- * @see #removeHierarchyListener
- * @since 1.4
- */
- public synchronized HierarchyListener[] getHierarchyListeners() {
- return (HierarchyListener[])(getListeners(HierarchyListener.class));
- }
-
- /**
- * Adds the specified hierarchy bounds listener to receive hierarchy
- * bounds events from this component when the hierarchy to which this
- * container belongs changes.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the hierarchy bounds listener
- * @see java.awt.event.HierarchyEvent
- * @see java.awt.event.HierarchyBoundsListener
- * @see #removeHierarchyBoundsListener
- * @see #getHierarchyBoundsListeners
- * @since 1.3
- */
- public void addHierarchyBoundsListener(HierarchyBoundsListener l) {
- if (l == null) {
- return;
- }
- boolean notifyAncestors;
- synchronized (this) {
- notifyAncestors =
- (hierarchyBoundsListener == null &&
- (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) == 0);
- hierarchyBoundsListener =
- AWTEventMulticaster.add(hierarchyBoundsListener, l);
- notifyAncestors = (notifyAncestors &&
- hierarchyBoundsListener != null);
- newEventsOnly = true;
- }
- if (notifyAncestors) {
- synchronized (getTreeLock()) {
- adjustListeningChildrenOnParent(
- AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK, 1);
- }
- }
- }
-
- /**
- * Removes the specified hierarchy bounds listener so that it no longer
- * receives hierarchy bounds events from this component. This method
- * performs no function, nor does it throw an exception, if the listener
- * specified by the argument was not previously added to this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the hierarchy bounds listener
- * @see java.awt.event.HierarchyEvent
- * @see java.awt.event.HierarchyBoundsListener
- * @see #addHierarchyBoundsListener
- * @see #getHierarchyBoundsListeners
- * @since 1.3
- */
- public void removeHierarchyBoundsListener(HierarchyBoundsListener l) {
- if (l == null) {
- return;
- }
- boolean notifyAncestors;
- synchronized (this) {
- notifyAncestors =
- (hierarchyBoundsListener != null &&
- (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) == 0);
- hierarchyBoundsListener =
- AWTEventMulticaster.remove(hierarchyBoundsListener, l);
- notifyAncestors = (notifyAncestors &&
- hierarchyBoundsListener == null);
- }
- if (notifyAncestors) {
- synchronized (getTreeLock()) {
- adjustListeningChildrenOnParent(
- AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK, -1);
- }
- }
- }
-
- // Should only be called while holding the tree lock
- int numListening(long mask) {
- if (dbg.on) {
- // One mask or the other, but not neither or both.
- dbg.assertion(mask == AWTEvent.HIERARCHY_EVENT_MASK ||
- mask == AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK);
- }
- if ((mask == AWTEvent.HIERARCHY_EVENT_MASK &&
- (hierarchyListener != null ||
- (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0)) ||
- (mask == AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK &&
- (hierarchyBoundsListener != null ||
- (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0))) {
- return 1;
- } else {
- return 0;
- }
- }
-
- // Should only be called while holding tree lock
- int countHierarchyMembers() {
- return 1;
- }
- // Should only be called while holding the tree lock
- int createHierarchyEvents(int id, Component changed,
- Container changedParent, long changeFlags,
- boolean enabledOnToolkit) {
- switch (id) {
- case HierarchyEvent.HIERARCHY_CHANGED:
- if (hierarchyListener != null ||
- (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 ||
- enabledOnToolkit) {
- HierarchyEvent e = new HierarchyEvent(this, id, changed,
- changedParent,
- changeFlags);
- dispatchEvent(e);
- return 1;
- }
- break;
- case HierarchyEvent.ANCESTOR_MOVED:
- case HierarchyEvent.ANCESTOR_RESIZED:
- if (dbg.on) {
- dbg.assertion(changeFlags == 0);
- }
- if (hierarchyBoundsListener != null ||
- (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 ||
- enabledOnToolkit) {
- HierarchyEvent e = new HierarchyEvent(this, id, changed,
- changedParent);
- dispatchEvent(e);
- return 1;
- }
- break;
- default:
- if (dbg.on) {
- dbg.assertion(false);
- }
- break;
- }
- return 0;
- }
-
- /**
- * Returns an array of all the hierarchy bounds listeners
- * registered on this component.
- *
- * @return all of this component's <code>HierarchyBoundsListener</code>s
- * or an empty array if no hierarchy bounds
- * listeners are currently registered
- *
- * @see #addHierarchyBoundsListener
- * @see #removeHierarchyBoundsListener
- * @since 1.4
- */
- public synchronized HierarchyBoundsListener[] getHierarchyBoundsListeners() {
- return (HierarchyBoundsListener[])
- (getListeners(HierarchyBoundsListener.class));
- }
-
- /*
- * Should only be called while holding the tree lock.
- * It's added only for overriding in java.awt.Window
- * because parent in Window is owner.
- */
- void adjustListeningChildrenOnParent(long mask, int num) {
- if (parent != null) {
- parent.adjustListeningChildren(mask, num);
- }
- }
-
- /**
- * Adds the specified key listener to receive key events from
- * this component.
- * If l is null, no exception is thrown and no action is performed.
- *
- * @param l the key listener.
- * @see java.awt.event.KeyEvent
- * @see java.awt.event.KeyListener
- * @see #removeKeyListener
- * @see #getKeyListeners
- * @since JDK1.1
- */
- public synchronized void addKeyListener(KeyListener l) {
- if (l == null) {
- return;
- }
- keyListener = AWTEventMulticaster.add(keyListener, l);
- newEventsOnly = true;
-
- // if this is a lightweight component, enable key events
- // in the native container.
- if (peer instanceof LightweightPeer) {
- parent.proxyEnableEvents(AWTEvent.KEY_EVENT_MASK);
- }
- }
-
- /**
- * Removes the specified key listener so that it no longer
- * receives key events from this component. This method performs
- * no function, nor does it throw an exception, if the listener
- * specified by the argument was not previously added to this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the key listener
- * @see java.awt.event.KeyEvent
- * @see java.awt.event.KeyListener
- * @see #addKeyListener
- * @see #getKeyListeners
- * @since JDK1.1
- */
- public synchronized void removeKeyListener(KeyListener l) {
- if (l == null) {
- return;
- }
- keyListener = AWTEventMulticaster.remove(keyListener, l);
- }
-
- /**
- * Returns an array of all the key listeners
- * registered on this component.
- *
- * @return all of this component's <code>KeyListener</code>s
- * or an empty array if no key
- * listeners are currently registered
- *
- * @see #addKeyListener
- * @see #removeKeyListener
- * @since 1.4
- */
- public synchronized KeyListener[] getKeyListeners() {
- return (KeyListener[]) (getListeners(KeyListener.class));
- }
-
- /**
- * Adds the specified mouse listener to receive mouse events from
- * this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the mouse listener
- * @see java.awt.event.MouseEvent
- * @see java.awt.event.MouseListener
- * @see #removeMouseListener
- * @see #getMouseListeners
- * @since JDK1.1
- */
- public synchronized void addMouseListener(MouseListener l) {
- if (l == null) {
- return;
- }
- mouseListener = AWTEventMulticaster.add(mouseListener,l);
- newEventsOnly = true;
-
- // if this is a lightweight component, enable mouse events
- // in the native container.
- if (peer instanceof LightweightPeer) {
- parent.proxyEnableEvents(AWTEvent.MOUSE_EVENT_MASK);
- }
- }
-
- /**
- * Removes the specified mouse listener so that it no longer
- * receives mouse events from this component. This method performs
- * no function, nor does it throw an exception, if the listener
- * specified by the argument was not previously added to this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the mouse listener
- * @see java.awt.event.MouseEvent
- * @see java.awt.event.MouseListener
- * @see #addMouseListener
- * @see #getMouseListeners
- * @since JDK1.1
- */
- public synchronized void removeMouseListener(MouseListener l) {
- if (l == null) {
- return;
- }
- mouseListener = AWTEventMulticaster.remove(mouseListener, l);
- }
-
- /**
- * Returns an array of all the mouse listeners
- * registered on this component.
- *
- * @return all of this component's <code>MouseListener</code>s
- * or an empty array if no mouse
- * listeners are currently registered
- *
- * @see #addMouseListener
- * @see #removeMouseListener
- * @since 1.4
- */
- public synchronized MouseListener[] getMouseListeners() {
- return (MouseListener[]) (getListeners(MouseListener.class));
- }
-
- /**
- * Adds the specified mouse motion listener to receive mouse motion
- * events from this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the mouse motion listener
- * @see java.awt.event.MouseEvent
- * @see java.awt.event.MouseMotionListener
- * @see #removeMouseMotionListener
- * @see #getMouseMotionListeners
- * @since JDK1.1
- */
- public synchronized void addMouseMotionListener(MouseMotionListener l) {
- if (l == null) {
- return;
- }
- mouseMotionListener = AWTEventMulticaster.add(mouseMotionListener,l);
- newEventsOnly = true;
-
- // if this is a lightweight component, enable mouse events
- // in the native container.
- if (peer instanceof LightweightPeer) {
- parent.proxyEnableEvents(AWTEvent.MOUSE_MOTION_EVENT_MASK);
- }
- }
-
- /**
- * Removes the specified mouse motion listener so that it no longer
- * receives mouse motion events from this component. This method performs
- * no function, nor does it throw an exception, if the listener
- * specified by the argument was not previously added to this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the mouse motion listener
- * @see java.awt.event.MouseEvent
- * @see java.awt.event.MouseMotionListener
- * @see #addMouseMotionListener
- * @see #getMouseMotionListeners
- * @since JDK1.1
- */
- public synchronized void removeMouseMotionListener(MouseMotionListener l) {
- if (l == null) {
- return;
- }
- mouseMotionListener = AWTEventMulticaster.remove(mouseMotionListener, l);
- }
-
- /**
- * Returns an array of all the mouse motion listeners
- * registered on this component.
- *
- * @return all of this component's <code>MouseMotionListener</code>s
- * or an empty array if no mouse motion
- * listeners are currently registered
- *
- * @see #addMouseMotionListener
- * @see #removeMouseMotionListener
- * @since 1.4
- */
- public synchronized MouseMotionListener[] getMouseMotionListeners() {
- return (MouseMotionListener[]) (getListeners(MouseMotionListener.class));
- }
-
- /**
- * Adds the specified mouse wheel listener to receive mouse wheel events
- * from this component. Containers also receive mouse wheel events from
- * sub-components.
- * <p>
- * For information on how mouse wheel events are dispatched, see
- * the class description for {@link MouseWheelEvent}.
- * <p>
- * If l is <code>null</code>, no exception is thrown and no
- * action is performed.
- *
- * @param l the mouse wheel listener
- * @see java.awt.event.MouseWheelEvent
- * @see java.awt.event.MouseWheelListener
- * @see #removeMouseWheelListener
- * @see #getMouseWheelListeners
- * @since 1.4
- */
- public synchronized void addMouseWheelListener(MouseWheelListener l) {
- if (l == null) {
- return;
- }
- mouseWheelListener = AWTEventMulticaster.add(mouseWheelListener,l);
- newEventsOnly = true;
-
- dbg.println("Component.addMouseWheelListener(): newEventsOnly = " + newEventsOnly);
-
- // if this is a lightweight component, enable mouse events
- // in the native container.
- if (peer instanceof LightweightPeer) {
- parent.proxyEnableEvents(AWTEvent.MOUSE_WHEEL_EVENT_MASK);
- }
- }
-
- /**
- * Removes the specified mouse wheel listener so that it no longer
- * receives mouse wheel events from this component. This method performs
- * no function, nor does it throw an exception, if the listener
- * specified by the argument was not previously added to this component.
- * If l is null, no exception is thrown and no action is performed.
- *
- * @param l the mouse wheel listener.
- * @see java.awt.event.MouseWheelEvent
- * @see java.awt.event.MouseWheelListener
- * @see #addMouseWheelListener
- * @see #getMouseWheelListeners
- * @since 1.4
- */
- public synchronized void removeMouseWheelListener(MouseWheelListener l) {
- if (l == null) {
- return;
- }
- mouseWheelListener = AWTEventMulticaster.remove(mouseWheelListener, l);
- }
-
- /**
- * Returns an array of all the mouse wheel listeners
- * registered on this component.
- *
- * @return all of this component's <code>MouseWheelListener</code>s
- * or an empty array if no mouse wheel
- * listeners are currently registered
- *
- * @see #addMouseWheelListener
- * @see #removeMouseWheelListener
- * @since 1.4
- */
- public synchronized MouseWheelListener[] getMouseWheelListeners() {
- return (MouseWheelListener[]) (getListeners(MouseWheelListener.class));
- }
-
- /**
- * Adds the specified input method listener to receive
- * input method events from this component. A component will
- * only receive input method events from input methods
- * if it also overrides <code>getInputMethodRequests</code> to return an
- * <code>InputMethodRequests</code> instance.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the input method listener
- * @see java.awt.event.InputMethodEvent
- * @see java.awt.event.InputMethodListener
- * @see #removeInputMethodListener
- * @see #getInputMethodListeners
- * @see #getInputMethodRequests
- * @since 1.2
- */
- public synchronized void addInputMethodListener(InputMethodListener l) {
- if (l == null) {
- return;
- }
- inputMethodListener = AWTEventMulticaster.add(inputMethodListener, l);
- newEventsOnly = true;
- }
-
- /**
- * Removes the specified input method listener so that it no longer
- * receives input method events from this component. This method performs
- * no function, nor does it throw an exception, if the listener
- * specified by the argument was not previously added to this component.
- * If listener <code>l</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param l the input method listener
- * @see java.awt.event.InputMethodEvent
- * @see java.awt.event.InputMethodListener
- * @see #addInputMethodListener
- * @see #getInputMethodListeners
- * @since 1.2
- */
- public synchronized void removeInputMethodListener(InputMethodListener l) {
- if (l == null) {
- return;
- }
- inputMethodListener = AWTEventMulticaster.remove(inputMethodListener, l);
- }
-
- /**
- * Returns an array of all the input method listeners
- * registered on this component.
- *
- * @return all of this component's <code>InputMethodListener</code>s
- * or an empty array if no input method
- * listeners are currently registered
- *
- * @see #addInputMethodListener
- * @see #removeInputMethodListener
- * @since 1.4
- */
- public synchronized InputMethodListener[] getInputMethodListeners() {
- return (InputMethodListener[]) (getListeners(InputMethodListener.class));
- }
-
- /**
- * Returns an array of all the objects currently registered
- * as <code><em>Foo</em>Listener</code>s
- * upon this <code>Component</code>.
- * <code><em>Foo</em>Listener</code>s are registered using the
- * <code>add<em>Foo</em>Listener</code> method.
- *
- * <p>
- * You can specify the <code>listenerType</code> argument
- * with a class literal, such as
- * <code><em>Foo</em>Listener.class</code>.
- * For example, you can query a
- * <code>Component</code> <code>c</code>
- * for its mouse listeners with the following code:
- *
- * <pre>MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));</pre>
- *
- * If no such listeners exist, this method returns an empty array.
- *
- * @param listenerType the type of listeners requested; this parameter
- * should specify an interface that descends from
- * <code>java.util.EventListener</code>
- * @return an array of all objects registered as
- * <code><em>Foo</em>Listener</code>s on this component,
- * or an empty array if no such listeners have been added
- * @exception ClassCastException if <code>listenerType</code>
- * doesn't specify a class or interface that implements
- * <code>java.util.EventListener</code>
- *
- * @see #getComponentListeners
- * @see #getFocusListeners
- * @see #getHierarchyListeners
- * @see #getHierarchyBoundsListeners
- * @see #getKeyListeners
- * @see #getMouseListeners
- * @see #getMouseMotionListeners
- * @see #getMouseWheelListeners
- * @see #getInputMethodListeners
- * @see #getPropertyChangeListeners
- *
- * @since 1.3
- */
- public <T extends EventListener> T[] getListeners(Class<T> listenerType) {
- EventListener l = null;
- if (listenerType == ComponentListener.class) {
- l = componentListener;
- } else if (listenerType == FocusListener.class) {
- l = focusListener;
- } else if (listenerType == HierarchyListener.class) {
- l = hierarchyListener;
- } else if (listenerType == HierarchyBoundsListener.class) {
- l = hierarchyBoundsListener;
- } else if (listenerType == KeyListener.class) {
- l = keyListener;
- } else if (listenerType == MouseListener.class) {
- l = mouseListener;
- } else if (listenerType == MouseMotionListener.class) {
- l = mouseMotionListener;
- } else if (listenerType == MouseWheelListener.class) {
- l = mouseWheelListener;
- } else if (listenerType == InputMethodListener.class) {
- l = inputMethodListener;
- } else if (listenerType == PropertyChangeListener.class) {
- return (T[])getPropertyChangeListeners();
- }
- return AWTEventMulticaster.getListeners(l, listenerType);
- }
-
- /**
- * Gets the input method request handler which supports
- * requests from input methods for this component. A component
- * that supports on-the-spot text input must override this
- * method to return an <code>InputMethodRequests</code> instance.
- * At the same time, it also has to handle input method events.
- *
- * @return the input method request handler for this component,
- * <code>null</code> by default
- * @see #addInputMethodListener
- * @since 1.2
- */
- public InputMethodRequests getInputMethodRequests() {
- return null;
- }
-
- /**
- * Gets the input context used by this component for handling
- * the communication with input methods when text is entered
- * in this component. By default, the input context used for
- * the parent component is returned. Components may
- * override this to return a private input context.
- *
- * @return the input context used by this component;
- * <code>null</code> if no context can be determined
- * @since 1.2
- */
- public InputContext getInputContext() {
- Container parent = this.parent;
- if (parent == null) {
- return null;
- } else {
- return parent.getInputContext();
- }
- }
-
- /**
- * Enables the events defined by the specified event mask parameter
- * to be delivered to this component.
- * <p>
- * Event types are automatically enabled when a listener for
- * that event type is added to the component.
- * <p>
- * This method only needs to be invoked by subclasses of
- * <code>Component</code> which desire to have the specified event
- * types delivered to <code>processEvent</code> regardless of whether
- * or not a listener is registered.
- * @param eventsToEnable the event mask defining the event types
- * @see #processEvent
- * @see #disableEvents
- * @see AWTEvent
- * @since JDK1.1
- */
- protected final void enableEvents(long eventsToEnable) {
- long notifyAncestors = 0;
- synchronized (this) {
- if ((eventsToEnable & AWTEvent.HIERARCHY_EVENT_MASK) != 0 &&
- hierarchyListener == null &&
- (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) == 0) {
- notifyAncestors |= AWTEvent.HIERARCHY_EVENT_MASK;
- }
- if ((eventsToEnable & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 &&
- hierarchyBoundsListener == null &&
- (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) == 0) {
- notifyAncestors |= AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK;
- }
- eventMask |= eventsToEnable;
- newEventsOnly = true;
- }
-
- // if this is a lightweight component, enable mouse events
- // in the native container.
- if (peer instanceof LightweightPeer) {
- parent.proxyEnableEvents(eventMask);
- }
- if (notifyAncestors != 0) {
- synchronized (getTreeLock()) {
- adjustListeningChildrenOnParent(notifyAncestors, 1);
- }
- }
- }
-
- /**
- * Disables the events defined by the specified event mask parameter
- * from being delivered to this component.
- * @param eventsToDisable the event mask defining the event types
- * @see #enableEvents
- * @since JDK1.1
- */
- protected final void disableEvents(long eventsToDisable) {
- long notifyAncestors = 0;
- synchronized (this) {
- if ((eventsToDisable & AWTEvent.HIERARCHY_EVENT_MASK) != 0 &&
- hierarchyListener == null &&
- (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0) {
- notifyAncestors |= AWTEvent.HIERARCHY_EVENT_MASK;
- }
- if ((eventsToDisable & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK)!=0 &&
- hierarchyBoundsListener == null &&
- (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0) {
- notifyAncestors |= AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK;
- }
- eventMask &= ~eventsToDisable;
- }
- if (notifyAncestors != 0) {
- synchronized (getTreeLock()) {
- adjustListeningChildrenOnParent(notifyAncestors, -1);
- }
- }
- }
-
- /**
- * Potentially coalesce an event being posted with an existing
- * event. This method is called by <code>EventQueue.postEvent</code>
- * if an event with the same ID as the event to be posted is found in
- * the queue (both events must have this component as their source).
- * This method either returns a coalesced event which replaces
- * the existing event (and the new event is then discarded), or
- * <code>null</code> to indicate that no combining should be done
- * (add the second event to the end of the queue). Either event
- * parameter may be modified and returned, as the other one is discarded
- * unless <code>null</code> is returned.
- * <p>
- * This implementation of <code>coalesceEvents</code> coalesces
- * two event types: mouse move (and drag) events,
- * and paint (and update) events.
- * For mouse move events the last event is always returned, causing
- * intermediate moves to be discarded. For paint events, the new
- * event is coalesced into a complex <code>RepaintArea</code> in the peer.
- * The new <code>AWTEvent</code> is always returned.
- *
- * @param existingEvent the event already on the <code>EventQueue</code>
- * @param newEvent the event being posted to the
- * <code>EventQueue</code>
- * @return a coalesced event, or <code>null</code> indicating that no
- * coalescing was done
- */
- protected AWTEvent coalesceEvents(AWTEvent existingEvent,
- AWTEvent newEvent) {
- int id = existingEvent.getID();
- if (dbg.on) {
- dbg.assertion(id == newEvent.getID() &&
- existingEvent.getSource().equals(newEvent.getSource()));
- }
-
- switch (id) {
- case Event.MOUSE_MOVE:
- case Event.MOUSE_DRAG: {
- MouseEvent e = (MouseEvent)existingEvent;
- if (e.getModifiers() == ((MouseEvent)newEvent).getModifiers()) {
- // Just return the newEvent, causing the old to be
- // discarded.
- return newEvent;
- }
- break;
- }
- case PaintEvent.PAINT:
- case PaintEvent.UPDATE: {
- if(peer != null && !(peer instanceof LightweightPeer)) {
- // EventQueue.postEvent should use peer.coalescePaintEvent
- return newEvent;
- }
- // This approach to coalescing paint events seems to be
- // better than any heuristic for unioning rectangles.
- PaintEvent existingPaintEvent = (PaintEvent) existingEvent;
- PaintEvent newPaintEvent = (PaintEvent) newEvent;
- Rectangle existingRect = existingPaintEvent.getUpdateRect();
- Rectangle newRect = newPaintEvent.getUpdateRect();
-
- if (dbg.on) {
- dbg.println("Component::coalesceEvents : newEvent : nullPeer : x = " +
- newRect.x + " y = " + newRect.y + " width = " + newRect.width +
- " height = " + newRect.height);
- }
-
- if (existingRect.contains(newRect)) {
- return existingEvent;
- }
- if (newRect.contains(existingRect)) {
- return newEvent;
- }
-
- break;
- }
- }
-
- return null;
- }
-
- /**
- * Processes events occurring on this component. By default this
- * method calls the appropriate
- * <code>process<event type>Event</code>
- * method for the given class of event.
- * <p>Note that if the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the event
- * @see #processComponentEvent
- * @see #processFocusEvent
- * @see #processKeyEvent
- * @see #processMouseEvent
- * @see #processMouseMotionEvent
- * @see #processInputMethodEvent
- * @see #processHierarchyEvent
- * @see #processMouseWheelEvent
- * @since JDK1.1
- */
- protected void processEvent(AWTEvent e) {
- if (e instanceof FocusEvent) {
- processFocusEvent((FocusEvent)e);
-
- } else if (e instanceof MouseEvent) {
- switch(e.getID()) {
- case MouseEvent.MOUSE_PRESSED:
- case MouseEvent.MOUSE_RELEASED:
- case MouseEvent.MOUSE_CLICKED:
- case MouseEvent.MOUSE_ENTERED:
- case MouseEvent.MOUSE_EXITED:
- processMouseEvent((MouseEvent)e);
- break;
- case MouseEvent.MOUSE_MOVED:
- case MouseEvent.MOUSE_DRAGGED:
- processMouseMotionEvent((MouseEvent)e);
- break;
- case MouseEvent.MOUSE_WHEEL:
- processMouseWheelEvent((MouseWheelEvent)e);
- break;
- }
-
- } else if (e instanceof KeyEvent) {
- processKeyEvent((KeyEvent)e);
-
- } else if (e instanceof ComponentEvent) {
- processComponentEvent((ComponentEvent)e);
- } else if (e instanceof InputMethodEvent) {
- processInputMethodEvent((InputMethodEvent)e);
- } else if (e instanceof HierarchyEvent) {
- switch (e.getID()) {
- case HierarchyEvent.HIERARCHY_CHANGED:
- processHierarchyEvent((HierarchyEvent)e);
- break;
- case HierarchyEvent.ANCESTOR_MOVED:
- case HierarchyEvent.ANCESTOR_RESIZED:
- processHierarchyBoundsEvent((HierarchyEvent)e);
- break;
- }
- }
- }
-
- /**
- * Processes component events occurring on this component by
- * dispatching them to any registered
- * <code>ComponentListener</code> objects.
- * <p>
- * This method is not called unless component events are
- * enabled for this component. Component events are enabled
- * when one of the following occurs:
- * <p><ul>
- * <li>A <code>ComponentListener</code> object is registered
- * via <code>addComponentListener</code>.
- * <li>Component events are enabled via <code>enableEvents</code>.
- * </ul>
- * <p>Note that if the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the component event
- * @see java.awt.event.ComponentEvent
- * @see java.awt.event.ComponentListener
- * @see #addComponentListener
- * @see #enableEvents
- * @since JDK1.1
- */
- protected void processComponentEvent(ComponentEvent e) {
- ComponentListener listener = componentListener;
- if (listener != null) {
- int id = e.getID();
- switch(id) {
- case ComponentEvent.COMPONENT_RESIZED:
- listener.componentResized(e);
- break;
- case ComponentEvent.COMPONENT_MOVED:
- listener.componentMoved(e);
- break;
- case ComponentEvent.COMPONENT_SHOWN:
- listener.componentShown(e);
- break;
- case ComponentEvent.COMPONENT_HIDDEN:
- listener.componentHidden(e);
- break;
- }
- }
- }
-
- /**
- * Processes focus events occurring on this component by
- * dispatching them to any registered
- * <code>FocusListener</code> objects.
- * <p>
- * This method is not called unless focus events are
- * enabled for this component. Focus events are enabled
- * when one of the following occurs:
- * <p><ul>
- * <li>A <code>FocusListener</code> object is registered
- * via <code>addFocusListener</code>.
- * <li>Focus events are enabled via <code>enableEvents</code>.
- * </ul>
- * <p>
- * If focus events are enabled for a <code>Component</code>,
- * the current <code>KeyboardFocusManager</code> determines
- * whether or not a focus event should be dispatched to
- * registered <code>FocusListener</code> objects. If the
- * events are to be dispatched, the <code>KeyboardFocusManager</code>
- * calls the <code>Component</code>'s <code>dispatchEvent</code>
- * method, which results in a call to the <code>Component</code>'s
- * <code>processFocusEvent</code> method.
- * <p>
- * If focus events are enabled for a <code>Component</code>, calling
- * the <code>Component</code>'s <code>dispatchEvent</code> method
- * with a <code>FocusEvent</code> as the argument will result in a
- * call to the <code>Component</code>'s <code>processFocusEvent</code>
- * method regardless of the current <code>KeyboardFocusManager</code>.
- * <p>
- * <p>Note that if the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the focus event
- * @see java.awt.event.FocusEvent
- * @see java.awt.event.FocusListener
- * @see java.awt.KeyboardFocusManager
- * @see #addFocusListener
- * @see #enableEvents
- * @see #dispatchEvent
- * @since JDK1.1
- */
- protected void processFocusEvent(FocusEvent e) {
- FocusListener listener = focusListener;
- if (listener != null) {
- int id = e.getID();
- switch(id) {
- case FocusEvent.FOCUS_GAINED:
- listener.focusGained(e);
- break;
- case FocusEvent.FOCUS_LOST:
- listener.focusLost(e);
- break;
- }
- }
- }
-
- /**
- * Processes key events occurring on this component by
- * dispatching them to any registered
- * <code>KeyListener</code> objects.
- * <p>
- * This method is not called unless key events are
- * enabled for this component. Key events are enabled
- * when one of the following occurs:
- * <p><ul>
- * <li>A <code>KeyListener</code> object is registered
- * via <code>addKeyListener</code>.
- * <li>Key events are enabled via <code>enableEvents</code>.
- * </ul>
- *
- * <p>
- * If key events are enabled for a <code>Component</code>,
- * the current <code>KeyboardFocusManager</code> determines
- * whether or not a key event should be dispatched to
- * registered <code>KeyListener</code> objects. The
- * <code>DefaultKeyboardFocusManager</code> will not dispatch
- * key events to a <code>Component</code> that is not the focus
- * owner or is not showing.
- * <p>
- * As of J2SE 1.4, <code>KeyEvent</code>s are redirected to
- * the focus owner. Please see the
- * <a href="doc-files/FocusSpec.html">Focus Specification</a>
- * for further information.
- * <p>
- * Calling a <code>Component</code>'s <code>dispatchEvent</code>
- * method with a <code>KeyEvent</code> as the argument will
- * result in a call to the <code>Component</code>'s
- * <code>processKeyEvent</code> method regardless of the
- * current <code>KeyboardFocusManager</code> as long as the
- * component is showing, focused, and enabled, and key events
- * are enabled on it.
- * <p>If the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the key event
- * @see java.awt.event.KeyEvent
- * @see java.awt.event.KeyListener
- * @see java.awt.KeyboardFocusManager
- * @see java.awt.DefaultKeyboardFocusManager
- * @see #processEvent
- * @see #dispatchEvent
- * @see #addKeyListener
- * @see #enableEvents
- * @see #isShowing
- * @since JDK1.1
- */
- protected void processKeyEvent(KeyEvent e) {
- KeyListener listener = keyListener;
- if (listener != null) {
- int id = e.getID();
- switch(id) {
- case KeyEvent.KEY_TYPED:
- listener.keyTyped(e);
- break;
- case KeyEvent.KEY_PRESSED:
- listener.keyPressed(e);
- break;
- case KeyEvent.KEY_RELEASED:
- listener.keyReleased(e);
- break;
- }
- }
- }
-
- /**
- * Processes mouse events occurring on this component by
- * dispatching them to any registered
- * <code>MouseListener</code> objects.
- * <p>
- * This method is not called unless mouse events are
- * enabled for this component. Mouse events are enabled
- * when one of the following occurs:
- * <p><ul>
- * <li>A <code>MouseListener</code> object is registered
- * via <code>addMouseListener</code>.
- * <li>Mouse events are enabled via <code>enableEvents</code>.
- * </ul>
- * <p>Note that if the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the mouse event
- * @see java.awt.event.MouseEvent
- * @see java.awt.event.MouseListener
- * @see #addMouseListener
- * @see #enableEvents
- * @since JDK1.1
- */
- protected void processMouseEvent(MouseEvent e) {
- MouseListener listener = mouseListener;
- if (listener != null) {
- int id = e.getID();
- switch(id) {
- case MouseEvent.MOUSE_PRESSED:
- listener.mousePressed(e);
- break;
- case MouseEvent.MOUSE_RELEASED:
- listener.mouseReleased(e);
- break;
- case MouseEvent.MOUSE_CLICKED:
- listener.mouseClicked(e);
- break;
- case MouseEvent.MOUSE_EXITED:
- listener.mouseExited(e);
- break;
- case MouseEvent.MOUSE_ENTERED:
- listener.mouseEntered(e);
- break;
- }
- }
- }
-
- /**
- * Processes mouse motion events occurring on this component by
- * dispatching them to any registered
- * <code>MouseMotionListener</code> objects.
- * <p>
- * This method is not called unless mouse motion events are
- * enabled for this component. Mouse motion events are enabled
- * when one of the following occurs:
- * <p><ul>
- * <li>A <code>MouseMotionListener</code> object is registered
- * via <code>addMouseMotionListener</code>.
- * <li>Mouse motion events are enabled via <code>enableEvents</code>.
- * </ul>
- * <p>Note that if the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the mouse motion event
- * @see java.awt.event.MouseEvent
- * @see java.awt.event.MouseMotionListener
- * @see #addMouseMotionListener
- * @see #enableEvents
- * @since JDK1.1
- */
- protected void processMouseMotionEvent(MouseEvent e) {
- MouseMotionListener listener = mouseMotionListener;
- if (listener != null) {
- int id = e.getID();
- switch(id) {
- case MouseEvent.MOUSE_MOVED:
- listener.mouseMoved(e);
- break;
- case MouseEvent.MOUSE_DRAGGED:
- listener.mouseDragged(e);
- break;
- }
- }
- }
-
- /**
- * Processes mouse wheel events occurring on this component by
- * dispatching them to any registered
- * <code>MouseWheelListener</code> objects.
- * <p>
- * This method is not called unless mouse wheel events are
- * enabled for this component. Mouse wheel events are enabled
- * when one of the following occurs:
- * <p><ul>
- * <li>A <code>MouseWheelListener</code> object is registered
- * via <code>addMouseWheelListener</code>.
- * <li>Mouse wheel events are enabled via <code>enableEvents</code>.
- * </ul>
- * <p>
- * For information on how mouse wheel events are dispatched, see
- * the class description for {@link MouseWheelEvent}.
- * <p>
- * Note that if the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the mouse wheel event
- * @see java.awt.event.MouseWheelEvent
- * @see java.awt.event.MouseWheelListener
- * @see #addMouseWheelListener
- * @see #enableEvents
- * @since 1.4
- */
- protected void processMouseWheelEvent(MouseWheelEvent e) {
- MouseWheelListener listener = mouseWheelListener;
- if (listener != null) {
- int id = e.getID();
- switch(id) {
- case MouseEvent.MOUSE_WHEEL:
- listener.mouseWheelMoved(e);
- break;
- }
- }
- }
-
- boolean postsOldMouseEvents() {
- return false;
- }
-
- /**
- * Processes input method events occurring on this component by
- * dispatching them to any registered
- * <code>InputMethodListener</code> objects.
- * <p>
- * This method is not called unless input method events
- * are enabled for this component. Input method events are enabled
- * when one of the following occurs:
- * <p><ul>
- * <li>An <code>InputMethodListener</code> object is registered
- * via <code>addInputMethodListener</code>.
- * <li>Input method events are enabled via <code>enableEvents</code>.
- * </ul>
- * <p>Note that if the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the input method event
- * @see java.awt.event.InputMethodEvent
- * @see java.awt.event.InputMethodListener
- * @see #addInputMethodListener
- * @see #enableEvents
- * @since 1.2
- */
- protected void processInputMethodEvent(InputMethodEvent e) {
- InputMethodListener listener = inputMethodListener;
- if (listener != null) {
- int id = e.getID();
- switch (id) {
- case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED:
- listener.inputMethodTextChanged(e);
- break;
- case InputMethodEvent.CARET_POSITION_CHANGED:
- listener.caretPositionChanged(e);
- break;
- }
- }
- }
-
- /**
- * Processes hierarchy events occurring on this component by
- * dispatching them to any registered
- * <code>HierarchyListener</code> objects.
- * <p>
- * This method is not called unless hierarchy events
- * are enabled for this component. Hierarchy events are enabled
- * when one of the following occurs:
- * <p><ul>
- * <li>An <code>HierarchyListener</code> object is registered
- * via <code>addHierarchyListener</code>.
- * <li>Hierarchy events are enabled via <code>enableEvents</code>.
- * </ul>
- * <p>Note that if the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the hierarchy event
- * @see java.awt.event.HierarchyEvent
- * @see java.awt.event.HierarchyListener
- * @see #addHierarchyListener
- * @see #enableEvents
- * @since 1.3
- */
- protected void processHierarchyEvent(HierarchyEvent e) {
- HierarchyListener listener = hierarchyListener;
- if (listener != null) {
- int id = e.getID();
- switch (id) {
- case HierarchyEvent.HIERARCHY_CHANGED:
- listener.hierarchyChanged(e);
- break;
- }
- }
- }
-
- /**
- * Processes hierarchy bounds events occurring on this component by
- * dispatching them to any registered
- * <code>HierarchyBoundsListener</code> objects.
- * <p>
- * This method is not called unless hierarchy bounds events
- * are enabled for this component. Hierarchy bounds events are enabled
- * when one of the following occurs:
- * <p><ul>
- * <li>An <code>HierarchyBoundsListener</code> object is registered
- * via <code>addHierarchyBoundsListener</code>.
- * <li>Hierarchy bounds events are enabled via <code>enableEvents</code>.
- * </ul>
- * <p>Note that if the event parameter is <code>null</code>
- * the behavior is unspecified and may result in an
- * exception.
- *
- * @param e the hierarchy event
- * @see java.awt.event.HierarchyEvent
- * @see java.awt.event.HierarchyBoundsListener
- * @see #addHierarchyBoundsListener
- * @see #enableEvents
- * @since 1.3
- */
- protected void processHierarchyBoundsEvent(HierarchyEvent e) {
- HierarchyBoundsListener listener = hierarchyBoundsListener;
- if (listener != null) {
- int id = e.getID();
- switch (id) {
- case HierarchyEvent.ANCESTOR_MOVED:
- listener.ancestorMoved(e);
- break;
- case HierarchyEvent.ANCESTOR_RESIZED:
- listener.ancestorResized(e);
- break;
- }
- }
- }
-
- /**
- * @deprecated As of JDK version 1.1
- * replaced by processEvent(AWTEvent).
- */
- @Deprecated
- public boolean handleEvent(Event evt) {
- switch (evt.id) {
- case Event.MOUSE_ENTER:
- return mouseEnter(evt, evt.x, evt.y);
-
- case Event.MOUSE_EXIT:
- return mouseExit(evt, evt.x, evt.y);
-
- case Event.MOUSE_MOVE:
- return mouseMove(evt, evt.x, evt.y);
-
- case Event.MOUSE_DOWN:
- return mouseDown(evt, evt.x, evt.y);
-
- case Event.MOUSE_DRAG:
- return mouseDrag(evt, evt.x, evt.y);
-
- case Event.MOUSE_UP:
- return mouseUp(evt, evt.x, evt.y);
-
- case Event.KEY_PRESS:
- case Event.KEY_ACTION:
- return keyDown(evt, evt.key);
-
- case Event.KEY_RELEASE:
- case Event.KEY_ACTION_RELEASE:
- return keyUp(evt, evt.key);
-
- case Event.ACTION_EVENT:
- return action(evt, evt.arg);
- case Event.GOT_FOCUS:
- return gotFocus(evt, evt.arg);
- case Event.LOST_FOCUS:
- return lostFocus(evt, evt.arg);
- }
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processMouseEvent(MouseEvent).
- */
- @Deprecated
- public boolean mouseDown(Event evt, int x, int y) {
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processMouseMotionEvent(MouseEvent).
- */
- @Deprecated
- public boolean mouseDrag(Event evt, int x, int y) {
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processMouseEvent(MouseEvent).
- */
- @Deprecated
- public boolean mouseUp(Event evt, int x, int y) {
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processMouseMotionEvent(MouseEvent).
- */
- @Deprecated
- public boolean mouseMove(Event evt, int x, int y) {
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processMouseEvent(MouseEvent).
- */
- @Deprecated
- public boolean mouseEnter(Event evt, int x, int y) {
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processMouseEvent(MouseEvent).
- */
- @Deprecated
- public boolean mouseExit(Event evt, int x, int y) {
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processKeyEvent(KeyEvent).
- */
- @Deprecated
- public boolean keyDown(Event evt, int key) {
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processKeyEvent(KeyEvent).
- */
- @Deprecated
- public boolean keyUp(Event evt, int key) {
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * should register this component as ActionListener on component
- * which fires action events.
- */
- @Deprecated
- public boolean action(Event evt, Object what) {
- return false;
- }
-
- /**
- * Makes this <code>Component</code> displayable by connecting it to a
- * native screen resource.
- * This method is called internally by the toolkit and should
- * not be called directly by programs.
- * @see #isDisplayable
- * @see #removeNotify
- * @since JDK1.0
- */
- public void addNotify() {
- synchronized (getTreeLock()) {
- ComponentPeer peer = this.peer;
- if (peer == null || peer instanceof LightweightPeer){
- if (peer == null) {
- // Update both the Component's peer variable and the local
- // variable we use for thread safety.
- this.peer = peer = getToolkit().createComponent(this);
- }
-
- // This is a lightweight component which means it won't be
- // able to get window-related events by itself. If any
- // have been enabled, then the nearest native container must
- // be enabled.
- if (parent != null) {
- long mask = 0;
- if ((mouseListener != null) || ((eventMask & AWTEvent.MOUSE_EVENT_MASK) != 0)) {
- mask |= AWTEvent.MOUSE_EVENT_MASK;
- }
- if ((mouseMotionListener != null) ||
- ((eventMask & AWTEvent.MOUSE_MOTION_EVENT_MASK) != 0)) {
- mask |= AWTEvent.MOUSE_MOTION_EVENT_MASK;
- }
- if ((mouseWheelListener != null ) ||
- ((eventMask & AWTEvent.MOUSE_WHEEL_EVENT_MASK) != 0)) {
- mask |= AWTEvent.MOUSE_WHEEL_EVENT_MASK;
- }
- if (focusListener != null || (eventMask & AWTEvent.FOCUS_EVENT_MASK) != 0) {
- mask |= AWTEvent.FOCUS_EVENT_MASK;
- }
- if (keyListener != null || (eventMask & AWTEvent.KEY_EVENT_MASK) != 0) {
- mask |= AWTEvent.KEY_EVENT_MASK;
- }
- if (mask != 0) {
- parent.proxyEnableEvents(mask);
- }
- }
- } else {
- // It's native. If the parent is lightweight it
- // will need some help.
- Container parent = this.parent;
- if (parent != null && parent.peer instanceof LightweightPeer) {
- nativeInLightFixer = new NativeInLightFixer();
- }
- }
- invalidate();
-
- int npopups = (popups != null? popups.size() : 0);
- for (int i = 0 ; i < npopups ; i++) {
- PopupMenu popup = (PopupMenu)popups.elementAt(i);
- popup.addNotify();
- }
-
- if (dropTarget != null) dropTarget.addNotify(peer);
-
- peerFont = getFont();
-
- // Update stacking order
- if (parent != null && parent.peer != null) {
- ContainerPeer parentContPeer = (ContainerPeer) parent.peer;
- // if our parent is lightweight and we are not
- // we should call restack on nearest heavyweight
- // container.
- if (parentContPeer instanceof LightweightPeer
- && ! (peer instanceof LightweightPeer))
- {
- Container hwParent = getNativeContainer();
- if (hwParent != null && hwParent.peer != null) {
- parentContPeer = (ContainerPeer) hwParent.peer;
- }
- }
- if (parentContPeer.isRestackSupported()) {
- parentContPeer.restack();
- }
- }
-
- if (hierarchyListener != null ||
- (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 ||
- Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK)) {
- HierarchyEvent e =
- new HierarchyEvent(this, HierarchyEvent.HIERARCHY_CHANGED,
- this, parent,
- HierarchyEvent.DISPLAYABILITY_CHANGED |
- ((isRecursivelyVisible())
- ? HierarchyEvent.SHOWING_CHANGED
- : 0));
- dispatchEvent(e);
- }
- }
- }
-
- /**
- * Makes this <code>Component</code> undisplayable by destroying it native
- * screen resource.
- * <p>
- * This method is called by the toolkit internally and should
- * not be called directly by programs. Code overriding
- * this method should call <code>super.removeNotify</code> as
- * the first line of the overriding method.
- *
- * @see #isDisplayable
- * @see #addNotify
- * @since JDK1.0
- */
- public void removeNotify() {
- KeyboardFocusManager.clearMostRecentFocusOwner(this);
- if (KeyboardFocusManager.getCurrentKeyboardFocusManager().
- getPermanentFocusOwner() == this)
- {
- KeyboardFocusManager.getCurrentKeyboardFocusManager().
- setGlobalPermanentFocusOwner(null);
- }
-
- synchronized (getTreeLock()) {
- if (isFocusOwner() && !nextFocusHelper()) {
- KeyboardFocusManager.getCurrentKeyboardFocusManager().
- clearGlobalFocusOwner();
- }
-
- int npopups = (popups != null? popups.size() : 0);
- for (int i = 0 ; i < npopups ; i++) {
- PopupMenu popup = (PopupMenu)popups.elementAt(i);
- popup.removeNotify();
- }
- // If there is any input context for this component, notify
- // that this component is being removed. (This has to be done
- // before hiding peer.)
- if ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) {
- InputContext inputContext = getInputContext();
- if (inputContext != null) {
- inputContext.removeNotify(this);
- }
- }
-
- ComponentPeer p = peer;
- if (p != null) {
-
- if (bufferStrategy instanceof FlipBufferStrategy) {
- ((FlipBufferStrategy)bufferStrategy).destroyBuffers();
- }
-
- if (dropTarget != null) dropTarget.removeNotify(peer);
-
- // Hide peer first to stop system events such as cursor moves.
- if (visible) {
- p.hide();
- }
-
- peer = null; // Stop peer updates.
- peerFont = null;
-
- Toolkit.getEventQueue().removeSourceEvents(this, false);
- KeyboardFocusManager.getCurrentKeyboardFocusManager().
- discardKeyEvents(this);
-
- p.dispose();
- }
-
- if (hierarchyListener != null ||
- (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 ||
- Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK)) {
- HierarchyEvent e =
- new HierarchyEvent(this, HierarchyEvent.HIERARCHY_CHANGED,
- this, parent,
- HierarchyEvent.DISPLAYABILITY_CHANGED |
- ((isRecursivelyVisible())
- ? HierarchyEvent.SHOWING_CHANGED
- : 0));
- dispatchEvent(e);
- }
- }
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processFocusEvent(FocusEvent).
- */
- @Deprecated
- public boolean gotFocus(Event evt, Object what) {
- return false;
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by processFocusEvent(FocusEvent).
- */
- @Deprecated
- public boolean lostFocus(Event evt, Object what) {
- return false;
- }
-
- /**
- * Returns whether this <code>Component</code> can become the focus
- * owner.
- *
- * @return <code>true</code> if this <code>Component</code> is
- * focusable; <code>false</code> otherwise
- * @see #setFocusable
- * @since JDK1.1
- * @deprecated As of 1.4, replaced by <code>isFocusable()</code>.
- */
- @Deprecated
- public boolean isFocusTraversable() {
- if (isFocusTraversableOverridden == FOCUS_TRAVERSABLE_UNKNOWN) {
- isFocusTraversableOverridden = FOCUS_TRAVERSABLE_DEFAULT;
- }
- return focusable;
- }
-
- /**
- * Returns whether this Component can be focused.
- *
- * @return <code>true</code> if this Component is focusable;
- * <code>false</code> otherwise.
- * @see #setFocusable
- * @since 1.4
- */
- public boolean isFocusable() {
- return isFocusTraversable();
- }
-
- /**
- * Sets the focusable state of this Component to the specified value. This
- * value overrides the Component's default focusability.
- *
- * @param focusable indicates whether this Component is focusable
- * @see #isFocusable
- * @since 1.4
- * @beaninfo
- * bound: true
- */
- public void setFocusable(boolean focusable) {
- boolean oldFocusable;
- synchronized (this) {
- oldFocusable = this.focusable;
- this.focusable = focusable;
- }
- isFocusTraversableOverridden = FOCUS_TRAVERSABLE_SET;
-
- firePropertyChange("focusable", oldFocusable, focusable);
- if (oldFocusable && !focusable) {
- if (isFocusOwner()) {
- autoTransferFocus(true);
- }
- KeyboardFocusManager.clearMostRecentFocusOwner(this);
- }
- }
-
- final boolean isFocusTraversableOverridden() {
- return (isFocusTraversableOverridden != FOCUS_TRAVERSABLE_DEFAULT);
- }
-
- /**
- * Sets the focus traversal keys for a given traversal operation for this
- * Component.
- * <p>
- * The default values for a Component's focus traversal keys are
- * implementation-dependent. Sun recommends that all implementations for a
- * particular native platform use the same default values. The
- * recommendations for Windows and Unix are listed below. These
- * recommendations are used in the Sun AWT implementations.
- *
- * <table border=1 summary="Recommended default values for a Component's focus traversal keys">
- * <tr>
- * <th>Identifier</th>
- * <th>Meaning</th>
- * <th>Default</th>
- * </tr>
- * <tr>
- * <td>KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS</td>
- * <td>Normal forward keyboard traversal</td>
- * <td>TAB on KEY_PRESSED, CTRL-TAB on KEY_PRESSED</td>
- * </tr>
- * <tr>
- * <td>KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS</td>
- * <td>Normal reverse keyboard 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 one focus traversal cycle</td>
- * <td>none</td>
- * </tr>
- * </table>
- *
- * To disable a traversal key, use an empty Set; Collections.EMPTY_SET is
- * recommended.
- * <p>
- * Using the AWTKeyStroke API, client code can specify on which of two
- * specific KeyEvents, KEY_PRESSED or KEY_RELEASED, the focus traversal
- * operation will occur. Regardless of which KeyEvent is specified,
- * however, all KeyEvents related to the focus traversal key, including the
- * associated KEY_TYPED event, will be consumed, and will not be dispatched
- * to any Component. It is a runtime error to specify a KEY_TYPED event as
- * mapping to a focus traversal operation, or to map the same event to
- * multiple default focus traversal operations.
- * <p>
- * If a value of null is specified for the Set, this Component inherits the
- * Set from its parent. If all ancestors of this Component have null
- * specified for the Set, then the current KeyboardFocusManager's default
- * Set is used.
- *
- * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
- * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
- * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
- * @param keystrokes the Set of AWTKeyStroke for the specified operation
- * @see #getFocusTraversalKeys
- * @see KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS
- * @see KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS
- * @see KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS
- * @throws IllegalArgumentException if id is not one of
- * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
- * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
- * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, or if keystrokes
- * contains null, or if any Object in keystrokes is not an
- * AWTKeyStroke, or if any keystroke represents a KEY_TYPED event,
- * or if any keystroke already maps to another focus traversal
- * operation for this Component
- * @since 1.4
- * @beaninfo
- * bound: true
- */
- public void setFocusTraversalKeys(int id,
- Set<? extends AWTKeyStroke> keystrokes)
- {
- if (id < 0 || id >= KeyboardFocusManager.TRAVERSAL_KEY_LENGTH - 1) {
- throw new IllegalArgumentException("invalid focus traversal key identifier");
- }
-
- setFocusTraversalKeys_NoIDCheck(id, keystrokes);
- }
-
- /**
- * Returns the Set of focus traversal keys for a given traversal operation
- * for this Component. (See
- * <code>setFocusTraversalKeys</code> for a full description of each key.)
- * <p>
- * If a Set of traversal keys has not been explicitly defined for this
- * Component, then this Component's parent's Set is returned. If no Set
- * has been explicitly defined for any of this Component's ancestors, then
- * the current KeyboardFocusManager's default Set is returned.
- *
- * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
- * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
- * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
- * @return the Set of AWTKeyStrokes for the specified operation. The Set
- * will be unmodifiable, and may be empty. null will never be
- * returned.
- * @see #setFocusTraversalKeys
- * @see KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS
- * @see KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS
- * @see KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS
- * @throws IllegalArgumentException if id is not one of
- * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
- * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
- * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
- * @since 1.4
- */
- public Set<AWTKeyStroke> getFocusTraversalKeys(int id) {
- if (id < 0 || id >= KeyboardFocusManager.TRAVERSAL_KEY_LENGTH - 1) {
- throw new IllegalArgumentException("invalid focus traversal key identifier");
- }
-
- return getFocusTraversalKeys_NoIDCheck(id);
- }
-
- // We define these methods so that Container does not need to repeat this
- // code. Container cannot call super.<method> because Container allows
- // DOWN_CYCLE_TRAVERSAL_KEY while Component does not. The Component method
- // would erroneously generate an IllegalArgumentException for
- // DOWN_CYCLE_TRAVERSAL_KEY.
- final void setFocusTraversalKeys_NoIDCheck(int id, Set keystrokes) {
- Set oldKeys;
-
- synchronized (this) {
- if (focusTraversalKeys == null) {
- initializeFocusTraversalKeys();
- }
-
- if (keystrokes != null) {
- for (Iterator iter = keystrokes.iterator(); iter.hasNext(); ) {
- Object obj = iter.next();
-
- if (obj == null) {
- throw new IllegalArgumentException("cannot set null focus traversal key");
- }
-
- // Generates a ClassCastException if the element is not an
- // AWTKeyStroke. This is desirable.
- AWTKeyStroke keystroke = (AWTKeyStroke)obj;
-
- if (keystroke.getKeyChar() != KeyEvent.CHAR_UNDEFINED) {
- throw new IllegalArgumentException("focus traversal keys cannot map to KEY_TYPED events");
- }
-
- for (int i = 0; i < focusTraversalKeys.length; i++) {
- if (i == id) {
- continue;
- }
-
- if (getFocusTraversalKeys_NoIDCheck(i).contains(keystroke))
- {
- throw new IllegalArgumentException("focus traversal keys must be unique for a Component");
- }
- }
- }
- }
-
- oldKeys = focusTraversalKeys[id];
- focusTraversalKeys[id] = (keystrokes != null)
- ? Collections.unmodifiableSet(new HashSet(keystrokes))
- : null;
- }
-
- firePropertyChange(focusTraversalKeyPropertyNames[id], oldKeys,
- keystrokes);
- }
- final Set getFocusTraversalKeys_NoIDCheck(int id) {
- // Okay to return Set directly because it is an unmodifiable view
- Set keystrokes = (focusTraversalKeys != null)
- ? focusTraversalKeys[id]
- : null;
-
- if (keystrokes != null) {
- return keystrokes;
- } else {
- Container parent = this.parent;
- if (parent != null) {
- return parent.getFocusTraversalKeys(id);
- } else {
- return KeyboardFocusManager.getCurrentKeyboardFocusManager().
- getDefaultFocusTraversalKeys(id);
- }
- }
- }
-
- /**
- * Returns whether the Set of focus traversal keys for the given focus
- * traversal operation has been explicitly defined for this Component. If
- * this method returns <code>false</code>, this Component is inheriting the
- * Set from an ancestor, or from the current KeyboardFocusManager.
- *
- * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
- * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
- * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
- * @return <code>true</code> if the the Set of focus traversal keys for the
- * given focus traversal operation has been explicitly defined for
- * this Component; <code>false</code> otherwise.
- * @throws IllegalArgumentException if id is not one of
- * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
- * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
- * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
- * @since 1.4
- */
- public boolean areFocusTraversalKeysSet(int id) {
- if (id < 0 || id >= KeyboardFocusManager.TRAVERSAL_KEY_LENGTH - 1) {
- throw new IllegalArgumentException("invalid focus traversal key identifier");
- }
-
- return (focusTraversalKeys != null && focusTraversalKeys[id] != null);
- }
-
- /**
- * Sets whether focus traversal keys are enabled for this Component.
- * Components for which focus traversal keys are disabled receive key
- * events for focus traversal keys. Components for which focus traversal
- * keys are enabled do not see these events; instead, the events are
- * automatically converted to traversal operations.
- *
- * @param focusTraversalKeysEnabled whether focus traversal keys are
- * enabled for this Component
- * @see #getFocusTraversalKeysEnabled
- * @see #setFocusTraversalKeys
- * @see #getFocusTraversalKeys
- * @since 1.4
- * @beaninfo
- * bound: true
- */
- public void setFocusTraversalKeysEnabled(boolean
- focusTraversalKeysEnabled) {
- boolean oldFocusTraversalKeysEnabled;
- synchronized (this) {
- oldFocusTraversalKeysEnabled = this.focusTraversalKeysEnabled;
- this.focusTraversalKeysEnabled = focusTraversalKeysEnabled;
- }
- firePropertyChange("focusTraversalKeysEnabled",
- oldFocusTraversalKeysEnabled,
- focusTraversalKeysEnabled);
- }
-
- /**
- * Returns whether focus traversal keys are enabled for this Component.
- * Components for which focus traversal keys are disabled receive key
- * events for focus traversal keys. Components for which focus traversal
- * keys are enabled do not see these events; instead, the events are
- * automatically converted to traversal operations.
- *
- * @return whether focus traversal keys are enabled for this Component
- * @see #setFocusTraversalKeysEnabled
- * @see #setFocusTraversalKeys
- * @see #getFocusTraversalKeys
- * @since 1.4
- */
- public boolean getFocusTraversalKeysEnabled() {
- return focusTraversalKeysEnabled;
- }
-
- /**
- * Requests that this Component get the input focus, and that this
- * Component's top-level ancestor become the focused Window. This component
- * must be displayable, visible, and focusable for the request to be
- * granted. Every effort will be made to honor the request; however, in
- * some cases it may be impossible to do so. Developers must never assume
- * that this Component is the focus owner until this Component receives a
- * FOCUS_GAINED event. If this request is denied because this Component's
- * top-level Window cannot become the focused Window, the request will be
- * remembered and will be granted when the Window is later focused by the
- * user.
- * <p>
- * This method cannot be used to set the focus owner to no Component at
- * all. Use <code>KeyboardFocusManager.clearGlobalFocusOwner()</code>
- * instead.
- * <p>
- * Because the focus behavior of this method is platform-dependent,
- * developers are strongly encouraged to use
- * <code>requestFocusInWindow</code> when possible.
- *
- * @see #requestFocusInWindow
- * @see java.awt.event.FocusEvent
- * @see #addFocusListener
- * @see #isFocusable
- * @see #isDisplayable
- * @see KeyboardFocusManager#clearGlobalFocusOwner
- * @since JDK1.0
- */
- public void requestFocus() {
- requestFocusHelper(false, true);
- }
-
- /**
- * Requests that this <code>Component</code> get the input focus,
- * and that this <code>Component</code>'s top-level ancestor
- * become the focused <code>Window</code>. This component
- * must be displayable, visible, and focusable for the request to be
- * granted. Every effort will be made to honor the request; however, in
- * some cases it may be impossible to do so. Developers must never assume
- * that this component is the focus owner until this component receives a
- * FOCUS_GAINED event. If this request is denied because this component's
- * top-level window cannot become the focused window, the request will be
- * remembered and will be granted when the window is later focused by the
- * user.
- * <p>
- * This method returns a boolean value. If <code>false</code> is returned,
- * the request is <b>guaranteed to fail</b>. If <code>true</code> is
- * returned, the request will succeed <b>unless</b> it is vetoed, or an
- * extraordinary event, such as disposal of the component's peer, occurs
- * before the request can be granted by the native windowing system. Again,
- * while a return value of <code>true</code> indicates that the request is
- * likely to succeed, developers must never assume that this component is
- * the focus owner until this component receives a FOCUS_GAINED event.
- * <p>
- * This method cannot be used to set the focus owner to no component at
- * all. Use <code>KeyboardFocusManager.clearGlobalFocusOwner</code>
- * instead.
- * <p>
- * Because the focus behavior of this method is platform-dependent,
- * developers are strongly encouraged to use
- * <code>requestFocusInWindow</code> when possible.
- * <p>
- * Every effort will be made to ensure that <code>FocusEvent</code>s
- * generated as a
- * result of this request will have the specified temporary value. However,
- * because specifying an arbitrary temporary state may not be implementable
- * on all native windowing systems, correct behavior for this method can be
- * guaranteed only for lightweight <code>Component</code>s.
- * This method is not intended
- * for general use, but exists instead as a hook for lightweight component
- * libraries, such as Swing.
- *
- * @param temporary true if the focus change is temporary,
- * such as when the window loses the focus; for
- * more information on temporary focus changes see the
- *<a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
- * @return <code>false</code> if the focus change request is guaranteed to
- * fail; <code>true</code> if it is likely to succeed
- * @see java.awt.event.FocusEvent
- * @see #addFocusListener
- * @see #isFocusable
- * @see #isDisplayable
- * @see KeyboardFocusManager#clearGlobalFocusOwner
- * @since 1.4
- */
- protected boolean requestFocus(boolean temporary) {
- return requestFocusHelper(temporary, true);
- }
-
- /**
- * Requests that this Component get the input focus, if this Component's
- * top-level ancestor is already the focused Window. This component must be
- * displayable, visible, and focusable for the request to be granted. Every
- * effort will be made to honor the request; however, in some cases it may
- * be impossible to do so. Developers must never assume that this Component
- * is the focus owner until this Component receives a FOCUS_GAINED event.
- * <p>
- * This method returns a boolean value. If <code>false</code> is returned,
- * the request is <b>guaranteed to fail</b>. If <code>true</code> is
- * returned, the request will succeed <b>unless</b> it is vetoed, or an
- * extraordinary event, such as disposal of the Component's peer, occurs
- * before the request can be granted by the native windowing system. Again,
- * while a return value of <code>true</code> indicates that the request is
- * likely to succeed, developers must never assume that this Component is
- * the focus owner until this Component receives a FOCUS_GAINED event.
- * <p>
- * This method cannot be used to set the focus owner to no Component at
- * all. Use <code>KeyboardFocusManager.clearGlobalFocusOwner()</code>
- * instead.
- * <p>
- * The focus behavior of this method can be implemented uniformly across
- * platforms, and thus developers are strongly encouraged to use this
- * method over <code>requestFocus</code> when possible. Code which relies
- * on <code>requestFocus</code> may exhibit different focus behavior on
- * different platforms.
- *
- * @return <code>false</code> if the focus change request is guaranteed to
- * fail; <code>true</code> if it is likely to succeed
- * @see #requestFocus
- * @see java.awt.event.FocusEvent
- * @see #addFocusListener
- * @see #isFocusable
- * @see #isDisplayable
- * @see KeyboardFocusManager#clearGlobalFocusOwner
- * @since 1.4
- */
- public boolean requestFocusInWindow() {
- return requestFocusHelper(false, false);
- }
-
- /**
- * Requests that this <code>Component</code> get the input focus,
- * if this <code>Component</code>'s
- * top-level ancestor is already the focused <code>Window</code>.
- * This component must be
- * displayable, visible, and focusable for the request to be granted. Every
- * effort will be made to honor the request; however, in some cases it may
- * be impossible to do so. Developers must never assume that this component
- * is the focus owner until this component receives a FOCUS_GAINED event.
- * <p>
- * This method returns a boolean value. If <code>false</code> is returned,
- * the request is <b>guaranteed to fail</b>. If <code>true</code> is
- * returned, the request will succeed <b>unless</b> it is vetoed, or an
- * extraordinary event, such as disposal of the component's peer, occurs
- * before the request can be granted by the native windowing system. Again,
- * while a return value of <code>true</code> indicates that the request is
- * likely to succeed, developers must never assume that this component is
- * the focus owner until this component receives a FOCUS_GAINED event.
- * <p>
- * This method cannot be used to set the focus owner to no component at
- * all. Use <code>KeyboardFocusManager.clearGlobalFocusOwner</code>
- * instead.
- * <p>
- * The focus behavior of this method can be implemented uniformly across
- * platforms, and thus developers are strongly encouraged to use this
- * method over <code>requestFocus</code> when possible. Code which relies
- * on <code>requestFocus</code> may exhibit different focus behavior on
- * different platforms.
- * <p>
- * Every effort will be made to ensure that <code>FocusEvent</code>s
- * generated as a
- * result of this request will have the specified temporary value. However,
- * because specifying an arbitrary temporary state may not be implementable
- * on all native windowing systems, correct behavior for this method can be
- * guaranteed only for lightweight components. This method is not intended
- * for general use, but exists instead as a hook for lightweight component
- * libraries, such as Swing.
- *
- * @param temporary true if the focus change is temporary,
- * such as when the window loses the focus; for
- * more information on temporary focus changes see the
- *<a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
- * @return <code>false</code> if the focus change request is guaranteed to
- * fail; <code>true</code> if it is likely to succeed
- * @see #requestFocus
- * @see java.awt.event.FocusEvent
- * @see #addFocusListener
- * @see #isFocusable
- * @see #isDisplayable
- * @see KeyboardFocusManager#clearGlobalFocusOwner
- * @since 1.4
- */
- protected boolean requestFocusInWindow(boolean temporary) {
- return requestFocusHelper(temporary, false);
- }
-
- final boolean requestFocusHelper(boolean temporary,
- boolean focusedWindowChangeAllowed) {
- if (isFocusable() && isVisible()) {
- ComponentPeer peer = this.peer;
- if (peer != null) {
- boolean recursivelyInvisible = false;
- Component window = this;
- while (!(window instanceof Window)) {
- if (!window.isVisible()) {
- recursivelyInvisible = true;
- }
- window = window.parent;
- }
- if (window == null || !((Window)window).isFocusableWindow()) {
- focusLog.finest("FAIL 1");
- return false;
- }
-
- // Update most-recent map
- KeyboardFocusManager.setMostRecentFocusOwner(this);
-
- if (recursivelyInvisible) {
- focusLog.finest("FAIL 1.5");
- return false;
- }
-
- Component heavyweight = (peer instanceof LightweightPeer)
- ? getNativeContainer() : this;
- if (heavyweight == null || !heavyweight.isVisible()) {
- focusLog.finest("FAIL 2");
- return false;
- }
- peer = heavyweight.peer;
- if (peer == null) {
- focusLog.finest("FAIL 3");
- return false;
- }
-
- // Focus this Component
- long time = EventQueue.getMostRecentEventTime();
- boolean success = peer.requestFocus
- (this, temporary, focusedWindowChangeAllowed, time);
- if (!success) {
- KeyboardFocusManager.getCurrentKeyboardFocusManager
- (appContext).dequeueKeyEvents(time, this);
- focusLog.finest("FAIL 4");
- } else {
- if (focusLog.isLoggable(Level.FINEST)) focusLog.finest("Pass for " + this);
- }
- return success;
- }
- }
- focusLog.finest("FAIL 5");
- return false;
- }
-
- final void autoTransferFocus(boolean clearOnFailure) {
- Component toTest = KeyboardFocusManager.
- getCurrentKeyboardFocusManager().getFocusOwner();
- if (toTest != this) {
- if (toTest != null) {
- toTest.autoTransferFocus(clearOnFailure);
- }
- return;
- }
-
- // the following code will execute only if this Component is the focus
- // owner
-
- if (!(isDisplayable() && isVisible() && isEnabled() && isFocusable())) {
- doAutoTransfer(clearOnFailure);
- return;
- }
-
- toTest = getParent();
-
- while (toTest != null && !(toTest instanceof Window)) {
- if (!(toTest.isDisplayable() && toTest.isVisible() &&
- (toTest.isEnabled() || toTest.isLightweight()))) {
- doAutoTransfer(clearOnFailure);
- return;
- }
- toTest = toTest.getParent();
- }
- }
- private void doAutoTransfer(boolean clearOnFailure) {
- if (clearOnFailure) {
- if (!nextFocusHelper()) {
- KeyboardFocusManager.getCurrentKeyboardFocusManager().
- clearGlobalFocusOwner();
- }
- } else {
- transferFocus();
- }
- }
-
- /**
- * Transfers the focus to the next component, as though this Component were
- * the focus owner.
- * @see #requestFocus()
- * @since JDK1.1
- */
- public void transferFocus() {
- nextFocus();
- }
-
- /**
- * Returns the Container which is the focus cycle root of this Component's
- * focus traversal cycle. Each focus traversal cycle has only a single
- * focus cycle root and each Component which is not a Container belongs to
- * only a single focus traversal cycle. Containers which are focus cycle
- * roots belong to two cycles: one rooted at the Container itself, and one
- * rooted at the Container's nearest focus-cycle-root ancestor. For such
- * Containers, this method will return the Container's nearest focus-cycle-
- * root ancestor.
- *
- * @return this Component's nearest focus-cycle-root ancestor
- * @see Container#isFocusCycleRoot()
- * @since 1.4
- */
- public Container getFocusCycleRootAncestor() {
- Container rootAncestor = this.parent;
- while (rootAncestor != null && !rootAncestor.isFocusCycleRoot()) {
- rootAncestor = rootAncestor.parent;
- }
- return rootAncestor;
- }
-
- /**
- * Returns whether the specified Container is the focus cycle root of this
- * Component's focus traversal cycle. Each focus traversal cycle has only
- * a single focus cycle root and each Component which is not a Container
- * belongs to only a single focus traversal cycle.
- *
- * @param container the Container to be tested
- * @return <code>true</code> if the specified Container is a focus-cycle-
- * root of this Component; <code>false</code> otherwise
- * @see Container#isFocusCycleRoot()
- * @since 1.4
- */
- public boolean isFocusCycleRoot(Container container) {
- Container rootAncestor = getFocusCycleRootAncestor();
- return (rootAncestor == container);
- }
-
- /**
- * @deprecated As of JDK version 1.1,
- * replaced by transferFocus().
- */
- @Deprecated
- public void nextFocus() {
- nextFocusHelper();
- }
-
- boolean nextFocusHelper() {
- Container rootAncestor = getFocusCycleRootAncestor();
- Component comp = this;
- while (rootAncestor != null &&
- !(rootAncestor.isShowing() &&
- rootAncestor.isFocusable() &&
- rootAncestor.isEnabled()))
- {
- comp = rootAncestor;
- rootAncestor = comp.getFocusCycleRootAncestor();
- }
- if (rootAncestor != null) {
- FocusTraversalPolicy policy =
- rootAncestor.getFocusTraversalPolicy();
- Component toFocus = policy.getComponentAfter(rootAncestor, comp);
- if (toFocus == null) {
- toFocus = policy.getDefaultComponent(rootAncestor);
- }
- if (toFocus != null) {
- if (focusLog.isLoggable(Level.FINER)) focusLog.finer("Next component " + toFocus);
- boolean res = toFocus.requestFocus(false);
- if (focusLog.isLoggable(Level.FINER)) focusLog.finer("Request focus returned " + res);
- return res;
- }
- }
- return false;
- }
-
- /**
- * Transfers the focus to the previous component, as though this Component
- * were the focus owner.
- * @see #requestFocus()
- * @since 1.4
- */
- public void transferFocusBackward() {
- Container rootAncestor = getFocusCycleRootAncestor();
- Component comp = this;
- while (rootAncestor != null &&
- !(rootAncestor.isShowing() &&
- rootAncestor.isFocusable() &&
- rootAncestor.isEnabled()))
- {
- comp = rootAncestor;
- rootAncestor = comp.getFocusCycleRootAncestor();
- }
- if (rootAncestor != null) {
- FocusTraversalPolicy policy =
- rootAncestor.getFocusTraversalPolicy();
- Component toFocus = policy.getComponentBefore(rootAncestor, comp);
- if (toFocus == null) {
- toFocus = policy.getDefaultComponent(rootAncestor);
- }
- if (toFocus != null) {
- toFocus.requestFocus();
- }
- }
- }
-
- /**
- * Transfers the focus up one focus traversal cycle. Typically, the focus
- * owner is set to this Component's focus cycle root, and the current focus
- * cycle root is set to the new focus owner's focus cycle root. If,
- * however, this Component's focus cycle root is a Window, then the focus
- * owner is set to the focus cycle root's default Component to focus, and
- * the current focus cycle root is unchanged.
- *
- * @see #requestFocus()
- * @see Container#isFocusCycleRoot()
- * @see Container#setFocusCycleRoot(boolean)
- * @since 1.4
- */
- public void transferFocusUpCycle() {
- Container rootAncestor;
- for (rootAncestor = getFocusCycleRootAncestor();
- rootAncestor != null && !(rootAncestor.isShowing() &&
- rootAncestor.isFocusable() &&
- rootAncestor.isEnabled());
- rootAncestor = rootAncestor.getFocusCycleRootAncestor()) {
- }
-
- if (rootAncestor != null) {
- Container rootAncestorRootAncestor =
- rootAncestor.getFocusCycleRootAncestor();
- KeyboardFocusManager.getCurrentKeyboardFocusManager().
- setGlobalCurrentFocusCycleRoot(
- (rootAncestorRootAncestor != null)
- ? rootAncestorRootAncestor
- : rootAncestor);
- rootAncestor.requestFocus();
- } else {
- Container window =
- (this instanceof Container) ? ((Container)this) : getParent();
- while (window != null && !(window instanceof Window)) {
- window = window.getParent();
- }
- if (window != null) {
- Component toFocus = window.getFocusTraversalPolicy().
- getDefaultComponent(window);
- if (toFocus != null) {
- KeyboardFocusManager.getCurrentKeyboardFocusManager().
- setGlobalCurrentFocusCycleRoot(window);
- toFocus.requestFocus();
- }
- }
- }
- }
-
- /**
- * Returns <code>true</code> if this <code>Component</code> is the
- * focus owner. This method is obsolete, and has been replaced by
- * <code>isFocusOwner()</code>.
- *
- * @return <code>true</code> if this <code>Component</code> is the
- * focus owner; <code>false</code> otherwise
- * @since 1.2
- */
- public boolean hasFocus() {
- return (KeyboardFocusManager.getCurrentKeyboardFocusManager().
- getFocusOwner() == this);
- }
-
- /**
- * Returns <code>true</code> if this <code>Component</code> is the
- * focus owner.
- *
- * @return <code>true</code> if this <code>Component</code> is the
- * focus owner; <code>false</code> otherwise
- * @since 1.4
- */
- public boolean isFocusOwner() {
- return hasFocus();
- }
-
- /**
- * Adds the specified popup menu to the component.
- * @param popup the popup menu to be added to the component.
- * @see #remove(MenuComponent)
- * @since JDK1.1
- */
- public synchronized void add(PopupMenu popup) {
- if (popup.parent != null) {
- popup.parent.remove(popup);
- }
- if (popups == null) {
- popups = new Vector();
- }
- popups.addElement(popup);
- popup.parent = this;
-
- if (peer != null) {
- if (popup.peer == null) {
- popup.addNotify();
- }
- }
- }
-
- /**
- * Removes the specified popup menu from the component.
- * @param popup the popup menu to be removed
- * @see #add(PopupMenu)
- * @since JDK1.1
- */
- public synchronized void remove(MenuComponent popup) {
- if (popups != null) {
- int index = popups.indexOf(popup);
- if (index >= 0) {
- PopupMenu pmenu = (PopupMenu)popup;
- if (pmenu.peer != null) {
- pmenu.removeNotify();
- }
- pmenu.parent = null;
- popups.removeElementAt(index);
- if (popups.size() == 0) {
- popups = null;
- }
- }
- }
- }
-
- /**
- * Returns a string representing the state of this component. This
- * method is intended to be used only for debugging purposes, and the
- * content and format of the returned string may vary between
- * implementations. The returned string may be empty but may not be
- * <code>null</code>.
- *
- * @return a string representation of this component's state
- * @since JDK1.0
- */
- protected String paramString() {
- String thisName = getName();
- String str = (thisName != null? thisName : "") + "," + x + "," + y + "," + width + "x" + height;
- if (!valid) {
- str += ",invalid";
- }
- if (!visible) {
- str += ",hidden";
- }
- if (!enabled) {
- str += ",disabled";
- }
- return str;
- }
-
- /**
- * Returns a string representation of this component and its values.
- * @return a string representation of this component
- * @since JDK1.0
- */
- public String toString() {
- return getClass().getName() + "[" + paramString() + "]";
- }
-
- /**
- * Prints a listing of this component to the standard system output
- * stream <code>System.out</code>.
- * @see java.lang.System#out
- * @since JDK1.0
- */
- public void list() {
- list(System.out, 0);
- }
-
- /**
- * Prints a listing of this component to the specified output
- * stream.
- * @param out a print stream
- * @since JDK1.0
- */
- public void list(PrintStream out) {
- list(out, 0);
- }
-
- /**
- * Prints out a list, starting at the specified indentation, to the
- * specified print stream.
- * @param out a print stream
- * @param indent number of spaces to indent
- * @see java.io.PrintStream#println(java.lang.Object)
- * @since JDK1.0
- */
- public void list(PrintStream out, int indent) {
- for (int i = 0 ; i < indent ; i++) {
- out.print(" ");
- }
- out.println(this);
- }
-
- /**
- * Prints a listing to the specified print writer.
- * @param out the print writer to print to
- * @since JDK1.1
- */
- public void list(PrintWriter out) {
- list(out, 0);
- }
-
- /**
- * Prints out a list, starting at the specified indentation, to
- * the specified print writer.
- * @param out the print writer to print to
- * @param indent the number of spaces to indent
- * @see java.io.PrintStream#println(java.lang.Object)
- * @since JDK1.1
- */
- public void list(PrintWriter out, int indent) {
- for (int i = 0 ; i < indent ; i++) {
- out.print(" ");
- }
- out.println(this);
- }
-
- /*
- * Fetches the native container somewhere higher up in the component
- * tree that contains this component.
- */
- Container getNativeContainer() {
- Container p = parent;
- while (p != null && p.peer instanceof LightweightPeer) {
- p = p.getParent();
- }
- return p;
- }
-
- /**
- * Adds a PropertyChangeListener to the listener list. The listener is
- * registered for all bound properties of this class, including the
- * following:
- * <ul>
- * <li>this Component's font ("font")</li>
- * <li>this Component's background color ("background")</li>
- * <li>this Component's foreground color ("foreground")</li>
- * <li>this Component's focusability ("focusable")</li>
- * <li>this Component's focus traversal keys enabled state
- * ("focusTraversalKeysEnabled")</li>
- * <li>this Component's Set of FORWARD_TRAVERSAL_KEYS
- * ("forwardFocusTraversalKeys")</li>
- * <li>this Component's Set of BACKWARD_TRAVERSAL_KEYS
- * ("backwardFocusTraversalKeys")</li>
- * <li>this Component's Set of UP_CYCLE_TRAVERSAL_KEYS
- * ("upCycleFocusTraversalKeys")</li>
- * <li>this Component's preferred size ("preferredSize")</li>
- * <li>this Component's minimum size ("minimumSize")</li>
- * <li>this Component's maximum size ("maximumSize")</li>
- * <li>this Component's name ("name")</li>
- * </ul>
- * Note that if this <code>Component</code> is inheriting a bound property, then no
- * event will be fired in response to a change in the inherited property.
- * <p>
- * If <code>listener</code> is <code>null</code>,
- * no exception is thrown and no action is performed.
- *
- * @param listener the property change listener to be added
- *
- * @see #removePropertyChangeListener
- * @see #getPropertyChangeListeners
- * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
- */
- public synchronized void addPropertyChangeListener(
- PropertyChangeListener listener) {
- if (listener == null) {
- return;
- }
- if (changeSupport == null) {
- changeSupport = new PropertyChangeSupport(this);
- }
- changeSupport.addPropertyChangeListener(listener);
- }
-
- /**
- * Removes a PropertyChangeListener from the listener list. This method
- * should be used to remove PropertyChangeListeners that were registered
- * for all bound properties of this class.
- * <p>
- * If listener is null, no exception is thrown and no action is performed.
- *
- * @param listener the PropertyChangeListener to be removed
- *
- * @see #addPropertyChangeListener
- * @see #getPropertyChangeListeners
- * @see #removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)
- */
- public synchronized void removePropertyChangeListener(
- PropertyChangeListener listener) {
- if (listener == null || changeSupport == null) {
- return;
- }
- changeSupport.removePropertyChangeListener(listener);
- }
-
- /**
- * Returns an array of all the property change listeners
- * registered on this component.
- *
- * @return all of this component's <code>PropertyChangeListener</code>s
- * or an empty array if no property change
- * listeners are currently registered
- *
- * @see #addPropertyChangeListener
- * @see #removePropertyChangeListener
- * @see #getPropertyChangeListeners(java.lang.String)
- * @see java.beans.PropertyChangeSupport#getPropertyChangeListeners
- * @since 1.4
- */
- public synchronized PropertyChangeListener[] getPropertyChangeListeners() {
- if (changeSupport == null) {
- return new PropertyChangeListener[0];
- }
- return changeSupport.getPropertyChangeListeners();
- }
-
- /**
- * Adds a PropertyChangeListener to the listener list for a specific
- * property. The specified property may be user-defined, or one of the
- * following:
- * <ul>
- * <li>this Component's font ("font")</li>
- * <li>this Component's background color ("background")</li>
- * <li>this Component's foreground color ("foreground")</li>
- * <li>this Component's focusability ("focusable")</li>
- * <li>this Component's focus traversal keys enabled state
- * ("focusTraversalKeysEnabled")</li>
- * <li>this Component's Set of FORWARD_TRAVERSAL_KEYS
- * ("forwardFocusTraversalKeys")</li>
- * <li>this Component's Set of BACKWARD_TRAVERSAL_KEYS
- * ("backwardFocusTraversalKeys")</li>
- * <li>this Component's Set of UP_CYCLE_TRAVERSAL_KEYS
- * ("upCycleFocusTraversalKeys")</li>
- * </ul>
- * Note that if this <code>Component</code> is inheriting a bound property, then no
- * event will be fired in response to a change in the inherited property.
- * <p>
- * If <code>propertyName</code> or <code>listener</code> is <code>null</code>,
- * no exception is thrown and no action is taken.
- *
- * @param propertyName one of the property names listed above
- * @param listener the property change listener to be added
- *
- * @see #removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
- * @see #getPropertyChangeListeners(java.lang.String)
- * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
- */
- public synchronized void addPropertyChangeListener(
- String propertyName,
- PropertyChangeListener listener) {
- if (listener == null) {
- return;
- }
- if (changeSupport == null) {
- changeSupport = new PropertyChangeSupport(this);
- }
- changeSupport.addPropertyChangeListener(propertyName, listener);
- }
-
- /**
- * Removes a <code>PropertyChangeListener</code> from the listener
- * list for a specific property. This method should be used to remove
- * <code>PropertyChangeListener</code>s
- * that were registered for a specific bound property.
- * <p>
- * If <code>propertyName</code> or <code>listener</code> is <code>null</code>,
- * no exception is thrown and no action is taken.
- *
- * @param propertyName a valid property name
- * @param listener the PropertyChangeListener to be removed
- *
- * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
- * @see #getPropertyChangeListeners(java.lang.String)
- * @see #removePropertyChangeListener(java.beans.PropertyChangeListener)
- */
- public synchronized void removePropertyChangeListener(
- String propertyName,
- PropertyChangeListener listener) {
- if (listener == null || changeSupport == null) {
- return;
- }
- changeSupport.removePropertyChangeListener(propertyName, listener);
- }
-
- /**
- * Returns an array of all the listeners which have been associated
- * with the named property.
- *
- * @return all of the <code>PropertyChangeListener</code>s associated with
- * the named property; if no such listeners have been added or
- * if <code>propertyName</code> is <code>null</code>, an empty
- * array is returned
- *
- * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
- * @see #removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
- * @see #getPropertyChangeListeners
- * @since 1.4
- */
- public synchronized PropertyChangeListener[] getPropertyChangeListeners(
- String propertyName) {
- if (changeSupport == null) {
- return new PropertyChangeListener[0];
- }
- return changeSupport.getPropertyChangeListeners(propertyName);
- }
-
- /**
- * Support for reporting bound property changes for Object properties.
- * This method can be called when a bound property has changed and it will
- * send the appropriate PropertyChangeEvent to any registered
- * PropertyChangeListeners.
- *
- * @param propertyName the property whose value has changed
- * @param oldValue the property's previous value
- * @param newValue the property's new value
- */
- protected void firePropertyChange(String propertyName,
- Object oldValue, Object newValue) {
- PropertyChangeSupport changeSupport = this.changeSupport;
- if (changeSupport == null ||
- (oldValue != null && newValue != null && oldValue.equals(newValue))) {
- return;
- }
- changeSupport.firePropertyChange(propertyName, oldValue, newValue);
- }
-
- /**
- * Support for reporting bound property changes for boolean properties.
- * This method can be called when a bound property has changed and it will
- * send the appropriate PropertyChangeEvent to any registered
- * PropertyChangeListeners.
- *
- * @param propertyName the property whose value has changed
- * @param oldValue the property's previous value
- * @param newValue the property's new value
- */
- protected void firePropertyChange(String propertyName,
- boolean oldValue, boolean newValue) {
- PropertyChangeSupport changeSupport = this.changeSupport;
- if (changeSupport == null || oldValue == newValue) {
- return;
- }
- changeSupport.firePropertyChange(propertyName, oldValue, newValue);
- }
-
- /**
- * Support for reporting bound property changes for integer properties.
- * This method can be called when a bound property has changed and it will
- * send the appropriate PropertyChangeEvent to any registered
- * PropertyChangeListeners.
- *
- * @param propertyName the property whose value has changed
- * @param oldValue the property's previous value
- * @param newValue the property's new value
- */
- protected void firePropertyChange(String propertyName,
- int oldValue, int newValue) {
- PropertyChangeSupport changeSupport = this.changeSupport;
- if (changeSupport == null || oldValue == newValue) {
- return;
- }
- changeSupport.firePropertyChange(propertyName, oldValue, newValue);
- }
-
- /**
- * Reports a bound property change.
- *
- * @param propertyName the programmatic name of the property
- * that was changed
- * @param oldValue the old value of the property (as a byte)
- * @param newValue the new value of the property (as a byte)
- * @see #firePropertyChange(java.lang.String, java.lang.Object,
- * java.lang.Object)
- * @since 1.5
- */
- public void firePropertyChange(String propertyName, byte oldValue, byte newValue) {
- if (changeSupport == null || oldValue == newValue) {
- return;
- }
- firePropertyChange(propertyName, new Byte(oldValue), new Byte(newValue));
- }
-
- /**
- * Reports a bound property change.
- *
- * @param propertyName the programmatic name of the property
- * that was changed
- * @param oldValue the old value of the property (as a char)
- * @param newValue the new value of the property (as a char)
- * @see #firePropertyChange(java.lang.String, java.lang.Object,
- * java.lang.Object)
- * @since 1.5
- */
- public void firePropertyChange(String propertyName, char oldValue, char newValue) {
- if (changeSupport == null || oldValue == newValue) {
- return;
- }
- firePropertyChange(propertyName, new Character(oldValue), new Character(newValue));
- }
-
- /**
- * Reports a bound property change.
- *
- * @param propertyName the programmatic name of the property
- * that was changed
- * @param oldValue the old value of the property (as a short)
- * @param newValue the old value of the property (as a short)
- * @see #firePropertyChange(java.lang.String, java.lang.Object,
- * java.lang.Object)
- * @since 1.5
- */
- public void firePropertyChange(String propertyName, short oldValue, short newValue) {
- if (changeSupport == null || oldValue == newValue) {
- return;
- }
- firePropertyChange(propertyName, new Short(oldValue), new Short(newValue));
- }
-
-
- /**
- * Reports a bound property change.
- *
- * @param propertyName the programmatic name of the property
- * that was changed
- * @param oldValue the old value of the property (as a long)
- * @param newValue the new value of the property (as a long)
- * @see #firePropertyChange(java.lang.String, java.lang.Object,
- * java.lang.Object)
- * @since 1.5
- */
- public void firePropertyChange(String propertyName, long oldValue, long newValue) {
- if (changeSupport == null || oldValue == newValue) {
- return;
- }
- firePropertyChange(propertyName, new Long(oldValue), new Long(newValue));
- }
-
- /**
- * Reports a bound property change.
- *
- * @param propertyName the programmatic name of the property
- * that was changed
- * @param oldValue the old value of the property (as a float)
- * @param newValue the new value of the property (as a float)
- * @see #firePropertyChange(java.lang.String, java.lang.Object,
- * java.lang.Object)
- * @since 1.5
- */
- public void firePropertyChange(String propertyName, float oldValue, float newValue) {
- if (changeSupport == null || oldValue == newValue) {
- return;
- }
- firePropertyChange(propertyName, new Float(oldValue), new Float(newValue));
- }
-
- /**
- * Reports a bound property change.
- *
- * @param propertyName the programmatic name of the property
- * that was changed
- * @param oldValue the old value of the property (as a double)
- * @param newValue the new value of the property (as a double)
- * @see #firePropertyChange(java.lang.String, java.lang.Object,
- * java.lang.Object)
- * @since 1.5
- */
- public void firePropertyChange(String propertyName, double oldValue, double newValue) {
- if (changeSupport == null || oldValue == newValue) {
- return;
- }
- firePropertyChange(propertyName, new Double(oldValue), new Double(newValue));
- }
-
-
- // Serialization support.
-
- /**
- * Component Serialized Data Version.
- *
- * @serial
- */
- private int componentSerializedDataVersion = 4;
-
- /**
- * This hack is for Swing serialization. It will invoke
- * the Swing package private method <code>compWriteObjectNotify</code>.
- */
- private void doSwingSerialization() {
- Package swingPackage = Package.getPackage("javax.swing");
- // Find the first Swing class. Swing classes MUST be loaded by
- // the bootstrap class loader, otherwise we don't consider them.
- Class klass = Component.this.getClass();
- while (klass != null && klass.getPackage() != swingPackage &&
- klass.getClassLoader() == null) {
- klass = klass.getSuperclass();
- }
- while (klass != null && klass.getClassLoader() == null) {
- if (klass.getPackage() == swingPackage) {
- final Class swingClass = klass;
- // Find the first override of the compWriteObjectNotify method
- Method[] methods = (Method[])AccessController.doPrivileged(
- new PrivilegedAction() {
- public Object run() {
- return swingClass.getDeclaredMethods();
- }
- });
- for (int counter = methods.length - 1; counter >= 0;
- counter--) {
- final Method method = methods[counter];
- if (method.getName().equals("compWriteObjectNotify")){
- // We found it, use doPrivileged to make it accessible
- // to use.
- AccessController.doPrivileged(new PrivilegedAction() {
- public Object run() {
- method.setAccessible(true);
- return null;
- }
- });
- // Invoke the method
- try {
- method.invoke(this, null);
- } catch (IllegalAccessException iae) {
- } catch (InvocationTargetException ite) {
- }
- // We're done, bail.
- return;
- }
- }
- }
- klass = klass.getSuperclass();
- }
- }
-
- /**
- * Writes default serializable fields to stream. Writes
- * a variety of serializable listeners as optional data.
- * The non-serializable listeners are detected and
- * no attempt is made to serialize them.
- *
- * @param s the <code>ObjectOutputStream</code> to write
- * @serialData <code>null</code> terminated sequence of
- * 0 or more pairs; the pair consists of a <code>String</code>
- * and an <code>Object</code> the <code>String</code> indicates
- * the type of object and is one of the following (as of 1.4):
- * <code>componentListenerK</code> indicating an
- * <code>ComponentListener</code> object;
- * <code>focusListenerK</code> indicating an
- * <code>FocusListener</code> object;
- * <code>keyListenerK</code> indicating an
- * <code>KeyListener</code> object;
- * <code>mouseListenerK</code> indicating an
- * <code>MouseListener</code> object;
- * <code>mouseMotionListenerK</code> indicating an
- * <code>MouseMotionListener</code> object;
- * <code>inputListenerK</code> indicating an
- * <code>InputListener</code> object;
- * <code>hierarchyListenerK</code> indicating an
- * <code>HierarchyListener</code> object;
- * <code>hierarchyBoundsListenerK</code> indicating an
- * <code>HierarchyBoundsListener</code> object;
- * <code>mouseWheelListenerK</code> indicating an
- * <code>MouseWheelListener</code> object
- * @serialData an optional <code>ComponentOrientation</code>
- * (after <code>inputMethodListener</code>, as of 1.2)
- *
- * @see AWTEventMulticaster#save(java.io.ObjectOutputStream, java.lang.String, java.util.EventListener)
- * @see #componentListenerK
- * @see #focusListenerK
- * @see #keyListenerK
- * @see #mouseListenerK
- * @see #mouseMotionListenerK
- * @see #inputListenerK
- * @see #hierarchyListenerK
- * @see #hierarchyBoundsListenerK
- * @see #mouseWheelListenerK
- * @see #readObject(ObjectInputStream)
- */
- private void writeObject(ObjectOutputStream s)
- throws IOException
- {
- doSwingSerialization();
-
- s.defaultWriteObject();
-
- AWTEventMulticaster.save(s, componentListenerK, componentListener);
- AWTEventMulticaster.save(s, focusListenerK, focusListener);
- AWTEventMulticaster.save(s, keyListenerK, keyListener);
- AWTEventMulticaster.save(s, mouseListenerK, mouseListener);
- AWTEventMulticaster.save(s, mouseMotionListenerK, mouseMotionListener);
- AWTEventMulticaster.save(s, inputMethodListenerK, inputMethodListener);
-
- s.writeObject(null);
- s.writeObject(componentOrientation);
-
- AWTEventMulticaster.save(s, hierarchyListenerK, hierarchyListener);
- AWTEventMulticaster.save(s, hierarchyBoundsListenerK,
- hierarchyBoundsListener);
- s.writeObject(null);
-
- AWTEventMulticaster.save(s, mouseWheelListenerK, mouseWheelListener);
- s.writeObject(null);
-
- }
-
- /**
- * Reads the <code>ObjectInputStream</code> and if it isn't
- * <code>null</code> adds a listener to receive a variety
- * of events fired by the component.
- * Unrecognized keys or values will be ignored.
- *
- * @param s the <code>ObjectInputStream</code> to read
- * @see #writeObject(ObjectOutputStream)
- */
- private void readObject(ObjectInputStream s)
- throws ClassNotFoundException, IOException
- {
- s.defaultReadObject();
-
- privateKey = new Object();
- appContext = AppContext.getAppContext();
-
- if (componentSerializedDataVersion < 4) {
- // These fields are non-transient and rely on default
- // serialization. However, the default values are insufficient,
- // so we need to set them explicitly for object data streams prior
- // to 1.4.
- focusable = true;
- isFocusTraversableOverridden = FOCUS_TRAVERSABLE_UNKNOWN;
- initializeFocusTraversalKeys();
- focusTraversalKeysEnabled = true;
- }
-
- Object keyOrNull;
- while(null != (keyOrNull = s.readObject())) {
- String key = ((String)keyOrNull).intern();
-
- if (componentListenerK == key)
- addComponentListener((ComponentListener)(s.readObject()));
-
- else if (focusListenerK == key)
- addFocusListener((FocusListener)(s.readObject()));
-
- else if (keyListenerK == key)
- addKeyListener((KeyListener)(s.readObject()));
-
- else if (mouseListenerK == key)
- addMouseListener((MouseListener)(s.readObject()));
-
- else if (mouseMotionListenerK == key)
- addMouseMotionListener((MouseMotionListener)(s.readObject()));
-
- else if (inputMethodListenerK == key)
- addInputMethodListener((InputMethodListener)(s.readObject()));
-
- else // skip value for unrecognized key
- s.readObject();
-
- }
-
- // Read the component's orientation if it's present
- Object orient = null;
-
- try {
- orient = s.readObject();
- } catch (java.io.OptionalDataException e) {
- // JDK 1.1 instances will not have this optional data.
- // e.eof will be true to indicate that there is no more
- // data available for this object.
- // If e.eof is not true, throw the exception as it
- // might have been caused by reasons unrelated to
- // componentOrientation.
-
- if (!e.eof) {
- throw (e);
- }
- }
-
- if (orient != null) {
- componentOrientation = (ComponentOrientation)orient;
- } else {
- componentOrientation = ComponentOrientation.UNKNOWN;
- }
-
- try {
- while(null != (keyOrNull = s.readObject())) {
- String key = ((String)keyOrNull).intern();
-
- if (hierarchyListenerK == key) {
- addHierarchyListener((HierarchyListener)(s.readObject()));
- }
- else if (hierarchyBoundsListenerK == key) {
- addHierarchyBoundsListener((HierarchyBoundsListener)
- (s.readObject()));
- }
- else {
- // skip value for unrecognized key
- s.readObject();
- }
- }
- } catch (java.io.OptionalDataException e) {
- // JDK 1.1/1.2 instances will not have this optional data.
- // e.eof will be true to indicate that there is no more
- // data available for this object.
- // If e.eof is not true, throw the exception as it
- // might have been caused by reasons unrelated to
- // hierarchy and hierarchyBounds listeners.
-
- if (!e.eof) {
- throw (e);
- }
- }
-
- try {
- while (null != (keyOrNull = s.readObject())) {
- String key = ((String)keyOrNull).intern();
-
- if (mouseWheelListenerK == key) {
- addMouseWheelListener((MouseWheelListener)(s.readObject()));
- }
- else {
- // skip value for unrecognized key
- s.readObject();
- }
- }
- } catch (java.io.OptionalDataException e) {
- // pre-1.3 instances will not have this optional data.
- // e.eof will be true to indicate that there is no more
- // data available for this object.
- // If e.eof is not true, throw the exception as it
- // might have been caused by reasons unrelated to
- // mouse wheel listeners
-
- if (!e.eof) {
- throw (e);
- }
- }
-
- if (popups != null) {
- int npopups = popups.size();
- for (int i = 0 ; i < npopups ; i++) {
- PopupMenu popup = (PopupMenu)popups.elementAt(i);
- popup.parent = this;
- }
- }
- }
-
- /**
- * Sets the language-sensitive orientation that is to be used to order
- * the elements or text within this component. Language-sensitive
- * <code>LayoutManager</code> and <code>Component</code>
- * subclasses will use this property to
- * determine how to lay out and draw components.
- * <p>
- * At construction time, a component's orientation is set to
- * <code>ComponentOrientation.UNKNOWN</code>,
- * indicating that it has not been specified
- * explicitly. The UNKNOWN orientation behaves the same as
- * <code>ComponentOrientation.LEFT_TO_RIGHT</code>.
- * <p>
- * To set the orientation of a single component, use this method.
- * To set the orientation of an entire component
- * hierarchy, use
- * {@link #applyComponentOrientation applyComponentOrientation}.
- *
- * @see ComponentOrientation
- *
- * @author Laura Werner, IBM
- * @beaninfo
- * bound: true
- */
- public void setComponentOrientation(ComponentOrientation o) {
- ComponentOrientation oldValue = componentOrientation;
- componentOrientation = o;
-
- // This is a bound property, so report the change to
- // any registered listeners. (Cheap if there are none.)
- firePropertyChange("componentOrientation", oldValue, o);
-
- // This could change the preferred size of the Component.
- if (valid) {
- invalidate();
- }
- }
-
- /**
- * Retrieves the language-sensitive orientation that is to be used to order
- * the elements or text within this component. <code>LayoutManager</code>
- * and <code>Component</code>
- * subclasses that wish to respect orientation should call this method to
- * get the component's orientation before performing layout or drawing.
- *
- * @see ComponentOrientation
- *
- * @author Laura Werner, IBM
- */
- public ComponentOrientation getComponentOrientation() {
- return componentOrientation;
- }
-
- /**
- * Sets the <code>ComponentOrientation</code> property of this component
- * and all components contained within it.
- *
- * @param orientation the new component orientation of this component and
- * the components contained within it.
- * @exception NullPointerException if <code>orientation</code> is null.
- * @see #setComponentOrientation
- * @see #getComponentOrientation
- * @since 1.4
- */
- public void applyComponentOrientation(ComponentOrientation orientation) {
- if (orientation == null) {
- throw new NullPointerException();
- }
- setComponentOrientation(orientation);
- }
-
- transient NativeInLightFixer nativeInLightFixer;
-
- /**
- * Checks that this component meets the prerequesites to be focus owner:
- * - it is enabled, visible, focusable
- * - it's parents are all enabled and showing
- * - top-level window is focusable
- * - if focus cycle root has DefaultFocusTraversalPolicy then it also checks that this policy accepts
- * this component as focus owner
- * @since 1.5
- */
- final boolean canBeFocusOwner() {
- // - it is enabled, visible, focusable
- if (!(isEnabled() && isDisplayable() && isVisible() && isFocusable())) {
- return false;
- }
-
- // - it's parents are all enabled and showing
- synchronized(getTreeLock()) {
- if (parent != null) {
- return parent.canContainFocusOwner(this);
- }
- }
- return true;
- }
-
- /**
- * This odd class is to help out a native component that has been
- * embedded in a lightweight component. Moving lightweight
- * components around and changing their visibility is not seen
- * by the native window system. This is a feature for lightweights,
- * but a problem for native components that depend upon the
- * lightweights. An instance of this class listens to the lightweight
- * parents of an associated native component (the outer class).
- *
- * @author Timothy Prinzing
- */
- final class NativeInLightFixer implements ComponentListener, ContainerListener {
-
- NativeInLightFixer() {
- lightParents = new Vector();
- install(parent);
- }
-
- void install(Container parent) {
- lightParents.clear();
- Container p = parent;
- boolean isLwParentsVisible = true;
- // stash a reference to the components that are being observed so that
- // we can reliably remove ourself as a listener later.
- for (; p.peer instanceof LightweightPeer; p = p.parent) {
-
- // register listeners and stash a reference
- p.addComponentListener(this);
- p.addContainerListener(this);
- lightParents.addElement(p);
- isLwParentsVisible &= p.isVisible();
- }
- // register with the native host (native parent of associated native)
- // to get notified if the top-level lightweight is removed.
- nativeHost = p;
- p.addContainerListener(this);
-
- // kick start the fixup. Since the event isn't looked at
- // we can simulate movement notification.
- componentMoved(null);
- if (!isLwParentsVisible) {
- synchronized (getTreeLock()) {
- if (peer != null) {
- peer.hide();
- }
- }
- }
- }
-
- // --- ComponentListener -------------------------------------------
-
- /**
- * Invoked when one of the lightweight parents has been resized.
- * This doesn't change the position of the native child so it
- * is ignored.
- */
- public void componentResized(ComponentEvent e) {
- }
-
- /**
- * Invoked when one of the lightweight parents has been moved.
- * The native peer must be told of the new position which is
- * relative to the native container that is hosting the
- * lightweight components.
- */
- public void componentMoved(ComponentEvent e) {
- synchronized (getTreeLock()) {
- int nativeX = x;
- int nativeY = y;
- for(Component c = parent; (c != null) &&
- (c.peer instanceof LightweightPeer);
- c = c.parent) {
-
- nativeX += c.x;
- nativeY += c.y;
- }
- if (peer != null) {
- peer.setBounds(nativeX, nativeY, width, height,
- ComponentPeer.SET_LOCATION);
- }
- }
- }
-
- /**
- * Invoked when a lightweight parent component has been
- * shown. The associated native component must also be
- * shown if it hasn't had an overriding hide done on it.
- */
- public void componentShown(ComponentEvent e) {
- if (isShowing()) {
- synchronized (getTreeLock()) {
- if (peer != null) {
- peer.show();
- }
- }
- }
- }
-
- /**
- * Invoked when component has been hidden.
- */
- public void componentHidden(ComponentEvent e) {
- if (visible) {
- synchronized (getTreeLock()) {
- if (peer != null) {
- peer.hide();
- }
- }
- }
- }
-
- // --- ContainerListener ------------------------------------
-
- /**
- * Invoked when a component has been added to a lightweight
- * parent. This doesn't effect the native component.
- */
- public void componentAdded(ContainerEvent e) {
- }
-
- /**
- * Invoked when a lightweight parent has been removed.
- * This means the services of this listener are no longer
- * required and it should remove all references (ie
- * registered listeners).
- */
- public void componentRemoved(ContainerEvent e) {
- Component c = e.getChild();
- if (c == Component.this) {
- removeReferences();
- } else {
- int n = lightParents.size();
- for (int i = 0; i < n; i++) {
- Container p = (Container) lightParents.elementAt(i);
- if (p == c) {
- removeReferences();
- break;
- }
- }
- }
- }
-
- /**
- * Removes references to this object so it can be
- * garbage collected.
- */
- void removeReferences() {
- int n = lightParents.size();
- for (int i = 0; i < n; i++) {
- Container c = (Container) lightParents.elementAt(i);
- c.removeComponentListener(this);
- c.removeContainerListener(this);
- }
- nativeHost.removeContainerListener(this);
- lightParents.clear();
- nativeHost = null;
- }
-
- Vector lightParents;
- Container nativeHost;
- }
-
- /**
- * Returns the <code>Window</code> ancestor of the component.
- * @return Window ancestor of the component or component by itself if it is Window;
- * null, if component is not a part of window hierarchy
- */
- Window getContainingWindow() {
- return getContainingWindow(this);
- }
- /**
- * Returns the <code>Window</code> ancestor of the component <code>comp</comp>.
- * @return Window ancestor of the component or component by itself if it is Window;
- * null, if component is not a part of window hierarchy
- */
- static Window getContainingWindow(Component comp) {
- while (comp != null && !(comp instanceof Window)) {
- comp = comp.getParent();
- }
-
- return (Window)comp;
- }
-
-
-
-
-
-
-
-
-
-
-
- /**
- * Initialize JNI field and method IDs
- */
- private static native void initIDs();
-
- /*
- * --- Accessibility Support ---
- *
- * Component will contain all of the methods in interface Accessible,
- * though it won't actually implement the interface - that will be up
- * to the individual objects which extend Component.
- */
-
- AccessibleContext accessibleContext = null;
-
- /**
- * Gets the <code>AccessibleContext</code> associated
- * with this <code>Component</code>.
- * The method implemented by this base
- * class returns null. Classes that extend <code>Component</code>
- * should implement this method to return the
- * <code>AccessibleContext</code> associated with the subclass.
- *
- *
- * @return the <code>AccessibleContext</code> of this
- * <code>Component</code>
- */
- public AccessibleContext getAccessibleContext() {
- return accessibleContext;
- }
-
- /**
- * Inner class of Component used to provide default support for
- * accessibility. This class is not meant to be used directly by
- * application developers, but is instead meant only to be
- * subclassed by component developers.
- * <p>
- * The class used to obtain the accessible role for this object.
- */
- protected abstract class AccessibleAWTComponent extends AccessibleContext
- implements Serializable, AccessibleComponent {
-
- private static final long serialVersionUID = 642321655757800191L;
-
- /**
- * Though the class is abstract, this should be called by
- * all sub-classes.
- */
- protected AccessibleAWTComponent() {
- }
-
- protected ComponentListener accessibleAWTComponentHandler = null;
- protected FocusListener accessibleAWTFocusHandler = null;
-
- /**
- * Fire PropertyChange listener, if one is registered,
- * when shown/hidden..
- */
- protected class AccessibleAWTComponentHandler implements ComponentListener {
- public void componentHidden(ComponentEvent e) {
- if (accessibleContext != null) {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- AccessibleState.VISIBLE, null);
- }
- }
-
- public void componentShown(ComponentEvent e) {
- if (accessibleContext != null) {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- null, AccessibleState.VISIBLE);
- }
- }
-
- public void componentMoved(ComponentEvent e) {
- }
-
- public void componentResized(ComponentEvent e) {
- }
- } // inner class AccessibleAWTComponentHandler
-
-
- /**
- * Fire PropertyChange listener, if one is registered,
- * when focus events happen
- */
- protected class AccessibleAWTFocusHandler implements FocusListener {
- public void focusGained(FocusEvent event) {
- if (accessibleContext != null) {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- null, AccessibleState.FOCUSED);
- }
- }
- public void focusLost(FocusEvent event) {
- if (accessibleContext != null) {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- AccessibleState.FOCUSED, null);
- }
- }
- } // inner class AccessibleAWTFocusHandler
-
-
- /**
- * Adds a <code>PropertyChangeListener</code> to the listener list.
- *
- * @param listener the property change listener to be added
- */
- public void addPropertyChangeListener(PropertyChangeListener listener) {
- if (accessibleAWTComponentHandler == null) {
- accessibleAWTComponentHandler = new AccessibleAWTComponentHandler();
- Component.this.addComponentListener(accessibleAWTComponentHandler);
- }
- if (accessibleAWTFocusHandler == null) {
- accessibleAWTFocusHandler = new AccessibleAWTFocusHandler();
- Component.this.addFocusListener(accessibleAWTFocusHandler);
- }
- super.addPropertyChangeListener(listener);
- }
-
- /**
- * Remove a PropertyChangeListener from the listener list.
- * This removes a PropertyChangeListener that was registered
- * for all properties.
- *
- * @param listener The PropertyChangeListener to be removed
- */
- public void removePropertyChangeListener(PropertyChangeListener listener) {
- if (accessibleAWTComponentHandler != null) {
- Component.this.removeComponentListener(accessibleAWTComponentHandler);
- accessibleAWTComponentHandler = null;
- }
- if (accessibleAWTFocusHandler != null) {
- Component.this.removeFocusListener(accessibleAWTFocusHandler);
- accessibleAWTFocusHandler = null;
- }
- super.removePropertyChangeListener(listener);
- }
-
- // AccessibleContext methods
- //
- /**
- * Gets the accessible name of this object. This should almost never
- * return <code>java.awt.Component.getName()</code>,
- * as that generally isn't a localized name,
- * and doesn't have meaning for the user. If the
- * object is fundamentally a text object (e.g. a menu item), the
- * accessible name should be the text of the object (e.g. "save").
- * If the object has a tooltip, the tooltip text may also be an
- * appropriate String to return.
- *
- * @return the localized name of the object -- can be
- * <code>null</code> if this
- * object does not have a name
- * @see javax.accessibility.AccessibleContext#setAccessibleName
- */
- public String getAccessibleName() {
- return accessibleName;
- }
-
- /**
- * Gets the accessible description of this object. This should be
- * a concise, localized description of what this object is - what
- * is its meaning to the user. If the object has a tooltip, the
- * tooltip text may be an appropriate string to return, assuming
- * it contains a concise description of the object (instead of just
- * the name of the object - e.g. a "Save" icon on a toolbar that
- * had "save" as the tooltip text shouldn't return the tooltip
- * text as the description, but something like "Saves the current
- * text document" instead).
- *
- * @return the localized description of the object -- can be
- * <code>null</code> if this object does not have a description
- * @see javax.accessibility.AccessibleContext#setAccessibleDescription
- */
- public String getAccessibleDescription() {
- return accessibleDescription;
- }
-
- /**
- * Gets the role of this object.
- *
- * @return an instance of <code>AccessibleRole</code>
- * describing the role of the object
- * @see javax.accessibility.AccessibleRole
- */
- public AccessibleRole getAccessibleRole() {
- return AccessibleRole.AWT_COMPONENT;
- }
-
- /**
- * Gets the state of this object.
- *
- * @return an instance of <code>AccessibleStateSet</code>
- * containing the current state set of the object
- * @see javax.accessibility.AccessibleState
- */
- public AccessibleStateSet getAccessibleStateSet() {
- return Component.this.getAccessibleStateSet();
- }
-
- /**
- * Gets the <code>Accessible</code> parent of this object.
- * If the parent of this object implements <code>Accessible</code>,
- * this method should simply return <code>getParent</code>.
- *
- * @return the <code>Accessible</code> parent of this
- * object -- can be <code>null</code> if this
- * object does not have an <code>Accessible</code> parent
- */
- public Accessible getAccessibleParent() {
- if (accessibleParent != null) {
- return accessibleParent;
- } else {
- Container parent = getParent();
- if (parent instanceof Accessible) {
- return (Accessible) parent;
- }
- }
- return null;
- }
-
- /**
- * Gets the index of this object in its accessible parent.
- *
- * @return the index of this object in its parent; or -1 if this
- * object does not have an accessible parent
- * @see #getAccessibleParent
- */
- public int getAccessibleIndexInParent() {
- return Component.this.getAccessibleIndexInParent();
- }
-
- /**
- * Returns the number of accessible children in the object. If all
- * of the children of this object implement <code>Accessible</code>,
- * then this method should return the number of children of this object.
- *
- * @return the number of accessible children in the object
- */
- public int getAccessibleChildrenCount() {
- return 0; // Components don't have children
- }
-
- /**
- * Returns the nth <code>Accessible</code> child of the object.
- *
- * @param i zero-based index of child
- * @return the nth <code>Accessible</code> child of the object
- */
- public Accessible getAccessibleChild(int i) {
- return null; // Components don't have children
- }
-
- /**
- * Returns the locale of this object.
- *
- * @return the locale of this object
- */
- public Locale getLocale() {
- return Component.this.getLocale();
- }
-
- /**
- * Gets the <code>AccessibleComponent</code> associated
- * with this object if one exists.
- * Otherwise return <code>null</code>.
- *
- * @return the component
- */
- public AccessibleComponent getAccessibleComponent() {
- return this;
- }
-
-
- // AccessibleComponent methods
- //
- /**
- * Gets the background color of this object.
- *
- * @return the background color, if supported, of the object;
- * otherwise, <code>null</code>
- */
- public Color getBackground() {
- return Component.this.getBackground();
- }
-
- /**
- * Sets the background color of this object.
- * (For transparency, see <code>isOpaque</code>.)
- *
- * @param c the new <code>Color</code> for the background
- * @see Component#isOpaque
- */
- public void setBackground(Color c) {
- Component.this.setBackground(c);
- }
-
- /**
- * Gets the foreground color of this object.
- *
- * @return the foreground color, if supported, of the object;
- * otherwise, <code>null</code>
- */
- public Color getForeground() {
- return Component.this.getForeground();
- }
-
- /**
- * Sets the foreground color of this object.
- *
- * @param c the new <code>Color</code> for the foreground
- */
- public void setForeground(Color c) {
- Component.this.setForeground(c);
- }
-
- /**
- * Gets the <code>Cursor</code> of this object.
- *
- * @return the <code>Cursor</code>, if supported,
- * of the object; otherwise, <code>null</code>
- */
- public Cursor getCursor() {
- return Component.this.getCursor();
- }
-
- /**
- * Sets the <code>Cursor</code> of this object.
- *
- * @param cursor the new <code>Cursor</code> for the object
- */
- public void setCursor(Cursor cursor) {
- Component.this.setCursor(cursor);
- }
-
- /**
- * Gets the <code>Font</code> of this object.
- *
- * @return the <code>Font</code>, if supported,
- * for the object; otherwise, <code>null</code>
- */
- public Font getFont() {
- return Component.this.getFont();
- }
-
- /**
- * Sets the <code>Font</code> of this object.
- *
- * @param f the new <code>Font</code> for the object
- */
- public void setFont(Font f) {
- Component.this.setFont(f);
- }
-
- /**
- * Gets the <code>FontMetrics</code> of this object.
- *
- * @param f the <code>Font</code>
- * @return the <code>FontMetrics</code>, if supported,
- * the object; otherwise, <code>null</code>
- * @see #getFont
- */
- public FontMetrics getFontMetrics(Font f) {
- if (f == null) {
- return null;
- } else {
- return Component.this.getFontMetrics(f);
- }
- }
-
- /**
- * Determines if the object is enabled.
- *
- * @return true if object is enabled; otherwise, false
- */
- public boolean isEnabled() {
- return Component.this.isEnabled();
- }
-
- /**
- * Sets the enabled state of the object.
- *
- * @param b if true, enables this object; otherwise, disables it
- */
- public void setEnabled(boolean b) {
- boolean old = Component.this.isEnabled();
- Component.this.setEnabled(b);
- if (b != old) {
- if (accessibleContext != null) {
- if (b) {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- null, AccessibleState.ENABLED);
- } else {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- AccessibleState.ENABLED, null);
- }
- }
- }
- }
-
- /**
- * Determines if the object is visible. Note: this means that the
- * object intends to be visible; however, it may not in fact be
- * showing on the screen because one of the objects that this object
- * is contained by is not visible. To determine if an object is
- * showing on the screen, use <code>isShowing</code>.
- *
- * @return true if object is visible; otherwise, false
- */
- public boolean isVisible() {
- return Component.this.isVisible();
- }
-
- /**
- * Sets the visible state of the object.
- *
- * @param b if true, shows this object; otherwise, hides it
- */
- public void setVisible(boolean b) {
- boolean old = Component.this.isVisible();
- Component.this.setVisible(b);
- if (b != old) {
- if (accessibleContext != null) {
- if (b) {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- null, AccessibleState.VISIBLE);
- } else {
- accessibleContext.firePropertyChange(
- AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
- AccessibleState.VISIBLE, null);
- }
- }
- }
- }
-
- /**
- * Determines if the object is showing. This is determined by checking
- * the visibility of the object and ancestors of the object. Note:
- * this will return true even if the object is obscured by another
- * (for example, it happens to be underneath a menu that was pulled
- * down).
- *
- * @return true if object is showing; otherwise, false
- */
- public boolean isShowing() {
- return Component.this.isShowing();
- }
-
- /**
- * Checks whether the specified point is within this object's bounds,
- * where the point's x and y coordinates are defined to be relative to
- * the coordinate system of the object.
- *
- * @param p the <code>Point</code> relative to the
- * coordinate system of the object
- * @return true if object contains <code>Point</code> otherwise false
- */
- public boolean contains(Point p) {
- return Component.this.contains(p);
- }
-
- /**
- * Returns the location of the object on the screen.
- *
- * @return location of object on screen -- can be
- * <code>null</code> if this object is not on the screen
- */
- public Point getLocationOnScreen() {
- synchronized (Component.this.getTreeLock()) {
- if (Component.this.isShowing()) {
- return Component.this.getLocationOnScreen();
- } else {
- return null;
- }
- }
- }
-
- /**
- * Gets the location of the object relative to the parent in the form
- * of a point specifying the object's top-left corner in the screen's
- * coordinate space.
- *
- * @return an instance of Point representing the top-left corner of
- * the object's bounds in the coordinate space of the screen;
- * <code>null</code> if this object or its parent are not on the screen
- */
- public Point getLocation() {
- return Component.this.getLocation();
- }
-
- /**
- * Sets the location of the object relative to the parent.
- * @param p the coordinates of the object
- */
- public void setLocation(Point p) {
- Component.this.setLocation(p);
- }
-
- /**
- * Gets the bounds of this object in the form of a Rectangle object.
- * The bounds specify this object's width, height, and location
- * relative to its parent.
- *
- * @return a rectangle indicating this component's bounds;
- * <code>null</code> if this object is not on the screen
- */
- public Rectangle getBounds() {
- return Component.this.getBounds();
- }
-
- /**
- * Sets the bounds of this object in the form of a
- * <code>Rectangle</code> object.
- * The bounds specify this object's width, height, and location
- * relative to its parent.
- *
- * @param r a rectangle indicating this component's bounds
- */
- public void setBounds(Rectangle r) {
- Component.this.setBounds(r);
- }
-
- /**
- * Returns the size of this object in the form of a
- * <code>Dimension</code> object. The height field of the
- * <code>Dimension</code> object contains this objects's
- * height, and the width field of the <code>Dimension</code>
- * object contains this object's width.
- *
- * @return a <code>Dimension</code> object that indicates
- * the size of this component; <code>null</code> if
- * this object is not on the screen
- */
- public Dimension getSize() {
- return Component.this.getSize();
- }
-
- /**
- * Resizes this object so that it has width width and height.
- *
- * @param d - the dimension specifying the new size of the object
- */
- public void setSize(Dimension d) {
- Component.this.setSize(d);
- }
-
- /**
- * Returns the <code>Accessible</code> child,
- * if one exists, contained at the local
- * coordinate <code>Point</code>. Otherwise returns
- * <code>null</code>.
- *
- * @param p the point defining the top-left corner of
- * the <code>Accessible</code>, given in the
- * coordinate space of the object's parent
- * @return the <code>Accessible</code>, if it exists,
- * at the specified location; else <code>null</code>
- */
- public Accessible getAccessibleAt(Point p) {
- return null; // Components don't have children
- }
-
- /**
- * Returns whether this object can accept focus or not.
- *
- * @return true if object can accept focus; otherwise false
- */
- public boolean isFocusTraversable() {
- return Component.this.isFocusTraversable();
- }
-
- /**
- * Requests focus for this object.
- */
- public void requestFocus() {
- Component.this.requestFocus();
- }
-
- /**
- * Adds the specified focus listener to receive focus events from this
- * component.
- *
- * @param l the focus listener
- */
- public void addFocusListener(FocusListener l) {
- Component.this.addFocusListener(l);
- }
-
- /**
- * Removes the specified focus listener so it no longer receives focus
- * events from this component.
- *
- * @param l the focus listener
- */
- public void removeFocusListener(FocusListener l) {
- Component.this.removeFocusListener(l);
- }
-
- } // inner class AccessibleAWTComponent
-
-
- /**
- * Gets the index of this object in its accessible parent.
- * If this object does not have an accessible parent, returns
- * -1.
- *
- * @return the index of this object in its accessible parent
- */
- int getAccessibleIndexInParent() {
- synchronized (getTreeLock()) {
- int index = -1;
- Container parent = this.getParent();
- if (parent != null && parent instanceof Accessible) {
- Component ca[] = parent.getComponents();
- for (int i = 0; i < ca.length; i++) {
- if (ca[i] instanceof Accessible) {
- index++;
- }
- if (this.equals(ca[i])) {
- return index;
- }
- }
- }
- return -1;
- }
- }
-
- /**
- * Gets the current state set of this object.
- *
- * @return an instance of <code>AccessibleStateSet</code>
- * containing the current state set of the object
- * @see AccessibleState
- */
- AccessibleStateSet getAccessibleStateSet() {
- synchronized (getTreeLock()) {
- AccessibleStateSet states = new AccessibleStateSet();
- if (this.isEnabled()) {
- states.add(AccessibleState.ENABLED);
- }
- if (this.isFocusTraversable()) {
- states.add(AccessibleState.FOCUSABLE);
- }
- if (this.isVisible()) {
- states.add(AccessibleState.VISIBLE);
- }
- if (this.isShowing()) {
- states.add(AccessibleState.SHOWING);
- }
- if (this.isFocusOwner()) {
- states.add(AccessibleState.FOCUSED);
- }
- if (this instanceof Accessible) {
- AccessibleContext ac = ((Accessible) this).getAccessibleContext();
- if (ac != null) {
- Accessible ap = ac.getAccessibleParent();
- if (ap != null) {
- AccessibleContext pac = ap.getAccessibleContext();
- if (pac != null) {
- AccessibleSelection as = pac.getAccessibleSelection();
- if (as != null) {
- states.add(AccessibleState.SELECTABLE);
- int i = ac.getAccessibleIndexInParent();
- if (i >= 0) {
- if (as.isAccessibleChildSelected(i)) {
- states.add(AccessibleState.SELECTED);
- }
- }
- }
- }
- }
- }
- }
- if (this instanceof javax.swing.JComponent) {
- if (((javax.swing.JComponent) this).isOpaque()) {
- states.add(AccessibleState.OPAQUE);
- }
- }
- return states;
- }
- }
-
- }