java.awt

Class AWTEvent

Implemented Interfaces:
Serializable
Known Direct Subclasses:
ActionEvent, AdjustmentEvent, AncestorEvent, ComponentEvent, ComponentReshapeEvent, HierarchyEvent, InputMethodEvent, InternalFrameEvent, InvocationEvent, ItemEvent, NativeEventLoopRunningEvent, 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.
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.
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.
protected boolean
consumed
Indicates if the event has been consumed.
protected int
id
The ID of the event.

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, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ACTION_EVENT_MASK

public static final long ACTION_EVENT_MASK
Mask for action events.
Field Value:
128L

ADJUSTMENT_EVENT_MASK

public static final long ADJUSTMENT_EVENT_MASK
Mask for adjustment events.
Field Value:
256L

COMPONENT_EVENT_MASK

public static final long COMPONENT_EVENT_MASK
Mask for selecting component events.
Field Value:
1L

CONTAINER_EVENT_MASK

public static final long CONTAINER_EVENT_MASK
Mask for selecting container events.
Field Value:
2L

FOCUS_EVENT_MASK

public static final long FOCUS_EVENT_MASK
Mask for selecting component focus events.
Field Value:
4L

HIERARCHY_BOUNDS_EVENT_MASK

public static final long HIERARCHY_BOUNDS_EVENT_MASK
Mask for hierarchy bounds events.
Field Value:
65536L
Since:
1.3

HIERARCHY_EVENT_MASK

public static final long HIERARCHY_EVENT_MASK
Mask for hierarchy events.
Field Value:
32768L
Since:
1.3

INPUT_METHOD_EVENT_MASK

public static final long INPUT_METHOD_EVENT_MASK
Mask for input method events.
Field Value:
2048L
Since:
1.3

INVOCATION_EVENT_MASK

public static final long INVOCATION_EVENT_MASK
Mask for invocation events.
Field Value:
16384L
Since:
1.3

ITEM_EVENT_MASK

public static final long ITEM_EVENT_MASK
Mask for item events.
Field Value:
512L

KEY_EVENT_MASK

public static final long KEY_EVENT_MASK
Mask for selecting keyboard events.
Field Value:
8L

MOUSE_EVENT_MASK

public static final long MOUSE_EVENT_MASK
Mask for mouse button events.
Field Value:
16L

MOUSE_MOTION_EVENT_MASK

public static final long MOUSE_MOTION_EVENT_MASK
Mask for mouse motion events.
Field Value:
32L

MOUSE_WHEEL_EVENT_MASK

public static final long MOUSE_WHEEL_EVENT_MASK
Mask for mouse wheel events.
Field Value:
131072L
Since:
1.4

PAINT_EVENT_MASK

public static final long PAINT_EVENT_MASK
Mask for paint events.
Field Value:
8192L
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.
Field Value:
1999

TEXT_EVENT_MASK

public static final long TEXT_EVENT_MASK
Mask for text events.
Field Value:
1024L

WINDOW_EVENT_MASK

public static final long WINDOW_EVENT_MASK
Mask for window events.
Field Value:
64L

WINDOW_FOCUS_EVENT_MASK

public static final long WINDOW_FOCUS_EVENT_MASK
Mask for window focus events.
Field Value:
524288L
Since:
1.4

WINDOW_STATE_EVENT_MASK

public static final long WINDOW_STATE_EVENT_MASK
Mask for window state events.
Field Value:
262144L
Since:
1.4

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.

id

protected int id
The ID of the event.

Constructor Details

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 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:
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.
Overrides:
toString in interface EventObject
Returns:
a string representing this event

AWTEvent.java -- the root event in AWT Copyright (C) 1999, 2000, 2002, 2005 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.