java.awt
Class AWTKeyStroke

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.AWTKeyStroke
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable
Direct Known Subclasses:
KeyStroke sample code for javax.swing.KeyStroke definition code for javax.swing.KeyStroke

public class AWTKeyStroke
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Serializable sample code for java.io.Serializable definition code for java.io.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, 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.

Since:
1.4
See Also:
getAWTKeyStroke(char) sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(char) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(char) , Serialized Form

Constructor Summary
protected AWTKeyStroke sample code for java.awt.AWTKeyStroke.AWTKeyStroke() definition code for java.awt.AWTKeyStroke.AWTKeyStroke() ()
          Constructs an AWTKeyStroke with default values.
protected AWTKeyStroke sample code for java.awt.AWTKeyStroke.AWTKeyStroke(char, int, int, boolean) definition code for java.awt.AWTKeyStroke.AWTKeyStroke(char, int, int, boolean) (char keyChar, int keyCode, int modifiers, boolean onKeyRelease)
          Constructs an AWTKeyStroke with the specified values.
 
Method Summary
 boolean equals sample code for java.awt.AWTKeyStroke.equals(java.lang.Object) definition code for java.awt.AWTKeyStroke.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  anObject)
          Returns true if this object is identical to the specified object.
static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke getAWTKeyStroke sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(char) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(char) (char keyChar)
          Returns a shared instance of an AWTKeyStroke that represents a KEY_TYPED event for the specified character.
static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke getAWTKeyStroke sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.Character, int) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.Character, int) (Character sample code for java.lang.Character definition code for java.lang.Character  keyChar, int modifiers)
          Returns a shared instance of an AWTKeyStroke, given a Character object and a set of modifiers.
static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke getAWTKeyStroke sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int) (int keyCode, int modifiers)
          Returns a shared instance of an AWTKeyStroke, given a numeric key code and a set of modifiers.
static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke getAWTKeyStroke sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int, boolean) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int, boolean) (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 sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke getAWTKeyStroke sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.String) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  s)
          Parses a string and returns an AWTKeyStroke.
static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke getAWTKeyStrokeForEvent sample code for java.awt.AWTKeyStroke.getAWTKeyStrokeForEvent(java.awt.event.KeyEvent) definition code for java.awt.AWTKeyStroke.getAWTKeyStrokeForEvent(java.awt.event.KeyEvent) (KeyEvent sample code for java.awt.event.KeyEvent definition code for java.awt.event.KeyEvent  anEvent)
          Returns an AWTKeyStroke which represents the stroke which generated a given KeyEvent.
 char getKeyChar sample code for java.awt.AWTKeyStroke.getKeyChar() definition code for java.awt.AWTKeyStroke.getKeyChar() ()
          Returns the character for this AWTKeyStroke.
 int getKeyCode sample code for java.awt.AWTKeyStroke.getKeyCode() definition code for java.awt.AWTKeyStroke.getKeyCode() ()
          Returns the numeric key code for this AWTKeyStroke.
 int getKeyEventType sample code for java.awt.AWTKeyStroke.getKeyEventType() definition code for java.awt.AWTKeyStroke.getKeyEventType() ()
          Returns the type of KeyEvent which corresponds to this AWTKeyStroke.
 int getModifiers sample code for java.awt.AWTKeyStroke.getModifiers() definition code for java.awt.AWTKeyStroke.getModifiers() ()
          Returns the modifier keys for this AWTKeyStroke.
 int hashCode sample code for java.awt.AWTKeyStroke.hashCode() definition code for java.awt.AWTKeyStroke.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 sample code for java.awt.AWTKeyStroke.isOnKeyRelease() definition code for java.awt.AWTKeyStroke.isOnKeyRelease() ()
          Returns whether this AWTKeyStroke represents a key release.
protected  Object sample code for java.lang.Object definition code for java.lang.Object readResolve sample code for java.awt.AWTKeyStroke.readResolve() definition code for java.awt.AWTKeyStroke.readResolve() ()
          Returns a cached instance of AWTKeyStroke (or a subclass of AWTKeyStroke) which is equal to this instance.
protected static void registerSubclass sample code for java.awt.AWTKeyStroke.registerSubclass(java.lang.Class) definition code for java.awt.AWTKeyStroke.registerSubclass(java.lang.Class) (Class sample code for java.lang.Class definition code for java.lang.Class <?> subclass)
          Registers a new class which the factory methods in AWTKeyStroke will use when generating new instances of AWTKeyStrokes.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.awt.AWTKeyStroke.toString() definition code for java.awt.AWTKeyStroke.toString() ()
          Returns a string that displays and identifies this object's properties.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

AWTKeyStroke sample code for java.awt.AWTKeyStroke() definition code for java.awt.AWTKeyStroke()

protected AWTKeyStroke()
Constructs an AWTKeyStroke with default values. The default values used are:
PropertyDefault 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.

See Also:
getAWTKeyStroke(char) sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(char) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(char)

AWTKeyStroke sample code for java.awt.AWTKeyStroke(char, int, int, boolean) definition code for java.awt.AWTKeyStroke(char, int, int, boolean)

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.

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) sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(char) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(char)
Method Detail

registerSubclass sample code for java.awt.AWTKeyStroke.registerSubclass(java.lang.Class<?>) definition code for java.awt.AWTKeyStroke.registerSubclass(java.lang.Class<?>)

protected static void registerSubclass(Class sample code for java.lang.Class definition code for java.lang.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.

Parameters:
subclass - the new Class of which the factory methods should create instances
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if subclass is null, or if subclass does not have a no-arg constructor
ClassCastException sample code for java.lang.ClassCastException definition code for java.lang.ClassCastException - if subclass is not AWTKeyStroke, or a class derived from AWTKeyStroke

getAWTKeyStroke sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(char) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(char)

public static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke  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 sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.Character, int) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.Character, int)

public static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke  getAWTKeyStroke(Character sample code for java.lang.Character definition code for java.lang.Character  keyChar,
                                           int modifiers)
Returns a shared instance of an AWTKeyStroke, given a 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: The old modifiers 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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if keyChar is null
See Also:
InputEvent sample code for java.awt.event.InputEvent definition code for java.awt.event.InputEvent

getAWTKeyStroke sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int, boolean) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int, boolean)

public static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.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:

The modifiers consist of any combination of: The old modifiers 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 sample code for java.awt.event.KeyEvent definition code for java.awt.event.KeyEvent , InputEvent sample code for java.awt.event.InputEvent definition code for java.awt.event.InputEvent

getAWTKeyStroke sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int)

public static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.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:

The modifiers consist of any combination of: The old modifiers 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 sample code for java.awt.event.KeyEvent definition code for java.awt.event.KeyEvent , InputEvent sample code for java.awt.event.InputEvent definition code for java.awt.event.InputEvent

getAWTKeyStrokeForEvent sample code for java.awt.AWTKeyStroke.getAWTKeyStrokeForEvent(java.awt.event.KeyEvent) definition code for java.awt.AWTKeyStroke.getAWTKeyStrokeForEvent(java.awt.event.KeyEvent)

public static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke  getAWTKeyStrokeForEvent(KeyEvent sample code for java.awt.event.KeyEvent definition code for java.awt.event.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.

Parameters:
anEvent - the KeyEvent from which to obtain the AWTKeyStroke
Returns:
the AWTKeyStroke that precipitated the event
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if anEvent is null

getAWTKeyStroke sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.String) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.String)

public static AWTKeyStroke sample code for java.awt.AWTKeyStroke definition code for java.awt.AWTKeyStroke  getAWTKeyStroke(String sample code for java.lang.String definition code for java.lang.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');
 

Parameters:
s - a String formatted as described above
Returns:
an AWTKeyStroke object for that String
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if s is null, or is formatted incorrectly

getKeyChar sample code for java.awt.AWTKeyStroke.getKeyChar() definition code for java.awt.AWTKeyStroke.getKeyChar()

public final char getKeyChar()
Returns the character for this AWTKeyStroke.

Returns:
a char value
See Also:
getAWTKeyStroke(char) sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(char) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(char)

getKeyCode sample code for java.awt.AWTKeyStroke.getKeyCode() definition code for java.awt.AWTKeyStroke.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) sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int)

getModifiers sample code for java.awt.AWTKeyStroke.getModifiers() definition code for java.awt.AWTKeyStroke.getModifiers()

public final int getModifiers()
Returns the modifier keys for this AWTKeyStroke.

Returns:
an int containing the modifiers
See Also:
getAWTKeyStroke(int,int) sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int)

isOnKeyRelease sample code for java.awt.AWTKeyStroke.isOnKeyRelease() definition code for java.awt.AWTKeyStroke.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) sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int, boolean) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(int, int, boolean)

getKeyEventType sample code for java.awt.AWTKeyStroke.getKeyEventType() definition code for java.awt.AWTKeyStroke.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 sample code for java.awt.event.KeyEvent definition code for java.awt.event.KeyEvent

hashCode sample code for java.awt.AWTKeyStroke.hashCode() definition code for java.awt.AWTKeyStroke.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 sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
an int that represents this object
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

equals sample code for java.awt.AWTKeyStroke.equals(java.lang.Object) definition code for java.awt.AWTKeyStroke.equals(java.lang.Object)

public final boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  anObject)
Returns true if this object is identical to the specified object.

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
anObject - the Object to compare this object to
Returns:
true if the objects are identical
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

toString sample code for java.awt.AWTKeyStroke.toString() definition code for java.awt.AWTKeyStroke.toString()

public String sample code for java.lang.String definition code for java.lang.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.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a String representation of this object
See Also:
getAWTKeyStroke(String) sample code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.String) definition code for java.awt.AWTKeyStroke.getAWTKeyStroke(java.lang.String)

readResolve sample code for java.awt.AWTKeyStroke.readResolve() definition code for java.awt.AWTKeyStroke.readResolve()

protected Object sample code for java.lang.Object definition code for java.lang.Object  readResolve()
                      throws ObjectStreamException sample code for java.io.ObjectStreamException definition code for java.io.ObjectStreamException 
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 sample code for java.io.ObjectStreamException definition code for java.io.ObjectStreamException