public class ActionEvent extends AWTEvent
A semantic event which indicates that a component-defined action occurred. This high-level event is generated by a component (such as a 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 Formpublic static final int SHIFT_MASK
The shift modifier. An indicator that the shift key was held down during the event.
public static final int CTRL_MASK
The control modifier. An indicator that the control key was held down during the event.
public static final int META_MASK
The meta modifier. An indicator that the meta key was held down during the event.
public static final int ALT_MASK
The alt modifier. An indicator that the alt key was held down during the event.
public static final int ACTION_FIRST
The first number in the range of ids used for action events.
public static final int ACTION_LAST
The last number in the range of ids used for action events.
@Native public static final int ACTION_PERFORMED
This event id indicates that a meaningful action occurred.
public ActionEvent(Object source,
int id,
String command) Constructs an 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) Constructs an 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) Constructs an 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()
Returns the command string associated with this action. This string allows a "modal" component to specify one of several commands, depending on its state. For example, a single button might toggle between "show details" and "hide details". The source object and the event would be the same in each case, but the command string would identify the intended action.
Note that if a null command string was passed to the constructor for this ActionEvent, this this method returns null.
public long getWhen()
Returns the timestamp of when this event occurred. Because an ActionEvent is a high-level, semantic event, the timestamp is typically the same as an underlying InputEvent.
public int getModifiers()
Returns the modifier keys held down during this action event.
public String paramString()
Returns a parameter string identifying this action event. This method is useful for event-logging and for debugging.
paramString in class AWTEvent
© 1993–2017, 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.