java.awt

Class AWTEvent

public abstract class AWTEvent extends EventObject

AWTEvent is the root event class for all AWT events in the JDK 1.1 event model. It supersedes the Event class from JDK 1.0. Subclasses outside of the java.awt package should have IDs greater than RESERVED_ID_MAX.

Event masks defined here are used by components in enableEvents to select event types not selected by registered listeners. Event masks are appropriately set when registering on components.

Since: 1.1

UNKNOWN: updated to 1.4

Field Summary
static longACTION_EVENT_MASK
Mask for action events.
static longADJUSTMENT_EVENT_MASK
Mask for adjustment events.
protected booleanconsumed
Indicates if the event has been consumed.
static longCOMPONENT_EVENT_MASK
Mask for selecting component events.
static longCONTAINER_EVENT_MASK
Mask for selecting container events.
static longFOCUS_EVENT_MASK
Mask for selecting component focus events.
static longHIERARCHY_BOUNDS_EVENT_MASK
Mask for hierarchy bounds events.
static longHIERARCHY_EVENT_MASK
Mask for hierarchy events.
protected intid
The ID of the event.
static longINPUT_METHOD_EVENT_MASK
Mask for input method events.
static longINVOCATION_EVENT_MASK
Mask for invocation events.
static longITEM_EVENT_MASK
Mask for item events.
static longKEY_EVENT_MASK
Mask for selecting keyboard events.
static longMOUSE_EVENT_MASK
Mask for mouse button events.
static longMOUSE_MOTION_EVENT_MASK
Mask for mouse motion events.
static longMOUSE_WHEEL_EVENT_MASK
Mask for mouse wheel events.
static longPAINT_EVENT_MASK
Mask for paint events.
static intRESERVED_ID_MAX
This is the highest number for event ids that are reserved for use by the AWT system itself.
static longTEXT_EVENT_MASK
Mask for text events.
static longWINDOW_EVENT_MASK
Mask for window events.
static longWINDOW_FOCUS_EVENT_MASK
Mask for window focus events.
static longWINDOW_STATE_EVENT_MASK
Mask for window state events.
Constructor Summary
AWTEvent(Event event)
Initializes a new AWTEvent from the old Java 1.0 event object.
AWTEvent(Object source, int id)
Create an event on the specified source object and id.
Method Summary
protected voidconsume()
Consumes this event so that it will not be processed in the default manner.
intgetID()
Returns the event type id.
protected booleanisConsumed()
Tests whether not not this event has been consumed.
StringparamString()
Returns a string representation of the state of this event.
voidsetSource(Object source)
Retarget the event, such as converting a heavyweight component to a lightweight child of the original.
StringtoString()
Create a string that represents this event in the format classname[eventstring] on sourcecomponentname.

Field Detail

ACTION_EVENT_MASK

public static final long ACTION_EVENT_MASK
Mask for action events.

ADJUSTMENT_EVENT_MASK

public static final long ADJUSTMENT_EVENT_MASK
Mask for adjustment events.

consumed

protected boolean consumed
Indicates if the event has been consumed. False mean it is passed to the peer, true means it has already been processed. Semantic events generated by low-level events always have the value true.

Serial: whether the event has been consumed

See Also: consume isConsumed

COMPONENT_EVENT_MASK

public static final long COMPONENT_EVENT_MASK
Mask for selecting component events.

CONTAINER_EVENT_MASK

public static final long CONTAINER_EVENT_MASK
Mask for selecting container events.

FOCUS_EVENT_MASK

public static final long FOCUS_EVENT_MASK
Mask for selecting component focus events.

HIERARCHY_BOUNDS_EVENT_MASK

public static final long HIERARCHY_BOUNDS_EVENT_MASK
Mask for hierarchy bounds events.

Since: 1.3

HIERARCHY_EVENT_MASK

public static final long HIERARCHY_EVENT_MASK
Mask for hierarchy events.

Since: 1.3

id

protected int id
The ID of the event.

Serial: the identifier number of this event

See Also: getID AWTEvent

INPUT_METHOD_EVENT_MASK

public static final long INPUT_METHOD_EVENT_MASK
Mask for input method events.

Since: 1.3

INVOCATION_EVENT_MASK

public static final long INVOCATION_EVENT_MASK
Mask for invocation events.

Since: 1.3

ITEM_EVENT_MASK

public static final long ITEM_EVENT_MASK
Mask for item events.

KEY_EVENT_MASK

public static final long KEY_EVENT_MASK
Mask for selecting keyboard events.

MOUSE_EVENT_MASK

public static final long MOUSE_EVENT_MASK
Mask for mouse button events.

MOUSE_MOTION_EVENT_MASK

public static final long MOUSE_MOTION_EVENT_MASK
Mask for mouse motion events.

MOUSE_WHEEL_EVENT_MASK

public static final long MOUSE_WHEEL_EVENT_MASK
Mask for mouse wheel events.

Since: 1.4

PAINT_EVENT_MASK

public static final long PAINT_EVENT_MASK
Mask for paint events.

Since: 1.3

RESERVED_ID_MAX

public static final int RESERVED_ID_MAX
This is the highest number for event ids that are reserved for use by the AWT system itself. Subclasses outside of java.awt should use higher ids.

TEXT_EVENT_MASK

public static final long TEXT_EVENT_MASK
Mask for text events.

WINDOW_EVENT_MASK

public static final long WINDOW_EVENT_MASK
Mask for window events.

WINDOW_FOCUS_EVENT_MASK

public static final long WINDOW_FOCUS_EVENT_MASK
Mask for window focus events.

Since: 1.4

WINDOW_STATE_EVENT_MASK

public static final long WINDOW_STATE_EVENT_MASK
Mask for window state events.

Since: 1.4

Constructor Detail

AWTEvent

public AWTEvent(Event event)
Initializes a new AWTEvent from the old Java 1.0 event object.

Parameters: event the old-style event

Throws: NullPointerException if event is null

AWTEvent

public AWTEvent(Object source, int id)
Create an event on the specified source object and id.

Parameters: source the object that caused the event id the event id

Throws: IllegalArgumentException if source is null

Method Detail

consume

protected void consume()
Consumes this event so that it will not be processed in the default manner.

getID

public int getID()
Returns the event type id.

Returns: the id number of this event

isConsumed

protected boolean isConsumed()
Tests whether not not this event has been consumed. A consumed event is not processed in the default manner.

Returns: true if this event has been consumed

paramString

public String paramString()
Returns a string representation of the state of this event. It may be empty, but must not be null; it is implementation defined.

Returns: a string representation of this event

setSource

public void setSource(Object source)
Retarget the event, such as converting a heavyweight component to a lightweight child of the original. This is not for general use, but is for event targeting systems like KeyboardFocusManager.

Parameters: source the new source

toString

public String toString()
Create a string that represents this event in the format classname[eventstring] on sourcecomponentname.

Returns: a string representing this event