java.awt.event
Class ActionEvent

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject 
      extended by java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent 
          extended by java.awt.event.ActionEvent
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class ActionEvent
extends AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.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 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".

Since:
1.1
See Also:
ActionListener sample code for java.awt.event.ActionListener definition code for java.awt.event.ActionListener , Tutorial: Java 1.1 Event Model, Reference: The Java Class Libraries (update file), Serialized Form

Field Summary
static int ACTION_FIRST sample code for java.awt.event.ActionEvent.ACTION_FIRST definition code for java.awt.event.ActionEvent.ACTION_FIRST
          The first number in the range of ids used for action events.
static int ACTION_LAST sample code for java.awt.event.ActionEvent.ACTION_LAST definition code for java.awt.event.ActionEvent.ACTION_LAST
          The last number in the range of ids used for action events.
static int ACTION_PERFORMED sample code for java.awt.event.ActionEvent.ACTION_PERFORMED definition code for java.awt.event.ActionEvent.ACTION_PERFORMED
          This event id indicates that a meaningful action occured.
static int ALT_MASK sample code for java.awt.event.ActionEvent.ALT_MASK definition code for java.awt.event.ActionEvent.ALT_MASK
          The alt modifier.
static int CTRL_MASK sample code for java.awt.event.ActionEvent.CTRL_MASK definition code for java.awt.event.ActionEvent.CTRL_MASK
          The control modifier.
static int META_MASK sample code for java.awt.event.ActionEvent.META_MASK definition code for java.awt.event.ActionEvent.META_MASK
          The meta modifier.
static int SHIFT_MASK sample code for java.awt.event.ActionEvent.SHIFT_MASK definition code for java.awt.event.ActionEvent.SHIFT_MASK
          The shift modifier.
 
Fields inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
ACTION_EVENT_MASK sample code for java.awt.AWTEvent.ACTION_EVENT_MASK definition code for java.awt.AWTEvent.ACTION_EVENT_MASK , ADJUSTMENT_EVENT_MASK sample code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK definition code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK , COMPONENT_EVENT_MASK sample code for java.awt.AWTEvent.COMPONENT_EVENT_MASK definition code for java.awt.AWTEvent.COMPONENT_EVENT_MASK , consumed sample code for java.awt.AWTEvent.consumed definition code for java.awt.AWTEvent.consumed , CONTAINER_EVENT_MASK sample code for java.awt.AWTEvent.CONTAINER_EVENT_MASK definition code for java.awt.AWTEvent.CONTAINER_EVENT_MASK , FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.FOCUS_EVENT_MASK , HIERARCHY_BOUNDS_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK , HIERARCHY_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK , id sample code for java.awt.AWTEvent.id definition code for java.awt.AWTEvent.id , INPUT_METHOD_EVENT_MASK sample code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK definition code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK , INVOCATION_EVENT_MASK sample code for java.awt.AWTEvent.INVOCATION_EVENT_MASK definition code for java.awt.AWTEvent.INVOCATION_EVENT_MASK , ITEM_EVENT_MASK sample code for java.awt.AWTEvent.ITEM_EVENT_MASK definition code for java.awt.AWTEvent.ITEM_EVENT_MASK , KEY_EVENT_MASK sample code for java.awt.AWTEvent.KEY_EVENT_MASK definition code for java.awt.AWTEvent.KEY_EVENT_MASK , MOUSE_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_EVENT_MASK , MOUSE_MOTION_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK , MOUSE_WHEEL_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK , PAINT_EVENT_MASK sample code for java.awt.AWTEvent.PAINT_EVENT_MASK definition code for java.awt.AWTEvent.PAINT_EVENT_MASK , RESERVED_ID_MAX sample code for java.awt.AWTEvent.RESERVED_ID_MAX definition code for java.awt.AWTEvent.RESERVED_ID_MAX , TEXT_EVENT_MASK sample code for java.awt.AWTEvent.TEXT_EVENT_MASK definition code for java.awt.AWTEvent.TEXT_EVENT_MASK , WINDOW_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_EVENT_MASK , WINDOW_FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK , WINDOW_STATE_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK
 
Fields inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
source sample code for java.util.EventObject.source definition code for java.util.EventObject.source
 
Constructor Summary
ActionEvent sample code for java.awt.event.ActionEvent.ActionEvent(java.lang.Object, int, java.lang.String) definition code for java.awt.event.ActionEvent.ActionEvent(java.lang.Object, int, java.lang.String) (Object sample code for java.lang.Object definition code for java.lang.Object  source, int id, String sample code for java.lang.String definition code for java.lang.String  command)
          Constructs an ActionEvent object.
ActionEvent sample code for java.awt.event.ActionEvent.ActionEvent(java.lang.Object, int, java.lang.String, int) definition code for java.awt.event.ActionEvent.ActionEvent(java.lang.Object, int, java.lang.String, int) (Object sample code for java.lang.Object definition code for java.lang.Object  source, int id, String sample code for java.lang.String definition code for java.lang.String  command, int modifiers)
          Constructs an ActionEvent object with modifier keys.
ActionEvent sample code for java.awt.event.ActionEvent.ActionEvent(java.lang.Object, int, java.lang.String, long, int) definition code for java.awt.event.ActionEvent.ActionEvent(java.lang.Object, int, java.lang.String, long, int) (Object sample code for java.lang.Object definition code for java.lang.Object  source, int id, String sample code for java.lang.String definition code for java.lang.String  command, long when, int modifiers)
          Constructs an ActionEvent object with the specified modifier keys and timestamp.
 
Method Summary
 String sample code for java.lang.String definition code for java.lang.String getActionCommand sample code for java.awt.event.ActionEvent.getActionCommand() definition code for java.awt.event.ActionEvent.getActionCommand() ()
          Returns the command string associated with this action.
 int getModifiers sample code for java.awt.event.ActionEvent.getModifiers() definition code for java.awt.event.ActionEvent.getModifiers() ()
          Returns the modifier keys held down during this action event.
 long getWhen sample code for java.awt.event.ActionEvent.getWhen() definition code for java.awt.event.ActionEvent.getWhen() ()
          Returns the timestamp of when this event occurred.
 String sample code for java.lang.String definition code for java.lang.String paramString sample code for java.awt.event.ActionEvent.paramString() definition code for java.awt.event.ActionEvent.paramString() ()
          Returns a parameter string identifying this action event.
 
Methods inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
consume sample code for java.awt.AWTEvent.consume() definition code for java.awt.AWTEvent.consume() , getID sample code for java.awt.AWTEvent.getID() definition code for java.awt.AWTEvent.getID() , isConsumed sample code for java.awt.AWTEvent.isConsumed() definition code for java.awt.AWTEvent.isConsumed() , setSource sample code for java.awt.AWTEvent.setSource(java.lang.Object) definition code for java.awt.AWTEvent.setSource(java.lang.Object) , toString sample code for java.awt.AWTEvent.toString() definition code for java.awt.AWTEvent.toString()
 
Methods inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
getSource sample code for java.util.EventObject.getSource() definition code for java.util.EventObject.getSource()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

SHIFT_MASK sample code for java.awt.event.ActionEvent.SHIFT_MASK

public static final int SHIFT_MASK
The shift modifier. An indicator that the shift key was held down during the event.

See Also:
Constant Field Values

CTRL_MASK sample code for java.awt.event.ActionEvent.CTRL_MASK

public static final int CTRL_MASK
The control modifier. An indicator that the control key was held down during the event.

See Also:
Constant Field Values

META_MASK sample code for java.awt.event.ActionEvent.META_MASK

public static final int META_MASK
The meta modifier. An indicator that the meta key was held down during the event.

See Also:
Constant Field Values

ALT_MASK sample code for java.awt.event.ActionEvent.ALT_MASK

public static final int ALT_MASK
The alt modifier. An indicator that the alt key was held down during the event.

See Also:
Constant Field Values

ACTION_FIRST sample code for java.awt.event.ActionEvent.ACTION_FIRST

public static final int ACTION_FIRST
The first number in the range of ids used for action events.

See Also:
Constant Field Values

ACTION_LAST sample code for java.awt.event.ActionEvent.ACTION_LAST

public static final int ACTION_LAST
The last number in the range of ids used for action events.

See Also:
Constant Field Values

ACTION_PERFORMED sample code for java.awt.event.ActionEvent.ACTION_PERFORMED

public static final int ACTION_PERFORMED
This event id indicates that a meaningful action occured.

See Also:
Constant Field Values
Constructor Detail

ActionEvent sample code for java.awt.event.ActionEvent(java.lang.Object, int, java.lang.String) definition code for java.awt.event.ActionEvent(java.lang.Object, int, java.lang.String)

public ActionEvent(Object sample code for java.lang.Object definition code for java.lang.Object  source,
                   int id,
                   String sample code for java.lang.String definition code for java.lang.String  command)
Constructs an ActionEvent object.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null. A null command string is legal, but not recommended.

Parameters:
source - the object that originated the event
id - an integer that identifies the event
command - a string that may specify a command (possibly one of several) associated with the event
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if source is null

ActionEvent sample code for java.awt.event.ActionEvent(java.lang.Object, int, java.lang.String, int) definition code for java.awt.event.ActionEvent(java.lang.Object, int, java.lang.String, int)

public ActionEvent(Object sample code for java.lang.Object definition code for java.lang.Object  source,
                   int id,
                   String sample code for java.lang.String definition code for java.lang.String  command,
                   int modifiers)
Constructs an ActionEvent object with modifier keys.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null. A null command string is legal, but not recommended.

Parameters:
source - the object that originated the event
id - an integer that identifies the event
command - a string that may specify a command (possibly one of several) associated with the event
modifiers - the modifier keys held down during this action
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if source is null

ActionEvent sample code for java.awt.event.ActionEvent(java.lang.Object, int, java.lang.String, long, int) definition code for java.awt.event.ActionEvent(java.lang.Object, int, java.lang.String, long, int)

public ActionEvent(Object sample code for java.lang.Object definition code for java.lang.Object  source,
                   int id,
                   String sample code for java.lang.String definition code for java.lang.String  command,
                   long when,
                   int modifiers)
Constructs an ActionEvent object with the specified modifier keys and timestamp.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null. A null command string is legal, but not recommended.

Parameters:
source - the object that originated the event
id - an integer that identifies the event
command - a string that may specify a command (possibly one of several) associated with the event
when - the time the event occurred
modifiers - the modifier keys held down during this action
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if source is null
Since:
1.4
Method Detail

getActionCommand sample code for java.awt.event.ActionEvent.getActionCommand() definition code for java.awt.event.ActionEvent.getActionCommand()

public String sample code for java.lang.String definition code for java.lang.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.

Returns:
the string identifying the command for this event

getWhen sample code for java.awt.event.ActionEvent.getWhen() definition code for java.awt.event.ActionEvent.getWhen()

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.

Returns:
this event's timestamp
Since:
1.4

getModifiers sample code for java.awt.event.ActionEvent.getModifiers() definition code for java.awt.event.ActionEvent.getModifiers()

public int getModifiers()
Returns the modifier keys held down during this action event.

Returns:
the bitwise-or of the modifier constants

paramString sample code for java.awt.event.ActionEvent.paramString() definition code for java.awt.event.ActionEvent.paramString()

public String sample code for java.lang.String definition code for java.lang.String  paramString()
Returns a parameter string identifying this action event. This method is useful for event-logging and for debugging.

Overrides:
paramString sample code for java.awt.AWTEvent.paramString() definition code for java.awt.AWTEvent.paramString() in class AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
Returns:
a string identifying the event and its associated command