Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.awt

Class AWTEvent

java.lang.Object
|
+--java.util.EventObject
   |
   +--java.awt.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:Authors:

Field Summary

static longACTION_EVENT_MASK

Mask for action events.
static longADJUSTMENT_EVENT_MASK

Mask for adjustment events.
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.
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.
booleanconsumed

Indicates if the event has been consumed.
intid

The ID of the event.

Constructor Summary

AWTEvent(java.awt.Event event)

Initializes a new AWTEvent from the old Java 1.0 event object.
AWTEvent(java.lang.Object source, int id)

Create an event on the specified source object and id.

Method Summary

voidconsume()

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

Returns the event type id.
booleanisConsumed()

Tests whether not not this event has been consumed.
java.lang.StringparamString()

Returns a string representation of the state of this event.
voidsetSource(java.lang.Object source)

Retarget the event, such as converting a heavyweight component to a lightweight child of the original.
java.lang.StringtoString()

Returns a string representation of this event.

Field Details

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.


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:

HIERARCHY_EVENT_MASK

public static final long HIERARCHY_EVENT_MASK

Mask for hierarchy events.

Since:

INPUT_METHOD_EVENT_MASK

public static final long INPUT_METHOD_EVENT_MASK

Mask for input method events.

Since:

INVOCATION_EVENT_MASK

public static final long INVOCATION_EVENT_MASK

Mask for invocation events.

Since:

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:

PAINT_EVENT_MASK

public static final long PAINT_EVENT_MASK

Mask for paint events.

Since:

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:

WINDOW_STATE_EVENT_MASK

public static final long WINDOW_STATE_EVENT_MASK

Mask for window state events.

Since:

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.

See Also:


id

protected int id

The ID of the event.

See Also:


Constructor Details

AWTEvent

public AWTEvent(java.awt.Event event)

Initializes a new AWTEvent from the old Java 1.0 event object.

Parameters:

Throws:


AWTEvent

public AWTEvent(java.lang.Object source, int id)

Create an event on the specified source object and id.

Parameters:

Throws:


Method Details

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:


isConsumed

protected boolean isConsumed()

Tests whether not not this event has been consumed. A consumed event is not processed in the default manner.

Returns:


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:


setSource

public void setSource(java.lang.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:


toString

public String toString()

Returns a string representation of this event. This is in the format getClass().getName() + '[' + paramString() + "] on " + source.

Returns: