java.awt.event
Class InputEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--java.awt.AWTEvent
              |
              +--java.awt.event.ComponentEvent
                    |
                    +--java.awt.event.InputEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

KeyEvent, MouseEvent

public abstract class InputEvent

extends ComponentEvent

Safe: The root event class for all component-level input events. Input events are delivered to listeners before they are processed normally by the source where they originated. This allows listeners and component subclasses to "consume" the event so that the source will not process them in their default manner. For example, consuming mousePressed events on a Button component will prevent the Button from being activated.

Since:

1.1

Version:

1.27 12/03/01

Author:

Carl Quinn

See Also:

KeyEvent, KeyAdapter, MouseEvent, MouseAdapter, MouseMotionAdapter, Serialized Form

Field Summary

static int	ALT_DOWN_MASK Enabled: The ALT key extended modifier constant.
static int	ALT_GRAPH_DOWN_MASK Enabled: The alt-graph key extended modifier constant.
static int	ALT_GRAPH_MASK Enabled: The alt-graph key modifier constant.
static int	ALT_MASK Enabled: The alt key modifier constant.
static int	BUTTON1_DOWN_MASK Enabled: The mouse button1 extended modifier constant.
static int	BUTTON1_MASK Enabled: The mouse button1 modifier constant.
static int	BUTTON2_DOWN_MASK Enabled: The mouse button2 extended modifier constant.
static int	BUTTON2_MASK Enabled: The mouse button2 modifier constant.
static int	BUTTON3_DOWN_MASK Enabled: The mouse button3 extended modifier constant.
static int	BUTTON3_MASK Enabled: The mouse button3 modifier constant.
static int	CTRL_DOWN_MASK Enabled: The CTRL key extended modifier constant.
static int	CTRL_MASK Enabled: The control key modifier constant.
(package private) static int	JDK_1_3_MODIFIERS
static int	META_DOWN_MASK Enabled: The META key extended modifier constant.
static int	META_MASK Enabled: The meta key modifier constant.
(package private) int	modifiers The state of the modifier key at the time the input event was fired.
(package private) static long	serialVersionUID
static int	SHIFT_DOWN_MASK Enabled: The SHIFT key extended modifier constant.
static int	SHIFT_MASK Enabled: The shift key modifier constant.
(package private) long	when The input events Time stamp.

Fields inherited from class java.awt.event.ComponentEvent

COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

(package private)

InputEvent(Component source, int id, long when, int modifiers) Constructs an InputEvent object with the specified source component, modifiers, and type.

Method Summary

void	consume() Enabled: Consumes this event so that it will not be processed in the default manner by the source which originated it.
int	getModifiers() Enabled: Returns the modifiers flag for this event.
int	getModifiersEx() Suppressed: Returns the extended modifiers flag for this event.
static String	getModifiersExText(int modifiers) Suppressed: Returns a String describing the extended modifier key(s), such as "Shift", "Button1" or "Ctrl+Shift" .
long	getWhen() Enabled: Returns the timestamp of when this event occurred.
private static void	initIDs() Initialize JNI field and method IDs for fields that may be accessed from C.
boolean	isAltDown() Enabled: Returns whether or not the Alt modifier is down on this event.
boolean	isAltGraphDown() Enabled: Returns whether or not the Alt-Graph modifier is down on this event.
boolean	isConsumed() Enabled: Returns whether or not this event has been consumed.
boolean	isControlDown() Enabled: Returns whether or not the Control modifier is down on this event.
boolean	isMetaDown() Enabled: Returns whether or not the Meta modifier is down on this event.
boolean	isShiftDown() Enabled: Returns whether or not the Shift modifier is down on this event.

Methods inherited from class java.awt.event.ComponentEvent

getComponent, paramString

Methods inherited from class java.awt.AWTEvent

getID, setSource, toString

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

SHIFT_MASK

public static final int SHIFT_MASK

Enabled: The shift key modifier constant. It is recommended that SHIFT_DOWN_MASK to be used instead.

CTRL_MASK

public static final int CTRL_MASK

Enabled: The control key modifier constant. It is recommended that CTRL_DOWN_MASK to be used instead.

META_MASK

public static final int META_MASK

Enabled: The meta key modifier constant. It is recommended that META_DOWN_MASK to be used instead.

ALT_MASK

public static final int ALT_MASK

Enabled: The alt key modifier constant. It is recommended that ALT_DOWN_MASK to be used instead.

ALT_GRAPH_MASK

public static final int ALT_GRAPH_MASK

Enabled: The alt-graph key modifier constant.

BUTTON1_MASK

public static final int BUTTON1_MASK

Enabled: The mouse button1 modifier constant. It is recommended that BUTTON1_DOWN_MASK to be used instead.

BUTTON2_MASK

public static final int BUTTON2_MASK

Enabled: The mouse button2 modifier constant. It is recommended that BUTTON2_DOWN_MASK to be used instead.

BUTTON3_MASK

public static final int BUTTON3_MASK

Enabled: The mouse button3 modifier constant. It is recommended that BUTTON3_DOWN_MASK to be used instead.

SHIFT_DOWN_MASK

public static final int SHIFT_DOWN_MASK

Enabled: The SHIFT key extended modifier constant.

Since:

1.4

CTRL_DOWN_MASK

public static final int CTRL_DOWN_MASK

Enabled: The CTRL key extended modifier constant.

Since:

1.4

META_DOWN_MASK

public static final int META_DOWN_MASK

Enabled: The META key extended modifier constant.

Since:

1.4

ALT_DOWN_MASK

public static final int ALT_DOWN_MASK

Enabled: The ALT key extended modifier constant.

Since:

1.4

BUTTON1_DOWN_MASK

public static final int BUTTON1_DOWN_MASK

Enabled: The mouse button1 extended modifier constant.

Since:

1.4

BUTTON2_DOWN_MASK

public static final int BUTTON2_DOWN_MASK

Enabled: The mouse button2 extended modifier constant.

Since:

1.4

BUTTON3_DOWN_MASK

public static final int BUTTON3_DOWN_MASK

Enabled: The mouse button3 extended modifier constant.

Since:

1.4

ALT_GRAPH_DOWN_MASK

public static final int ALT_GRAPH_DOWN_MASK

Enabled: The alt-graph key extended modifier constant.

Since:

1.4

JDK_1_3_MODIFIERS

static final int JDK_1_3_MODIFIERS

when

long when

The input events Time stamp. The time stamp is in UTC format that indicates when the input event was created.

See Also:

getWhen()

modifiers

int modifiers

The state of the modifier key at the time the input event was fired.

See Also:

getModifiers(), java.awt.event.MouseEvent

serialVersionUID

static final long serialVersionUID

Constructor Detail

InputEvent

InputEvent(Component source,
           int id,
           long when,
           int modifiers)

Constructs an InputEvent object with the specified source component, modifiers, and type.

Parameters:

source - the object where the event originated

Method Detail

initIDs

private static void initIDs()

Initialize JNI field and method IDs for fields that may be accessed from C.

isShiftDown

public boolean isShiftDown()

Enabled: Returns whether or not the Shift modifier is down on this event.

isControlDown

public boolean isControlDown()

Enabled: Returns whether or not the Control modifier is down on this event.

isMetaDown

public boolean isMetaDown()

Enabled: Returns whether or not the Meta modifier is down on this event.

isAltDown

public boolean isAltDown()

Enabled: Returns whether or not the Alt modifier is down on this event.

isAltGraphDown

public boolean isAltGraphDown()

Enabled: Returns whether or not the Alt-Graph modifier is down on this event.

getWhen

public long getWhen()

Enabled: Returns the timestamp of when this event occurred.

getModifiers

public int getModifiers()

Enabled: Returns the modifiers flag for this event.

getModifiersEx

public int getModifiersEx()

Suppressed: Returns the extended modifiers flag for this event. Extended modifiers represent state of all modal keys, such of ALT, CTRL, META and mouse buttons just after event occured

For example, if the user presses button 1 followed by button 2, and then releases them in the same order, the following sequence of events is generated:

    MOUSE_PRESSED:  BUTTON1_DOWN_MASK
    MOUSE_PRESSED:  BUTTON1_DOWN_MASK | BUTTON2_DOWN_MASK
    MOUSE_RELEASED: BUTTON2_DOWN_MASK
    MOUSE_CLICKED:  BUTTON2_DOWN_MASK
    MOUSE_RELEASED: 
    MOUSE_CLICKED:  
 

It is not recommended to compare the return value of this method via == because new modifiers can be added in the future. For example, the appropriate way to check that SHIFT and BUTTON1 are down, but CTRL is up is demonstrated by the following code:

    int onmask = SHIFT_DOWN_MASK | BUTTON1_DOWN_MASK;
    int offmask = CTRL_DOWN_MASK;
    if (event.getModifiersEx() & (onmask | offmask) == onmask) {
        ...
    }
 

The above code will work even if new modifiers are added.

Since:

1.4

consume

public void consume()

Enabled: Consumes this event so that it will not be processed in the default manner by the source which originated it.

Overrides:

consume in class AWTEvent

isConsumed

public boolean isConsumed()

Enabled: Returns whether or not this event has been consumed.

Overrides:

isConsumed in class AWTEvent

See Also:

consume()

getModifiersExText

public static String getModifiersExText(int modifiers)

Suppressed: Returns a String describing the extended modifier key(s), such as "Shift", "Button1" or "Ctrl+Shift" . These strings can be localized by changing the awt.properties file.

Returns:

string a text description of the combination of extended modifier keys that were held down during the event

Since:

1.4