public class AWTKeyStroke extends Object implements Serializable
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, 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.
getAWTKeyStroke(char), Serialized Formprotected AWTKeyStroke()
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 |
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) Constructs an 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 AWTKeyStroke
modifiers - a bitwise-ored combination of any modifiersonKeyRelease - true if this AWTKeyStroke corresponds to a key release; false otherwisegetAWTKeyStroke(char)protected static void registerSubclass(Class<?> subclass)
Registers a new class which the factory methods in 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 instancesIllegalArgumentException - if subclass is null, or if subclass does not have a no-arg constructorClassCastException - if subclass is not AWTKeyStroke, or a class derived from AWTKeyStroke
public static AWTKeyStroke getAWTKeyStroke(char keyChar)
Returns a shared instance of an AWTKeyStroke that represents a KEY_TYPED event for the specified character.
keyChar - the character value for a keyboard keyAWTKeyStroke object for that keypublic static AWTKeyStroke getAWTKeyStroke(Character keyChar,
int modifiers) 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 charactermodifiers - a bitwise-ored combination of any modifiersAWTKeyStroke object for that keyIllegalArgumentException - if keyChar is null
InputEventpublic 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.
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 java.awt.event.KeyEvent.getExtendedKeyCodeForChar. The modifiers consist of any combination of: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 otherwiseKeyEvent, InputEvent
public static AWTKeyStroke getAWTKeyStroke(int keyCode,
int modifiers) 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 keymodifiers - a bitwise-ored combination of any modifiersAWTKeyStroke object for that keyKeyEvent, InputEvent
public static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent)
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 eventNullPointerException - if anEvent is nullpublic static AWTKeyStroke getAWTKeyStroke(String s)
Parses 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 aboveAWTKeyStroke object for that StringIllegalArgumentException - if s is null, or is formatted incorrectlypublic final char getKeyChar()
Returns the character for this AWTKeyStroke.
getAWTKeyStroke(char), KeyEvent.getKeyChar()
public final int getKeyCode()
Returns the numeric key code for this AWTKeyStroke.
getAWTKeyStroke(int,int), KeyEvent.getKeyCode()
public final int getModifiers()
Returns the modifier keys for this AWTKeyStroke.
getAWTKeyStroke(int,int)public final boolean isOnKeyRelease()
Returns whether this AWTKeyStroke represents a key release.
true if this AWTKeyStroke represents a key release; false otherwisegetAWTKeyStroke(int,int,boolean)public final int getKeyEventType()
Returns the type of KeyEvent which corresponds to this AWTKeyStroke.
KeyEvent.KEY_PRESSED, KeyEvent.KEY_TYPED, or KeyEvent.KEY_RELEASED
KeyEventpublic 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.
hashCode in class Object
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
public final boolean equals(Object anObject)
Returns true if this object is identical to the specified object.
equals in class Object
anObject - the Object to compare this object toObject.hashCode(), HashMap
public String toString()
Returns 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.
toString in class Object
getAWTKeyStroke(String)protected Object readResolve()
throws ObjectStreamException Returns a cached instance of AWTKeyStroke (or a subclass of AWTKeyStroke) which is equal to this instance.
ObjectStreamException
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.