Package com.intellij.ui

Class KeyStrokeAdapter

java.lang.Object

com.intellij.ui.KeyStrokeAdapter

All Implemented Interfaces:

java.awt.event.KeyListener, java.util.EventListener

public class KeyStrokeAdapter
extends java.lang.Object
implements java.awt.event.KeyListener

Constructor Summary

Constructors

Constructor and Description
KeyStrokeAdapter()

Method Summary

Modifier and Type	Method and Description
static javax.swing.KeyStroke	getDefaultKeyStroke(java.awt.event.KeyEvent event)
static javax.swing.KeyStroke	getKeyStroke(java.awt.event.KeyEvent event, boolean extended)
static javax.swing.KeyStroke	getKeyStroke(java.lang.String string) Parses a string and returns the corresponding key stroke.
void	keyPressed(java.awt.event.KeyEvent event)
protected boolean	keyPressed(javax.swing.KeyStroke stroke)
void	keyReleased(java.awt.event.KeyEvent event)
protected boolean	keyReleased(javax.swing.KeyStroke stroke)
void	keyTyped(java.awt.event.KeyEvent event)
protected boolean	keyTyped(javax.swing.KeyStroke stroke)
static java.lang.String	toString(javax.swing.KeyStroke stroke) Returns a string that represents the specified key stroke.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyStrokeAdapter

public KeyStrokeAdapter()

Method Detail

keyTyped

public void keyTyped(java.awt.event.KeyEvent event)

Specified by:

keyTyped in interface java.awt.event.KeyListener

keyTyped

protected boolean keyTyped(javax.swing.KeyStroke stroke)

keyPressed

public void keyPressed(java.awt.event.KeyEvent event)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyPressed

protected boolean keyPressed(javax.swing.KeyStroke stroke)

keyReleased

public void keyReleased(java.awt.event.KeyEvent event)

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyReleased

protected boolean keyReleased(javax.swing.KeyStroke stroke)

getDefaultKeyStroke

public static javax.swing.KeyStroke getDefaultKeyStroke(java.awt.event.KeyEvent event)

Parameters:

event - the specified key event to process

Returns:

a key stroke or null if it is not applicable

See Also:

KeyStroke.getKeyStrokeForEvent(KeyEvent)

getKeyStroke

public static javax.swing.KeyStroke getKeyStroke(java.awt.event.KeyEvent event,
                                                 boolean extended)

Parameters:

event - the specified key event to process

extended - true if extended key code should be used

Returns:

a key stroke or null if it is not applicable

See Also:

JComponent.processKeyBindings(KeyEvent, boolean)

getKeyStroke

public static javax.swing.KeyStroke getKeyStroke(java.lang.String string)

Parses a string and returns the corresponding key stroke. The string must have the following syntax:

    <modifiers>* (<typedID> | <pressedReleasedID>)
 

where

    modifiers := shift | ctrl | control | meta | alt | altGr | altGraph
    typedID := typed <char>
    pressedReleasedID := (pressed | released) key
 

If typed, pressed or released is not specified, pressed is assumed. The char is a string of length 1 giving Unicode character. The key is a virtual key name or an integer that represents a key code. Note that the virtual key name is a second part of a name of the corresponding field defined in the KeyEvent class.

This method has two differences from the KeyStroke.getKeyStroke(String) method. First, it does not throw an exception if the specified string cannot be parsed. Second, it supports an integer representation of a key code if the corresponding virtual key is not specified in the KeyEvent class.

This method returns null if the specified string is null or if it cannot be parsed. The error message is logged without throwing an exception.

Parameters:

string - the specified string to parse as described above

Returns:

a key stroke string represented by the specified string

toString

public static java.lang.String toString(javax.swing.KeyStroke stroke)

Returns a string that represents the specified key stroke. The result of this method can be passed as a parameter to the getKeyStroke(String) method to produce a key stroke equal to the specified key stroke.

This method has two differences from the AWTKeyStroke.toString() method. First, the resulting string does not contain the "pressed" keyword. Second, the resulting string contains a hexadecimal integer instead of null if the corresponding virtual key is not specified in the KeyEvent class.

This method returns null if the specified key stroke is null or if its keyCode and keyChar both are undefined.

Parameters:

stroke - the specified key stroke to process

Returns:

a string representation of the specified key stroke