On this page
Class ComponentEvent
- All Implemented Interfaces:
-
Serializable
- Direct Known Subclasses:
ContainerEvent,FocusEvent,InputEvent,PaintEvent,WindowEvent
public class ComponentEvent extends AWTEvent
Component events are provided for notification purposes ONLY; The AWT will automatically handle component moves and resizes internally so that GUI layout works properly regardless of whether a program is receiving these events or not.
In addition to serving as the base class for other component-related events (InputEvent, FocusEvent, WindowEvent, ContainerEvent), this class defines the events that indicate changes in a component's size, position, or visibility.
This low-level event is generated by a component object (such as a List) when the component is moved, resized, rendered invisible, or made visible again. The event is passed to every ComponentListener or ComponentAdapter object which registered to receive such events using the component's addComponentListener method. (ComponentAdapter objects implement the ComponentListener interface.) Each such listener object gets this ComponentEvent when the event occurs.
An unspecified behavior will be caused if the id parameter of any particular ComponentEvent instance is not in the range from COMPONENT_FIRST to COMPONENT_LAST.
- Since:
- 1.1
- See Also:
Field Summary
| Modifier and Type | Field | Description |
|---|---|---|
static final int |
COMPONENT_FIRST |
The first number in the range of ids used for component events.
|
static final int |
COMPONENT_HIDDEN |
This event indicates that the component was rendered invisible.
|
static final int |
COMPONENT_LAST |
The last number in the range of ids used for component events.
|
static final int |
COMPONENT_MOVED |
This event indicates that the component's position changed.
|
static final int |
COMPONENT_RESIZED |
This event indicates that the component's size changed.
|
static final int |
COMPONENT_SHOWN |
This event indicates that the component was made visible.
|
Fields declared in 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 declared in class java.util.EventObject
source
Constructor Summary
| Constructor | Description |
|---|---|
ComponentEvent |
Constructs a ComponentEvent object.
|
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
Component |
getComponent() |
Returns the originator of the event.
|
String |
paramString() |
Returns a parameter string identifying this event.
|
Methods declared in class java.util.EventObject
getSource
Field Details
COMPONENT_FIRST
public static final int COMPONENT_FIRST
- See Also:
COMPONENT_LAST
public static final int COMPONENT_LAST
- See Also:
COMPONENT_MOVED
@Native public static final int COMPONENT_MOVED
- See Also:
COMPONENT_RESIZED
@Native public static final int COMPONENT_RESIZED
- See Also:
COMPONENT_SHOWN
@Native public static final int COMPONENT_SHOWN
- See Also:
COMPONENT_HIDDEN
@Native public static final int COMPONENT_HIDDEN
- See Also:
Constructor Details
ComponentEvent
public ComponentEvent(Component source, int id)
ComponentEvent object.
This method throws an IllegalArgumentException if source is null.
- Parameters:
source- TheComponentthat originated the eventid- An integer indicating the type of event. For information on allowable values, see the class description forComponentEvent- Throws:
IllegalArgumentException- ifsourceis null- See Also:
Method Details
getComponent
public Component getComponent()
- Returns:
-
the
Componentobject that originated the event, ornullif the object is not aComponent.
paramString
public String paramString()
- Overrides:
paramStringin classAWTEvent- Returns:
- a string identifying the event and its attributes
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/event/ComponentEvent.html