java.lang.Object | |
↳ | java.awt.AWTKeyStroke |
Known Direct Subclasses |
An AWTKeyStroke
represents a key action on the
keyboard, or equivalent input device. AWTKeyStroke
s
can correspond to only a press or release of a
particular key, just as KEY_PRESSED
and
KEY_RELEASED
KeyEvent
s do;
alternately, they can correspond to typing a specific Java character, just
as KEY_TYPED
KeyEvent
s do.
In all cases, AWTKeyStroke
s can specify modifiers
(alt, shift, control, meta, altGraph, or a combination thereof) which must be present
during the action for an exact match.
AWTKeyStrokes
are immutable, and are intended
to be unique. Client code should never create an
AWTKeyStroke
on its own, but should instead use
a variant of getAWTKeyStroke
. Client use of these factory
methods allows the AWTKeyStroke
implementation
to cache and share instances efficiently.
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs an
AWTKeyStroke with default values. | |||||||||||
Constructs an
AWTKeyStroke with the specified
values. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns true if this object is identical to the specified object.
| |||||||||||
Returns a shared instance of an
AWTKeyStroke ,
given a numeric key code and a set of modifiers, specifying
whether the key is activated when it is pressed or released. | |||||||||||
Returns a shared instance of an
AWTKeyStroke
that represents a KEY_TYPED event for the
specified Character object and a set of modifiers. | |||||||||||
Returns a shared instance of an
AWTKeyStroke
that represents a KEY_TYPED event for the
specified character. | |||||||||||
Returns a shared instance of an
AWTKeyStroke ,
given a numeric key code and a set of modifiers. | |||||||||||
Parses a string and returns an
AWTKeyStroke . | |||||||||||
Returns an
AWTKeyStroke which represents the
stroke which generated a given KeyEvent . | |||||||||||
Returns the character for this
AWTKeyStroke . | |||||||||||
Returns the numeric key code for this
AWTKeyStroke . | |||||||||||
Returns the type of
KeyEvent which corresponds to
this AWTKeyStroke . | |||||||||||
Returns the modifier keys for this
AWTKeyStroke . | |||||||||||
Returns a numeric value for this object that is likely to be unique,
making it a good choice as the index value in a hash table.
| |||||||||||
Returns whether this
AWTKeyStroke represents a key release. | |||||||||||
Returns a string that displays and identifies this object's properties.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns a cached instance of
AWTKeyStroke (or a subclass of
AWTKeyStroke ) which is equal to this instance. | |||||||||||
Registers a new class which the factory methods in
AWTKeyStroke will use when generating new
instances of AWTKeyStroke s. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Constructs an AWTKeyStroke
with default values.
The default values used are:
Property | Default Value |
---|---|
Key Char | KeyEvent.CHAR_UNDEFINED |
Key Code | KeyEvent.VK_UNDEFINED |
Modifiers | none |
On key release? | false |
AWTKeyStroke
s should not be constructed
by client code. Use a variant of getAWTKeyStroke
instead.Constructs an AWTKeyStroke
with the specified
values. AWTKeyStroke
s should not be constructed
by client code. Use a variant of getAWTKeyStroke
instead.
keyChar | the character value for a keyboard key |
---|---|
keyCode | the key code for this AWTKeyStroke |
modifiers | a bitwise-ored combination of any modifiers |
onKeyRelease | true if this
AWTKeyStroke corresponds
to a key release; false otherwise |
Returns true if this object is identical to the specified object.
anObject | the Object to compare this object to |
---|
Returns a shared instance of an AWTKeyStroke
,
given a numeric key code and a set of modifiers, specifying
whether the key is activated when it is pressed or released.
The "virtual key" constants defined in
java.awt.event.KeyEvent
can be
used to specify the key code. For example:
java.awt.event.KeyEvent.VK_ENTER
java.awt.event.KeyEvent.VK_TAB
java.awt.event.KeyEvent.VK_SPACE
keyCode | an int specifying the numeric code for a keyboard key |
---|---|
modifiers | a bitwise-ored combination of any modifiers |
onKeyRelease | true if the AWTKeyStroke
should represent a key release; false otherwise |
Returns a shared instance of an AWTKeyStroke
that represents a KEY_TYPED
event for the
specified Character object and a set of modifiers. Note
that the first parameter is of type Character rather than
char. This is to avoid inadvertent clashes with
calls to getAWTKeyStroke(int keyCode, int modifiers)
.
The modifiers consist of any combination of following:
keyChar | the Character object for a keyboard character |
---|---|
modifiers | a bitwise-ored combination of any modifiers |
AWTKeyStroke
object for that keyIllegalArgumentException | if keyChar is
null |
---|
Returns a shared instance of an AWTKeyStroke
that represents a KEY_TYPED
event for the
specified character.
keyChar | the character value for a keyboard key |
---|
AWTKeyStroke
object for that key
Returns a shared instance of an AWTKeyStroke
,
given a numeric key code and a set of modifiers. The returned
AWTKeyStroke
will correspond to a key press.
The "virtual key" constants defined in
java.awt.event.KeyEvent
can be
used to specify the key code. For example:
java.awt.event.KeyEvent.VK_ENTER
java.awt.event.KeyEvent.VK_TAB
java.awt.event.KeyEvent.VK_SPACE
keyCode | an int specifying the numeric code for a keyboard key |
---|---|
modifiers | a bitwise-ored combination of any modifiers |
AWTKeyStroke
object for that keyParses a string and returns an AWTKeyStroke
.
The string must have the following syntax:
<modifiers>* (<typedID> | <pressedReleasedID>) modifiers := shift | control | ctrl | meta | alt | altGraph typedID := typed <typedKey> typedKey := string of length 1 giving Unicode character. pressedReleasedID := (pressed | released) key key := KeyEvent key code name, i.e. the name following "VK_".If typed, pressed or released is not specified, pressed is assumed. Here are some examples:
"INSERT" => getAWTKeyStroke(KeyEvent.VK_INSERT, 0); "control DELETE" => getAWTKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK); "alt shift X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK); "alt shift released X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true); "typed a" => getAWTKeyStroke('a');
s | a String formatted as described above |
---|
AWTKeyStroke
object for that StringIllegalArgumentException | if s is null ,
or is formatted incorrectly
|
---|
Returns an AWTKeyStroke
which represents the
stroke which generated a given KeyEvent
.
This method obtains the keyChar from a KeyTyped
event, and the keyCode from a KeyPressed
or
KeyReleased
event. The KeyEvent
modifiers are
obtained for all three types of KeyEvent
.
anEvent | the KeyEvent from which to
obtain the AWTKeyStroke |
---|
AWTKeyStroke
that precipitated the event
NullPointerException | if anEvent is null |
---|
Returns the character for this AWTKeyStroke
.
Returns the numeric key code for this AWTKeyStroke
.
Returns the type of KeyEvent
which corresponds to
this AWTKeyStroke
.
KeyEvent.KEY_PRESSED
,
KeyEvent.KEY_TYPED
,
or KeyEvent.KEY_RELEASED
Returns the modifier keys for this AWTKeyStroke
.
Returns a numeric value for this object that is likely to be unique, making it a good choice as the index value in a hash table.
Returns whether this AWTKeyStroke
represents a key release.
true
if this AWTKeyStroke
represents a key release; false
otherwiseReturns a string that displays and identifies this object's properties.
The String
returned by this method can be passed
as a parameter to getAWTKeyStroke(String)
to produce
a key stroke equal to this key stroke.
Returns a cached instance of AWTKeyStroke
(or a subclass of
AWTKeyStroke
) which is equal to this instance.
ObjectStreamException |
---|
Registers a new class which the factory methods in
AWTKeyStroke
will use when generating new
instances of AWTKeyStroke
s. After invoking this
method, the factory methods will return instances of the specified
Class. The specified Class must be either AWTKeyStroke
or derived from AWTKeyStroke
, and it must have a
no-arg constructor. The constructor can be of any accessibility,
including private
. This operation
flushes the current AWTKeyStroke
cache.
subclass | the new Class of which the factory methods should create instances |
---|
IllegalArgumentException | if subclass is null ,
or if subclass does not have a no-arg constructor |
---|---|
ClassCastException | if subclass is not
AWTKeyStroke , or a class derived from
AWTKeyStroke
|