File	Doc	Category	Size	Date	Package
KeyStroke.java	API Doc	Java SE 6 API	11915	Tue Jun 10 00:26:40 BST 2008	javax.swing

KeyStroke

• java.lang.Object
  • java.awt.AWTKeyStroke

Fields Summary
private static final long	serialVersionUID Serial Version ID.

Constructors Summary
private KeyStroke()
private KeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease) super(keyChar, keyCode, modifiers, onKeyRelease);

Methods Summary
public static javax.swing.KeyStroke	getKeyStroke(char keyChar) Returns a shared instance of a KeyStroke that represents a KEY_TYPED event for the specified character. param keyChar the character value for a keyboard key return a KeyStroke object for that key synchronized (AWTKeyStroke.class) { registerSubclass(KeyStroke.class); return (KeyStroke)getAWTKeyStroke(keyChar); }
public static javax.swing.KeyStroke	getKeyStroke(char keyChar, boolean onKeyRelease) 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. param keyChar the character value for a keyboard key param onKeyRelease true if this KeyStroke corresponds to a key release; false otherwise. return a KeyStroke object for that key deprecated use getKeyStroke(char) return new KeyStroke(keyChar, KeyEvent.VK_UNDEFINED, 0, onKeyRelease);
public static javax.swing.KeyStroke	getKeyStroke(java.lang.Character keyChar, int modifiers) Returns a shared instance of a {@code KeyStroke} that represents a {@code 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 getKeyStroke(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. param keyChar the Character object for a keyboard character param modifiers a bitwise-ored combination of any modifiers return an KeyStroke object for that key throws IllegalArgumentException if keyChar is null see java.awt.event.InputEvent since 1.3 synchronized (AWTKeyStroke.class) { registerSubclass(KeyStroke.class); return (KeyStroke)getAWTKeyStroke(keyChar, modifiers); }
public static javax.swing.KeyStroke	getKeyStroke(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. 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. param keyCode an int specifying the numeric code for a keyboard key param modifiers a bitwise-ored combination of any modifiers param onKeyRelease true if the KeyStroke should represent a key release; false otherwise. return a KeyStroke object for that key see java.awt.event.KeyEvent see java.awt.event.InputEvent synchronized (AWTKeyStroke.class) { registerSubclass(KeyStroke.class); return (KeyStroke)getAWTKeyStroke(keyCode, modifiers, onKeyRelease); }
public static javax.swing.KeyStroke	getKeyStroke(int keyCode, int modifiers) Returns 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 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. param keyCode an int specifying the numeric code for a keyboard key param modifiers a bitwise-ored combination of any modifiers return a KeyStroke object for that key see java.awt.event.KeyEvent see java.awt.event.InputEvent synchronized (AWTKeyStroke.class) { registerSubclass(KeyStroke.class); return (KeyStroke)getAWTKeyStroke(keyCode, modifiers); }
public static javax.swing.KeyStroke	getKeyStroke(java.lang.String s) Parses a string and returns a KeyStroke. 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. param s a String formatted as described above return a KeyStroke object for that String, or null if the specified String is null, or is formatted incorrectly if (s == null || s.length() == 0) { return null; } synchronized (AWTKeyStroke.class) { registerSubclass(KeyStroke.class); try { return (KeyStroke)getAWTKeyStroke(s); } catch (IllegalArgumentException e) { return null; } }
public static javax.swing.KeyStroke	getKeyStrokeForEvent(java.awt.event.KeyEvent anEvent) Returns 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. param anEvent the KeyEvent from which to obtain the KeyStroke throws NullPointerException if anEvent is null return the KeyStroke that precipitated the event synchronized (AWTKeyStroke.class) { registerSubclass(KeyStroke.class); return (KeyStroke)getAWTKeyStrokeForEvent(anEvent); }