This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

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

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.

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(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, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_EVENT_MASK

public static final long ACTION_EVENT_MASK
The event mask for selecting action events.

ADJUSTMENT_EVENT_MASK

public static final long ADJUSTMENT_EVENT_MASK
The event mask for selecting adjustment events.

COMPONENT_EVENT_MASK

public static final long COMPONENT_EVENT_MASK
The event mask for selecting component events.

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.

CONTAINER_EVENT_MASK

public static final long CONTAINER_EVENT_MASK
The event mask for selecting container events.

FOCUS_EVENT_MASK

public static final long FOCUS_EVENT_MASK
The event mask for selecting focus events.

HIERARCHY_BOUNDS_EVENT_MASK

public static final long HIERARCHY_BOUNDS_EVENT_MASK
The event mask for selecting hierarchy bounds events.

HIERARCHY_EVENT_MASK

public static final long HIERARCHY_EVENT_MASK
The event mask for selecting hierarchy events.

id

protected int id
The event's id.

INPUT_METHOD_EVENT_MASK

public static final long INPUT_METHOD_EVENT_MASK
The event mask for selecting input method events.

INVOCATION_EVENT_MASK

public static final long INVOCATION_EVENT_MASK
The event mask for selecting invocation events.

ITEM_EVENT_MASK

public static final long ITEM_EVENT_MASK
The event mask for selecting item events.

KEY_EVENT_MASK

public static final long KEY_EVENT_MASK
The event mask for selecting key events.

MOUSE_EVENT_MASK

public static final long MOUSE_EVENT_MASK
The event mask for selecting mouse events.

MOUSE_MOTION_EVENT_MASK

public static final long MOUSE_MOTION_EVENT_MASK
The event mask for selecting mouse motion events.

MOUSE_WHEEL_EVENT_MASK

public static final long MOUSE_WHEEL_EVENT_MASK
The event mask for selecting mouse wheel events.

PAINT_EVENT_MASK

public static final long PAINT_EVENT_MASK
The event mask for selecting paint events.

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.

TEXT_EVENT_MASK

public static final long TEXT_EVENT_MASK
The event mask for selecting text events.

WINDOW_EVENT_MASK

public static final long WINDOW_EVENT_MASK
The event mask for selecting window events.

WINDOW_FOCUS_EVENT_MASK

public static final long WINDOW_FOCUS_EVENT_MASK
The event mask for selecting window focus events.

WINDOW_STATE_EVENT_MASK

public static final long WINDOW_STATE_EVENT_MASK
The event mask for selecting window state events.
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
id - the event type
Method Detail

consume

protected void consume()
Consumes this event, if this event can be consumed. Only low-level, system events can be consumed

getID

public int getID()
Returns the event type.

isConsumed

protected boolean isConsumed()
Returns whether this event has been consumed.

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

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

toString

public String toString()
Returns a String representation of this object.

Overrides:
toString in class EventObject
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.