|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.awt.AWTKeyStroke
public class AWTKeyStroke
An AWTKeyStroke represents a key action on the
keyboard, or equivalent input device. AWTKeyStrokes
can correspond to only a press or release of a
particular key, just as KEY_PRESSED and
KEY_RELEASED KeyEvents do;
alternately, they can correspond to typing a specific Java character, just
as KEY_TYPED KeyEvents do.
In all cases, AWTKeyStrokes can specify modifiers
(alt, shift, control, meta, 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.
getAWTKeyStroke(char),
Serialized Form| Constructor Summary | |
|---|---|
protected |
AWTKeyStroke()
Constructs an AWTKeyStroke with default values. |
protected |
AWTKeyStroke(char keyChar,
int keyCode,
int modifiers,
boolean onKeyRelease)
Constructs an AWTKeyStroke with the specified
values. |
| Method Summary | |
|---|---|
boolean |
equals(Object anObject)
Returns true if this object is identical to the specified object. |
static AWTKeyStroke |
getAWTKeyStroke(char keyChar)
Returns a shared instance of an AWTKeyStroke
that represents a KEY_TYPED event for the
specified character. |
static AWTKeyStroke |
getAWTKeyStroke(Character keyChar,
int modifiers)
Returns a shared instance of an AWTKeyStroke,
given a Character object and a set of modifiers. |
static AWTKeyStroke |
getAWTKeyStroke(int keyCode,
int modifiers)
Returns a shared instance of an AWTKeyStroke,
given a numeric key code and a set of modifiers. |
static AWTKeyStroke |
getAWTKeyStroke(int keyCode,
int modifiers,
boolean onKeyRelease)
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. |
static AWTKeyStroke |
getAWTKeyStroke(String s)
Parses a string and returns an AWTKeyStroke. |
static AWTKeyStroke |
getAWTKeyStrokeForEvent(KeyEvent anEvent)
Returns an AWTKeyStroke which represents the
stroke which generated a given KeyEvent. |
char |
getKeyChar()
Returns the character for this AWTKeyStroke. |
int |
getKeyCode()
Returns the numeric key code for this AWTKeyStroke. |
int |
getKeyEventType()
Returns the type of KeyEvent which corresponds to
this AWTKeyStroke. |
int |
getModifiers()
Returns the modifier keys for this AWTKeyStroke. |
int |
hashCode()
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. |
boolean |
isOnKeyRelease()
Returns whether this AWTKeyStroke represents a key release. |
protected Object |
readResolve()
Returns a cached instance of AWTKeyStroke (or a subclass of
AWTKeyStroke) which is equal to this instance. |
protected static void |
registerSubclass(Class<?> subclass)
Registers a new class which the factory methods in AWTKeyStroke will use when generating new
instances of AWTKeyStrokes. |
String |
toString()
Returns a string that displays and identifies this object's properties. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
protected AWTKeyStroke()
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 |
AWTKeyStrokes should not be constructed
by client code. Use a variant of getAWTKeyStroke
instead.
getAWTKeyStroke(char)
protected AWTKeyStroke(char keyChar,
int keyCode,
int modifiers,
boolean onKeyRelease)
AWTKeyStroke with the specified
values. AWTKeyStrokes should not be constructed
by client code. Use a variant of getAWTKeyStroke
instead.
keyChar - the character value for a keyboard keykeyCode - the key code for this AWTKeyStrokemodifiers - a bitwise-ored combination of any modifiersonKeyRelease - true if this
AWTKeyStroke corresponds
to a key release; false otherwisegetAWTKeyStroke(char)| Method Detail |
|---|
protected static void registerSubclass(Class<?> subclass)
AWTKeyStroke will use when generating new
instances of AWTKeyStrokes. 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
AWTKeyStrokepublic static AWTKeyStroke getAWTKeyStroke(char keyChar)
AWTKeyStroke
that represents a KEY_TYPED event for the
specified character.
keyChar - the character value for a keyboard key
AWTKeyStroke object for that key
public static AWTKeyStroke getAWTKeyStroke(Character keyChar,
int modifiers)
AWTKeyStroke,
given a 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:
keyChar - the Character object for a keyboard charactermodifiers - a bitwise-ored combination of any modifiers
AWTKeyStroke object for that key
IllegalArgumentException - if keyChar is
nullInputEvent
public static AWTKeyStroke getAWTKeyStroke(int keyCode,
int modifiers,
boolean onKeyRelease)
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 keymodifiers - a bitwise-ored combination of any modifiersonKeyRelease - true if the AWTKeyStroke
should represent a key release; false otherwise
KeyEvent,
InputEvent
public static AWTKeyStroke getAWTKeyStroke(int keyCode,
int modifiers)
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 keymodifiers - a bitwise-ored combination of any modifiers
AWTKeyStroke object for that keyKeyEvent,
InputEventpublic static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent)
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 nullpublic static AWTKeyStroke getAWTKeyStroke(String s)
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 String
IllegalArgumentException - if s is null,
or is formatted incorrectlypublic final char getKeyChar()
AWTKeyStroke.
getAWTKeyStroke(char)public final int getKeyCode()
AWTKeyStroke.
getAWTKeyStroke(int,int)public final int getModifiers()
AWTKeyStroke.
getAWTKeyStroke(int,int)public final boolean isOnKeyRelease()
AWTKeyStroke represents a key release.
true if this AWTKeyStroke
represents a key release; false otherwisegetAWTKeyStroke(int,int,boolean)public final int getKeyEventType()
KeyEvent which corresponds to
this AWTKeyStroke.
KeyEvent.KEY_PRESSED,
KeyEvent.KEY_TYPED,
or KeyEvent.KEY_RELEASEDKeyEventpublic int hashCode()
hashCode in class ObjectObject.equals(java.lang.Object),
Hashtablepublic final boolean equals(Object anObject)
equals in class ObjectanObject - the Object to compare this object to
Object.hashCode(),
Hashtablepublic String toString()
String returned by this method can be passed
as a parameter to getAWTKeyStroke(String) to produce
a key stroke equal to this key stroke.
toString in class ObjectgetAWTKeyStroke(String)
protected Object readResolve()
throws ObjectStreamException
AWTKeyStroke (or a subclass of
AWTKeyStroke) which is equal to this instance.
ObjectStreamException
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.