All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.Component

java.lang.Object
   |
   +----java.awt.Component

public class Component

extends Object

implements ImageObserver, MenuContainer, Serializable

componentListener

focusListener

keyListener

locale

The locale for the component.

LOCK

The locking object for AWT component-tree and layout operations.

mouseListener

mouseMotionListener

newEventsOnly

action(Event, Object)

DEPRECATED: Replaced by processActionEvent(KeyEvent e); Called if an action occurs in the Component.

add(PopupMenu)

Adds the specified popup menu to the component.

addComponentListener(ComponentListener)

Adds the specified component listener to receive component events from this component.

addFocusListener(FocusListener)

Adds the specified focus listener to receive focus events from this component.

addKeyListener(KeyListener)

Adds the specified key listener to receive key events from this component.

addMouseListener(MouseListener)

Adds the specified mouse listener to receive mouse events from this component.

addMouseMotionListener(MouseMotionListener)

Adds the specified mouse motion listener to receive mouse motion events from this component.

addNotify()

Notifies the Component that it has been added to a container and the peer should be created.

bounds()

DEPRECATED: Replaced by getBounds().

checkImage(Image, ImageObserver)

Returns the status of the construction of a screen representation of the specified image.

checkImage(Image, int, int, ImageObserver)

Returns the status of the construction of a scaled screen representation of the specified image.

contains(int, int)

Checks whether this component "contains" the specified (x, y) location, where x and y are defined to be relative to the coordinate system of this component.

contains(Point)

Checks whether this component "contains" the specified point, where x and y in the point are defined to be relative to the coordinate system of this component.

createImage(ImageProducer)

Creates an image from the specified image producer.

createImage(int, int)

Creates an off-screen drawable Image to be used for double buffering.

deliverEvent(Event)

DEPRECATED: replaced by dispatchEvent(AWTEvent e)

disable()

DEPRECATED: Replaced by setEnabled(boolean).

disableEvents(long)

Disables the events defined by the specified event mask parameter from being delivered to this component.

doLayout()

Lays out the component.

enable()

DEPRECATED: Replaced by setEnabled(boolean).

enable(boolean)

DEPRECATED: Replaced by setEnabled(boolean).

enableEvents(long)

Enables the events defined by the specified event mask parameter to be delivered to this component.

getBackground()

Gets the background color.

getBounds()

Returns the current bounds of this component.

getColorModel()

Gets the ColorModel used to display the component on the output device.

getComponentAt(int, int)

Returns the component or subcomponent that contains the x,y location.

getComponentAt(Point)

Returns the component or subcomponent that contains the specified point.

getCursor()

Gets the cursor set on this component.

getFont()

Gets the font of the component.

getFontMetrics(Font)

Gets the font metrics for this component.

getForeground()

Gets the foreground color.

getGraphics()

Gets a Graphics context for this component.

getLocale()

Gets the locale of the component.

getLocation()

Returns the current location of this component.

getMinimumSize()

Returns the mininimum size of this component.

getName()

Gets the name of the component.

getParent()

Gets the parent of the component.

getPeer()

DEPRECATED

getPreferredSize()

Returns the preferred size of this component.

getSize()

Returns the current size of this component.

getToolkit()

Gets the toolkit of the component.

gotFocus(Event, Object)

DEPRECATED: Replaced by processFocusEvent(FocusEvent e); Indicates that this component has received the input focus.

handleEvent(Event)

DEPRECATED: Replaced by processEvent(AWTEvent e); Handles the event.

hide()

DEPRECATED: Replaced by setVisible(boolean).

imageUpdate(Image, int, int, int, int, int)

Repaints the component when the image has changed.

inside(int, int)

DEPRECATED: Replaced by contains(int, int).

invalidate()

Invalidates the component.

isEnabled()

Checks if this Component is enabled.

isFocusTraversable()

Returns whether this component can be traversed using Tab or Shift-Tab keyboard focus traversal.

isShowing()

Checks if this Component is showing on screen.

isValid()

Checks if this Component is valid.

isVisible()

Checks if this Component is visible.

keyDown(Event, int)

DEPRECATED: Replaced by processKeyEvent(KeyEvent e); Called if a character is pressed.

keyUp(Event, int)

DEPRECATED: Replaced by processKeyEvent(KeyEvent e); Called if a character is released.

layout()

DEPRECATED: Replaced by doLayout().

list()

Prints a listing to a print stream.

list(PrintStream)

Prints a listing to the specified print out stream.

list(PrintStream, int)

Prints out a list, starting at the specified indention, to the specified print stream.

locate(int, int)

DEPRECATED: Replaced by getComponentAt(int, int).

location()

DEPRECATED: Replaced by getLocation().

lostFocus(Event, Object)

DEPRECATED: Replaced by processFocusEvent(FocusEvent e); Indicates that this component has lost the input focus.

minimumSize()

DEPRECATED: Replaced by getMinimumSize().

mouseDown(Event, int, int)

DEPRECATED: Replaced by processMouseEvent(MouseEvent e); Called if the mouse is down.

mouseDrag(Event, int, int)

DEPRECATED: Replaced by processMouseMotionEvent(MouseEvent e); Called if the mouse is dragged (the mouse button is down).

mouseEnter(Event, int, int)

DEPRECATED: Replaced by processMouseEvent(MouseEvent e); Called when the mouse enters the component.

mouseExit(Event, int, int)

DEPRECATED: Replaced by processMouseEvent(MouseEvent e); Called when the mouse exits the component.

mouseMove(Event, int, int)

DEPRECATED: Replaced by processMouseMotionEvent(MouseEvent e); Called if the mouse moves (the mouse button is up).

mouseUp(Event, int, int)

DEPRECATED: Replaced by processMouseEvent(MouseEvent e); Called if the mouse is up.

move(int, int)

DEPRECATED: Replaced by setLocation(int, int).

nextFocus()

DEPRECATED: Replaced by transferFocus().

paint(Graphics)

Paints the component.

paintAll(Graphics)

Paints the component and its subcomponents.

paramString()

Returns the parameter String of this Component.

postEvent(Event)

DEPRECATED: Replaced by dispatchEvent(AWTEvent e); Posts an event to this component.

preferredSize()

DEPRECATED: Replaced by getPreferredSize().

prepareImage(Image, ImageObserver)

Prepares an image for rendering on this Component.

prepareImage(Image, int, int, ImageObserver)

Prepares an image for rendering on this Component at the specified width and height.

print(Graphics)

Prints this component.

printAll(Graphics)

Prints the component and its subcomponents.

processComponentEvent(ComponentEvent)

Processes component events occurring on this component by dispatching them to any registered ComponentListener objects.

processEvent(AWTEvent)

Processes events occurring on this component.

processFocusEvent(FocusEvent)

Processes focus events occurring on this component by dispatching them to any registered FocusListener objects.

processKeyEvent(KeyEvent)

Processes key events occurring on this component by dispatching them to any registered KeyListener objects.

processMouseEvent(MouseEvent)

Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects.

processMouseMotionEvent(MouseEvent)

Processes mouse motion events occurring on this component by dispatching them to any registered MouseMotionListener objects.

remove(MenuComponent)

Removes the specified popup menu from the component.

removeComponentListener(ComponentListener)

Removes the specified listener so it no longer receives component events from this component.

removeFocusListener(FocusListener)

Removes the specified focus listener so it no longer receives focus events from this component.

removeKeyListener(KeyListener)

Removes the specified key listener so it no longer receives key events from this component.

removeMouseListener(MouseListener)

Removes the specified mouse listener so it no longer receives mouse events from this component.

removeMouseMotionListener(MouseMotionListener)

Removes the specified mouse motion listener so it no longer receives mouse motion events from this component.

removeNotify()

Notifies the Component that it has been removed from its container and it needs to destroy the peer.

repaint()

Repaints the component.

repaint(int, int, int, int)

Repaints part of the component.

repaint(long)

Repaints the component.

repaint(long, int, int, int, int)

Repaints part of the component.

requestFocus()

Requests the input focus.

reshape(int, int, int, int)

DEPRECATED: Replaced by setBounds(int, int, int, int).

resize(Dimension)

DEPRECATED: Replaced by setSize(Dimension).

resize(int, int)

DEPRECATED: Replaced by setSize(int, int).

setBackground(Color)

Sets the background color.

setBounds(int, int, int, int)

Reshapes the Component to the specified bounding box.

setBounds(Rectangle)

Reshapes the Component to the specified bounding box.

setCursor(Cursor)

Set the cursor image to a predefined cursor.

setEnabled(boolean)

Enables a component.

setFont(Font)

Sets the font of the component.

setForeground(Color)

Sets the foreground color.

setLocale(Locale)

Sets the locale of the component.

setLocation(int, int)

Moves the Component to a new location.

setLocation(Point)

Moves the Component to a new location.

setName(String)

Sets the name of the component to the specified string.

setSize(Dimension)

Resizes the Component to the specified dimension.

setSize(int, int)

Resizes the Component to the specified width and height.

setVisible(boolean)

Shows or hides the component depending on the boolean flag b.

show()

DEPRECATED: Replaced by setVisible(boolean).

show(boolean)

DEPRECATED: Replaced by setVisible(boolean).

size()

DEPRECATED: Replaced by getSize().

toString()

Returns the String representation of this Component's values.

transferFocus()

Transfers the focus to the next component.

update(Graphics)

Updates the component.

validate()

Ensures that a component has a valid layout.

  protected Locale locale

The locale for the component.

See Also:

getLocale

  public final static Object LOCK

The locking object for AWT component-tree and layout operations. NOTE: This may need to remain public, not only for access from peer code but also from application code that wishes to always acquire locks in the same order.

  protected boolean newEventsOnly

  protected ComponentListener componentListener

  protected FocusListener focusListener

  protected KeyListener keyListener

  protected MouseListener mouseListener

  protected MouseMotionListener mouseMotionListener

  public String getName()

Gets the name of the component.

  public void setName(String name)

Sets the name of the component to the specified string.

Parameters:

name - the name of the component.

  public Container getParent()

Gets the parent of the component.

  public ComponentPeer getPeer()

DEPRECATED

  public Toolkit getToolkit()

Gets the toolkit of the component. This toolkit is used to create the peer for this component. Note that the Frame which contains a Component controls which toolkit is used so if the Component has not yet been added to a Frame or if it is later moved to a different Frame, the toolkit it uses may change.

  public boolean isValid()

Checks if this Component is valid. Components are invalidated when they are first shown on the screen.

See Also:

validate, invalidate

  public boolean isVisible()

Checks if this Component is visible. Components are initially visible (with the exception of top level components such as Frame).

See Also:

setVisible

  public boolean isShowing()

Checks if 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.

See Also:

setVisible

  public boolean isEnabled()

Checks if this Component is enabled. Components are initially enabled.

See Also:

setEnabled

  public void setEnabled(boolean b)

Enables a component.

See Also:

isEnabled

  public void enable()

DEPRECATED: Replaced by setEnabled(boolean).

  public void enable(boolean b)

DEPRECATED: Replaced by setEnabled(boolean).

  public void disable()

DEPRECATED: Replaced by setEnabled(boolean).

  public void setVisible(boolean b)

Shows or hides the component depending on the boolean flag b.

Parameters:

b - if true, show the component; otherwise, hide the component.

See Also:

isVisible

  public void show()

DEPRECATED: Replaced by setVisible(boolean).

  public void show(boolean b)

DEPRECATED: Replaced by setVisible(boolean).

  public void hide()

DEPRECATED: Replaced by setVisible(boolean).

  public Color getForeground()

Gets the foreground color. If the component does not have a foreground color, the foreground color of its parent is returned.

See Also:

setForeground

  public void setForeground(Color c)

Sets the foreground color.

Parameters:

c - the Color

See Also:

getForeground

  public Color getBackground()

Gets the background color. If the component does not have a background color, the background color of its parent is returned.

See Also:

setBackground

  public void setBackground(Color c)

Sets the background color.

Parameters:

c - the Color

See Also:

getBackground

  public Font getFont()

Gets the font of the component. If the component does not have a font, the font of its parent is returned.

See Also:

setFont

  public synchronized void setFont(Font f)

Sets the font of the component.

Parameters:

f - the font

See Also:

getFont

  public Locale getLocale()

Gets the locale of the component. If the component does not have a locale, the locale of its parent is returned.

Throws: IllegalComponentStateException

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.

See Also:

setLocale

  public void setLocale(Locale l)

Sets the locale of the component.

Parameters:

l - the locale

See Also:

getLocale

  public ColorModel getColorModel()

Gets the ColorModel used to display the component on the output device.

See Also:

ColorModel

  public Point getLocation()

Returns the current location of this component. The location will be in the parent's coordinate space.

See Also:

setLocation

  public Point location()

DEPRECATED: Replaced by getLocation().

  public void setLocation(int x,
                          int y)

Moves the Component to a new location. The x and y coordinates are in the parent's coordinate space.

Parameters:

x - the x coordinate

y - the y coordinate

See Also:

getLocation, setBounds

  public void move(int x,
                   int y)

DEPRECATED: Replaced by setLocation(int, int).

  public void setLocation(Point p)

Moves the Component to a new location. The point p is given in the parent's coordinate space.

Parameters:

p - the new location for the coordinate

See Also:

getLocation, setBounds

  public Dimension getSize()

Returns the current size of this component.

See Also:

setSize

  public Dimension size()

DEPRECATED: Replaced by getSize().

  public void setSize(int width,
                      int height)

Resizes the Component to the specified width and height.

Parameters:

width - the width of the component

height - the height of the component

See Also:

size, setBounds

  public void resize(int width,
                     int height)

DEPRECATED: Replaced by setSize(int, int).

  public void setSize(Dimension d)

Resizes the Component to the specified dimension.

Parameters:

d - the component dimension

See Also:

size, setBounds

  public void resize(Dimension d)

DEPRECATED: Replaced by setSize(Dimension).

  public Rectangle getBounds()

Returns the current bounds of this component.

See Also:

setBounds

  public Rectangle bounds()

DEPRECATED: Replaced by getBounds().

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

Reshapes the Component to the specified bounding box.

Parameters:

x - the x coordinate

y - the y coordinate

width - the width of the component

height - the height of the component

See Also:

getBounds, setLocation, setSize

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

DEPRECATED: Replaced by setBounds(int, int, int, int).

  public void setBounds(Rectangle r)

Reshapes the Component to the specified bounding box.

Parameters:

r - the new bounding rectangle for the component

See Also:

getBounds, setLocation, setSize

  public Dimension getPreferredSize()

Returns the preferred size of this component.

See Also:

getMinimumSize, LayoutManager

  public Dimension preferredSize()

DEPRECATED: Replaced by getPreferredSize().

  public Dimension getMinimumSize()

Returns the mininimum size of this component.

See Also:

getPreferredSize, LayoutManager

  public Dimension minimumSize()

DEPRECATED: Replaced by getMinimumSize().

  public void doLayout()

Lays out the component. This is usually called when the component (more specifically, container) is validated.

See Also:

validate, LayoutManager

  public void layout()

DEPRECATED: Replaced by doLayout().

  public void validate()

Ensures that a component has a valid layout. This method is primarily intended to operate on Container instances.

See Also:

invalidate, layout, LayoutManager, validate

  public void invalidate()

Invalidates the component. The component and all parents above it are marked as needing to be laid out. This method can be called often, so it needs to execute quickly.

See Also:

validate, layout, LayoutManager

  public Graphics getGraphics()

Gets a Graphics context for this component. This method will return null if the component is currently not on the screen.

See Also:

paint

  public FontMetrics getFontMetrics(Font font)

Gets the font metrics for this component.

Parameters:

font - the font

See Also:

getFont

  public synchronized void setCursor(Cursor cursor)

Set the cursor image to a predefined cursor.

Parameters:

cursorType - one of the cursor constants defined above.

See Also:

Cursor

  public Cursor getCursor()

Gets the cursor set on this component.

  public void paint(Graphics g)

Paints the component.

Parameters:

g - the specified Graphics window

See Also:

update

  public void update(Graphics g)

Updates the component. This method is called in response to a call to repaint. You can assume that the background is not cleared.

Parameters:

g - the specified Graphics window

See Also:

paint, repaint

  public void paintAll(Graphics g)

Paints the component and its subcomponents.

Parameters:

g - the specified Graphics window

See Also:

paint

  public void repaint()

Repaints the component. This will result in a call to update as soon as possible.

See Also:

paint

  public void repaint(long tm)

Repaints the component. This will result in a call to update within tm milliseconds.

Parameters:

tm - maximum time in milliseconds before update

See Also:

paint

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

Repaints part of the component. This will result in a call to update as soon as possible.

Parameters:

x - the x coordinate

y - the y coordinate

width - the width

height - the height

See Also:

repaint

  public void repaint(long tm,
                      int x,
                      int y,
                      int width,
                      int height)

Repaints part of the component. This will result in a call to update width tm millseconds.

Parameters:

tm - maximum time in milliseconds before update

x - the x coordinate

y - the y coordinate

width - the width

height - the height

See Also:

repaint

  public void print(Graphics g)

Prints this component. The default implementation of this method calls paint.

Parameters:

g - the specified Graphics window

See Also:

paint

  public void printAll(Graphics g)

Prints the component and its subcomponents.

Parameters:

g - the specified Graphics window

See Also:

print

  public boolean imageUpdate(Image img,
                             int flags,
                             int x,
                             int y,
                             int w,
                             int h)

Repaints the component when the image has changed.

Returns:

true if image has changed; false otherwise.

  public Image createImage(ImageProducer producer)

Creates an image from the specified image producer.

Parameters:

producer - the image producer

  public Image createImage(int width,
                           int height)

Creates an off-screen drawable Image to be used for double buffering.

Parameters:

width - the specified width

height - the specified height

  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.

Parameters:

image - the Image to prepare a screen representation for

observer - the ImageObserver object to be notified as the image is being prepared

Returns:

true if the image has already been fully prepared

See Also:

ImageObserver

  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.

Parameters:

image - the Image to prepare a screen representation for

width - the width of the desired screen representation

height - the height of the desired screen representation

observer - the ImageObserver object to be notified as the image is being prepared

Returns:

true if the image has already been fully prepared

See Also:

ImageObserver

  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. Use the prepareImage method to force the loading of an image.

Parameters:

image - the Image to check the status of

observer - the ImageObserver object to be notified as the image is being prepared

Returns:

the boolean OR of the ImageObserver flags for the data that is currently available

See Also:

ImageObserver, prepareImage

  public int checkImage(Image image,
                        int width,
                        int height,
                        ImageObserver observer)

Returns the status of the construction of a scaled screen representation of the specified image. This method does not cause the image to begin loading, use the prepareImage method to force the loading of an image.

Parameters:

image - the Image to check the status of

width - the width of the scaled version to check the status of

height - the height of the scaled version to check the status of

observer - the ImageObserver object to be notified as the image is being prepared

Returns:

the boolean OR of the ImageObserver flags for the data that is currently available

See Also:

ImageObserver, prepareImage

  public boolean contains(int x,
                          int y)

Checks whether this component "contains" the specified (x, y) location, where x and y are defined to be relative to the coordinate system of this component.

Parameters:

x - the x coordinate

y - the y coordinate

See Also:

getComponentAt

  public boolean inside(int x,
                        int y)

DEPRECATED: Replaced by contains(int, int).

  public boolean contains(Point p)

Checks whether this component "contains" the specified point, where x and y in the point are defined to be relative to the coordinate system of this component.

Parameters:

p - the point

See Also:

getComponentAt

  public Component getComponentAt(int x,
                                  int y)

Returns the component or subcomponent that contains the x,y location.

Parameters:

x - the x coordinate

y - the y coordinate

See Also:

contains

  public Component locate(int x,
                          int y)

DEPRECATED: Replaced by getComponentAt(int, int).

  public Component getComponentAt(Point p)

Returns the component or subcomponent that contains the specified point.

Parameters:

p - the point

See Also:

contains

  public void deliverEvent(Event e)

DEPRECATED: replaced by dispatchEvent(AWTEvent e)

  public boolean postEvent(Event e)

DEPRECATED: Replaced by dispatchEvent(AWTEvent e); Posts an event to this component. This will result in a call to handleEvent. If handleEvent returns false the event is passed on to the parent of this component.

Parameters:

e - the event

See Also:

handleEvent, deliverEvent

  public synchronized void addComponentListener(ComponentListener l)

Adds the specified component listener to receive component events from this component.

Parameters:

l - the component listener

  public synchronized void removeComponentListener(ComponentListener l)

Removes the specified listener so it no longer receives component events from this component.

Parameters:

l - the component listener

  public synchronized void addFocusListener(FocusListener l)

Adds the specified focus listener to receive focus events from this component.

Parameters:

l - the focus listener

  public synchronized void removeFocusListener(FocusListener l)

Removes the specified focus listener so it no longer receives focus events from this component.

Parameters:

l - the focus listener

  public synchronized void addKeyListener(KeyListener l)

Adds the specified key listener to receive key events from this component.

Parameters:

l - the key listener

  public synchronized void removeKeyListener(KeyListener l)

Removes the specified key listener so it no longer receives key events from this component.

Parameters:

l - the key listener

  public synchronized void addMouseListener(MouseListener l)

Adds the specified mouse listener to receive mouse events from this component.

Parameters:

l - the mouse listener

  public synchronized void removeMouseListener(MouseListener l)

Removes the specified mouse listener so it no longer receives mouse events from this component.

Parameters:

l - the mouse listener

  public synchronized void addMouseMotionListener(MouseMotionListener l)

Adds the specified mouse motion listener to receive mouse motion events from this component.

Parameters:

l - the mouse motion listener

  public synchronized void removeMouseMotionListener(MouseMotionListener l)

Removes the specified mouse motion listener so it no longer receives mouse motion events from this component.

Parameters:

l - the mouse motion listener

  protected final 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 type is added to the component, therefore this method only needs to be invoked by subclasses of a component which desire to have the specified event types delivered to processEvent regardless of whether a listener is registered.

Parameters:

eventsToEnable - the event mask defining the event types

  protected final void disableEvents(long eventsToDisable)

Disables the events defined by the specified event mask parameter from being delivered to this component.

Parameters:

eventsToDisable - the event mask defining the event types

  protected void processEvent(AWTEvent e)

Processes events occurring on this component. By default this method will call the appropriate processXXXEvent method for the class of event.

Parameters:

e - the event

See Also:

processComponentEvent, processFocusEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent

  protected void processComponentEvent(ComponentEvent e)

Processes component events occurring on this component by dispatching them to any registered ComponentListener objects. NOTE: This method will not be called unless component events are enabled for this component; this happens when one of the following occurs: a) A ComponentListener object is registered via addComponentListner() b) Component events are enabled via enableEvents()

Parameters:

e - the component event

  protected void processFocusEvent(FocusEvent e)

Processes focus events occurring on this component by dispatching them to any registered FocusListener objects. NOTE: This method will not be called unless focus events are enabled for this component; this happens when one of the following occurs: a) A FocusListener object is registered via addFocusListener() b) Focus events are enabled via enableEvents()

Parameters:

e - the focus event

  protected boolean processKeyEvent(KeyEvent e)

Processes key events occurring on this component by dispatching them to any registered KeyListener objects. Returns true if the event is not to be passed on to the peer (to consume the event), returns false if the event should be sent and processed by the peer. By default this method returns false. NOTE: This method will not be called unless key events are enabled for this component; this happens when one of the following occurs: a) A KeyListener object is registered via addKeyListener() b) Key events are enabled via enableEvents()

Parameters:

e - the key event

  protected boolean processMouseEvent(MouseEvent e)

Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects. Returns true if the event is not to be passed on to the peer (to consume the event), returns false if the event should be sent and processed by the peer. By default this method returns false. NOTE: This method will not be called unless mouse events are enabled for this component; this happens when one of the following occurs: a) A MouseListener object is registered via addMouseListener() b) Mouse events are enabled via enableEvents()

Parameters:

e - the mouse event

  protected boolean processMouseMotionEvent(MouseEvent e)

Processes mouse motion events occurring on this component by dispatching them to any registered MouseMotionListener objects. Returns true if the event is not to be passed on to the peer (to consume the event), returns false if the event should be sent and processed by the peer. By default this method returns false. NOTE: This method will not be called unless mouse motion events are enabled for this component; this happens when one of the following occurs: a) A MouseMotionListener object is registered via addMouseMotionListener() b) Mouse Motion events are enabled via enableEvents()

Parameters:

e - the mouse motion event

  public boolean handleEvent(Event evt)

DEPRECATED: Replaced by processEvent(AWTEvent e); Handles the event. Returns true if the event is handled and should not be passed to the parent of this component. The default event handler calls some helper methods to make life easier on the programmer.

Parameters:

evt - the event

See Also:

mouseEnter, mouseExit, mouseMove, mouseDown, mouseDrag, mouseUp, keyDown, action

  public boolean mouseDown(Event evt,
                           int x,
                           int y)

DEPRECATED: Replaced by processMouseEvent(MouseEvent e); Called if the mouse is down.

Parameters:

evt - the event

x - the x coordinate

y - the y coordinate

See Also:

handleEvent

  public boolean mouseDrag(Event evt,
                           int x,
                           int y)

DEPRECATED: Replaced by processMouseMotionEvent(MouseEvent e); Called if the mouse is dragged (the mouse button is down).

Parameters:

evt - the event

x - the x coordinate

y - the y coordinate

See Also:

handleEvent

  public boolean mouseUp(Event evt,
                         int x,
                         int y)

DEPRECATED: Replaced by processMouseEvent(MouseEvent e); Called if the mouse is up.

Parameters:

evt - the event

x - the x coordinate

y - the y coordinate

See Also:

handleEvent

  public boolean mouseMove(Event evt,
                           int x,
                           int y)

DEPRECATED: Replaced by processMouseMotionEvent(MouseEvent e); Called if the mouse moves (the mouse button is up).

Parameters:

evt - the event

x - the x coordinate

y - the y coordinate

See Also:

handleEvent

  public boolean mouseEnter(Event evt,
                            int x,
                            int y)

DEPRECATED: Replaced by processMouseEvent(MouseEvent e); Called when the mouse enters the component.

Parameters:

evt - the event

x - the x coordinate

y - the y coordinate

See Also:

handleEvent

  public boolean mouseExit(Event evt,
                           int x,
                           int y)

DEPRECATED: Replaced by processMouseEvent(MouseEvent e); Called when the mouse exits the component.

Parameters:

evt - the event

x - the x coordinate

y - the y coordinate

See Also:

handleEvent

  public boolean keyDown(Event evt,
                         int key)

DEPRECATED: Replaced by processKeyEvent(KeyEvent e); Called if a character is pressed.

Parameters:

evt - the event

key - the key that's pressed

See Also:

handleEvent

  public boolean keyUp(Event evt,
                       int key)

DEPRECATED: Replaced by processKeyEvent(KeyEvent e); Called if a character is released.

Parameters:

evt - the event

key - the key that's released

See Also:

handleEvent

  public boolean action(Event evt,
                        Object what)

DEPRECATED: Replaced by processActionEvent(KeyEvent e); Called if an action occurs in the Component.

Parameters:

evt - the event

what - the action that's occuring

See Also:

handleEvent

  public void addNotify()

Notifies the Component that it has been added to a container and the peer should be created. This method should be called by Container.add, and not by user code directly.

See Also:

removeNotify

  public void removeNotify()

Notifies the Component that it has been removed from its container and it needs to destroy the peer. This method should be called by Container.remove, and not by user code directly.

See Also:

addNotify

  public boolean gotFocus(Event evt,
                          Object what)

DEPRECATED: Replaced by processFocusEvent(FocusEvent e); Indicates that this component has received the input focus.

See Also:

requestFocus, lostFocus

  public boolean lostFocus(Event evt,
                           Object what)

DEPRECATED: Replaced by processFocusEvent(FocusEvent e); Indicates that this component has lost the input focus.

See Also:

requestFocus, gotFocus

  public void requestFocus()

Requests the input focus. The gotFocus() method will be called if this method is successful. The component must be visible on the screen for this request to be granted.

See Also:

gotFocus

  public void transferFocus()

Transfers the focus to the next component.

See Also:

requestFocus, gotFocus

  public void nextFocus()

DEPRECATED: Replaced by transferFocus().

  public synchronized void add(PopupMenu popup)

Adds the specified popup menu to the component.

Parameters:

popup - the popup menu to be added to the component

  public synchronized void remove(MenuComponent popup)

Removes the specified popup menu from the component.

Parameters:

popup - the popup menu to be removed

  protected String paramString()

Returns the parameter String of this Component.

  public String toString()

Returns the String representation of this Component's values.

Overrides:

toString in class Object

  public void list()

Prints a listing to a print stream.

  public void list(PrintStream out)

Prints a listing to the specified print out stream.

Parameters:

out - the Stream name

  public void list(PrintStream out,
                   int indent)

Prints out a list, starting at the specified indention, to the specified print stream.

Parameters:

out - the Stream name

indent - the start of the list

  public boolean isFocusTraversable()

Returns whether this component can be traversed using Tab or Shift-Tab keyboard focus traversal.

All Packages  Class Hierarchy  This Package  Previous  Next  Index