KeyStroke JDK 1.6)

Methods

Hide/Show inherited methods

publicfinal boolean equals (Object anObject) [Inherited From AWTKeyStroke]

Returns true if this object is identical to the specified object.

publicstatic AWTKeyStroke getAWTKeyStroke (char keyChar) [Inherited From AWTKeyStroke]

Returns a shared instance of an AWTKeyStroke that represents a KEY_TYPED event for the specified character.

Returns a shared instance of an AWTKeyStroke
that represents a KEY_TYPED event for the
specified character.
Returns: an AWTKeyStroke object for that key
Parameters:
- keyChar - the character value for a keyboard key

publicstatic AWTKeyStroke getAWTKeyStroke (Character keyChar, int modifiers) [Inherited From AWTKeyStroke]

Returns a shared instance of an AWTKeyStroke that represents a KEY_TYPED event for the specified Character object and a set of 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.
Returns: an AWTKeyStroke object for that key
Parameters:
- keyChar - the Character object for a keyboard character
- modifiers - a bitwise-ored combination of any modifiers
Throws:
- IllegalArgumentException - if keyChar is null
See Also: InputEvent,

publicstatic AWTKeyStroke getAWTKeyStroke (int keyCode, int modifiers) [Inherited From AWTKeyStroke]

Returns a shared instance of an AWTKeyStroke, given a numeric key code and a set of 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.
Returns: an AWTKeyStroke object for that key
Parameters:
- keyCode - an int specifying the numeric code for a keyboard key
- modifiers - a bitwise-ored combination of any modifiers
See Also: KeyEvent, InputEvent,

publicstatic AWTKeyStroke getAWTKeyStroke (int keyCode, int modifiers, boolean onKeyRelease) [Inherited From AWTKeyStroke]

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

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.
Returns: an AWTKeyStroke object for that key
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
See Also: KeyEvent, InputEvent,

publicstatic AWTKeyStroke getAWTKeyStroke (String s) [Inherited From AWTKeyStroke]

Parses a string and returns an AWTKeyStroke.

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');

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

publicstatic AWTKeyStroke getAWTKeyStrokeForEvent (KeyEvent anEvent) [Inherited From AWTKeyStroke]

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.
Returns: the AWTKeyStroke that precipitated the event
Parameters:
- anEvent - the KeyEvent from which to obtain the AWTKeyStroke
Throws:
- NullPointerException - if anEvent is null

publicfinal char getKeyChar () [Inherited From AWTKeyStroke]

Returns the character for this AWTKeyStroke.

Returns the character for this AWTKeyStroke.
Returns: a char value
See Also: AWTKeyStroke.getAWTKeyStroke(char), KeyEvent.getKeyChar(),

publicfinal int getKeyCode () [Inherited From AWTKeyStroke]

Returns the numeric key code for this AWTKeyStroke.

Returns the numeric key code for this AWTKeyStroke.
Returns: an int containing the key code value
See Also: AWTKeyStroke.getAWTKeyStroke(int,int), KeyEvent.getKeyCode(),

publicfinal int getKeyEventType () [Inherited From AWTKeyStroke]

Returns the type of KeyEvent which corresponds to this AWTKeyStroke.

Returns the type of KeyEvent which corresponds to
this AWTKeyStroke.
Returns: KeyEvent.KEY_PRESSED, KeyEvent.KEY_TYPED, or KeyEvent.KEY_RELEASED
See Also: KeyEvent,

publicstatic KeyStroke getKeyStroke (char keyChar)

Returns a shared instance of a KeyStroke that represents a KEY_TYPED event for the specified character.

Returns a shared instance of a KeyStroke
that represents a KEY_TYPED event for the
specified character.
Returns: a KeyStroke object for that key
Parameters:
- keyChar - the character value for a keyboard key

publicstatic KeyStroke getKeyStroke (Character keyChar, int modifiers)

Returns a shared instance of a KeyStroke that represents a KEY_TYPED event for the specified Character object and a set of modifiers.

Returns a shared instance of a KeyStroke
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
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.
Returns: an KeyStroke object for that key
Parameters:
- keyChar - the Character object for a keyboard character
- modifiers - a bitwise-ored combination of any modifiers
Throws:
- IllegalArgumentException - if keyChar is null
Since: 1.3
See Also: InputEvent,

@Deprecated

publicstatic 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.

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.
Returns: a KeyStroke object for that key
Parameters:
- keyChar - the character value for a keyboard key
- onKeyRelease - true if this KeyStroke corresponds to a key release; false otherwise.

publicstatic KeyStroke getKeyStroke (int keyCode, int modifiers)

Returns a shared instance of a KeyStroke, given a numeric key code and a set of modifiers.

publicstatic 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.
Returns: a KeyStroke object for that key
Parameters:
- keyCode - an int specifying the numeric code for a keyboard key
- modifiers - a bitwise-ored combination of any modifiers
- onKeyRelease - true if the KeyStroke should represent a key release; false otherwise.
See Also: KeyEvent, InputEvent,

publicstatic KeyStroke getKeyStroke (String s)

Parses a string and returns a KeyStroke.

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.
Returns: a KeyStroke object for that String, or null if the specified String is null, or is formatted incorrectly
Parameters:
- s - a String formatted as described above

publicstatic KeyStroke getKeyStrokeForEvent (KeyEvent anEvent)

Returns a KeyStroke which represents the stroke which generated a given KeyEvent.

publicfinal int getModifiers () [Inherited From AWTKeyStroke]

Returns the modifier keys for this AWTKeyStroke.

Returns the modifier keys for this AWTKeyStroke.
Returns: an int containing the modifiers
See Also: AWTKeyStroke.getAWTKeyStroke(int,int),

public int hashCode () [Inherited From AWTKeyStroke]

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.

publicfinal boolean isOnKeyRelease () [Inherited From AWTKeyStroke]

Returns whether this AWTKeyStroke represents a key release.

Returns whether this AWTKeyStroke represents a key release.
Returns: true if this AWTKeyStroke represents a key release; false otherwise
See Also: AWTKeyStroke.getAWTKeyStroke(int,int,boolean),

protected Object readResolve () throws ObjectStreamException [Inherited From AWTKeyStroke]

Returns a cached instance of AWTKeyStroke (or a subclass of AWTKeyStroke) which is equal to this instance.

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

protectedstatic void registerSubclass (Class<Object> subclass) [Inherited From AWTKeyStroke]

Registers a new class which the factory methods in AWTKeyStroke will use when generating new instances of AWTKeyStrokes.

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 - if subclass is null, or if subclass does not have a no-arg constructor
- ClassCastException - if subclass is not AWTKeyStroke, or a class derived from AWTKeyStroke

public String toString () [Inherited From AWTKeyStroke]

Returns a string that displays and identifies this object's properties.

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.
Returns: a String representation of this object
See Also: AWTKeyStroke.getAWTKeyStroke(String),