Serializable
KeyEvent
, MouseEvent
public abstract sealed class InputEvent extends ComponentEvent permits KeyEvent, MouseEvent
Modifier and Type | Field | Description |
---|---|---|
static final int |
ALT_DOWN_MASK |
The Alt key extended modifier constant. |
static final int |
ALT_GRAPH_DOWN_MASK |
The AltGraph key extended modifier constant. |
static final int |
ALT_GRAPH_MASK |
Deprecated. |
static final int |
ALT_MASK |
Deprecated. It is recommended that ALT_DOWN_MASK and getModifiersEx() be used instead |
static final int |
BUTTON1_DOWN_MASK |
The Mouse Button1 extended modifier constant. |
static final int |
BUTTON1_MASK |
Deprecated. It is recommended that BUTTON1_DOWN_MASK and getModifiersEx() be used instead |
static final int |
BUTTON2_DOWN_MASK |
The Mouse Button2 extended modifier constant. |
static final int |
BUTTON2_MASK |
Deprecated. It is recommended that BUTTON2_DOWN_MASK and getModifiersEx() be used instead. |
static final int |
BUTTON3_DOWN_MASK |
The Mouse Button3 extended modifier constant. |
static final int |
BUTTON3_MASK |
Deprecated. It is recommended that BUTTON3_DOWN_MASK and getModifiersEx() be used instead. |
static final int |
CTRL_DOWN_MASK |
The Control key extended modifier constant. |
static final int |
CTRL_MASK |
Deprecated. It is recommended that CTRL_DOWN_MASK and getModifiersEx() be used instead |
static final int |
META_DOWN_MASK |
The Meta key extended modifier constant. |
static final int |
META_MASK |
Deprecated. It is recommended that META_DOWN_MASK and getModifiersEx() be used instead |
static final int |
SHIFT_DOWN_MASK |
The Shift key extended modifier constant. |
static final int |
SHIFT_MASK |
Deprecated. It is recommended that SHIFT_DOWN_MASK and getModifiersEx() be used instead |
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 | 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 |
A method to obtain a mask for any existing mouse button. |
int |
getModifiers() |
Deprecated. It is recommended that extended modifier keys and getModifiersEx() be used instead |
int |
getModifiersEx() |
Returns the extended modifier mask for this event. |
static String |
getModifiersExText |
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
@Deprecated(since="9") public static final int SHIFT_MASK
getModifiersEx()
be used instead@Deprecated(since="9") public static final int CTRL_MASK
getModifiersEx()
be used instead@Deprecated(since="9") public static final int META_MASK
getModifiersEx()
be used instead@Deprecated(since="9") public static final int ALT_MASK
getModifiersEx()
be used instead@Deprecated(since="9") public static final int ALT_GRAPH_MASK
getModifiersEx()
be used instead@Deprecated(since="9") public static final int BUTTON1_MASK
getModifiersEx()
be used instead@Deprecated(since="9") public static final int BUTTON2_MASK
getModifiersEx()
be used instead. Note that BUTTON2_MASK has the same value as ALT_MASK.@Deprecated(since="9") public static final int BUTTON3_MASK
getModifiersEx()
be used instead. Note that BUTTON3_MASK has the same value as META_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 buttonspublic boolean isShiftDown()
public boolean isControlDown()
public boolean isMetaDown()
public boolean isAltDown()
public boolean isAltGraphDown()
public long getWhen()
@Deprecated(since="9") public int getModifiers()
getModifiersEx()
be used insteadpublic int getModifiersEx()
Extended modifiers are the modifiers that ends with the _DOWN_MASK suffix, such as ALT_DOWN_MASK, BUTTON1_DOWN_MASK, and others.
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.
public void consume()
public boolean isConsumed()
isConsumed
in class AWTEvent
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
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/event/InputEvent.html
getModifiersEx()
be used instead