java.awt.event

Class ComponentEvent

java.lang.Object

java.util.EventObject

java.awt.AWTEvent

java.awt.event.ComponentEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ContainerEvent, FocusEvent, InputEvent, PaintEvent, WindowEvent

public class ComponentEvent
extends AWTEvent

This class is for events generated when a component is moved, resized, hidden, or shown. These events normally do not need to be handled by the application, since the AWT system automatically takes care of them. This is also the superclass for other events on components, but ComponentListeners ignore such subclasses.

Since:

1.1

See Also:

ComponentAdapter, ComponentListener, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPONENT_FIRST This is the first id in the range of ids used by this class.
static int	COMPONENT_HIDDEN This id indicates that a component was hidden.
static int	COMPONENT_LAST This is the last id in the range of ids used by this class.
static int	COMPONENT_MOVED This id indicates that a component was moved.
static int	COMPONENT_RESIZED This id indicates that a component was resized.
static int	COMPONENT_SHOWN This id indicates that a component was shown.

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ComponentEvent(Component source, int id) Initializes a new instance of ComponentEvent with the specified source and id.

Method Summary

Methods

Modifier and Type	Method and Description
Component	getComponent() This method returns the event source as a Component.
String	paramString() This method returns a string identifying this event.

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, setSource, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COMPONENT_FIRST

public static final int COMPONENT_FIRST

This is the first id in the range of ids used by this class.

See Also:

Constant Field Values

COMPONENT_LAST

public static final int COMPONENT_LAST

This is the last id in the range of ids used by this class.

See Also:

Constant Field Values

COMPONENT_MOVED

public static final int COMPONENT_MOVED

This id indicates that a component was moved.

See Also:

Constant Field Values

COMPONENT_RESIZED

public static final int COMPONENT_RESIZED

This id indicates that a component was resized.

See Also:

Constant Field Values

COMPONENT_SHOWN

public static final int COMPONENT_SHOWN

This id indicates that a component was shown.

See Also:

Constant Field Values

COMPONENT_HIDDEN

public static final int COMPONENT_HIDDEN

This id indicates that a component was hidden.

See Also:

Constant Field Values

Constructor Detail

ComponentEvent

public ComponentEvent(Component source,
              int id)

Initializes a new instance of ComponentEvent with the specified source and id. Note that an invalid id leads to unspecified results.

Parameters:

source - the source of the event

id - the event id

Throws:

IllegalArgumentException - if source is null

Method Detail

getComponent

public Component getComponent()

This method returns the event source as a Component. If the source has subsequently been modified to a non-Component, this returns null.

Returns:

the event source as a Component, or null

paramString

public String paramString()

This method returns a string identifying this event. This is the field name of the id type, and for COMPONENT_MOVED or COMPONENT_RESIZED, the new bounding box of the component.

Overrides:

paramString in class AWTEvent

Returns:

a string identifying this event