- java.lang.Object
- 
- java.awt.AWTKeyStroke
 
- 
- All Implemented Interfaces:
- Serializable
 - Direct Known Subclasses:
- KeyStroke
 
 public class AWTKeyStroke extends Object implements Serializable AnAWTKeyStrokerepresents a key action on the keyboard, or equivalent input device.AWTKeyStrokes can correspond to only a press or release of a particular key, just asKEY_PRESSEDandKEY_RELEASED KeyEvents do; alternately, they can correspond to typing a specific Java character, just asKEY_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.AWTKeyStrokesare immutable, and are intended to be unique. Client code should never create anAWTKeyStrokeon its own, but should instead use a variant ofgetAWTKeyStroke. Client use of these factory methods allows theAWTKeyStrokeimplementation to cache and share instances efficiently.- Since:
- 1.4
- See Also:
- getAWTKeyStroke(char), Serialized Form
 
- 
- 
Constructor SummaryConstructors Modifier Constructor Description protectedAWTKeyStroke()Constructs anAWTKeyStrokewith default values.protectedAWTKeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease)Constructs anAWTKeyStrokewith the specified values.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleanequals(Object anObject)Returns true if this object is identical to the specified object.static AWTKeyStrokegetAWTKeyStroke(char keyChar)Returns a shared instance of anAWTKeyStrokethat represents aKEY_TYPEDevent for the specified character.static AWTKeyStrokegetAWTKeyStroke(int keyCode, int modifiers)Returns a shared instance of anAWTKeyStroke, given a numeric key code and a set of modifiers.static AWTKeyStrokegetAWTKeyStroke(int keyCode, int modifiers, boolean onKeyRelease)Returns a shared instance of anAWTKeyStroke, given a numeric key code and a set of modifiers, specifying whether the key is activated when it is pressed or released.static AWTKeyStrokegetAWTKeyStroke(Character keyChar, int modifiers)Returns a shared instance of anAWTKeyStrokethat represents aKEY_TYPEDevent for the specified Character object and a set of modifiers.static AWTKeyStrokegetAWTKeyStroke(String s)Parses a string and returns anAWTKeyStroke.static AWTKeyStrokegetAWTKeyStrokeForEvent(KeyEvent anEvent)Returns anAWTKeyStrokewhich represents the stroke which generated a givenKeyEvent.chargetKeyChar()Returns the character for thisAWTKeyStroke.intgetKeyCode()Returns the numeric key code for thisAWTKeyStroke.intgetKeyEventType()Returns the type ofKeyEventwhich corresponds to thisAWTKeyStroke.intgetModifiers()Returns the modifier keys for thisAWTKeyStroke.inthashCode()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.booleanisOnKeyRelease()Returns whether thisAWTKeyStrokerepresents a key release.protected ObjectreadResolve()Returns a cached instance ofAWTKeyStroke(or a subclass ofAWTKeyStroke) which is equal to this instance.protected static voidregisterSubclass(Class<?> subclass)Deprecated.StringtoString()Returns a string that displays and identifies this object's properties.
 
- 
- 
- 
Constructor Detail- 
AWTKeyStrokeprotected AWTKeyStroke() Constructs anAWTKeyStrokewith default values. The default values used are:AWTKeyStroke default values Property Default Value Key Char KeyEvent.CHAR_UNDEFINEDKey Code KeyEvent.VK_UNDEFINEDModifiers none On key release? falseAWTKeyStrokes should not be constructed by client code. Use a variant ofgetAWTKeyStrokeinstead.- See Also:
- getAWTKeyStroke(char)
 
 - 
AWTKeyStrokeprotected AWTKeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease)Constructs anAWTKeyStrokewith the specified values.AWTKeyStrokes should not be constructed by client code. Use a variant ofgetAWTKeyStrokeinstead.- 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-- trueif this- AWTKeyStrokecorresponds to a key release;- falseotherwise
- See Also:
- getAWTKeyStroke(char)
 
 
- 
 - 
Method Detail- 
registerSubclass@Deprecated protected static void registerSubclass(Class<?> subclass) Deprecated.The method has no effect and is only left present to avoid introducing a binary incompatibility.- Parameters:
- subclass- the new Class of which the factory methods should create instances
 
 - 
getAWTKeyStrokepublic static AWTKeyStroke getAWTKeyStroke(char keyChar) Returns a shared instance of anAWTKeyStrokethat represents aKEY_TYPEDevent for the specified character.- Parameters:
- keyChar- the character value for a keyboard key
- Returns:
- an AWTKeyStrokeobject for that key
 
 - 
getAWTKeyStrokepublic static AWTKeyStroke getAWTKeyStroke(Character keyChar, int modifiers) Returns a shared instance of anAWTKeyStrokethat represents aKEY_TYPEDevent 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 togetAWTKeyStroke(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
 - 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
 - Parameters:
- keyChar- the Character object for a keyboard character
- modifiers- a bitwise-ored combination of any modifiers
- Returns:
- an AWTKeyStrokeobject for that key
- Throws:
- IllegalArgumentException- if- keyCharis- null
- See Also:
- InputEvent
 
 - 
getAWTKeyStrokepublic static AWTKeyStroke getAWTKeyStroke(int keyCode, int modifiers, boolean onKeyRelease) Returns a shared instance of anAWTKeyStroke, 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.KeyEventcan 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:- 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
 - 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
 - Parameters:
- keyCode- an int specifying the numeric code for a keyboard key
- modifiers- a bitwise-ored combination of any modifiers
- onKeyRelease-- trueif the- AWTKeyStrokeshould represent a key release;- falseotherwise
- Returns:
- an AWTKeyStroke object for that key
- See Also:
- KeyEvent,- InputEvent
 
 - 
getAWTKeyStrokepublic static AWTKeyStroke getAWTKeyStroke(int keyCode, int modifiers) Returns a shared instance of anAWTKeyStroke, given a numeric key code and a set of modifiers. The returnedAWTKeyStrokewill correspond to a key press.The "virtual key" constants defined in java.awt.event.KeyEventcan 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.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
 - 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
 - Parameters:
- keyCode- an int specifying the numeric code for a keyboard key
- modifiers- a bitwise-ored combination of any modifiers
- Returns:
- an AWTKeyStrokeobject for that key
- See Also:
- KeyEvent,- InputEvent
 
 - 
getAWTKeyStrokeForEventpublic static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent) Returns anAWTKeyStrokewhich represents the stroke which generated a givenKeyEvent.This method obtains the keyChar from a KeyTypedevent, and the keyCode from aKeyPressedorKeyReleasedevent. TheKeyEventmodifiers are obtained for all three types ofKeyEvent.- Parameters:
- anEvent- the- KeyEventfrom which to obtain the- AWTKeyStroke
- Returns:
- the AWTKeyStrokethat precipitated the event
- Throws:
- NullPointerException- if- anEventis null
 
 - 
getAWTKeyStrokepublic static AWTKeyStroke getAWTKeyStroke(String s) Parses a string and returns anAWTKeyStroke. 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 AWTKeyStrokeobject for that String
- Throws:
- IllegalArgumentException- if- sis- null, or is formatted incorrectly
 
 - 
getKeyCharpublic final char getKeyChar() Returns the character for thisAWTKeyStroke.- Returns:
- a char value
- See Also:
- getAWTKeyStroke(char),- KeyEvent.getKeyChar()
 
 - 
getKeyCodepublic final int getKeyCode() Returns the numeric key code for thisAWTKeyStroke.- Returns:
- an int containing the key code value
- See Also:
- getAWTKeyStroke(int,int),- KeyEvent.getKeyCode()
 
 - 
getModifierspublic final int getModifiers() Returns the modifier keys for thisAWTKeyStroke.- Returns:
- an int containing the modifiers
- See Also:
- getAWTKeyStroke(int,int)
 
 - 
isOnKeyReleasepublic final boolean isOnKeyRelease() Returns whether thisAWTKeyStrokerepresents a key release.- Returns:
- trueif this- AWTKeyStrokerepresents a key release;- falseotherwise
- See Also:
- getAWTKeyStroke(int,int,boolean)
 
 - 
getKeyEventTypepublic final int getKeyEventType() Returns the type ofKeyEventwhich corresponds to thisAWTKeyStroke.- Returns:
- KeyEvent.KEY_PRESSED,- KeyEvent.KEY_TYPED, or- KeyEvent.KEY_RELEASED
- See Also:
- KeyEvent
 
 - 
hashCodepublic 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:
- hashCodein class- Object
- Returns:
- an int that represents this object
- See Also:
- Object.equals(java.lang.Object),- System.identityHashCode(java.lang.Object)
 
 - 
equalspublic final boolean equals(Object anObject) Returns true if this object is identical to the specified object.- Overrides:
- equalsin class- Object
- Parameters:
- anObject- the Object to compare this object to
- Returns:
- true if the objects are identical
- See Also:
- Object.hashCode(),- HashMap
 
 - 
toStringpublic String toString() Returns a string that displays and identifies this object's properties. TheStringreturned by this method can be passed as a parameter togetAWTKeyStroke(String)to produce a key stroke equal to this key stroke.- Overrides:
- toStringin class- Object
- Returns:
- a String representation of this object
- See Also:
- getAWTKeyStroke(String)
 
 - 
readResolveprotected Object readResolve() throws ObjectStreamException Returns a cached instance ofAWTKeyStroke(or a subclass ofAWTKeyStroke) which is equal to this instance.- Returns:
- a cached instance which is equal to this instance
- Throws:
- ObjectStreamException- if a serialization problem occurs
 
 
- 
 
-