Home » openjdk-7 » java » awt » [javadoc | source]
java.awt
public class: AWTKeyStroke [javadoc | source]
java.lang.Object
   java.awt.AWTKeyStroke

All Implemented Interfaces:
    java$io$Serializable

Direct Known Subclasses:
    KeyStroke

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, altGraph, 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.

Field Summary
static final  long serialVersionUID     
Constructor:
 protected AWTKeyStroke() 
 protected AWTKeyStroke(char keyChar,
    int keyCode,
    int modifiers,
    boolean onKeyRelease) 
Method from java.awt.AWTKeyStroke Summary:
equals,   getAWTKeyStroke,   getAWTKeyStroke,   getAWTKeyStroke,   getAWTKeyStroke,   getAWTKeyStroke,   getAWTKeyStrokeForEvent,   getKeyChar,   getKeyCode,   getKeyEventType,   getModifiers,   getModifiersText,   getVKText,   hashCode,   isOnKeyRelease,   readResolve,   registerSubclass,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.AWTKeyStroke Detail:
 public final boolean equals(Object anObject) 
    Returns true if this object is identical to the specified object.
 public static AWTKeyStroke getAWTKeyStroke(char keyChar) 
    Returns a shared instance of an AWTKeyStroke that represents a KEY_TYPED event for the specified character.
 public static AWTKeyStroke getAWTKeyStroke(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');
    
 public static AWTKeyStroke getAWTKeyStroke(Character keyChar,
    int modifiers) 
    Returns a shared instance of an {@code AWTKeyStroke} 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 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.
 public static 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:

    • 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.
 public static 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:

    • java.awt.event.KeyEvent.VK_ENTER
    • java.awt.event.KeyEvent.VK_TAB
    • java.awt.event.KeyEvent.VK_SPACE
    Alternatively, the key code may be obtained by calling 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
    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.
 public static AWTKeyStroke getAWTKeyStrokeForEvent(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.

 public final char getKeyChar() 
    Returns the character for this AWTKeyStroke.
 public final int getKeyCode() 
    Returns the numeric key code for this AWTKeyStroke.
 public final int getKeyEventType() 
    Returns the type of KeyEvent which corresponds to this AWTKeyStroke.
 public final int getModifiers() 
    Returns the modifier keys for this AWTKeyStroke.
 static String getModifiersText(int modifiers) 
 static String getVKText(int keyCode) 
 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.
 public final boolean isOnKeyRelease() 
    Returns whether this AWTKeyStroke represents a key release.
 protected Object readResolve() throws ObjectStreamException 
    Returns a cached instance of AWTKeyStroke (or a subclass of AWTKeyStroke) which is equal to this instance.
 protected static  void registerSubclass(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.
 public 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.