Whole document tree
|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.awt.event
Class ActionEvent
java.lang.Object | +--java.util.EventObject | +--java.awt.AWTEvent | +--java.awt.event.ActionEvent
- All Implemented Interfaces:
- Serializable
- public class ActionEvent
- extends AWTEvent
A semantic event which indicates that a component-defined action occured.
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.
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, Tutorial: Java 1.1 Event Model, Reference: The Java Class Libraries (update file), Serialized Form
| Field Summary | |
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 occured. |
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. |
| Fields inherited from class java.util.EventObject |
source |
| Constructor Summary | |
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. |
|
| Method Summary | |
String |
getActionCommand()
Returns the command string associated with this action. |
int |
getModifiers()
Returns the modifier keys held down during this action event. |
String |
paramString()
Returns a parameter string identifying this action event. |
| Methods inherited from class java.awt.AWTEvent |
consume, finalize, getID, isConsumed, toString |
| Methods inherited from class java.util.EventObject |
getSource |
| Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
SHIFT_MASK
public static final int SHIFT_MASK
- The shift modifier. An indicator that the shift key was held down during the event.
CTRL_MASK
public static final int CTRL_MASK
- The control modifier. An indicator that the control key was held down during the event.
META_MASK
public static final int META_MASK
- The meta modifier. An indicator that the meta key was held down during the event.
ALT_MASK
public static final int ALT_MASK
- The alt modifier. An indicator that the alt key was held down during the event.
ACTION_FIRST
public static final int ACTION_FIRST
- The first number in the range of ids used for action events.
ACTION_LAST
public static final int ACTION_LAST
- The last number in the range of ids used for action events.
ACTION_PERFORMED
public static final int ACTION_PERFORMED
- This event id indicates that a meaningful action occured.
| Constructor Detail |
ActionEvent
public ActionEvent(Object source, int id, String command)
- Constructs an
ActionEventobject.- Parameters:
source- the object that originated the eventid- an integer that identifies the eventcommand- a string that may specify a command (possibly one of several) associated with the event
ActionEvent
public ActionEvent(Object source, int id, String command, int modifiers)
- Constructs an
ActionEventobject with modifier keys.- Parameters:
source- the object that originated the eventid- an integer that identifies the eventcommand- a string that may specify a command (possibly one of several) associated with the eventmodifiers- the modifier keys held down during this action
| Method Detail |
getActionCommand
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.
- Returns:
- the string identifying the command for this event
getModifiers
public int getModifiers()
- Returns the modifier keys held down during this action event.
- Returns:
- the integer sum of the modifier constants
paramString
public String paramString()
- Returns a parameter string identifying this action event.
This method is useful for event-logging and for debugging.
- Overrides:
paramStringin classAWTEvent
- Returns:
- a string identifying the event and its associated command
|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.