|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.EventObject java.awt.AWTEvent java.awt.event.ActionEvent
public class ActionEvent
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".
ActionListener
,
Tutorial: Java 1.1 Event Model,
Serialized FormField 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. |
|
ActionEvent(Object source,
int id,
String command,
long when,
int modifiers)
Constructs an ActionEvent object with the specified
modifier keys and timestamp. |
Method Summary | |
---|---|
String |
getActionCommand()
Returns the command string associated with this action. |
int |
getModifiers()
Returns the modifier keys held down during this action event. |
long |
getWhen()
Returns the timestamp of when this event occurred. |
String |
paramString()
Returns a parameter string identifying this action event. |
Methods inherited from class java.awt.AWTEvent |
---|
consume, getID, isConsumed, setSource, toString |
Methods inherited from class java.util.EventObject |
---|
getSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int SHIFT_MASK
public static final int CTRL_MASK
public static final int META_MASK
public static final int ALT_MASK
public static final int ACTION_FIRST
public static final int ACTION_LAST
public static final int ACTION_PERFORMED
Constructor Detail |
---|
public ActionEvent(Object source, int id, String command)
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.
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
IllegalArgumentException
- if source
is nullpublic ActionEvent(Object source, int id, String command, int modifiers)
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.
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
IllegalArgumentException
- if source
is nullpublic ActionEvent(Object source, int id, String command, long when, int modifiers)
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.
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 eventwhen
- the time the event occurredmodifiers
- the modifier keys held down during this action
IllegalArgumentException
- if source
is nullMethod Detail |
---|
public String getActionCommand()
Note that if a null
command string was passed
to the constructor for this ActionEvent
, this
this method returns null
.
public long getWhen()
public int getModifiers()
public String paramString()
paramString
in class AWTEvent
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.