public abstract class java.awt
Component


Hide details Login
Java SE 6
  
Implements: ImageObserver, MenuContainer, Serializable
Inner classes: Component.BaselineResizeBehavior, Component.FlipBufferStrategy, Component.BltBufferStrategy, Component.AccessibleAWTComponent
Extended by: Button, Canvas, Checkbox, Choice, Container, Label, List, Scrollbar, TextComponent

A component 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.

The Component class is the abstract superclass of the nonmenu-related Abstract Window Toolkit components. Class Component 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.

Serialization

It is important to note that only AWT listeners which conform to the Serializable 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 writeObject time. Developers will need, as always, to consider the implications of making an object serializable. One situation to watch out for is this:
    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");
        }
    }
 
In this example, serializing aButton by itself will cause MyApp 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 MyApp and the ActionListener being serializable one can use a nested class, as in the following example:
    import java.awt.*;
    import java.awt.event.*;
    import java.io.Serializable;

    class MyApp java.io.Serializable
    {
         BigObjectThatShouldNotBeSerializedWithAButton bigOne;
         Button aButton = new Button();

         static class MyActionListener implements ActionListener
         {
             public void actionPerformed(ActionEvent e)
             {
                 System.out.println("Hello There");
             }
         }
 
         MyApp()
         {
             aButton.addActionListener(new MyActionListener());
         }
    }
 

Note: For more information on the paint mechanisms utilitized by AWT and Swing, including information on how to write the most efficient painting code, see Painting in AWT and Swing.

For details on the focus subsystem, see How to Use the Focus Subsystem, a section in The Java Tutorial, and the Focus Specification for more information.
version1.426, 07/27/06


Fields
final public static float TOP_ALIGNMENT
Ease-of-use constant for getAlignmentY(). Specifies an alignment to the top of the component.
See also getAlignmentY
final public static float CENTER_ALIGNMENT
Ease-of-use constant for getAlignmentY and getAlignmentX. Specifies an alignment to the center of the component
See also getAlignmentX, getAlignmentY
final public static float BOTTOM_ALIGNMENT
Ease-of-use constant for getAlignmentY. Specifies an alignment to the bottom of the component.
See also getAlignmentY
final public static float LEFT_ALIGNMENT
Ease-of-use constant for getAlignmentX. Specifies an alignment to the left side of the component.
See also getAlignmentX
final public static float RIGHT_ALIGNMENT
Ease-of-use constant for getAlignmentX. Specifies an alignment to the right side of the component.
See also getAlignmentX

Constructors
protected Component()
Constructs a new component. Class Component 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 Frame object).

Methods
public boolean
action(Event evt, Object what)

deprecatedAs of JDK version 1.1, should register this component as ActionListener on component which fires action events.
public void add(PopupMenu popup)
Adds the specified popup menu to the component.
popupthe popup menu to be added to the component.
ThrowsNullPointerException: if popup is null
sinceJDK1.1
See also remove(MenuComponent)
public void addComponentListener(ComponentListener l)
Adds the specified component listener to receive component events from this component. If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe component listener
sinceJDK1.1
See also java.awt.event.ComponentEvent, java.awt.event.ComponentListener, removeComponentListener, getComponentListeners

public void addFocusListener(FocusListener l)
Adds the specified focus listener to receive focus events from this component when this component gains input focus. If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe focus listener
sinceJDK1.1
See also java.awt.event.FocusEvent, java.awt.event.FocusListener, removeFocusListener, getFocusListeners

public void addHierarchyBoundsListener(HierarchyBoundsListener l)
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 l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe hierarchy bounds listener
since1.3
See also java.awt.event.HierarchyEvent, java.awt.event.HierarchyBoundsListener, removeHierarchyBoundsListener, getHierarchyBoundsListeners

public void addHierarchyListener(HierarchyListener l)
Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes. If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe hierarchy listener
since1.3
See also java.awt.event.HierarchyEvent, java.awt.event.HierarchyListener, removeHierarchyListener, getHierarchyListeners

public void addInputMethodListener(InputMethodListener l)
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 getInputMethodRequests to return an InputMethodRequests instance. If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe input method listener
since1.2
See also java.awt.event.InputMethodEvent, java.awt.event.InputMethodListener, removeInputMethodListener, getInputMethodListeners, getInputMethodRequests

public void addKeyListener(KeyListener l)
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.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe key listener.
sinceJDK1.1
See also java.awt.event.KeyEvent, java.awt.event.KeyListener, removeKeyListener, getKeyListeners

public void addMouseListener(MouseListener l)
Adds the specified mouse listener to receive mouse events from this component. If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe mouse listener
sinceJDK1.1
See also java.awt.event.MouseEvent, java.awt.event.MouseListener, removeMouseListener, getMouseListeners

public void addMouseMotionListener(MouseMotionListener l)
Adds the specified mouse motion listener to receive mouse motion events from this component. If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe mouse motion listener
sinceJDK1.1
See also java.awt.event.MouseEvent, java.awt.event.MouseMotionListener, removeMouseMotionListener, getMouseMotionListeners

public void addMouseWheelListener(MouseWheelListener l)
Adds the specified mouse wheel listener to receive mouse wheel events from this component. Containers also receive mouse wheel events from sub-components.

For information on how mouse wheel events are dispatched, see the class description for MouseWheelEvent.

If l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe mouse wheel listener
since1.4
See also java.awt.event.MouseWheelEvent, java.awt.event.MouseWheelListener, removeMouseWheelListener, getMouseWheelListeners

public void addNotify()
Makes this Component 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.
sinceJDK1.0
See also isDisplayable, removeNotify
public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list. The listener is registered for all bound properties of this class, including the following:
  • this Component's font ("font")
  • this Component's background color ("background")
  • this Component's foreground color ("foreground")
  • this Component's focusability ("focusable")
  • this Component's focus traversal keys enabled state ("focusTraversalKeysEnabled")
  • this Component's Set of FORWARD_TRAVERSAL_KEYS ("forwardFocusTraversalKeys")
  • this Component's Set of BACKWARD_TRAVERSAL_KEYS ("backwardFocusTraversalKeys")
  • this Component's Set of UP_CYCLE_TRAVERSAL_KEYS ("upCycleFocusTraversalKeys")
  • this Component's preferred size ("preferredSize")
  • this Component's minimum size ("minimumSize")
  • this Component's maximum size ("maximumSize")
  • this Component's name ("name")
Note that if this Component is inheriting a bound property, then no event will be fired in response to a change in the inherited property.

If listener is null, no exception is thrown and no action is performed.
listenerthe property change listener to be added
See also removePropertyChangeListener, getPropertyChangeListeners, addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)

public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list for a specific property. The specified property may be user-defined, or one of the following:
  • this Component's font ("font")
  • this Component's background color ("background")
  • this Component's foreground color ("foreground")
  • this Component's focusability ("focusable")
  • this Component's focus traversal keys enabled state ("focusTraversalKeysEnabled")
  • this Component's Set of FORWARD_TRAVERSAL_KEYS ("forwardFocusTraversalKeys")
  • this Component's Set of BACKWARD_TRAVERSAL_KEYS ("backwardFocusTraversalKeys")
  • this Component's Set of UP_CYCLE_TRAVERSAL_KEYS ("upCycleFocusTraversalKeys")
Note that if this Component is inheriting a bound property, then no event will be fired in response to a change in the inherited property.

If propertyName or listener is null, no exception is thrown and no action is taken.
propertyNameone of the property names listed above
listenerthe property change listener to be added
See also removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), getPropertyChangeListeners(java.lang.String), addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)

public void applyComponentOrientation(ComponentOrientation orientation)
Sets the ComponentOrientation property of this component and all components contained within it.
orientationthe new component orientation of this component and the components contained within it.
ThrowsNullPointerException: if orientation is null.
since1.4
See also setComponentOrientation, getComponentOrientation
public boolean areFocusTraversalKeysSet(int 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 false, this Component is inheriting the Set from an ancestor, or from the current KeyboardFocusManager.
idone of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
returntrue if the the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Component; false otherwise.
ThrowsIllegalArgumentException: if id is not one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
since1.4
public Rectangle
bounds()

deprecatedAs of JDK version 1.1, replaced by getBounds().
public int checkImage(Image image, ImageObserver observer)
Returns the status of the construction of a screen representation of the specified image.

This method does not cause the image to begin loading. An application must use the prepareImage method to force the loading of an image.

Information on the flags returned by this method can be found with the discussion of the ImageObserver interface.
imagethe Image object whose status is being checked
observerthe ImageObserver object to be notified as the image is being prepared
returnthe bitwise inclusive OR of ImageObserver flags indicating what information about the image is currently available
sinceJDK1.0
See also prepareImage(Image, int, int, java.awt.image.ImageObserver), checkImage(Image, int, int, java.awt.image.ImageObserver), java.awt.image.ImageObserver

public int checkImage(Image image, int width, int height, ImageObserver observer)
Returns the status of the construction of a screen representation of the specified image.

This method does not cause the image to begin loading. An application must use the prepareImage method to force the loading of an image.

The checkImage method of Component calls its peer's checkImage method to calculate the flags. If this component does not yet have a peer, the component's toolkit's checkImage method is called instead.

Information on the flags returned by this method can be found with the discussion of the ImageObserver interface.
imagethe Image object whose status is being checked
widththe width of the scaled version whose status is to be checked
heightthe height of the scaled version whose status is to be checked
observerthe ImageObserver object to be notified as the image is being prepared
returnthe bitwise inclusive OR of ImageObserver flags indicating what information about the image is currently available
sinceJDK1.0
See also prepareImage(Image, int, int, java.awt.image.ImageObserver), checkImage(Image, int, int, java.awt.image.ImageObserver), java.awt.image.ImageObserver

protected AWTEvent coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)
Potentially coalesce an event being posted with an existing event. This method is called by EventQueue.postEvent 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 null 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 null is returned.

This implementation of coalesceEvents 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 RepaintArea in the peer. The new AWTEvent is always returned.
existingEventthe event already on the EventQueue
newEventthe event being posted to the EventQueue
returna coalesced event, or null indicating that no coalescing was done

public boolean contains(int x, int y)
Checks whether this component "contains" the specified point, where x and y are defined to be relative to the coordinate system of this component.
xthe x coordinate of the point
ythe y coordinate of the point
sinceJDK1.1
See also getComponentAt(int, int)
public boolean contains(Point p)
Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component.
pthe point
sinceJDK1.1
See also getComponentAt(Point)
public Image createImage(ImageProducer producer)
Creates an image from the specified image producer.
producerthe image producer
returnthe image produced
sinceJDK1.0
public Image createImage(int width, int height)
Creates an off-screen drawable image to be used for double buffering.
widththe specified width
heightthe specified height
returnan off-screen drawable image, which can be used for double buffering. The return value may be null if the component is not displayable. This will always happen if GraphicsEnvironment.isHeadless() returns true.
sinceJDK1.0
See also isDisplayable, isHeadless
public VolatileImage createVolatileImage(int width, int height)
Creates a volatile off-screen drawable image to be used for double buffering.
widththe specified width.
heightthe specified height.
returnan off-screen drawable image, which can be used for double buffering. The return value may be null if the component is not displayable. This will always happen if GraphicsEnvironment.isHeadless() returns true.
since1.4
See also java.awt.image.VolatileImage, isDisplayable, isHeadless
public VolatileImage createVolatileImage(int width, int height, ImageCapabilities caps) throws AWTException
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 VolatileImage interface.
widththe specified width.
heightthe specified height.
capsthe image capabilities
ThrowsAWTException: if an image with the specified capabilities cannot be created
returna VolatileImage object, which can be used to manage surface contents loss and capabilities.
since1.4
See also java.awt.image.VolatileImage
public void
deliverEvent(Event e)

deprecatedAs of JDK version 1.1, replaced by dispatchEvent(AWTEvent e).
public void
disable()

deprecatedAs of JDK version 1.1, replaced by setEnabled(boolean).
final protected void disableEvents(long eventsToDisable)
Disables the events defined by the specified event mask parameter from being delivered to this component.
eventsToDisablethe event mask defining the event types
sinceJDK1.1
See also enableEvents
final public void dispatchEvent(AWTEvent e)
Dispatches an event to this component or one of its sub components. Calls processEvent before returning for 1.1-style events which have been enabled for the Component.
ethe event
public void doLayout()
Prompts the layout manager to lay out this component. This is usually called when the component (more specifically, container) is validated.
See also validate, java.awt.LayoutManager
public void
enable()

deprecatedAs of JDK version 1.1, replaced by setEnabled(boolean).
public void
enable(boolean b)

deprecatedAs of JDK version 1.1, replaced by setEnabled(boolean).
final protected void enableEvents(long eventsToEnable)
Enables the events defined by the specified event mask parameter to be delivered to this component.

Event types are automatically enabled when a listener for that event type is added to the component.

This method only needs to be invoked by subclasses of Component which desire to have the specified event types delivered to processEvent regardless of whether or not a listener is registered.
eventsToEnablethe event mask defining the event types
sinceJDK1.1
See also processEvent, disableEvents, java.awt.AWTEvent

public void enableInputMethods(boolean enable)
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.
enabletrue to enable, false to disable
since1.2
See also processKeyEvent
protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
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.
propertyNamethe property whose value has changed
oldValuethe property's previous value
newValuethe property's new value
protected void firePropertyChange(String propertyName, boolean oldValue, boolean 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.
propertyNamethe property whose value has changed
oldValuethe property's previous value
newValuethe property's new value
since1.4
protected void firePropertyChange(String propertyName, int oldValue, int 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.
propertyNamethe property whose value has changed
oldValuethe property's previous value
newValuethe property's new value
since1.4
public void firePropertyChange(String propertyName, byte oldValue, byte newValue)
Reports a bound property change.
propertyNamethe programmatic name of the property that was changed
oldValuethe old value of the property (as a byte)
newValuethe new value of the property (as a byte)
since1.5
See also firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)
public void firePropertyChange(String propertyName, char oldValue, char newValue)
Reports a bound property change.
propertyNamethe programmatic name of the property that was changed
oldValuethe old value of the property (as a char)
newValuethe new value of the property (as a char)
since1.5
See also firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)
public void firePropertyChange(String propertyName, short oldValue, short newValue)
Reports a bound property change.
propertyNamethe programmatic name of the property that was changed
oldValuethe old value of the property (as a short)
newValuethe old value of the property (as a short)
since1.5
See also firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)
public void firePropertyChange(String propertyName, long oldValue, long newValue)
Reports a bound property change.
propertyNamethe programmatic name of the property that was changed
oldValuethe old value of the property (as a long)
newValuethe new value of the property (as a long)
since1.5
See also firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)
public void firePropertyChange(String propertyName, float oldValue, float newValue)
Reports a bound property change.
propertyNamethe programmatic name of the property that was changed
oldValuethe old value of the property (as a float)
newValuethe new value of the property (as a float)
since1.5
See also firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)
public void firePropertyChange(String propertyName, double oldValue, double newValue)
Reports a bound property change.
propertyNamethe programmatic name of the property that was changed
oldValuethe old value of the property (as a double)
newValuethe new value of the property (as a double)
since1.5
See also firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)
public boolean
gotFocus(Event evt, Object what)

deprecatedAs of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
public boolean
handleEvent(Event evt)

deprecatedAs of JDK version 1.1 replaced by processEvent(AWTEvent).
public boolean hasFocus()
Returns true if this Component is the focus owner. This method is obsolete, and has been replaced by isFocusOwner().
returntrue if this Component is the focus owner; false otherwise
since1.2
public void
hide()

deprecatedAs of JDK version 1.1, replaced by setVisible(boolean).
public boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h)
Repaints the component when the image has changed. This imageUpdate method of an ImageObserver is called when more information about an image which had been previously requested using an asynchronous routine such as the drawImage method of Graphics becomes available. See the definition of imageUpdate for more information on this method and its arguments.

The imageUpdate method of Component incrementally draws an image on the component as more of the bits of the image are available.

If the system property awt.image.incrementaldraw is missing or has the value true, 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.

Also, if incremental drawing is in effect, the value of the system property awt.image.redrawrate 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.

The interpretation of the x, y, width, and height arguments depends on the value of the infoflags argument.
imgthe image being observed
infoflagssee imageUpdate for more information
xthe x coordinate
ythe y coordinate
wthe width
hthe height
returnfalse if the infoflags indicate that the image is completely loaded; true otherwise.
sinceJDK1.0
See also java.awt.image.ImageObserver, drawImage(Image, int, int, Color, java.awt.image.ImageObserver), drawImage(Image, int, int, java.awt.image.ImageObserver), drawImage(Image, int, int, int, int, Color, java.awt.image.ImageObserver), drawImage(Image, int, int, int, int, java.awt.image.ImageObserver), imageUpdate(java.awt.Image, int, int, int, int, int)

public boolean
inside(int x, int y)

deprecatedAs of JDK version 1.1, replaced by contains(int, int).
public void invalidate()
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.
sinceJDK1.0
See also validate, doLayout, java.awt.LayoutManager
public boolean
keyDown(Event evt, int key)

deprecatedAs of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
public boolean
keyUp(Event evt, int key)

deprecatedAs of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
public void
layout()

deprecatedAs of JDK version 1.1, replaced by doLayout().
public void list()
Prints a listing of this component to the standard system output stream System.out.
sinceJDK1.0
See also out
public void list(PrintStream out)
Prints a listing of this component to the specified output stream.
outa print stream
sinceJDK1.0
public void list(PrintStream out, int indent)
Prints out a list, starting at the specified indentation, to the specified print stream.
outa print stream
indentnumber of spaces to indent
sinceJDK1.0
See also println(java.lang.Object)
public void list(PrintWriter out)
Prints a listing to the specified print writer.
outthe print writer to print to
sinceJDK1.1
public void list(PrintWriter out, int indent)
Prints out a list, starting at the specified indentation, to the specified print writer.
outthe print writer to print to
indentthe number of spaces to indent
sinceJDK1.1
See also println(java.lang.Object)
public Component
locate(int x, int y)

deprecatedAs of JDK version 1.1, replaced by getComponentAt(int, int).
public Point
location()

deprecatedAs of JDK version 1.1, replaced by getLocation().
public boolean
lostFocus(Event evt, Object what)

deprecatedAs of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
public Dimension
minimumSize()

deprecatedAs of JDK version 1.1, replaced by getMinimumSize().
public boolean
mouseDown(Event evt, int x, int y)

deprecatedAs of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
public boolean
mouseDrag(Event evt, int x, int y)

deprecatedAs of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
public boolean
mouseEnter(Event evt, int x, int y)

deprecatedAs of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
public boolean
mouseExit(Event evt, int x, int y)

deprecatedAs of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
public boolean
mouseMove(Event evt, int x, int y)

deprecatedAs of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
public boolean
mouseUp(Event evt, int x, int y)

deprecatedAs of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
public void
move(int x, int y)

deprecatedAs of JDK version 1.1, replaced by setLocation(int, int).
public void
nextFocus()

deprecatedAs of JDK version 1.1, replaced by transferFocus().
public void paint(Graphics g)
Paints this component.

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 Graphics parameter is set to the area which needs to be painted. Subclasses of Component that override this method need not call super.paint(g).

For performance reasons, Components with zero width or height aren't considered to need painting when they are first shown, and also aren't considered to need repair.

Note: For more information on the paint mechanisms utilitized by AWT and Swing, including information on how to write the most efficient painting code, see Painting in AWT and Swing.
gthe graphics context to use for painting
sinceJDK1.0
See also update

public void paintAll(Graphics g)
Paints this component and all of its subcomponents.

The origin of the graphics context, its (00) coordinate point, is the top-left corner of this component. The clipping region of the graphics context is the bounding rectangle of this component.
gthe graphics context to use for painting
sinceJDK1.0
See also paint

protected String paramString()
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 null.
returna string representation of this component's state
sinceJDK1.0
public boolean
postEvent(Event e)

deprecatedAs of JDK version 1.1, replaced by dispatchEvent(AWTEvent).
public Dimension
preferredSize()

deprecatedAs of JDK version 1.1, replaced by getPreferredSize().
public boolean prepareImage(Image image, ImageObserver observer)
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.
imagethe Image for which to prepare a screen representation
observerthe ImageObserver object to be notified as the image is being prepared
returntrue if the image has already been fully prepared; false otherwise
sinceJDK1.0
public boolean prepareImage(Image image, int width, int height, ImageObserver observer)
Prepares an image for rendering on this component at the specified width and height.

The image data is downloaded asynchronously in another thread, and an appropriately scaled screen representation of the image is generated.
imagethe instance of Image for which to prepare a screen representation
widththe width of the desired screen representation
heightthe height of the desired screen representation
observerthe ImageObserver object to be notified as the image is being prepared
returntrue if the image has already been fully prepared; false otherwise
sinceJDK1.0
See also java.awt.image.ImageObserver

public void print(Graphics g)
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.

The default implementation of this method calls the paint method.

The origin of the graphics context, its (00) coordinate point, is the top-left corner of this component. The clipping region of the graphics context is the bounding rectangle of this component.
gthe graphics context to use for printing
sinceJDK1.0
See also paint(Graphics)

public void printAll(Graphics g)
Prints this component and all of its subcomponents.

The origin of the graphics context, its (00) coordinate point, is the top-left corner of this component. The clipping region of the graphics context is the bounding rectangle of this component.
gthe graphics context to use for printing
sinceJDK1.0
See also print(Graphics)

protected void processComponentEvent(ComponentEvent e)
Processes component events occurring on this component by dispatching them to any registered ComponentListener objects.

This method is not called unless component events are enabled for this component. Component events are enabled when one of the following occurs:

  • A ComponentListener object is registered via addComponentListener.
  • Component events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.
ethe component event
sinceJDK1.1
See also java.awt.event.ComponentEvent, java.awt.event.ComponentListener, addComponentListener, enableEvents

protected void processEvent(AWTEvent e)
Processes events occurring on this component. By default this method calls the appropriate process<event type>Event method for the given class of event.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.
ethe event
sinceJDK1.1
See also processComponentEvent, processFocusEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processInputMethodEvent, processHierarchyEvent, processMouseWheelEvent

protected void processFocusEvent(FocusEvent e)
Processes focus events occurring on this component by dispatching them to any registered FocusListener objects.

This method is not called unless focus events are enabled for this component. Focus events are enabled when one of the following occurs:

  • A FocusListener object is registered via addFocusListener.
  • Focus events are enabled via enableEvents.

If focus events are enabled for a Component, the current KeyboardFocusManager determines whether or not a focus event should be dispatched to registered FocusListener objects. If the events are to be dispatched, the KeyboardFocusManager calls the Component's dispatchEvent method, which results in a call to the Component's processFocusEvent method.

If focus events are enabled for a Component, calling the Component's dispatchEvent method with a FocusEvent as the argument will result in a call to the Component's processFocusEvent method regardless of the current KeyboardFocusManager.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.
ethe focus event
sinceJDK1.1
See also java.awt.event.FocusEvent, java.awt.event.FocusListener, java.awt.KeyboardFocusManager, addFocusListener, enableEvents, dispatchEvent

protected void processHierarchyBoundsEvent(HierarchyEvent e)
Processes hierarchy bounds events occurring on this component by dispatching them to any registered HierarchyBoundsListener objects.

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:

  • An HierarchyBoundsListener object is registered via addHierarchyBoundsListener.
  • Hierarchy bounds events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.
ethe hierarchy event
since1.3
See also java.awt.event.HierarchyEvent, java.awt.event.HierarchyBoundsListener, addHierarchyBoundsListener, enableEvents

protected void processHierarchyEvent(HierarchyEvent e)
Processes hierarchy events occurring on this component by dispatching them to any registered HierarchyListener objects.

This method is not called unless hierarchy events are enabled for this component. Hierarchy events are enabled when one of the following occurs:

  • An HierarchyListener object is registered via addHierarchyListener.
  • Hierarchy events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.
ethe hierarchy event
since1.3
See also java.awt.event.HierarchyEvent, java.awt.event.HierarchyListener, addHierarchyListener, enableEvents

protected void processInputMethodEvent(InputMethodEvent e)
Processes input method events occurring on this component by dispatching them to any registered InputMethodListener objects.

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:

  • An InputMethodListener object is registered via addInputMethodListener.
  • Input method events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.
ethe input method event
since1.2
See also java.awt.event.InputMethodEvent, java.awt.event.InputMethodListener, addInputMethodListener, enableEvents

protected void processKeyEvent(KeyEvent e)
Processes key events occurring on this component by dispatching them to any registered KeyListener objects.

This method is not called unless key events are enabled for this component. Key events are enabled when one of the following occurs:

  • A KeyListener object is registered via addKeyListener.
  • Key events are enabled via enableEvents.

If key events are enabled for a Component, the current KeyboardFocusManager determines whether or not a key event should be dispatched to registered KeyListener objects. The DefaultKeyboardFocusManager will not dispatch key events to a Component that is not the focus owner or is not showing.

As of J2SE 1.4, KeyEvents are redirected to the focus owner. Please see the Focus Specification for further information.

Calling a Component's dispatchEvent method with a KeyEvent as the argument will result in a call to the Component's processKeyEvent method regardless of the current KeyboardFocusManager as long as the component is showing, focused, and enabled, and key events are enabled on it.

If the event parameter is null the behavior is unspecified and may result in an exception.
ethe key event
sinceJDK1.1
See also java.awt.event.KeyEvent, java.awt.event.KeyListener, java.awt.KeyboardFocusManager, java.awt.DefaultKeyboardFocusManager, processEvent, dispatchEvent, addKeyListener, enableEvents, isShowing

protected void processMouseEvent(MouseEvent e)
Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects.

This method is not called unless mouse events are enabled for this component. Mouse events are enabled when one of the following occurs:

  • A MouseListener object is registered via addMouseListener.
  • Mouse events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.
ethe mouse event
sinceJDK1.1
See also java.awt.event.MouseEvent, java.awt.event.MouseListener, addMouseListener, enableEvents

protected void processMouseMotionEvent(MouseEvent e)
Processes mouse motion events occurring on this component by dispatching them to any registered MouseMotionListener objects.

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:

  • A MouseMotionListener object is registered via addMouseMotionListener.
  • Mouse motion events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.
ethe mouse motion event
sinceJDK1.1
See also java.awt.event.MouseEvent, java.awt.event.MouseMotionListener, addMouseMotionListener, enableEvents

protected void processMouseWheelEvent(MouseWheelEvent e)
Processes mouse wheel events occurring on this component by dispatching them to any registered MouseWheelListener objects.

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:

  • A MouseWheelListener object is registered via addMouseWheelListener.
  • Mouse wheel events are enabled via enableEvents.

For information on how mouse wheel events are dispatched, see the class description for MouseWheelEvent.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.
ethe mouse wheel event
since1.4
See also java.awt.event.MouseWheelEvent, java.awt.event.MouseWheelListener, addMouseWheelListener, enableEvents

public void remove(MenuComponent popup)
Removes the specified popup menu from the component.
popupthe popup menu to be removed
sinceJDK1.1
See also add(PopupMenu)
public void removeComponentListener(ComponentListener l)
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 l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe component listener
sinceJDK1.1
See also java.awt.event.ComponentEvent, java.awt.event.ComponentListener, addComponentListener, getComponentListeners

public void removeFocusListener(FocusListener l)
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 l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe focus listener
sinceJDK1.1
See also java.awt.event.FocusEvent, java.awt.event.FocusListener, addFocusListener, getFocusListeners

public void removeHierarchyBoundsListener(HierarchyBoundsListener l)
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 l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe hierarchy bounds listener
since1.3
See also java.awt.event.HierarchyEvent, java.awt.event.HierarchyBoundsListener, addHierarchyBoundsListener, getHierarchyBoundsListeners

public void removeHierarchyListener(HierarchyListener l)
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 l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe hierarchy listener
since1.3
See also java.awt.event.HierarchyEvent, java.awt.event.HierarchyListener, addHierarchyListener, getHierarchyListeners

public void removeInputMethodListener(InputMethodListener l)
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 l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe input method listener
since1.2
See also java.awt.event.InputMethodEvent, java.awt.event.InputMethodListener, addInputMethodListener, getInputMethodListeners

public void removeKeyListener(KeyListener l)
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 l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe key listener
sinceJDK1.1
See also java.awt.event.KeyEvent, java.awt.event.KeyListener, addKeyListener, getKeyListeners

public void removeMouseListener(MouseListener l)
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 l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe mouse listener
sinceJDK1.1
See also java.awt.event.MouseEvent, java.awt.event.MouseListener, addMouseListener, getMouseListeners

public void removeMouseMotionListener(MouseMotionListener l)
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 l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe mouse motion listener
sinceJDK1.1
See also java.awt.event.MouseEvent, java.awt.event.MouseMotionListener, addMouseMotionListener, getMouseMotionListeners

public void removeMouseWheelListener(MouseWheelListener l)
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.

Refer to AWT Threading Issues for details on AWT's threading model.
lthe mouse wheel listener.
since1.4
See also java.awt.event.MouseWheelEvent, java.awt.event.MouseWheelListener, addMouseWheelListener, getMouseWheelListeners

public void removeNotify()
Makes this Component undisplayable by destroying it native screen resource.

This method is called by the toolkit internally and should not be called directly by programs. Code overriding this method should call super.removeNotify as the first line of the overriding method.
sinceJDK1.0
See also isDisplayable, addNotify

public void removePropertyChangeListener(PropertyChangeListener 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.

If listener is null, no exception is thrown and no action is performed.
listenerthe PropertyChangeListener to be removed
See also addPropertyChangeListener, getPropertyChangeListeners, removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)

public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list for a specific property. This method should be used to remove PropertyChangeListeners that were registered for a specific bound property.

If propertyName or listener is null, no exception is thrown and no action is taken.
propertyNamea valid property name
listenerthe PropertyChangeListener to be removed
See also addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), getPropertyChangeListeners(java.lang.String), removePropertyChangeListener(java.beans.PropertyChangeListener)

public void repaint()
Repaints this component.

If this component is a lightweight component, this method causes a call to this component's paint method as soon as possible. Otherwise, this method causes a call to this component's update method as soon as possible.

Note: For more information on the paint mechanisms utilitized by AWT and Swing, including information on how to write the most efficient painting code, see Painting in AWT and Swing.
sinceJDK1.0
See also update(Graphics)

VePaacommon noteThu Nov 26 01:11:44 PST 2009
This method is thread-safe, can be called from outside the event dispatching thread. Reference: http://java.sun.com/products/jfc/tsc/articles/threads/threads1.html
public void repaint(long tm)
Repaints the component. If this component is a lightweight component, this results in a call to paint within tm milliseconds.

Note: For more information on the paint mechanisms utilitized by AWT and Swing, including information on how to write the most efficient painting code, see Painting in AWT and Swing.
tmmaximum time in milliseconds before update
sinceJDK1.0
See also paint, update(Graphics)

public void repaint(int x, int y, int width, int height)
Repaints the specified rectangle of this component.

If this component is a lightweight component, this method causes a call to this component's paint method as soon as possible. Otherwise, this method causes a call to this component's update method as soon as possible.

Note: For more information on the paint mechanisms utilitized by AWT and Swing, including information on how to write the most efficient painting code, see Painting in AWT and Swing.
xthe x coordinate
ythe y coordinate
widththe width
heightthe height
sinceJDK1.0
See also update(Graphics)

public void repaint(long tm, int x, int y, int width, int height)
Repaints the specified rectangle of this component within tm milliseconds.

If this component is a lightweight component, this method causes a call to this component's paint method. Otherwise, this method causes a call to this component's update method.

Note: For more information on the paint mechanisms utilitized by AWT and Swing, including information on how to write the most efficient painting code, see Painting in AWT and Swing.
tmmaximum time in milliseconds before update
xthe x coordinate
ythe y coordinate
widththe width
heightthe height
sinceJDK1.0
See also update(Graphics)

public void requestFocus()
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, focusable, visible and all of its ancestors (with the exception of the top-level Window) must be visible 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.

This method cannot be used to set the focus owner to no Component at all. Use KeyboardFocusManager.clearGlobalFocusOwner() instead.

Because the focus behavior of this method is platform-dependent, developers are strongly encouraged to use requestFocusInWindow when possible.

Note: Not all focus transfers result from invoking this method. As such, a component may receive focus without this or any of the other requestFocus methods of Component being invoked.
sinceJDK1.0
See also requestFocusInWindow, java.awt.event.FocusEvent, addFocusListener, isFocusable, isDisplayable, clearGlobalFocusOwner

protected boolean requestFocus(boolean temporary)
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, focusable, visible and all of its ancestors (with the exception of the top-level Window) must be visible 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.

This method returns a boolean value. If false is returned, the request is guaranteed to fail. If true is returned, the request will succeed unless 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 true 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.

This method cannot be used to set the focus owner to no component at all. Use KeyboardFocusManager.clearGlobalFocusOwner instead.

Because the focus behavior of this method is platform-dependent, developers are strongly encouraged to use requestFocusInWindow when possible.

Every effort will be made to ensure that FocusEvents 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.

Note: Not all focus transfers result from invoking this method. As such, a component may receive focus without this or any of the other requestFocus methods of Component being invoked.
temporarytrue if the focus change is temporary, such as when the window loses the focus; for more information on temporary focus changes see the Focus Specification
returnfalse if the focus change request is guaranteed to fail; true if it is likely to succeed
since1.4
See also java.awt.event.FocusEvent, addFocusListener, isFocusable, isDisplayable, clearGlobalFocusOwner

public boolean requestFocusInWindow()
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, focusable, visible and all of its ancestors (with the exception of the top-level Window) must be visible 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.

This method returns a boolean value. If false is returned, the request is guaranteed to fail. If true is returned, the request will succeed unless 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 true 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.

This method cannot be used to set the focus owner to no Component at all. Use KeyboardFocusManager.clearGlobalFocusOwner() instead.

The focus behavior of this method can be implemented uniformly across platforms, and thus developers are strongly encouraged to use this method over requestFocus when possible. Code which relies on requestFocus may exhibit different focus behavior on different platforms.

Note: Not all focus transfers result from invoking this method. As such, a component may receive focus without this or any of the other requestFocus methods of Component being invoked.
returnfalse if the focus change request is guaranteed to fail; true if it is likely to succeed
since1.4
See also requestFocus, java.awt.event.FocusEvent, addFocusListener, isFocusable, isDisplayable, clearGlobalFocusOwner

protected boolean requestFocusInWindow(boolean temporary)
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, focusable, visible and all of its ancestors (with the exception of the top-level Window) must be visible 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.

This method returns a boolean value. If false is returned, the request is guaranteed to fail. If true is returned, the request will succeed unless 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 true 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.

This method cannot be used to set the focus owner to no component at all. Use KeyboardFocusManager.clearGlobalFocusOwner instead.

The focus behavior of this method can be implemented uniformly across platforms, and thus developers are strongly encouraged to use this method over requestFocus when possible. Code which relies on requestFocus may exhibit different focus behavior on different platforms.

Every effort will be made to ensure that FocusEvents 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.

Note: Not all focus transfers result from invoking this method. As such, a component may receive focus without this or any of the other requestFocus methods of Component being invoked.
temporarytrue if the focus change is temporary, such as when the window loses the focus; for more information on temporary focus changes see the Focus Specification
returnfalse if the focus change request is guaranteed to fail; true if it is likely to succeed
since1.4
See also requestFocus, java.awt.event.FocusEvent, addFocusListener, isFocusable, isDisplayable, clearGlobalFocusOwner

public void
reshape(int x, int y, int width, int height)

deprecatedAs of JDK version 1.1, replaced by setBounds(int, int, int, int).
public void
resize(int width, int height)

deprecatedAs of JDK version 1.1, replaced by setSize(int, int).
public void
resize(Dimension d)

deprecatedAs of JDK version 1.1, replaced by setSize(Dimension).
public void
show()

deprecatedAs of JDK version 1.1, replaced by setVisible(boolean).
public void
show(boolean b)

deprecatedAs of JDK version 1.1, replaced by setVisible(boolean).
public Dimension
size()

deprecatedAs of JDK version 1.1, replaced by getSize().
public String toString()
Returns a string representation of this component and its values.
returna string representation of this component
sinceJDK1.0
public void transferFocus()
Transfers the focus to the next component, as though this Component were the focus owner.
sinceJDK1.1
See also requestFocus()
public void transferFocusBackward()
Transfers the focus to the previous component, as though this Component were the focus owner.
since1.4
See also requestFocus()
public void transferFocusUpCycle()
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.
since1.4
See also requestFocus(), isFocusCycleRoot(), setFocusCycleRoot(boolean)
public void update(Graphics g)
Updates this component.

If this component is not a lightweight component, the AWT calls the update method in response to a call to repaint. You can assume that the background is not cleared.

The update method of Component calls this component's paint method to redraw this component. This method is commonly overridden by subclasses which need to do additional work in response to a call to repaint. Subclasses of Component that override this method should either call super.update(g), or call paint(g) directly from their update method.

The origin of the graphics context, its (00) coordinate point, is the top-left corner of this component. The clipping region of the graphics context is the bounding rectangle of this component.

Note: For more information on the paint mechanisms utilitized by AWT and Swing, including information on how to write the most efficient painting code, see Painting in AWT and Swing.
gthe specified context to use for updating
sinceJDK1.0
See also paint, repaint()

public void validate()
Ensures that this component has a valid layout. This method is primarily intended to operate on instances of Container.
sinceJDK1.0
See also invalidate, doLayout(), java.awt.LayoutManager, validate

Properties
public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this Component. The method implemented by this base class returns null. Classes that extend Component should implement this method to return the AccessibleContext associated with the subclass.
returnthe AccessibleContext of this Component
since1.3
public float getAlignmentX()
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 getAlignmentY()
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 void setBackground(Color c)
Sets the background color of this component.

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.
cthe color to become this component's color; if this parameter is null, then this component will inherit the background color of its parent
sinceJDK1.0
beaninfobound: true
See also getBackground

public Color getBackground()
Gets the background color of this component.
returnthis component's background color; if this component does not have a background color, the background color of its parent is returned
sinceJDK1.0
See also setBackground
public boolean isBackgroundSet()
Returns whether the background color has been explicitly set for this Component. If this method returns false, this Component is inheriting its background color from an ancestor.
returntrue if the background color has been explicitly set for this Component; false otherwise.
since1.4
public int getBaseline(int width, int height)
Returns the baseline. The baseline is measured from the top of the component. This method is primarily meant for LayoutManagers to align components along their baseline. A return value less than 0 indicates this component does not have a reasonable baseline and that LayoutManagers should not align this component on its baseline.

The default implementation returns -1. Subclasses that support baseline should override appropriately. If a value >= 0 is returned, then the component has a valid baseline for any size >= the minimum size and getBaselineResizeBehavior can be used to determine how the baseline changes with size.
widththe width to get the baseline for
heightthe height to get the baseline for
returnthe baseline or < 0 indicating there is no reasonable baseline
ThrowsIllegalArgumentException: if width or height is < 0
since1.6
See also getBaselineResizeBehavior, java.awt.FontMetrics

public Component.BaselineResizeBehavior getBaselineResizeBehavior()
Returns an enum indicating how the baseline of the component changes as the size changes. This method is primarily meant for layout managers and GUI builders.

The default implementation returns BaselineResizeBehavior.OTHER. Subclasses that have a baseline should override appropriately. Subclasses should never return null; if the baseline can not be calculated return BaselineResizeBehavior.OTHER. Callers should first ask for the baseline using getBaseline and if a value >= 0 is returned use this method. It is acceptable for this method to return a value other than BaselineResizeBehavior.OTHER even if getBaseline returns a value less than 0.
returnan enum indicating how the baseline changes as the component size changes
since1.6
See also getBaseline(int, int)

public void setBounds(int x, int y, int width, int height)
Moves and resizes this component. The new location of the top-left corner is specified by x and y, and the new size is specified by width and height.
xthe new x-coordinate of this component
ythe new y-coordinate of this component
widththe new width of this component
heightthe new height of this component
sinceJDK1.1
See also getBounds, setLocation(int, int), setLocation(Point), setSize(int, int), setSize(Dimension)
public void setBounds(Rectangle r)
Moves and resizes this component to conform to the new bounding rectangle r. This component's new position is specified by r.x and r.y, and its new size is specified by r.width and r.height
rthe new bounding rectangle for this component
sinceJDK1.1
See also getBounds, setLocation(int, int), setLocation(Point), setSize(int, int), setSize(Dimension)
public Rectangle getBounds()
Gets the bounds of this component in the form of a Rectangle object. The bounds specify this component's width, height, and location relative to its parent.
returna rectangle indicating this component's bounds
See also setBounds, getLocation, getSize
public Rectangle getBounds(Rectangle rv)
Stores the bounds of this component into "return value" rv and return rv. If rv is null a new Rectangle is allocated. This version of getBounds is useful if the caller wants to avoid allocating a new Rectangle object on the heap.
rvthe return value, modified to the components bounds
returnrv
public ColorModel getColorModel()
Gets the instance of ColorModel used to display the component on the output device.
returnthe color model used by this component
sinceJDK1.0
See also java.awt.image.ColorModel, getColorModel(), getColorModel()
public Component getComponentAt(int x, int y)
Determines if this component or one of its immediate subcomponents contains the (xy) location, and if so, returns the containing component. This method only looks one level deep. If the point (xy) is inside a subcomponent that itself has subcomponents, it does not go looking down the subcomponent tree.

The locate method of Component simply returns the component itself if the (xy) coordinate location is inside its bounding box, and null otherwise.
xthe x coordinate
ythe y coordinate
returnthe component or subcomponent that contains the (xy) location; null if the location is outside this component
sinceJDK1.0
See also contains(int, int)

public Component getComponentAt(Point p)
Returns the component or subcomponent that contains the specified point.
pthe point
sinceJDK1.1
See also contains
public ComponentListener[] getComponentListeners()
Returns an array of all the component listeners registered on this component.
returnall of this comonent's ComponentListeners or an empty array if no component listeners are currently registered
since1.4
See also addComponentListener, removeComponentListener
public void setComponentOrientation(ComponentOrientation o)
Sets the language-sensitive orientation that is to be used to order the elements or text within this component. Language-sensitive LayoutManager and Component subclasses will use this property to determine how to lay out and draw components.

At construction time, a component's orientation is set to ComponentOrientation.UNKNOWN, indicating that it has not been specified explicitly. The UNKNOWN orientation behaves the same as ComponentOrientation.LEFT_TO_RIGHT.

To set the orientation of a single component, use this method. To set the orientation of an entire component hierarchy, use applyComponentOrientation.
beaninfobound: true
See also java.awt.ComponentOrientation

public ComponentOrientation getComponentOrientation()
Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component. LayoutManager and Component subclasses that wish to respect orientation should call this method to get the component's orientation before performing layout or drawing.
See also java.awt.ComponentOrientation
public void setCursor(Cursor cursor)
Sets the cursor image to the specified cursor. This cursor image is displayed when the contains method for this component returns true for the current cursor location, and this Component is visible, displayable, and enabled. Setting the cursor of a Container causes that cursor to be displayed within all of the container's subcomponents, except for those that have a non-null cursor.

The method may have no visual effect if the Java platform implementation and/or the native system do not support changing the mouse cursor shape.
cursorOne of the constants defined by the Cursor class; if this parameter is null then this component will inherit the cursor of its parent
sinceJDK1.1
See also isEnabled, isShowing, getCursor, contains, createCustomCursor, java.awt.Cursor

public Cursor getCursor()
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, Cursor.DEFAULT_CURSOR is returned.
sinceJDK1.1
See also setCursor
public boolean isCursorSet()
Returns whether the cursor has been explicitly set for this Component. If this method returns false, this Component is inheriting its cursor from an ancestor.
returntrue if the cursor has been explicitly set for this Component; false otherwise.
since1.4
public boolean isDisplayable()
Determines whether this component is displayable. A component is displayable when it is connected to a native screen resource.

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.

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.
returntrue if the component is displayable, false otherwise
since1.2
See also add(Component), pack, show, remove(Component), dispose

public boolean isDoubleBuffered()
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.
returnfalse by default
public void setDropTarget(DropTarget dt)
Associate a DropTarget with this component. The Component will receive drops only if it is enabled.
dtThe DropTarget
See also isEnabled
public DropTarget getDropTarget()
Gets the DropTarget associated with this Component.
public void setEnabled(boolean b)
Enables or disables this component, depending on the value of the parameter b. An enabled component can respond to user input and generate events. Components are enabled initially by default.

Note: Disabling a lightweight component does not prevent it from receiving MouseEvents.

Note: Disabling a heavyweight container prevents all components in this container from receiving any input events. But disabling a lightweight container affects only this container.
bIf true, this component is enabled; otherwise this component is disabled
sinceJDK1.1
See also isEnabled, isLightweight

public boolean isEnabled()
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 setEnabled method.
returntrue if the component is enabled, false otherwise
sinceJDK1.0
See also setEnabled
public void setFocusable(boolean focusable)
Sets the focusable state of this Component to the specified value. This value overrides the Component's default focusability.
focusableindicates whether this Component is focusable
since1.4
beaninfobound: true
See also isFocusable
public boolean isFocusable()
Returns whether this Component can be focused.
returntrue if this Component is focusable; false otherwise.
since1.4
See also setFocusable
public boolean isFocusCycleRoot(Container container)
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.
containerthe Container to be tested
returntrue if the specified Container is a focus-cycle- root of this Component; false otherwise
since1.4
See also isFocusCycleRoot()
public Container getFocusCycleRootAncestor()
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.
returnthis Component's nearest focus-cycle-root ancestor
since1.4
See also isFocusCycleRoot()
public FocusListener[] getFocusListeners()
Returns an array of all the focus listeners registered on this component.
returnall of this component's FocusListeners or an empty array if no component listeners are currently registered
since1.4
See also addFocusListener, removeFocusListener
public boolean isFocusOwner()
Returns true if this Component is the focus owner.
returntrue if this Component is the focus owner; false otherwise
since1.4
public boolean
isFocusTraversable()

Returns whether this Component can become the focus owner.
returntrue if this Component is focusable; false otherwise
sinceJDK1.1
deprecatedAs of 1.4, replaced by isFocusable().
See also setFocusable
public void setFocusTraversalKeys(int id, Set keystrokes)
Sets the focus traversal keys for a given traversal operation for this Component.

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.
Identifier Meaning Default
KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS Normal forward keyboard traversal TAB on KEY_PRESSED, CTRL-TAB on KEY_PRESSED
KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS Normal reverse keyboard traversal SHIFT-TAB on KEY_PRESSED, CTRL-SHIFT-TAB on KEY_PRESSED
KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS Go up one focus traversal cycle none
To disable a traversal key, use an empty Set; Collections.EMPTY_SET is recommended.

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.

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.
idone of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
keystrokesthe Set of AWTKeyStroke for the specified operation
ThrowsIllegalArgumentException: 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
since1.4
beaninfobound: true
See also getFocusTraversalKeys, FORWARD_TRAVERSAL_KEYS, BACKWARD_TRAVERSAL_KEYS, UP_CYCLE_TRAVERSAL_KEYS

public Set getFocusTraversalKeys(int id)
Returns the Set of focus traversal keys for a given traversal operation for this Component. (See setFocusTraversalKeys for a full description of each key.)

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.
idone of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
returnthe Set of AWTKeyStrokes for the specified operation. The Set will be unmodifiable, and may be empty. null will never be returned.
ThrowsIllegalArgumentException: if id is not one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
since1.4
See also setFocusTraversalKeys, FORWARD_TRAVERSAL_KEYS, BACKWARD_TRAVERSAL_KEYS, UP_CYCLE_TRAVERSAL_KEYS

public void setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled)
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.
focusTraversalKeysEnabledwhether focus traversal keys are enabled for this Component
since1.4
beaninfobound: true
See also getFocusTraversalKeysEnabled, setFocusTraversalKeys, getFocusTraversalKeys
public boolean getFocusTraversalKeysEnabled()
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.
returnwhether focus traversal keys are enabled for this Component
since1.4
See also setFocusTraversalKeysEnabled, setFocusTraversalKeys, getFocusTraversalKeys
public void setFont(Font f)
Sets the font of this component.
fthe font to become this component's font; if this parameter is null then this component will inherit the font of its parent
sinceJDK1.0
beaninfobound: true
See also getFont
public Font getFont()
Gets the font of this component.
returnthis component's font; if a font has not been set for this component, the font of its parent is returned
sinceJDK1.0
See also setFont
public FontMetrics getFontMetrics(Font font)
Gets the font metrics for the specified font. Warning: Since Font metrics are affected by the FontRenderContext and this method does not provide one, it can return only metrics for the default render context which may not match that used when rendering on the Component if Graphics2D functionality is being used. Instead metrics can be obtained at rendering time by calling Graphics#getFontMetrics() or text measurement APIs on the Font class.
fontthe font for which font metrics is to be obtained
returnthe font metrics for font
sinceJDK1.0
See also getFont, getPeer, getFontMetrics(Font), getFontMetrics(Font)
public boolean isFontSet()
Returns whether the font has been explicitly set for this Component. If this method returns false, this Component is inheriting its font from an ancestor.
returntrue if the font has been explicitly set for this Component; false otherwise.
since1.4
public void setForeground(Color c)
Sets the foreground color of this component.
cthe color to become this component's foreground color; if this parameter is null then this component will inherit the foreground color of its parent
sinceJDK1.0
See also getForeground
public Color getForeground()
Gets the foreground color of this component.
returnthis component's foreground color; if this component does not have a foreground color, the foreground color of its parent is returned
sinceJDK1.0
beaninfobound: true
See also setForeground
public boolean isForegroundSet()
Returns whether the foreground color has been explicitly set for this Component. If this method returns false, this Component is inheriting its foreground color from an ancestor.
returntrue if the foreground color has been explicitly set for this Component; false otherwise.
since1.4
public Graphics getGraphics()
Creates a graphics context for this component. This method will return null if this component is currently not displayable.
returna graphics context for this component, or null if it has none
sinceJDK1.0
See also paint
public GraphicsConfiguration getGraphicsConfiguration()
Gets the GraphicsConfiguration associated with this Component. If the Component has not been assigned a specific GraphicsConfiguration, the GraphicsConfiguration of the Component object's top-level container is returned. If the Component has been created, but not yet added to a Container, this method returns null.
returnthe GraphicsConfiguration used by this Component or null
since1.3
public int getHeight()
Returns the current height of this component. This method is preferable to writing component.getBounds().height, or component.getSize().height because it doesn't cause any heap allocations.
returnthe current height of this component
since1.2
public HierarchyBoundsListener[] getHierarchyBoundsListeners()
Returns an array of all the hierarchy bounds listeners registered on this component.
returnall of this component's HierarchyBoundsListeners or an empty array if no hierarchy bounds listeners are currently registered
since1.4
See also addHierarchyBoundsListener, removeHierarchyBoundsListener
public HierarchyListener[] getHierarchyListeners()
Returns an array of all the hierarchy listeners registered on this component.
returnall of this component's HierarchyListeners or an empty array if no hierarchy listeners are currently registered
since1.4
See also addHierarchyListener, removeHierarchyListener
public void setIgnoreRepaint(boolean ignoreRepaint)
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.

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.
since1.4
See also getIgnoreRepaint, createBufferStrategy, createBufferStrategy, java.awt.image.BufferStrategy, setFullScreenWindow

public boolean getIgnoreRepaint()
returnwhether or not paint messages received from the operating system should be ignored.
since1.4
See also setIgnoreRepaint
public InputContext getInputContext()
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.
returnthe input context used by this component; null if no context can be determined
since1.2
public InputMethodListener[] getInputMethodListeners()
Returns an array of all the input method listeners registered on this component.
returnall of this component's InputMethodListeners or an empty array if no input method listeners are currently registered
since1.4
See also addInputMethodListener, removeInputMethodListener
public InputMethodRequests getInputMethodRequests()
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 InputMethodRequests instance. At the same time, it also has to handle input method events.
returnthe input method request handler for this component, null by default
since1.2
See also addInputMethodListener
public KeyListener[] getKeyListeners()
Returns an array of all the key listeners registered on this component.
returnall of this component's KeyListeners or an empty array if no key listeners are currently registered
since1.4
See also addKeyListener, removeKeyListener
public boolean isLightweight()
A lightweight component doesn't have a native toolkit peer. Subclasses of Component and Container, other than the ones defined in this package like Button or Scrollbar, are lightweight. All of the Swing components are lightweights.

This method will always return false if this component is not displayable because it is impossible to determine the weight of an undisplayable component.
returntrue if this component has a lightweight peer; false if it has a native peer or no peer
since1.2
See also isDisplayable

public EventListener[]<T> getListeners(Class listenerType)
Returns an array of all the objects currently registered as FooListeners upon this Component. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a Component c for its mouse listeners with the following code:

MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));
If no such listeners exist, this method returns an empty array.
listenerTypethe type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
returnan array of all objects registered as FooListeners on this component, or an empty array if no such listeners have been added
ThrowsClassCastException: if listenerType doesn't specify a class or interface that implements java.util.EventListener
since1.3
See also getComponentListeners, getFocusListeners, getHierarchyListeners, getHierarchyBoundsListeners, getKeyListeners, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getInputMethodListeners, getPropertyChangeListeners
public void setLocale(Locale l)
Sets the locale of this component. This is a bound property.
lthe locale to become this component's locale
sinceJDK1.1
See also getLocale
public Locale getLocale()
Gets the locale of this component.
returnthis component's locale; if this component does not have a locale, the locale of its parent is returned
ThrowsIllegalComponentStateException: if the Component 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
sinceJDK1.1
See also setLocale
public void setLocation(int x, int y)
Moves this component to a new location. The top-left corner of the new location is specified by the x and y parameters in the coordinate space of this component's parent.
xthe x-coordinate of the new location's top-left corner in the parent's coordinate space
ythe y-coordinate of the new location's top-left corner in the parent's coordinate space
sinceJDK1.1
See also getLocation, setBounds
public void setLocation(Point p)
Moves this component to a new location. The top-left corner of the new location is specified by point p. Point p is given in the parent's coordinate space.
pthe point defining the top-left corner of the new location, given in the coordinate space of this component's parent
sinceJDK1.1
See also getLocation, setBounds
public Point getLocation()
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.

Due to the asynchronous nature of native event handling, this method can return outdated values (for instance, after several calls of setLocation() in rapid succession). For this reason, the recommended method of obtaining a component's position is within java.awt.event.ComponentListener.componentMoved(), which is called after the operating system has finished moving the component.

returnan instance of Point representing the top-left corner of the component's bounds in the coordinate space of the component's parent
sinceJDK1.1
See also setLocation, getLocationOnScreen
public Point getLocation(Point rv)
Stores the x,y origin of this component into "return value" rv and return rv. If rv is null a new Point is allocated. This version of getLocation is useful if the caller wants to avoid allocating a new Point object on the heap.
rvthe return value, modified to the components location
returnrv
public Point getLocationOnScreen()
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.
returnan instance of Point representing the top-left corner of the component's bounds in the coordinate space of the screen
ThrowsIllegalComponentStateException: if the component is not showing on the screen
See also setLocation, getLocation
public void setMaximumSize(Dimension maximumSize)
Sets the maximum size of this component to a constant value. Subsequent calls to getMaximumSize will always return this value. Setting the maximum size to null restores the default behavior.
maximumSizea Dimension containing the desired maximum allowable size
since1.5
See also getMaximumSize, isMaximumSizeSet
public Dimension getMaximumSize()
Gets the maximum size of this component.
returna dimension object indicating this component's maximum size
See also getMinimumSize, getPreferredSize, java.awt.LayoutManager
public boolean isMaximumSizeSet()
Returns true if the maximum size has been set to a non-null value otherwise returns false.
returntrue if maximumSize is non-null, false otherwise
since1.5
public void setMinimumSize(Dimension minimumSize)
Sets the minimum size of this component to a constant value. Subsequent calls to getMinimumSize will always return this value. Setting the minimum size to null restores the default behavior.
minimumSizethe new minimum size of this component
since1.5
See also getMinimumSize, isMinimumSizeSet
public Dimension getMinimumSize()
Gets the mininimum size of this component.
returna dimension object indicating this component's minimum size
See also getPreferredSize, java.awt.LayoutManager
public boolean isMinimumSizeSet()
Returns whether or not setMinimumSize has been invoked with a non-null value.
returntrue if setMinimumSize has been invoked with a non-null value.
since1.5
public MouseListener[] getMouseListeners()
Returns an array of all the mouse listeners registered on this component.
returnall of this component's MouseListeners or an empty array if no mouse listeners are currently registered
since1.4
See also addMouseListener, removeMouseListener
public MouseMotionListener[] getMouseMotionListeners()
Returns an array of all the mouse motion listeners registered on this component.
returnall of this component's MouseMotionListeners or an empty array if no mouse motion listeners are currently registered
since1.4
See also addMouseMotionListener, removeMouseMotionListener
public Point getMousePosition() throws HeadlessException
Returns the position of the mouse pointer in this Component's coordinate space if the Component is directly under the mouse pointer, otherwise returns null. If the Component is not showing on the screen, this method returns null even if the mouse pointer is above the area where the Component would be displayed. If the Component is partially or fully obscured by other Components or native windows, this method returns a non-null value only if the mouse pointer is located above the unobscured part of the Component.

For Containers it returns a non-null value if the mouse is above the Container itself or above any of its descendants. Use Container#getMousePosition(boolean) if you need to exclude children.

Sometimes the exact mouse coordinates are not important, and the only thing that matters is whether a specific Component is under the mouse pointer. If the return value of this method is null, mouse pointer is not directly above the Component.
ThrowsHeadlessException: if GraphicsEnvironment.isHeadless() returns true
returnmouse coordinates relative to this Component, or null
since1.5
See also isShowing, getMousePosition

public MouseWheelListener[] getMouseWheelListeners()
Returns an array of all the mouse wheel listeners registered on this component.
returnall of this component's MouseWheelListeners or an empty array if no mouse wheel listeners are currently registered
since1.4
See also addMouseWheelListener, removeMouseWheelListener
public void setName(String name)
Sets the name of the component to the specified string.
namethe string that is to be this component's name
sinceJDK1.1
See also getName
public String getName()
Gets the name of the component.
returnthis component's name
sinceJDK1.1
See also setName
public boolean isOpaque()
Returns true if this component is completely opaque, returns false by default.

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.

Subclasses that guarantee to always completely paint their contents should override this method and return true. All of the "heavyweight" AWT components are opaque.
returntrue if this component is completely opaque
since1.2
See also isLightweight

public Container getParent()
Gets the parent of this component.
returnthe parent container of this component
sinceJDK1.0
public ComponentPeer
getPeer()

deprecatedAs of JDK version 1.1, programs should not directly manipulate peers; replaced by boolean isDisplayable().
public void setPreferredSize(Dimension preferredSize)
Sets the preferred size of this component to a constant value. Subsequent calls to getPreferredSize will always return this value. Setting the preferred size to null restores the default behavior.
preferredSizeThe new preferred size, or null
since1.5
See also getPreferredSize, isPreferredSizeSet
public Dimension getPreferredSize()
Gets the preferred size of this component.
returna dimension object indicating this component's preferred size
See also getMinimumSize, java.awt.LayoutManager
public boolean isPreferredSizeSet()
Returns true if the preferred size has been set to a non-null value otherwise returns false.
returntrue if setPreferredSize has been invoked with a non-null value.
since1.5
public PropertyChangeListener[] getPropertyChangeListeners()
Returns an array of all the property change listeners registered on this component.
returnall of this component's PropertyChangeListeners or an empty array if no property change listeners are currently registered
since1.4
See also addPropertyChangeListener, removePropertyChangeListener, getPropertyChangeListeners(java.lang.String), getPropertyChangeListeners
public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
Returns an array of all the listeners which have been associated with the named property.
returnall of the PropertyChangeListeners associated with the named property; if no such listeners have been added or if propertyName is null, an empty array is returned
since1.4
See also addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), getPropertyChangeListeners
public boolean isShowing()
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.

Note: sometimes there is no way to detect whether the Component is actually visible to the user. This can happen when:

  • the component has been added to a visible ScrollPane but the Component is not currently in the scroll pane's view port.
  • the Component is obscured by another Component or Container.
returntrue if the component is showing, false otherwise
sinceJDK1.0
See also setVisible
public void setSize(int width, int height)
Resizes this component so that it has width width and height height.
widththe new width of this component in pixels
heightthe new height of this component in pixels
sinceJDK1.1
See also getSize, setBounds
public void setSize(Dimension d)
Resizes this component so that it has width d.width and height d.height.
dthe dimension specifying the new size of this component
sinceJDK1.1
See also setSize, setBounds
public Dimension getSize()
Returns the size of this component in the form of a Dimension object. The height field of the Dimension object contains this component's height, and the width field of the Dimension object contains this component's width.
returna Dimension object that indicates the size of this component
sinceJDK1.1
See also setSize
public Dimension getSize(Dimension rv)
Stores the width/height of this component into "return value" rv and return rv. If rv is null a new Dimension object is allocated. This version of getSize is useful if the caller wants to avoid allocating a new Dimension object on the heap.
rvthe return value, modified to the components size
returnrv
public Toolkit getToolkit()
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.
returnthe toolkit of this component
sinceJDK1.0
final public Object getTreeLock()
Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations.
returnthis component's locking object
public boolean isValid()
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.
returntrue if the component is valid, false otherwise
sinceJDK1.0
See also validate, invalidate
public void setVisible(boolean b)
Shows or hides this component depending on the value of parameter b.
bif true, shows this component; otherwise, hides this component
sinceJDK1.1
See also isVisible
public boolean isVisible()
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 Frame objects.
returntrue if the component is visible, false otherwise
sinceJDK1.0
See also setVisible
public int getWidth()
Returns the current width of this component. This method is preferable to writing component.getBounds().width, or component.getSize().width because it doesn't cause any heap allocations.
returnthe current width of this component
since1.2
public int getX()
Returns the current x coordinate of the components origin. This method is preferable to writing component.getBounds().x, or component.getLocation().x because it doesn't cause any heap allocations.
returnthe current x coordinate of the components origin
since1.2
public int getY()
Returns the current y coordinate of the components origin. This method is preferable to writing component.getBounds().y, or component.getLocation().y because it doesn't cause any heap allocations.
returnthe current y coordinate of the components origin
since1.2