Serializable
public class ActionEvent extends AWTEvent
Button
) when the component-specific action occurs (such as being pressed). The event is passed to every ActionListener
object that registered to receive such events using the component's addActionListener
method. Note: To invoke an ActionEvent
on a Button
using the keyboard, use the Space bar.
The object that implements the ActionListener
interface gets this ActionEvent
when the event occurs. The listener is therefore spared the details of processing individual mouse movements and mouse clicks, and can instead process a "meaningful" (semantic) event like "button pressed".
An unspecified behavior will be caused if the id
parameter of any particular ActionEvent
instance is not in the range from ACTION_FIRST
to ACTION_LAST
.
Modifier and Type | Field | Description |
---|---|---|
static final int |
ACTION_FIRST |
The first number in the range of ids used for action events. |
static final int |
ACTION_LAST |
The last number in the range of ids used for action events. |
static final int |
ACTION_PERFORMED |
This event id indicates that a meaningful action occurred. |
static final int |
ALT_MASK |
The alt modifier. |
static final int |
CTRL_MASK |
The control modifier. |
static final int |
META_MASK |
The meta modifier. |
static final int |
SHIFT_MASK |
The shift modifier. |
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
Constructor | Description |
---|---|
ActionEvent |
Constructs an ActionEvent object. |
ActionEvent |
Constructs an ActionEvent object with modifier keys. |
ActionEvent |
Constructs an ActionEvent object with the specified modifier keys and timestamp. |
Modifier and Type | Method | Description |
---|---|---|
String |
getActionCommand() |
Returns the command string associated with this action. |
int |
getModifiers() |
Returns the modifier keys held down during this action event. |
long |
getWhen() |
Returns the timestamp of when this event occurred. |
String |
paramString() |
Returns a parameter string identifying this action event. |
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 ACTION_FIRST
public static final int ACTION_LAST
@Native public static final int ACTION_PERFORMED
public ActionEvent(Object source, int id, String command)
ActionEvent
object. This method throws an IllegalArgumentException
if source
is null
. A null command
string is legal, but not recommended.
source
- The object that originated the eventid
- An integer that identifies the event. For information on allowable values, see the class description for ActionEvent
command
- A string that may specify a command (possibly one of several) associated with the eventIllegalArgumentException
- if source
is nullpublic ActionEvent(Object source, int id, String command, int modifiers)
ActionEvent
object with modifier keys. This method throws an IllegalArgumentException
if source
is null
. A null command
string is legal, but not recommended.
source
- The object that originated the eventid
- An integer that identifies the event. For information on allowable values, see the class description for ActionEvent
command
- A string that may specify a command (possibly one of several) associated with the eventmodifiers
- The modifier keys down during event (shift, ctrl, alt, meta). Passing negative parameter is not recommended. Zero value means that no modifiers were passedIllegalArgumentException
- if source
is nullpublic ActionEvent(Object source, int id, String command, long when, int modifiers)
ActionEvent
object with the specified modifier keys and timestamp. This method throws an IllegalArgumentException
if source
is null
. A null command
string is legal, but not recommended.
source
- The object that originated the eventid
- An integer that identifies the event. For information on allowable values, see the class description for ActionEvent
command
- A string that may specify a command (possibly one of several) associated with the eventwhen
- A long that gives the time the event occurred. Passing negative or zero value is not recommendedmodifiers
- The modifier keys down during event (shift, ctrl, alt, meta). Passing negative parameter is not recommended. Zero value means that no modifiers were passedIllegalArgumentException
- if source
is nullpublic String getActionCommand()
Note that if a null
command string was passed to the constructor for this ActionEvent
, this this method returns null
.
public long getWhen()
public int getModifiers()
public String paramString()
paramString
in class AWTEvent
© 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/ActionEvent.html