public class

ComponentEvent

extends AWTEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ java.awt.AWTEvent
       ↳ java.awt.event.ComponentEvent
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

A low-level event which indicates that a component moved, changed size, or changed visibility (also, the root class for the other component-level events).

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.

Summary

Constants
int COMPONENT_FIRST The first number in the range of ids used for component events.
int COMPONENT_HIDDEN This event indicates that the component was rendered invisible.
int COMPONENT_LAST The last number in the range of ids used for component events.
int COMPONENT_MOVED This event indicates that the component's position changed.
int COMPONENT_RESIZED This event indicates that the component's size changed.
int COMPONENT_SHOWN This event indicates that the component was made visible.
[Expand]
Inherited Constants
From class java.awt.AWTEvent
[Expand]
Inherited Fields
From class java.awt.AWTEvent
From class java.util.EventObject
Public Constructors
ComponentEvent(Component source, int id)
Constructs a ComponentEvent object.
Public Methods
Component getComponent()
Returns the originator of the event.
String paramString()
Returns a parameter string identifying this event.
[Expand]
Inherited Methods
From class java.awt.AWTEvent
From class java.util.EventObject
From class java.lang.Object

Constants

public static final int COMPONENT_FIRST

The first number in the range of ids used for component events.

Constant Value: 100 (0x00000064)

public static final int COMPONENT_HIDDEN

This event indicates that the component was rendered invisible.

Constant Value: 103 (0x00000067)

public static final int COMPONENT_LAST

The last number in the range of ids used for component events.

Constant Value: 103 (0x00000067)

public static final int COMPONENT_MOVED

This event indicates that the component's position changed.

Constant Value: 100 (0x00000064)

public static final int COMPONENT_RESIZED

This event indicates that the component's size changed.

Constant Value: 101 (0x00000065)

public static final int COMPONENT_SHOWN

This event indicates that the component was made visible.

Constant Value: 102 (0x00000066)

Public Constructors

public ComponentEvent (Component source, int id)

Constructs a ComponentEvent object.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.

Parameters
source the Component that originated the event
id an integer indicating the type of event
Throws
IllegalArgumentException if source is null

Public Methods

public Component getComponent ()

Returns the originator of the event.

Returns
  • the Component object that originated the event, or null if the object is not a Component.

public String paramString ()

Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

Returns
  • a string identifying the event and its attributes