| |
|
| java.awt.AWTEvent
 java.awt.event.ActionEvent
| ActionEvent | | public class ActionEvent extends AWTEvent (Code) | | 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".
See Also: ActionListener
See Also: Tutorial: Java 1.1 Event Model
author:
Carl Quinn
version:
1.38 05/05/07
since:
1.1 |
| Field Summary | |
| final public static int | ACTION_FIRST
The first number in the range of ids used for action events. | | final public static int | ACTION_LAST
The last number in the range of ids used for action events. | | final public static int | ACTION_PERFORMED
This event id indicates that a meaningful action occured. | | final public static int | ALT_MASK
The alt modifier. | | final public static int | CTRL_MASK
The control modifier. | | final public static int | META_MASK
The meta modifier. | | final public static int | SHIFT_MASK
The shift modifier. | | String | actionCommand
The nonlocalized string that gives more details
of what actually caused the event. | | int | modifiers
This represents the key modifier that was selected,
and is used to determine the state of the selected key. | | long | when
Timestamp of when this event occurred. |
| Constructor Summary | |
| public | ActionEvent(Object source, int id, String command)
Constructs an ActionEvent object.
Note that passing in an invalid id results in
unspecified behavior. | | 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. | | 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. |
| Method Summary | |
| 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. | | public int | getModifiers()
Returns the modifier keys held down during this action event. | | public long | getWhen()
Returns the timestamp of when this event occurred. | | public String | paramString()
Returns a parameter string identifying this action event. |
| ACTION_FIRST | | final public static int ACTION_FIRST(Code) | | The first number in the range of ids used for action events.
|
| ACTION_LAST | | final public static int ACTION_LAST(Code) | | The last number in the range of ids used for action events.
|
| ACTION_PERFORMED | | final public static int ACTION_PERFORMED(Code) | | This event id indicates that a meaningful action occured.
|
| ALT_MASK | | final public static int ALT_MASK(Code) | | The alt modifier. An indicator that the alt key was held
down during the event.
|
| CTRL_MASK | | final public static int CTRL_MASK(Code) | | The control modifier. An indicator that the control key was held
down during the event.
|
| META_MASK | | final public static int META_MASK(Code) | | The meta modifier. An indicator that the meta key was held
down during the event.
|
| SHIFT_MASK | | final public static int SHIFT_MASK(Code) | | The shift modifier. An indicator that the shift key was held
down during the event.
|
| actionCommand | | String actionCommand(Code) | | The nonlocalized string that gives more details
of what actually caused the event.
This information is very specific to the component
that fired it.
See Also: ActionEvent.getActionCommand |
| modifiers | | int modifiers(Code) | | This represents the key modifier that was selected,
and is used to determine the state of the selected key.
If no modifier has been selected it will default to
zero.
See Also: ActionEvent.getModifiers |
| when | | long when(Code) | | 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.
See Also: ActionEvent.getWhen |
| ActionEvent | | public ActionEvent(Object source, int id, String command)(Code) | | 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
Parameters:
id - an integer that identifies the event
Parameters:
command - a string that may specify a command (possibly one of several) associated with the event
throws:
IllegalArgumentException - if source is null |
| ActionEvent | | public ActionEvent(Object source, int id, String command, int modifiers)(Code) | | 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
Parameters:
id - an integer that identifies the event
Parameters:
command - a string that may specify a command (possibly one of several) associated with the event
Parameters:
modifiers - the modifier keys held down during this action
throws:
IllegalArgumentException - if source is null |
| ActionEvent | | public ActionEvent(Object source, int id, String command, long when, int modifiers)(Code) | | 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
Parameters:
id - an integer that identifies the event
Parameters:
command - a string that may specify a command (possibly one of several) associated with the event
Parameters:
when - the time the event occurred
Parameters:
modifiers - the modifier keys held down during this action
throws:
IllegalArgumentException - if source is null
since:
1.4 |
| getActionCommand | | public String getActionCommand()(Code) | | 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.
the string identifying the command for this event |
| getModifiers | | public int getModifiers()(Code) | | Returns the modifier keys held down during this action event.
the bitwise-or of the modifier constants |
| getWhen | | public long getWhen()(Code) | | 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.
this event's timestamp
since:
1.4 |
| paramString | | public String paramString()(Code) | | Returns a parameter string identifying this action event.
This method is useful for event-logging and for debugging.
a string identifying the event and its associated command |
|
|
|