java.awt
Class AWTEvent

java.lang.Object
  extended by java.util.EventObject
      extended by java.awt.AWTEvent
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ActionEvent, AdjustmentEvent, AncestorEvent, ComponentEvent, HierarchyEvent, InputMethodEvent, InternalFrameEvent, InvocationEvent, ItemEvent, TextEvent

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
See Also:
Serialized Form

Field Summary
static long ACTION_EVENT_MASK
          Mask for action events.
static long ADJUSTMENT_EVENT_MASK
          Mask for adjustment events.
static long COMPONENT_EVENT_MASK
          Mask for selecting component events.
protected  boolean consumed
          Indicates if the event has been consumed.
static long CONTAINER_EVENT_MASK
          Mask for selecting container events.
static long FOCUS_EVENT_MASK
          Mask for selecting component focus events.
static long HIERARCHY_BOUNDS_EVENT_MASK
          Mask for hierarchy bounds events.
static long HIERARCHY_EVENT_MASK
          Mask for hierarchy events.
protected  int id
          The ID of the event.
static long INPUT_METHOD_EVENT_MASK
          Mask for input method events.
static long INVOCATION_EVENT_MASK
          Mask for invocation events.
static long ITEM_EVENT_MASK
          Mask for item events.
static long KEY_EVENT_MASK
          Mask for selecting keyboard events.
static long MOUSE_EVENT_MASK
          Mask for mouse button events.
static long MOUSE_MOTION_EVENT_MASK
          Mask for mouse motion events.
static long MOUSE_WHEEL_EVENT_MASK
          Mask for mouse wheel events.
static long PAINT_EVENT_MASK
          Mask for paint events.
static int RESERVED_ID_MAX
          This is the highest number for event ids that are reserved for use by the AWT system itself.
static long TEXT_EVENT_MASK
          Mask for text events.
static long WINDOW_EVENT_MASK
          Mask for window events.
static long WINDOW_FOCUS_EVENT_MASK
          Mask for window focus events.
static long WINDOW_STATE_EVENT_MASK
          Mask for window state events.
 
Fields inherited from class java.util.EventObject
source
 
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  void consume()
          Consumes this event so that it will not be processed in the default manner.
 int getID()
          Returns the event type id.
protected  boolean isConsumed()
          Tests whether not not this event has been consumed.
 String paramString()
          Returns a string representation of the state of this event.
 void setSource(Object source)
          Retarget the event, such as converting a heavyweight component to a lightweight child of the original.
 String toString()
          Create a string that represents this event in the format classname[eventstring] on sourcecomponentname.
 
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

id

protected int id
The ID of the event.

See Also:
getID(), AWTEvent(Object, int)

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:
consume(), isConsumed()

COMPONENT_EVENT_MASK

public static final long COMPONENT_EVENT_MASK
Mask for selecting component events.

See Also:
Constant Field Values

CONTAINER_EVENT_MASK

public static final long CONTAINER_EVENT_MASK
Mask for selecting container events.

See Also:
Constant Field Values

FOCUS_EVENT_MASK

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

See Also:
Constant Field Values

KEY_EVENT_MASK

public static final long KEY_EVENT_MASK
Mask for selecting keyboard events.

See Also:
Constant Field Values

MOUSE_EVENT_MASK

public static final long MOUSE_EVENT_MASK
Mask for mouse button events.

See Also:
Constant Field Values

MOUSE_MOTION_EVENT_MASK

public static final long MOUSE_MOTION_EVENT_MASK
Mask for mouse motion events.

See Also:
Constant Field Values

WINDOW_EVENT_MASK

public static final long WINDOW_EVENT_MASK
Mask for window events.

See Also:
Constant Field Values

ACTION_EVENT_MASK

public static final long ACTION_EVENT_MASK
Mask for action events.

See Also:
Constant Field Values

ADJUSTMENT_EVENT_MASK

public static final long ADJUSTMENT_EVENT_MASK
Mask for adjustment events.

See Also:
Constant Field Values

ITEM_EVENT_MASK

public static final long ITEM_EVENT_MASK
Mask for item events.

See Also:
Constant Field Values

TEXT_EVENT_MASK

public static final long TEXT_EVENT_MASK
Mask for text events.

See Also:
Constant Field Values

INPUT_METHOD_EVENT_MASK

public static final long INPUT_METHOD_EVENT_MASK
Mask for input method events.

Since:
1.3
See Also:
Constant Field Values

PAINT_EVENT_MASK

public static final long PAINT_EVENT_MASK
Mask for paint events.

Since:
1.3
See Also:
Constant Field Values

INVOCATION_EVENT_MASK

public static final long INVOCATION_EVENT_MASK
Mask for invocation events.

Since:
1.3
See Also:
Constant Field Values

HIERARCHY_EVENT_MASK

public static final long HIERARCHY_EVENT_MASK
Mask for hierarchy events.

Since:
1.3
See Also:
Constant Field Values

HIERARCHY_BOUNDS_EVENT_MASK

public static final long HIERARCHY_BOUNDS_EVENT_MASK
Mask for hierarchy bounds events.

Since:
1.3
See Also:
Constant Field Values

MOUSE_WHEEL_EVENT_MASK

public static final long MOUSE_WHEEL_EVENT_MASK
Mask for mouse wheel events.

Since:
1.4
See Also:
Constant Field Values

WINDOW_STATE_EVENT_MASK

public static final long WINDOW_STATE_EVENT_MASK
Mask for window state events.

Since:
1.4
See Also:
Constant Field Values

WINDOW_FOCUS_EVENT_MASK

public static final long WINDOW_FOCUS_EVENT_MASK
Mask for window focus events.

Since:
1.4
See Also:
Constant Field Values

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.

See Also:
Constant Field Values
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

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

getID

public int getID()
Returns the event type id.

Returns:
the id number of this event

toString

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

Overrides:
toString in class EventObject
Returns:
a string representing this event
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

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

consume

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


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