Class KeyStroke
- All Implemented Interfaces:
- Serializable
KeyStrokes are used to define high-level (semantic) action events. Instead of trapping every keystroke and throwing away the ones you are not interested in, those keystrokes you care about automatically initiate actions on the Components with which they are registered.
 KeyStrokes are immutable, and are intended to be unique. Client code cannot
 create a KeyStroke; a variant of getKeyStroke must be used
 instead. These factory methods allow the KeyStroke implementation to cache
 and share instances efficiently.
 
 Warning:
 Serialized objects of this class will not be compatible with
 future Swing releases. The current serialization support is
 appropriate for short term storage or RMI between applications running
 the same version of Swing.  As of 1.4, support for long term storage
 of all JavaBeans
 has been added to the java.beans package.
 Please see XMLEncoder.
- Since:
- 1.2
- See Also:
- 
Method SummaryModifier and TypeMethodDescriptionstatic KeyStrokegetKeyStroke(char keyChar) Returns a shared instance of aKeyStrokethat represents aKEY_TYPEDevent for the specified character.static KeyStrokegetKeyStroke(char keyChar, boolean onKeyRelease) Deprecated.use getKeyStroke(char)static KeyStrokegetKeyStroke(int keyCode, int modifiers) Returns a shared instance of a KeyStroke, given a numeric key code and a set of modifiers.static KeyStrokegetKeyStroke(int keyCode, int modifiers, boolean onKeyRelease) Returns a shared instance of a KeyStroke, given a numeric key code and a set of modifiers, specifying whether the key is activated when it is pressed or released.static KeyStrokegetKeyStroke(Character keyChar, int modifiers) Returns a shared instance of aKeyStrokethat represents aKEY_TYPEDevent for the specified Character object and a set of modifiers.static KeyStrokeParses a string and returns aKeyStroke.static KeyStrokegetKeyStrokeForEvent(KeyEvent anEvent) Returns a KeyStroke which represents the stroke which generated a given KeyEvent.Methods declared in class java.awt.AWTKeyStrokeequals, getAWTKeyStroke, getAWTKeyStroke, getAWTKeyStroke, getAWTKeyStroke, getAWTKeyStroke, getAWTKeyStrokeForEvent, getKeyChar, getKeyCode, getKeyEventType, getModifiers, hashCode, isOnKeyRelease, readResolve, registerSubclass, toString
- 
Method Details- 
getKeyStrokeReturns a shared instance of aKeyStrokethat represents aKEY_TYPEDevent for the specified character.- Parameters:
- keyChar- the character value for a keyboard key
- Returns:
- a KeyStroke object for that key
 
- 
getKeyStrokeDeprecated.use getKeyStroke(char)Returns an instance of a KeyStroke, specifying whether the key is considered to be activated when it is pressed or released. Unlike all other factory methods in this class, the instances returned by this method are not necessarily cached or shared.- Parameters:
- keyChar- the character value for a keyboard key
- onKeyRelease-- trueif this KeyStroke corresponds to a key release;- falseotherwise.
- Returns:
- a KeyStroke object for that key
 
- 
getKeyStrokeReturns a shared instance of aKeyStrokethat 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 togetKeyStroke(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 KeyStroke object for that key
- Throws:
- IllegalArgumentException- if keyChar is null
- Since:
- 1.3
- See Also:
 
- 
getKeyStrokeReturns a shared instance of a KeyStroke, 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:- 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 KeyStroke should represent a key release;- falseotherwise.
- Returns:
- a KeyStroke object for that key
- See Also:
 
- 
getKeyStrokeReturns a shared instance of a KeyStroke, given a numeric key code and a set of modifiers. The returned KeyStroke 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
 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
- Returns:
- a KeyStroke object for that key
- See Also:
 
- 
getKeyStrokeForEventReturns a KeyStroke 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 KeyStroke
- Returns:
- the KeyStroke that precipitated the event
- Throws:
- NullPointerException- if- anEventis null
 
- 
getKeyStrokeParses a string and returns aKeyStroke. 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" => getKeyStroke(KeyEvent.VK_INSERT, 0); "control DELETE" => getKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK); "alt shift X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK); "alt shift released X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true); "typed a" => getKeyStroke('a');In order to maintain backward-compatibility, specifying a null String, or a String which is formatted incorrectly, returns null.- Parameters:
- s- a String formatted as described above
- Returns:
- a KeyStroke object for that String, or null if the specified String is null, or is formatted incorrectly
- See Also:
 
 
-