AWTEvent (Java 2 Platform SE 5.0) (original) (raw)
java.awt
Class AWTEvent
java.lang.Object
java.util.EventObject
java.awt.AWTEvent
All Implemented Interfaces:
Direct Known Subclasses:
ActionEvent, AdjustmentEvent, AncestorEvent, ComponentEvent, HierarchyEvent, InputMethodEvent, InternalFrameEvent, InvocationEvent, ItemEvent, TextEvent
public abstract class AWTEvent
extends EventObject
The root event class for all AWT events. This class and its subclasses supercede the original java.awt.Event class. Subclasses of this root AWTEvent class defined outside of the java.awt.event package should define event ID values greater than the value defined by RESERVED_ID_MAX.
The event masks defined in this class are needed by Component subclasses which are using Component.enableEvents() to select for event types not selected by registered listeners. If a listener is registered on a component, the appropriate event mask is already set internally by the component.
The masks are also used to specify to which types of events an AWTEventListener should listen. The masks are bitwise-ORed together and passed to Toolkit.addAWTEventListener.
Since:
1.1
See Also:
Component.enableEvents(long), [Toolkit.addAWTEventListener(java.awt.event.AWTEventListener, long)](../../java/awt/Toolkit.html#addAWTEventListener%28java.awt.event.AWTEventListener, long%29), ActionEvent, AdjustmentEvent, ComponentEvent, ContainerEvent, FocusEvent, InputMethodEvent, InvocationEvent, ItemEvent, HierarchyEvent, KeyEvent, MouseEvent, MouseWheelEvent, PaintEvent, TextEvent, WindowEvent, Serialized Form
| Field Summary | |
|---|---|
| static long | ACTION_EVENT_MASK The event mask for selecting action events. |
| static long | ADJUSTMENT_EVENT_MASK The event mask for selecting adjustment events. |
| static long | COMPONENT_EVENT_MASK The event mask for selecting component events. |
| protected boolean | consumed Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not. |
| static long | CONTAINER_EVENT_MASK The event mask for selecting container events. |
| static long | FOCUS_EVENT_MASK The event mask for selecting focus events. |
| static long | HIERARCHY_BOUNDS_EVENT_MASK The event mask for selecting hierarchy bounds events. |
| static long | HIERARCHY_EVENT_MASK The event mask for selecting hierarchy events. |
| protected int | id The event's id. |
| static long | INPUT_METHOD_EVENT_MASK The event mask for selecting input method events. |
| static long | INVOCATION_EVENT_MASK The event mask for selecting invocation events. |
| static long | ITEM_EVENT_MASK The event mask for selecting item events. |
| static long | KEY_EVENT_MASK The event mask for selecting key events. |
| static long | MOUSE_EVENT_MASK The event mask for selecting mouse events. |
| static long | MOUSE_MOTION_EVENT_MASK The event mask for selecting mouse motion events. |
| static long | MOUSE_WHEEL_EVENT_MASK The event mask for selecting mouse wheel events. |
| static long | PAINT_EVENT_MASK The event mask for selecting paint events. |
| static int | RESERVED_ID_MAX The maximum value for reserved AWT event IDs. |
| static long | TEXT_EVENT_MASK The event mask for selecting text events. |
| static long | WINDOW_EVENT_MASK The event mask for selecting window events. |
| static long | WINDOW_FOCUS_EVENT_MASK The event mask for selecting window focus events. |
| static long | WINDOW_STATE_EVENT_MASK The event mask for selecting window state events. |
| Fields inherited from class java.util.EventObject |
|---|
| source |
| Constructor Summary |
|---|
| AWTEvent(Event event) Constructs an AWTEvent object from the parameters of a 1.0-style event. |
| [AWTEvent](../../java/awt/AWTEvent.html#AWTEvent%28java.lang.Object, int%29)(Object source, int id) Constructs an AWTEvent object with the specified source object and type. |
| Method Summary | |
|---|---|
| protected void | consume() Consumes this event, if this event can be consumed. |
| int | getID() Returns the event type. |
| protected boolean | isConsumed() Returns whether this event has been consumed. |
| String | paramString() Returns a string representing the state of this Event. |
| void | setSource(Object newSource) Retargets an event to a new source. |
| String | toString() Returns a String representation of this object. |
| 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](../../java/lang/Object.html#wait%28long, int%29) |
| Field Detail |
|---|
id
protected int id
The event's id.
See Also:
getID(), [AWTEvent(java.lang.Object, int)](../../java/awt/AWTEvent.html#AWTEvent%28java.lang.Object, int%29)
consumed
protected boolean consumed
Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not. Semantic events always have a 'true' value since they were generated by the peer in response to a low-level event.
See Also:
COMPONENT_EVENT_MASK
public static final long COMPONENT_EVENT_MASK
The event mask for selecting component events.
See Also:
CONTAINER_EVENT_MASK
public static final long CONTAINER_EVENT_MASK
The event mask for selecting container events.
See Also:
FOCUS_EVENT_MASK
public static final long FOCUS_EVENT_MASK
The event mask for selecting focus events.
See Also:
KEY_EVENT_MASK
public static final long KEY_EVENT_MASK
The event mask for selecting key events.
See Also:
MOUSE_EVENT_MASK
public static final long MOUSE_EVENT_MASK
The event mask for selecting mouse events.
See Also:
MOUSE_MOTION_EVENT_MASK
public static final long MOUSE_MOTION_EVENT_MASK
The event mask for selecting mouse motion events.
See Also:
WINDOW_EVENT_MASK
public static final long WINDOW_EVENT_MASK
The event mask for selecting window events.
See Also:
ACTION_EVENT_MASK
public static final long ACTION_EVENT_MASK
The event mask for selecting action events.
See Also:
ADJUSTMENT_EVENT_MASK
public static final long ADJUSTMENT_EVENT_MASK
The event mask for selecting adjustment events.
See Also:
ITEM_EVENT_MASK
public static final long ITEM_EVENT_MASK
The event mask for selecting item events.
See Also:
TEXT_EVENT_MASK
public static final long TEXT_EVENT_MASK
The event mask for selecting text events.
See Also:
INPUT_METHOD_EVENT_MASK
public static final long INPUT_METHOD_EVENT_MASK
The event mask for selecting input method events.
See Also:
PAINT_EVENT_MASK
public static final long PAINT_EVENT_MASK
The event mask for selecting paint events.
See Also:
INVOCATION_EVENT_MASK
public static final long INVOCATION_EVENT_MASK
The event mask for selecting invocation events.
See Also:
HIERARCHY_EVENT_MASK
public static final long HIERARCHY_EVENT_MASK
The event mask for selecting hierarchy events.
See Also:
HIERARCHY_BOUNDS_EVENT_MASK
public static final long HIERARCHY_BOUNDS_EVENT_MASK
The event mask for selecting hierarchy bounds events.
See Also:
MOUSE_WHEEL_EVENT_MASK
public static final long MOUSE_WHEEL_EVENT_MASK
The event mask for selecting mouse wheel events.
Since:
1.4
See Also:
WINDOW_STATE_EVENT_MASK
public static final long WINDOW_STATE_EVENT_MASK
The event mask for selecting window state events.
Since:
1.4
See Also:
WINDOW_FOCUS_EVENT_MASK
public static final long WINDOW_FOCUS_EVENT_MASK
The event mask for selecting window focus events.
Since:
1.4
See Also:
RESERVED_ID_MAX
public static final int RESERVED_ID_MAX
The maximum value for reserved AWT event IDs. Programs defining their own event IDs should use IDs greater than this value.
See Also:
| Constructor Detail |
|---|
AWTEvent
public AWTEvent(Event event)
Constructs an AWTEvent object from the parameters of a 1.0-style event.
Parameters:
event - the old-style event
AWTEvent
public AWTEvent(Object source, int id)
Constructs an AWTEvent object with the specified source object and type.
Parameters:
source - the object where the event originated
| Method Detail |
|---|
setSource
public void setSource(Object newSource)
Retargets an event to a new source. This method is typically used to retarget an event to a lightweight child Component of the original heavyweight source.
This method is intended to be used only by event targeting subsystems, such as client-defined KeyboardFocusManagers. It is not for general client use.
Parameters:
newSource - the new Object to which the event should be dispatched
getID
public int getID()
Returns the event type.
toString
public String toString()
Returns a String representation of this object.
Overrides:
[toString](../../java/util/EventObject.html#toString%28%29) in class [EventObject](../../java/util/EventObject.html "class in java.util")
Returns:
A a String representation of this EventObject.
paramString
public String paramString()
Returns a string representing the state of this Event. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.
Returns:
a string representation of this event
consume
protected void consume()
Consumes this event, if this event can be consumed. Only low-level, system events can be consumed
isConsumed
protected boolean isConsumed()
Returns whether this event has been consumed.
Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.