java.awt.event
Class InputEvent

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject 
      extended by java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent 
          extended by java.awt.event.ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent 
              extended by java.awt.event.InputEvent
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable
Direct Known Subclasses:
KeyEvent sample code for java.awt.event.KeyEvent definition code for java.awt.event.KeyEvent , MouseEvent sample code for java.awt.event.MouseEvent definition code for java.awt.event.MouseEvent

public abstract class InputEvent
extends ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent

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
See Also:
KeyEvent sample code for java.awt.event.KeyEvent definition code for java.awt.event.KeyEvent , KeyAdapter sample code for java.awt.event.KeyAdapter definition code for java.awt.event.KeyAdapter , MouseEvent sample code for java.awt.event.MouseEvent definition code for java.awt.event.MouseEvent , MouseAdapter sample code for java.awt.event.MouseAdapter definition code for java.awt.event.MouseAdapter , MouseMotionAdapter sample code for java.awt.event.MouseMotionAdapter definition code for java.awt.event.MouseMotionAdapter , Serialized Form

Field Summary
static int ALT_DOWN_MASK sample code for java.awt.event.InputEvent.ALT_DOWN_MASK definition code for java.awt.event.InputEvent.ALT_DOWN_MASK
          The Alt key extended modifier constant.
static int ALT_GRAPH_DOWN_MASK sample code for java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK definition code for java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK
          The AltGraph key extended modifier constant.
static int ALT_GRAPH_MASK sample code for java.awt.event.InputEvent.ALT_GRAPH_MASK definition code for java.awt.event.InputEvent.ALT_GRAPH_MASK
          The AltGraph key modifier constant.
static int ALT_MASK sample code for java.awt.event.InputEvent.ALT_MASK definition code for java.awt.event.InputEvent.ALT_MASK
          The Alt key modifier constant.
static int BUTTON1_DOWN_MASK sample code for java.awt.event.InputEvent.BUTTON1_DOWN_MASK definition code for java.awt.event.InputEvent.BUTTON1_DOWN_MASK
          The Mouse Button1 extended modifier constant.
static int BUTTON1_MASK sample code for java.awt.event.InputEvent.BUTTON1_MASK definition code for java.awt.event.InputEvent.BUTTON1_MASK
          The Mouse Button1 modifier constant.
static int BUTTON2_DOWN_MASK sample code for java.awt.event.InputEvent.BUTTON2_DOWN_MASK definition code for java.awt.event.InputEvent.BUTTON2_DOWN_MASK
          The Mouse Button2 extended modifier constant.
static int BUTTON2_MASK sample code for java.awt.event.InputEvent.BUTTON2_MASK definition code for java.awt.event.InputEvent.BUTTON2_MASK
          The Mouse Button2 modifier constant.
static int BUTTON3_DOWN_MASK sample code for java.awt.event.InputEvent.BUTTON3_DOWN_MASK definition code for java.awt.event.InputEvent.BUTTON3_DOWN_MASK
          The Mouse Button3 extended modifier constant.
static int BUTTON3_MASK sample code for java.awt.event.InputEvent.BUTTON3_MASK definition code for java.awt.event.InputEvent.BUTTON3_MASK
          The Mouse Button3 modifier constant.
static int CTRL_DOWN_MASK sample code for java.awt.event.InputEvent.CTRL_DOWN_MASK definition code for java.awt.event.InputEvent.CTRL_DOWN_MASK
          The Control key extended modifier constant.
static int CTRL_MASK sample code for java.awt.event.InputEvent.CTRL_MASK definition code for java.awt.event.InputEvent.CTRL_MASK
          The Control key modifier constant.
static int META_DOWN_MASK sample code for java.awt.event.InputEvent.META_DOWN_MASK definition code for java.awt.event.InputEvent.META_DOWN_MASK
          The Meta key extended modifier constant.
static int META_MASK sample code for java.awt.event.InputEvent.META_MASK definition code for java.awt.event.InputEvent.META_MASK
          The Meta key modifier constant.
static int SHIFT_DOWN_MASK sample code for java.awt.event.InputEvent.SHIFT_DOWN_MASK definition code for java.awt.event.InputEvent.SHIFT_DOWN_MASK
          The Shift key extended modifier constant.
static int SHIFT_MASK sample code for java.awt.event.InputEvent.SHIFT_MASK definition code for java.awt.event.InputEvent.SHIFT_MASK
          The Shift key modifier constant.
 
Fields inherited from class java.awt.event.ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent
COMPONENT_FIRST sample code for java.awt.event.ComponentEvent.COMPONENT_FIRST definition code for java.awt.event.ComponentEvent.COMPONENT_FIRST , COMPONENT_HIDDEN sample code for java.awt.event.ComponentEvent.COMPONENT_HIDDEN definition code for java.awt.event.ComponentEvent.COMPONENT_HIDDEN , COMPONENT_LAST sample code for java.awt.event.ComponentEvent.COMPONENT_LAST definition code for java.awt.event.ComponentEvent.COMPONENT_LAST , COMPONENT_MOVED sample code for java.awt.event.ComponentEvent.COMPONENT_MOVED definition code for java.awt.event.ComponentEvent.COMPONENT_MOVED , COMPONENT_RESIZED sample code for java.awt.event.ComponentEvent.COMPONENT_RESIZED definition code for java.awt.event.ComponentEvent.COMPONENT_RESIZED , COMPONENT_SHOWN sample code for java.awt.event.ComponentEvent.COMPONENT_SHOWN definition code for java.awt.event.ComponentEvent.COMPONENT_SHOWN
 
Fields inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
ACTION_EVENT_MASK sample code for java.awt.AWTEvent.ACTION_EVENT_MASK definition code for java.awt.AWTEvent.ACTION_EVENT_MASK , ADJUSTMENT_EVENT_MASK sample code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK definition code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK , COMPONENT_EVENT_MASK sample code for java.awt.AWTEvent.COMPONENT_EVENT_MASK definition code for java.awt.AWTEvent.COMPONENT_EVENT_MASK , consumed sample code for java.awt.AWTEvent.consumed definition code for java.awt.AWTEvent.consumed , CONTAINER_EVENT_MASK sample code for java.awt.AWTEvent.CONTAINER_EVENT_MASK definition code for java.awt.AWTEvent.CONTAINER_EVENT_MASK , FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.FOCUS_EVENT_MASK , HIERARCHY_BOUNDS_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK , HIERARCHY_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK , id sample code for java.awt.AWTEvent.id definition code for java.awt.AWTEvent.id , INPUT_METHOD_EVENT_MASK sample code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK definition code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK , INVOCATION_EVENT_MASK sample code for java.awt.AWTEvent.INVOCATION_EVENT_MASK definition code for java.awt.AWTEvent.INVOCATION_EVENT_MASK , ITEM_EVENT_MASK sample code for java.awt.AWTEvent.ITEM_EVENT_MASK definition code for java.awt.AWTEvent.ITEM_EVENT_MASK , KEY_EVENT_MASK sample code for java.awt.AWTEvent.KEY_EVENT_MASK definition code for java.awt.AWTEvent.KEY_EVENT_MASK , MOUSE_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_EVENT_MASK , MOUSE_MOTION_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK , MOUSE_WHEEL_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK , PAINT_EVENT_MASK sample code for java.awt.AWTEvent.PAINT_EVENT_MASK definition code for java.awt.AWTEvent.PAINT_EVENT_MASK , RESERVED_ID_MAX sample code for java.awt.AWTEvent.RESERVED_ID_MAX definition code for java.awt.AWTEvent.RESERVED_ID_MAX , TEXT_EVENT_MASK sample code for java.awt.AWTEvent.TEXT_EVENT_MASK definition code for java.awt.AWTEvent.TEXT_EVENT_MASK , WINDOW_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_EVENT_MASK , WINDOW_FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK , WINDOW_STATE_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK
 
Fields inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
source sample code for java.util.EventObject.source definition code for java.util.EventObject.source
 
Method Summary
 void consume sample code for java.awt.event.InputEvent.consume() definition code for java.awt.event.InputEvent.consume() ()
          Consumes this event so that it will not be processed in the default manner by the source which originated it.
 int getModifiers sample code for java.awt.event.InputEvent.getModifiers() definition code for java.awt.event.InputEvent.getModifiers() ()
          Returns the modifier mask for this event.
 int getModifiersEx sample code for java.awt.event.InputEvent.getModifiersEx() definition code for java.awt.event.InputEvent.getModifiersEx() ()
          Returns the extended modifier mask for this event.
static String sample code for java.lang.String definition code for java.lang.String getModifiersExText sample code for java.awt.event.InputEvent.getModifiersExText(int) definition code for java.awt.event.InputEvent.getModifiersExText(int) (int modifiers)
          Returns a String describing the extended modifier keys and mouse buttons, such as "Shift", "Button1", or "Ctrl+Shift".
 long getWhen sample code for java.awt.event.InputEvent.getWhen() definition code for java.awt.event.InputEvent.getWhen() ()
          Returns the timestamp of when this event occurred.
 boolean isAltDown sample code for java.awt.event.InputEvent.isAltDown() definition code for java.awt.event.InputEvent.isAltDown() ()
          Returns whether or not the Alt modifier is down on this event.
 boolean isAltGraphDown sample code for java.awt.event.InputEvent.isAltGraphDown() definition code for java.awt.event.InputEvent.isAltGraphDown() ()
          Returns whether or not the AltGraph modifier is down on this event.
 boolean isConsumed sample code for java.awt.event.InputEvent.isConsumed() definition code for java.awt.event.InputEvent.isConsumed() ()
          Returns whether or not this event has been consumed.
 boolean isControlDown sample code for java.awt.event.InputEvent.isControlDown() definition code for java.awt.event.InputEvent.isControlDown() ()
          Returns whether or not the Control modifier is down on this event.
 boolean isMetaDown sample code for java.awt.event.InputEvent.isMetaDown() definition code for java.awt.event.InputEvent.isMetaDown() ()
          Returns whether or not the Meta modifier is down on this event.
 boolean isShiftDown sample code for java.awt.event.InputEvent.isShiftDown() definition code for java.awt.event.InputEvent.isShiftDown() ()
          Returns whether or not the Shift modifier is down on this event.
 
Methods inherited from class java.awt.event.ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent
getComponent sample code for java.awt.event.ComponentEvent.getComponent() definition code for java.awt.event.ComponentEvent.getComponent() , paramString sample code for java.awt.event.ComponentEvent.paramString() definition code for java.awt.event.ComponentEvent.paramString()
 
Methods inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
getID sample code for java.awt.AWTEvent.getID() definition code for java.awt.AWTEvent.getID() , setSource sample code for java.awt.AWTEvent.setSource(java.lang.Object) definition code for java.awt.AWTEvent.setSource(java.lang.Object) , toString sample code for java.awt.AWTEvent.toString() definition code for java.awt.AWTEvent.toString()
 
Methods inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
getSource sample code for java.util.EventObject.getSource() definition code for java.util.EventObject.getSource()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

SHIFT_MASK sample code for java.awt.event.InputEvent.SHIFT_MASK

public static final int SHIFT_MASK
The Shift key modifier constant. It is recommended that SHIFT_DOWN_MASK be used instead.

See Also:
Constant Field Values

CTRL_MASK sample code for java.awt.event.InputEvent.CTRL_MASK

public static final int CTRL_MASK
The Control key modifier constant. It is recommended that CTRL_DOWN_MASK be used instead.

See Also:
Constant Field Values

META_MASK sample code for java.awt.event.InputEvent.META_MASK

public static final int META_MASK
The Meta key modifier constant. It is recommended that META_DOWN_MASK be used instead.

See Also:
Constant Field Values

ALT_MASK sample code for java.awt.event.InputEvent.ALT_MASK

public static final int ALT_MASK
The Alt key modifier constant. It is recommended that ALT_DOWN_MASK be used instead.

See Also:
Constant Field Values

ALT_GRAPH_MASK sample code for java.awt.event.InputEvent.ALT_GRAPH_MASK

public static final int ALT_GRAPH_MASK
The AltGraph key modifier constant.

See Also:
Constant Field Values

BUTTON1_MASK sample code for java.awt.event.InputEvent.BUTTON1_MASK

public static final int BUTTON1_MASK
The Mouse Button1 modifier constant. It is recommended that BUTTON1_DOWN_MASK be used instead.

See Also:
Constant Field Values

BUTTON2_MASK sample code for java.awt.event.InputEvent.BUTTON2_MASK

public static final int BUTTON2_MASK
The Mouse Button2 modifier constant. It is recommended that BUTTON2_DOWN_MASK be used instead. Note that BUTTON2_MASK has the same value as ALT_MASK.

See Also:
Constant Field Values

BUTTON3_MASK sample code for java.awt.event.InputEvent.BUTTON3_MASK

public static final int BUTTON3_MASK
The Mouse Button3 modifier constant. It is recommended that BUTTON3_DOWN_MASK be used instead. Note that BUTTON3_MASK has the same value as META_MASK.

See Also:
Constant Field Values

SHIFT_DOWN_MASK sample code for java.awt.event.InputEvent.SHIFT_DOWN_MASK

public static final int SHIFT_DOWN_MASK
The Shift key extended modifier constant.

Since:
1.4
See Also:
Constant Field Values

CTRL_DOWN_MASK sample code for java.awt.event.InputEvent.CTRL_DOWN_MASK

public static final int CTRL_DOWN_MASK
The Control key extended modifier constant.

Since:
1.4
See Also:
Constant Field Values

META_DOWN_MASK sample code for java.awt.event.InputEvent.META_DOWN_MASK

public static final int META_DOWN_MASK
The Meta key extended modifier constant.

Since:
1.4
See Also:
Constant Field Values

ALT_DOWN_MASK sample code for java.awt.event.InputEvent.ALT_DOWN_MASK

public static final int ALT_DOWN_MASK
The Alt key extended modifier constant.

Since:
1.4
See Also:
Constant Field Values

BUTTON1_DOWN_MASK sample code for java.awt.event.InputEvent.BUTTON1_DOWN_MASK

public static final int BUTTON1_DOWN_MASK
The Mouse Button1 extended modifier constant.

Since:
1.4
See Also:
Constant Field Values

BUTTON2_DOWN_MASK sample code for java.awt.event.InputEvent.BUTTON2_DOWN_MASK

public static final int BUTTON2_DOWN_MASK
The Mouse Button2 extended modifier constant.

Since:
1.4
See Also:
Constant Field Values

BUTTON3_DOWN_MASK sample code for java.awt.event.InputEvent.BUTTON3_DOWN_MASK

public static final int BUTTON3_DOWN_MASK
The Mouse Button3 extended modifier constant.

Since:
1.4
See Also:
Constant Field Values

ALT_GRAPH_DOWN_MASK sample code for java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK

public static final int ALT_GRAPH_DOWN_MASK
The AltGraph key extended modifier constant.

Since:
1.4
See Also:
Constant Field Values
Method Detail

isShiftDown sample code for java.awt.event.InputEvent.isShiftDown() definition code for java.awt.event.InputEvent.isShiftDown()

public boolean isShiftDown()
Returns whether or not the Shift modifier is down on this event.


isControlDown sample code for java.awt.event.InputEvent.isControlDown() definition code for java.awt.event.InputEvent.isControlDown()

public boolean isControlDown()
Returns whether or not the Control modifier is down on this event.


isMetaDown sample code for java.awt.event.InputEvent.isMetaDown() definition code for java.awt.event.InputEvent.isMetaDown()

public boolean isMetaDown()
Returns whether or not the Meta modifier is down on this event.


isAltDown sample code for java.awt.event.InputEvent.isAltDown() definition code for java.awt.event.InputEvent.isAltDown()

public boolean isAltDown()
Returns whether or not the Alt modifier is down on this event.


isAltGraphDown sample code for java.awt.event.InputEvent.isAltGraphDown() definition code for java.awt.event.InputEvent.isAltGraphDown()

public boolean isAltGraphDown()
Returns whether or not the AltGraph modifier is down on this event.


getWhen sample code for java.awt.event.InputEvent.getWhen() definition code for java.awt.event.InputEvent.getWhen()

public long getWhen()
Returns the timestamp of when this event occurred.


getModifiers sample code for java.awt.event.InputEvent.getModifiers() definition code for java.awt.event.InputEvent.getModifiers()

public int getModifiers()
Returns the modifier mask for this event.


getModifiersEx sample code for java.awt.event.InputEvent.getModifiersEx() definition code for java.awt.event.InputEvent.getModifiersEx()

public int getModifiersEx()
Returns the extended modifier mask for this event. Extended modifiers represent the state of all modal keys, such as ALT, CTRL, META, and the mouse buttons just after the event occurred

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 using == 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 sample code for java.awt.event.InputEvent.consume() definition code for java.awt.event.InputEvent.consume()

public void consume()
Consumes this event so that it will not be processed in the default manner by the source which originated it.

Overrides:
consume sample code for java.awt.AWTEvent.consume() definition code for java.awt.AWTEvent.consume() in class AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent

isConsumed sample code for java.awt.event.InputEvent.isConsumed() definition code for java.awt.event.InputEvent.isConsumed()

public boolean isConsumed()
Returns whether or not this event has been consumed.

Overrides:
isConsumed sample code for java.awt.AWTEvent.isConsumed() definition code for java.awt.AWTEvent.isConsumed() in class AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
See Also:
consume() sample code for java.awt.event.InputEvent.consume() definition code for java.awt.event.InputEvent.consume()

getModifiersExText sample code for java.awt.event.InputEvent.getModifiersExText(int) definition code for java.awt.event.InputEvent.getModifiersExText(int)

public static String sample code for java.lang.String definition code for java.lang.String  getModifiersExText(int modifiers)
Returns a String describing the extended modifier keys and mouse buttons, such as "Shift", "Button1", or "Ctrl+Shift". These strings can be localized by changing the awt.properties file.

Parameters:
modifiers - a modifier mask describing the extended modifier keys and mouse buttons for the event
Returns:
a text description of the combination of extended modifier keys and mouse buttons that were held down during the event.
Since:
1.4