AWTKeyStroke (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- java.awt.AWTKeyStroke
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
KeyStroke

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 andKEY_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 anAWTKeyStroke 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.
Since:
1.4
See Also:
getAWTKeyStroke(char), Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
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

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
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 that represents a KEY_TYPED event for the specified 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 ofAWTKeyStroke) which is equal to this instance.
protected static void	registerSubclass(Class<?> subclass)	Registers a new class which the factory methods inAWTKeyStroke 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](../../java/lang/Object.html "class in java.lang")  
   `[clone](../../java/lang/Object.html#clone--), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### AWTKeyStroke  
 protected 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                    |  
 `AWTKeyStroke`s should not be constructed by client code. Use a variant of `getAWTKeyStroke` instead.  
 See Also:  
 [getAWTKeyStroke(char)](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke-char-)  
 * #### AWTKeyStroke  
 protected AWTKeyStroke(char keyChar,  
                        int keyCode,  
                        int modifiers,  
                        boolean onKeyRelease)  
 Constructs an `AWTKeyStroke` with the specified values. `AWTKeyStroke`s should not be constructed by client code. Use a variant of `getAWTKeyStroke` instead.  
 Parameters:  
 `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  
 See Also:  
 [getAWTKeyStroke(char)](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke-char-)

Method Detail

* #### registerSubclass  
protected static void registerSubclass([Class](../../java/lang/Class.html "class in java.lang")<?> subclass)  
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.  
Parameters:  
`subclass` \- the new Class of which the factory methods should create instances  
Throws:  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if subclass is `null`, or if subclass does not have a no-arg constructor  
`[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if subclass is not`AWTKeyStroke`, or a class derived from`AWTKeyStroke`  
* #### getAWTKeyStroke  
public static [AWTKeyStroke](../../java/awt/AWTKeyStroke.html "class in java.awt") getAWTKeyStroke(char keyChar)  
Returns a shared instance of an `AWTKeyStroke` that represents a `KEY_TYPED` event for the specified character.  
Parameters:  
`keyChar` \- the character value for a keyboard key  
Returns:  
an `AWTKeyStroke` object for that key  
* #### getAWTKeyStroke  
public static [AWTKeyStroke](../../java/awt/AWTKeyStroke.html "class in java.awt") getAWTKeyStroke([Character](../../java/lang/Character.html "class in java.lang") 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:  
         * java.awt.event.InputEvent.SHIFT\_DOWN\_MASK  
         * java.awt.event.InputEvent.CTRL\_DOWN\_MASK  
         * java.awt.event.InputEvent.META\_DOWN\_MASK  
         * java.awt.event.InputEvent.ALT\_DOWN\_MASK  
         * java.awt.event.InputEvent.ALT\_GRAPH\_DOWN\_MASK  
 The old modifiers listed below also can be used, but they are mapped to \_DOWN\_ modifiers.  
         * java.awt.event.InputEvent.SHIFT\_MASK  
         * java.awt.event.InputEvent.CTRL\_MASK  
         * java.awt.event.InputEvent.META\_MASK  
         * java.awt.event.InputEvent.ALT\_MASK  
         * java.awt.event.InputEvent.ALT\_GRAPH\_MASK  
 also can be used, but they are mapped to \_DOWN\_ modifiers. Since these numbers are all different powers of two, any combination of them is an integer in which each bit represents a different modifier key. Use 0 to specify no modifiers.  
Parameters:  
`keyChar` \- the Character object for a keyboard character  
`modifiers` \- a bitwise-ored combination of any modifiers  
Returns:  
an `AWTKeyStroke` object for that key  
Throws:  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `keyChar` is`null`  
See Also:  
[InputEvent](../../java/awt/event/InputEvent.html "class in java.awt.event")  
* #### getAWTKeyStroke  
public static [AWTKeyStroke](../../java/awt/AWTKeyStroke.html "class in java.awt") 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`  
 Alternatively, the key code may be obtained by calling`java.awt.event.KeyEvent.getExtendedKeyCodeForChar`. The modifiers consist of any combination of:  
         * java.awt.event.InputEvent.SHIFT\_DOWN\_MASK  
         * java.awt.event.InputEvent.CTRL\_DOWN\_MASK  
         * java.awt.event.InputEvent.META\_DOWN\_MASK  
         * java.awt.event.InputEvent.ALT\_DOWN\_MASK  
         * java.awt.event.InputEvent.ALT\_GRAPH\_DOWN\_MASK  
 The old modifiers  
         * java.awt.event.InputEvent.SHIFT\_MASK  
         * java.awt.event.InputEvent.CTRL\_MASK  
         * java.awt.event.InputEvent.META\_MASK  
         * java.awt.event.InputEvent.ALT\_MASK  
         * java.awt.event.InputEvent.ALT\_GRAPH\_MASK  
 also can be used, but they are mapped to \_DOWN\_ modifiers. Since these numbers are all different powers of two, any combination of them is an integer in which each bit represents a different modifier key. Use 0 to specify no modifiers.  
Parameters:  
`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:  
an AWTKeyStroke object for that key  
See Also:  
[KeyEvent](../../java/awt/event/KeyEvent.html "class in java.awt.event"), [InputEvent](../../java/awt/event/InputEvent.html "class in java.awt.event")  
* #### getAWTKeyStroke  
public static [AWTKeyStroke](../../java/awt/AWTKeyStroke.html "class in java.awt") 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`  
 The modifiers consist of any combination of:  
         * java.awt.event.InputEvent.SHIFT\_DOWN\_MASK  
         * java.awt.event.InputEvent.CTRL\_DOWN\_MASK  
         * java.awt.event.InputEvent.META\_DOWN\_MASK  
         * java.awt.event.InputEvent.ALT\_DOWN\_MASK  
         * java.awt.event.InputEvent.ALT\_GRAPH\_DOWN\_MASK  
 The old modifiers  
         * java.awt.event.InputEvent.SHIFT\_MASK  
         * java.awt.event.InputEvent.CTRL\_MASK  
         * java.awt.event.InputEvent.META\_MASK  
         * java.awt.event.InputEvent.ALT\_MASK  
         * java.awt.event.InputEvent.ALT\_GRAPH\_MASK  
 also can be used, but they are mapped to \_DOWN\_ modifiers. Since these numbers are all different powers of two, any combination of them is an integer in which each bit represents a different modifier key. Use 0 to specify no modifiers.  
Parameters:  
`keyCode` \- an int specifying the numeric code for a keyboard key  
`modifiers` \- a bitwise-ored combination of any modifiers  
Returns:  
an `AWTKeyStroke` object for that key  
See Also:  
[KeyEvent](../../java/awt/event/KeyEvent.html "class in java.awt.event"), [InputEvent](../../java/awt/event/InputEvent.html "class in java.awt.event")  
* #### getAWTKeyStrokeForEvent  
public static [AWTKeyStroke](../../java/awt/AWTKeyStroke.html "class in java.awt") getAWTKeyStrokeForEvent([KeyEvent](../../java/awt/event/KeyEvent.html "class in java.awt.event") 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`.  
Parameters:  
`anEvent` \- the `KeyEvent` from which to obtain the `AWTKeyStroke`  
Returns:  
the `AWTKeyStroke` that precipitated the event  
Throws:  
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if `anEvent` is null  
* #### getAWTKeyStroke  
public static [AWTKeyStroke](../../java/awt/AWTKeyStroke.html "class in java.awt") getAWTKeyStroke([String](../../java/lang/String.html "class in java.lang") 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');  
       
Parameters:  
`s` \- a String formatted as described above  
Returns:  
an `AWTKeyStroke` object for that String  
Throws:  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `s` is `null`, or is formatted incorrectly  
* #### getKeyChar  
public final char getKeyChar()  
Returns the character for this `AWTKeyStroke`.  
Returns:  
a char value  
See Also:  
[getAWTKeyStroke(char)](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke-char-), [KeyEvent.getKeyChar()](../../java/awt/event/KeyEvent.html#getKeyChar--)  
* #### getKeyCode  
public final int getKeyCode()  
Returns the numeric key code for this `AWTKeyStroke`.  
Returns:  
an int containing the key code value  
See Also:  
[getAWTKeyStroke(int,int)](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke-int-int-), [KeyEvent.getKeyCode()](../../java/awt/event/KeyEvent.html#getKeyCode--)  
* #### getModifiers  
public final int getModifiers()  
Returns the modifier keys for this `AWTKeyStroke`.  
Returns:  
an int containing the modifiers  
See Also:  
[getAWTKeyStroke(int,int)](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke-int-int-)  
* #### isOnKeyRelease  
public final boolean isOnKeyRelease()  
Returns whether this `AWTKeyStroke` represents a key release.  
Returns:  
`true` if this `AWTKeyStroke` represents a key release; `false` otherwise  
See Also:  
[getAWTKeyStroke(int,int,boolean)](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke-int-int-boolean-)  
* #### getKeyEventType  
public final int getKeyEventType()  
Returns the type of `KeyEvent` which corresponds to this `AWTKeyStroke`.  
Returns:  
`KeyEvent.KEY_PRESSED`,`KeyEvent.KEY_TYPED`, or `KeyEvent.KEY_RELEASED`  
See Also:  
[KeyEvent](../../java/awt/event/KeyEvent.html "class in java.awt.event")  
* #### hashCode  
public 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.  
Overrides:  
`[hashCode](../../java/lang/Object.html#hashCode--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
Returns:  
an int that represents this object  
See Also:  
[Object.equals(java.lang.Object)](../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../java/lang/System.html#identityHashCode-java.lang.Object-)  
* #### equals  
public final boolean equals([Object](../../java/lang/Object.html "class in java.lang") anObject)  
Returns true if this object is identical to the specified object.  
Overrides:  
`[equals](../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
Parameters:  
`anObject` \- the Object to compare this object to  
Returns:  
true if the objects are identical  
See Also:  
[Object.hashCode()](../../java/lang/Object.html#hashCode--), [HashMap](../../java/util/HashMap.html "class in java.util")  
* #### toString  
public [String](../../java/lang/String.html "class in java.lang") 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.  
Overrides:  
`[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
Returns:  
a String representation of this object  
See Also:  
[getAWTKeyStroke(String)](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke-java.lang.String-)  
* #### readResolve  
protected [Object](../../java/lang/Object.html "class in java.lang") readResolve()  
                      throws [ObjectStreamException](../../java/io/ObjectStreamException.html "class in java.io")  
Returns a cached instance of `AWTKeyStroke` (or a subclass of`AWTKeyStroke`) which is equal to this instance.  
Returns:  
a cached instance which is equal to this instance  
Throws:  
`[ObjectStreamException](../../java/io/ObjectStreamException.html "class in java.io")`

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

AWTKeyStroke (Java Platform SE 8 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail