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
.
ActionListener
,
Tutorial: How to Write an Action Listener,
Serialized FormModifier and Type | Field | Description |
---|---|---|
static int |
ACTION_FIRST |
The first number in the range of ids used for action events.
|
static int |
ACTION_LAST |
The last number in the range of ids used for action events.
|
static int |
ACTION_PERFORMED |
This event id indicates that a meaningful action occurred.
|
static int |
ALT_MASK |
The alt modifier.
|
static int |
CTRL_MASK |
The control modifier.
|
static int |
META_MASK |
The meta modifier.
|
static 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(Object source,
int id,
String command) |
Constructs an
ActionEvent object. |
ActionEvent(Object source,
int id,
String command,
int modifiers) |
Constructs an
ActionEvent object with modifier keys. |
ActionEvent(Object source,
int id,
String command,
long when,
int modifiers) |
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 nullEventObject.getSource()
,
AWTEvent.getID()
,
getActionCommand()
public 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 nullEventObject.getSource()
,
AWTEvent.getID()
,
getActionCommand()
,
getModifiers()
public 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 eventmodifiers
- The modifier keys down during event
(shift, ctrl, alt, meta).
Passing negative parameter is not recommended.
Zero value means that no modifiers were passedwhen
- A long that gives the time the event occurred.
Passing negative or zero value
is not recommendedIllegalArgumentException
- if source
is nullEventObject.getSource()
,
AWTEvent.getID()
,
getActionCommand()
,
getModifiers()
,
getWhen()
public 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
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, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps