ActionEvent JDK 1.6)

Description

public class ActionEvent

A semantic event which indicates that a component-defined action occurred.

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".

See also: ActionListener Tutorial: Java 1.1 Event Model

Constructors

public ActionEvent (Object source, int id, 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 - if source is null

public ActionEvent (Object source, int id, 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 - if source is null

public ActionEvent (Object source, int id, 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 - if source is null
Since: 1.4

Methods

Hide/Show inherited methods

protected void consume () [Inherited From AWTEvent]

Consumes this event, if this event can be consumed.

public String getActionCommand ()

Returns the command string associated with this action.

public int getID () [Inherited From AWTEvent]

Returns the event type.

public int getModifiers ()

Returns the modifier keys held down during this action event.

public Object getSource () [Inherited From EventObject]

The object on which the Event initially occurred.

public long getWhen ()

Returns the timestamp of when this event occurred.

protected boolean isConsumed () [Inherited From AWTEvent]

Returns whether this event has been consumed.

public String paramString () [Overrides AWTEvent]

Returns a parameter string identifying this action event.

public void setSource (Object newSource) [Inherited From AWTEvent]

Retargets an event to a new source.

public String toString () [Inherited From AWTEvent]

Returns a String representation of this object.

Fields

Hide/Show inherited fields

publicfinalstatic long ACTION_EVENT_MASK = "128" [Inherited From AWTEvent]

The event mask for selecting action events.

publicfinalstatic int ACTION_FIRST = "1001"

The first number in the range of ids used for action events.

publicfinalstatic int ACTION_LAST = "1001"

The last number in the range of ids used for action events.

publicfinalstatic int ACTION_PERFORMED = "1001"

This event id indicates that a meaningful action occured.

pack-private String actionCommand

The nonlocalized string that gives more details of what actually caused the event.

publicfinalstatic long ADJUSTMENT_EVENT_MASK = "256" [Inherited From AWTEvent]

The event mask for selecting adjustment events.

publicfinalstatic int ALT_MASK = "8"

The alt modifier.

publicfinalstatic long COMPONENT_EVENT_MASK = "1" [Inherited From AWTEvent]

The event mask for selecting component events.

protected boolean consumed [Inherited From AWTEvent]

Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not.

publicfinalstatic long CONTAINER_EVENT_MASK = "2" [Inherited From AWTEvent]

The event mask for selecting container events.

publicfinalstatic int CTRL_MASK = "2"

The control modifier.

publicfinalstatic long FOCUS_EVENT_MASK = "4" [Inherited From AWTEvent]

The event mask for selecting focus events.

publicfinalstatic long HIERARCHY_BOUNDS_EVENT_MASK = "65536" [Inherited From AWTEvent]

The event mask for selecting hierarchy bounds events.

publicfinalstatic long HIERARCHY_EVENT_MASK = "32768" [Inherited From AWTEvent]

The event mask for selecting hierarchy events.

protected int id [Inherited From AWTEvent]

The event's id.

publicfinalstatic long INPUT_METHOD_EVENT_MASK = "2048" [Inherited From AWTEvent]

The event mask for selecting input method events.

publicfinalstatic long INVOCATION_EVENT_MASK = "16384" [Inherited From AWTEvent]

The event mask for selecting invocation events.

publicfinalstatic long ITEM_EVENT_MASK = "512" [Inherited From AWTEvent]

The event mask for selecting item events.

publicfinalstatic long KEY_EVENT_MASK = "8" [Inherited From AWTEvent]

The event mask for selecting key events.

publicfinalstatic int META_MASK = "4"

The meta modifier.

pack-private int modifiers

This represents the key modifier that was selected, and is used to determine the state of the selected key.

publicfinalstatic long MOUSE_EVENT_MASK = "16" [Inherited From AWTEvent]

The event mask for selecting mouse events.

publicfinalstatic long MOUSE_MOTION_EVENT_MASK = "32" [Inherited From AWTEvent]

The event mask for selecting mouse motion events.

publicfinalstatic long MOUSE_WHEEL_EVENT_MASK = "131072" [Inherited From AWTEvent]

The event mask for selecting mouse wheel events.

publicfinalstatic long PAINT_EVENT_MASK = "8192" [Inherited From AWTEvent]

The event mask for selecting paint events.

publicfinalstatic int RESERVED_ID_MAX = "1999" [Inherited From AWTEvent]

The maximum value for reserved AWT event IDs.

publicfinalstatic int SHIFT_MASK = "1"

The shift modifier.

protectedtransient Object source [Inherited From EventObject]

The object on which the Event initially occurred.

publicfinalstatic long TEXT_EVENT_MASK = "1024" [Inherited From AWTEvent]

The event mask for selecting text events.

pack-private long when

Timestamp of when this event occurred.

publicfinalstatic long WINDOW_EVENT_MASK = "64" [Inherited From AWTEvent]

The event mask for selecting window events.

publicfinalstatic long WINDOW_FOCUS_EVENT_MASK = "524288" [Inherited From AWTEvent]

The event mask for selecting window focus events.

publicfinalstatic long WINDOW_STATE_EVENT_MASK = "262144" [Inherited From AWTEvent]

The event mask for selecting window state events.