public abstract class InputEvent extends ComponentEvent
KeyEvent
,
KeyAdapter
,
MouseEvent
,
MouseAdapter
,
MouseMotionAdapter
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
ALT_DOWN_MASK
The Alt key extended modifier constant.
|
static int |
ALT_GRAPH_DOWN_MASK
The AltGraph key extended modifier constant.
|
static int |
ALT_GRAPH_MASK
The AltGraph key modifier constant.
|
static int |
ALT_MASK
The Alt key modifier constant.
|
static int |
BUTTON1_DOWN_MASK
The Mouse Button1 extended modifier constant.
|
static int |
BUTTON1_MASK
The Mouse Button1 modifier constant.
|
static int |
BUTTON2_DOWN_MASK
The Mouse Button2 extended modifier constant.
|
static int |
BUTTON2_MASK
The Mouse Button2 modifier constant.
|
static int |
BUTTON3_DOWN_MASK
The Mouse Button3 extended modifier constant.
|
static int |
BUTTON3_MASK
The Mouse Button3 modifier constant.
|
static int |
CTRL_DOWN_MASK
The Control key extended modifier constant.
|
static int |
CTRL_MASK
The Control key modifier constant.
|
static int |
META_DOWN_MASK
The Meta key extended modifier constant.
|
static int |
META_MASK
The Meta key modifier constant.
|
static int |
SHIFT_DOWN_MASK
The Shift key extended modifier constant.
|
static int |
SHIFT_MASK
The Shift key modifier constant.
|
COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN
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
source
Modifier and Type | Method and Description |
---|---|
void |
consume()
Consumes this event so that it will not be processed
in the default manner by the source which originated it.
|
static int |
getMaskForButton(int button)
A method to obtain a mask for any existing mouse button.
|
int |
getModifiers()
Returns the modifier mask for this event.
|
int |
getModifiersEx()
Returns the extended modifier mask for this event.
|
static String |
getModifiersExText(int modifiers)
Returns a String describing the extended modifier keys and
mouse buttons, such as "Shift", "Button1", or "Ctrl+Shift".
|
long |
getWhen()
Returns the difference in milliseconds between the timestamp of when this event occurred and
midnight, January 1, 1970 UTC.
|
boolean |
isAltDown()
Returns whether or not the Alt modifier is down on this event.
|
boolean |
isAltGraphDown()
Returns whether or not the AltGraph modifier is down on this event.
|
boolean |
isConsumed()
Returns whether or not this event has been consumed.
|
boolean |
isControlDown()
Returns whether or not the Control modifier is down on this event.
|
boolean |
isMetaDown()
Returns whether or not the Meta modifier is down on this event.
|
boolean |
isShiftDown()
Returns whether or not the Shift modifier is down on this event.
|
getComponent, paramString
getSource
public static final int SHIFT_MASK
public static final int CTRL_MASK
public static final int META_MASK
public static final int ALT_MASK
public static final int ALT_GRAPH_MASK
public static final int BUTTON1_MASK
public static final int BUTTON2_MASK
public static final int BUTTON3_MASK
public static final int SHIFT_DOWN_MASK
public static final int CTRL_DOWN_MASK
public static final int META_DOWN_MASK
public static final int ALT_DOWN_MASK
public static final int BUTTON1_DOWN_MASK
public static final int BUTTON2_DOWN_MASK
public static final int BUTTON3_DOWN_MASK
public static final int ALT_GRAPH_DOWN_MASK
public static int getMaskForButton(int button)
mousePress(buttons)
and
mouseRelease(buttons)
modifiers
parameter when creating a new MouseEvent
instance
modifiersEx
of existing MouseEvent
button
- is a number to represent a button starting from 1.
For example,
int button = InputEvent.getMaskForButton(1);will have the same meaning as
int button = InputEvent.getMaskForButton(MouseEvent.BUTTON1);because
MouseEvent.BUTTON1
equals to 1.
If a mouse has three enabled buttons(see MouseInfo.getNumberOfButtons()
)
then the values from the left column passed into the method will return
corresponding values from the right column:
button returned maskIf a mouse has more than three enabled buttons then more values are admissible (4, 5, etc.). There is no assigned constants for these extended buttons. The button masks for the extra buttons returned by this method have no assigned names like the first three button masks.BUTTON1
BUTTON1_DOWN_MASK
BUTTON2
BUTTON2_DOWN_MASK
BUTTON3
BUTTON3_DOWN_MASK
This method has the following implementation restriction.
It returns masks for a limited number of buttons only. The maximum number is
implementation dependent and may vary.
This limit is defined by the relevant number
of buttons that may hypothetically exist on the mouse but it is greater than the
MouseInfo.getNumberOfButtons()
.
IllegalArgumentException
- if button
is less than zero or greater than the number
of button masks reserved for buttonsMouseInfo.getNumberOfButtons()
,
Toolkit.areExtraMouseButtonsEnabled()
,
getModifiers()
,
MouseEvent.getModifiersEx()
public boolean isShiftDown()
public boolean isControlDown()
public boolean isMetaDown()
public boolean isAltDown()
public boolean isAltGraphDown()
public long getWhen()
public int getModifiers()
public int getModifiersEx()
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.
public void consume()
public boolean isConsumed()
isConsumed
in class AWTEvent
consume()
public static String getModifiersExText(int modifiers)
awt.properties
file.
Note that passing negative parameter is incorrect, and will cause the returning an unspecified string. Zero parameter means that no modifiers were passed and will cause the returning an empty string.
modifiers
- a modifier mask describing the extended
modifier keys and mouse buttons for the event Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.