Where Am I? Class Hierarchy (JDK) All Classes (JDK) All Fields and Methods (JDK)

Class java.awt.event.KeyEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----java.awt.AWTEvent
                   |
                   +----java.awt.event.ComponentEvent
                           |
                           +----java.awt.event.InputEvent
                                   |
                                   +----java.awt.event.KeyEvent

public class KeyEvent
extends InputEvent

The component-level keyboard event.


Variable Index

CHAR_UNDEFINED
KEY_PRESSED and KEY_RELEASED events which do not map to a valid Unicode character do not have a defined keyChar.
KEY_FIRST
Marks the first integer id for the range of key event ids.
KEY_LAST
Marks the last integer id for the range of key event ids.
KEY_PRESSED
The key pressed event type.
KEY_RELEASED
The key released event type.
KEY_TYPED
The key typed event type.
VK_0
VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)
VK_1
VK_2
VK_3
VK_4
VK_5
VK_6
VK_7
VK_8
VK_9
VK_A
VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)
VK_ACCEPT
VK_ADD
VK_ALT
VK_B
VK_BACK_QUOTE
VK_BACK_SLASH
VK_BACK_SPACE
VK_C
VK_CANCEL
VK_CAPS_LOCK
VK_CLEAR
VK_CLOSE_BRACKET
VK_COMMA
VK_CONTROL
VK_CONVERT
VK_D
VK_DECIMAL
VK_DELETE
VK_DIVIDE
VK_DOWN
VK_E
VK_END
VK_ENTER
Virtual key codes.
VK_EQUALS
VK_ESCAPE
VK_F
VK_F1
VK_F10
VK_F11
VK_F12
VK_F2
VK_F3
VK_F4
VK_F5
VK_F6
VK_F7
VK_F8
VK_F9
VK_FINAL
for Asian Keyboard
VK_G
VK_H
VK_HELP
VK_HOME
VK_I
VK_INSERT
VK_J
VK_K
VK_KANA
VK_KANJI
VK_L
VK_LEFT
VK_M
VK_META
VK_MODECHANGE
VK_MULTIPLY
VK_N
VK_NONCONVERT
VK_NUM_LOCK
VK_NUMPAD0
VK_NUMPAD1
VK_NUMPAD2
VK_NUMPAD3
VK_NUMPAD4
VK_NUMPAD5
VK_NUMPAD6
VK_NUMPAD7
VK_NUMPAD8
VK_NUMPAD9
VK_O
VK_OPEN_BRACKET
VK_P
VK_PAGE_DOWN
VK_PAGE_UP
VK_PAUSE
VK_PERIOD
VK_PRINTSCREEN
VK_Q
VK_QUOTE
VK_R
VK_RIGHT
VK_S
VK_SCROLL_LOCK
VK_SEMICOLON
VK_SEPARATER
VK_SHIFT
VK_SLASH
VK_SPACE
VK_SUBTRACT
VK_T
VK_TAB
VK_U
VK_UNDEFINED
KEY_TYPED events do not have a defined keyCode.
VK_UP
VK_V
VK_W
VK_X
VK_Y
VK_Z

Constructor Index

KeyEvent(Component, int, long, int, int)
KeyEvent(Component, int, long, int, int, char)
Constructs a KeyEvent object with the specified source component, type, modifiers, and key.

Method Index

getKeyChar()
Returns the character associated with the key in this event.
getKeyCode()
Returns the integer key-code associated with the key in this event.
getKeyModifiersText(int)
Returns a String describing the modifier key(s), such as "Shift", or "Ctrl+Shift".
getKeyText(int)
Returns a String describing the keyCode, such as "HOME", "F1" or "A".
isActionKey()
Returns whether or not the key in this event is an "action" key, as defined in Event.java.
paramString()
setKeyChar(char)
setKeyCode(int)
setModifiers(int)
Change the modifiers for a KeyEvent.

Variables

KEY_FIRST
 public static final int KEY_FIRST
Marks the first integer id for the range of key event ids.

KEY_LAST
 public static final int KEY_LAST
Marks the last integer id for the range of key event ids.

KEY_TYPED
 public static final int KEY_TYPED
The key typed event type. This type is generated by a combination of a key press followed by a key release.

KEY_PRESSED
 public static final int KEY_PRESSED
The key pressed event type.

KEY_RELEASED
 public static final int KEY_RELEASED
The key released event type.

VK_ENTER
 public static final int VK_ENTER
Virtual key codes. These codes report which keyboard key has been pressed, rather than any character generated by one or more keys being pressed. For example, pressing the Shift key will cause a KEY_PRESSED event with a VK_SHIFT keyCode, while pressing the 'a' key will result in a VK_A keyCode. After the 'a' key is released, a KEY_RELEASED event will be fired with VK_A, followed by a KEY_TYPED event with a keyChar value of 'A'. Key combinations which do not result in characters, such as action keys like F1, will not generate KEY_TYPED events. Note: not all keyboards or systems are capable of generating all virtual key codes. No attempt is made in Java to artificially generate these keys. WARNING: aside from those keys where are defined by the Java language (VK_ENTER, VK_BACK_SPACE, and VK_TAB), do not rely on the values of these constants. Sun reserves the right to change these values as needed to accomodate a wider range of keyboards in the future.

VK_BACK_SPACE
 public static final int VK_BACK_SPACE
VK_TAB
 public static final int VK_TAB
VK_CANCEL
 public static final int VK_CANCEL
VK_CLEAR
 public static final int VK_CLEAR
VK_SHIFT
 public static final int VK_SHIFT
VK_CONTROL
 public static final int VK_CONTROL
VK_ALT
 public static final int VK_ALT
VK_PAUSE
 public static final int VK_PAUSE
VK_CAPS_LOCK
 public static final int VK_CAPS_LOCK
VK_ESCAPE
 public static final int VK_ESCAPE
VK_SPACE
 public static final int VK_SPACE
VK_PAGE_UP
 public static final int VK_PAGE_UP
VK_PAGE_DOWN
 public static final int VK_PAGE_DOWN
VK_END
 public static final int VK_END
VK_HOME
 public static final int VK_HOME
VK_LEFT
 public static final int VK_LEFT
VK_UP
 public static final int VK_UP
VK_RIGHT
 public static final int VK_RIGHT
VK_DOWN
 public static final int VK_DOWN
VK_COMMA
 public static final int VK_COMMA
VK_PERIOD
 public static final int VK_PERIOD
VK_SLASH
 public static final int VK_SLASH
VK_0
 public static final int VK_0
VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)

VK_1
 public static final int VK_1
VK_2
 public static final int VK_2
VK_3
 public static final int VK_3
VK_4
 public static final int VK_4
VK_5
 public static final int VK_5
VK_6
 public static final int VK_6
VK_7
 public static final int VK_7
VK_8
 public static final int VK_8
VK_9
 public static final int VK_9
VK_SEMICOLON
 public static final int VK_SEMICOLON
VK_EQUALS
 public static final int VK_EQUALS
VK_A
 public static final int VK_A
VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)

VK_B
 public static final int VK_B
VK_C
 public static final int VK_C
VK_D
 public static final int VK_D
VK_E
 public static final int VK_E
VK_F
 public static final int VK_F
VK_G
 public static final int VK_G
VK_H
 public static final int VK_H
VK_I
 public static final int VK_I
VK_J
 public static final int VK_J
VK_K
 public static final int VK_K
VK_L
 public static final int VK_L
VK_M
 public static final int VK_M
VK_N
 public static final int VK_N
VK_O
 public static final int VK_O
VK_P
 public static final int VK_P
VK_Q
 public static final int VK_Q
VK_R
 public static final int VK_R
VK_S
 public static final int VK_S
VK_T
 public static final int VK_T
VK_U
 public static final int VK_U
VK_V
 public static final int VK_V
VK_W
 public static final int VK_W
VK_X
 public static final int VK_X
VK_Y
 public static final int VK_Y
VK_Z
 public static final int VK_Z
VK_OPEN_BRACKET
 public static final int VK_OPEN_BRACKET
VK_BACK_SLASH
 public static final int VK_BACK_SLASH
VK_CLOSE_BRACKET
 public static final int VK_CLOSE_BRACKET
VK_NUMPAD0
 public static final int VK_NUMPAD0
VK_NUMPAD1
 public static final int VK_NUMPAD1
VK_NUMPAD2
 public static final int VK_NUMPAD2
VK_NUMPAD3
 public static final int VK_NUMPAD3
VK_NUMPAD4
 public static final int VK_NUMPAD4
VK_NUMPAD5
 public static final int VK_NUMPAD5
VK_NUMPAD6
 public static final int VK_NUMPAD6
VK_NUMPAD7
 public static final int VK_NUMPAD7
VK_NUMPAD8
 public static final int VK_NUMPAD8
VK_NUMPAD9
 public static final int VK_NUMPAD9
VK_MULTIPLY
 public static final int VK_MULTIPLY
VK_ADD
 public static final int VK_ADD
VK_SEPARATER
 public static final int VK_SEPARATER
VK_SUBTRACT
 public static final int VK_SUBTRACT
VK_DECIMAL
 public static final int VK_DECIMAL
VK_DIVIDE
 public static final int VK_DIVIDE
VK_F1
 public static final int VK_F1
VK_F2
 public static final int VK_F2
VK_F3
 public static final int VK_F3
VK_F4
 public static final int VK_F4
VK_F5
 public static final int VK_F5
VK_F6
 public static final int VK_F6
VK_F7
 public static final int VK_F7
VK_F8
 public static final int VK_F8
VK_F9
 public static final int VK_F9
VK_F10
 public static final int VK_F10
VK_F11
 public static final int VK_F11
VK_F12
 public static final int VK_F12
VK_DELETE
 public static final int VK_DELETE
VK_NUM_LOCK
 public static final int VK_NUM_LOCK
VK_SCROLL_LOCK
 public static final int VK_SCROLL_LOCK
VK_PRINTSCREEN
 public static final int VK_PRINTSCREEN
VK_INSERT
 public static final int VK_INSERT
VK_HELP
 public static final int VK_HELP
VK_META
 public static final int VK_META
VK_BACK_QUOTE
 public static final int VK_BACK_QUOTE
VK_QUOTE
 public static final int VK_QUOTE
VK_FINAL
 public static final int VK_FINAL
for Asian Keyboard

VK_CONVERT
 public static final int VK_CONVERT
VK_NONCONVERT
 public static final int VK_NONCONVERT
VK_ACCEPT
 public static final int VK_ACCEPT
VK_MODECHANGE
 public static final int VK_MODECHANGE
VK_KANA
 public static final int VK_KANA
VK_KANJI
 public static final int VK_KANJI
VK_UNDEFINED
 public static final int VK_UNDEFINED
KEY_TYPED events do not have a defined keyCode.

CHAR_UNDEFINED
 public static final char CHAR_UNDEFINED
KEY_PRESSED and KEY_RELEASED events which do not map to a valid Unicode character do not have a defined keyChar.


Constructors

KeyEvent
 public KeyEvent(Component source,
                 int id,
                 long when,
                 int modifiers,
                 int keyCode,
                 char keyChar)
Constructs a KeyEvent object with the specified source component, type, modifiers, and key.

Parameters:
source - the object where the event originated
KeyEvent
 public KeyEvent(Component source,
                 int id,
                 long when,
                 int modifiers,
                 int keyCode)

Methods

getKeyCode
 public int getKeyCode()
Returns the integer key-code associated with the key in this event. For KEY_TYPED events, keyCode is VK_UNDEFINED.

setKeyCode
 public void setKeyCode(int keyCode)
setKeyChar
 public void setKeyChar(char keyChar)
setModifiers
 public void setModifiers(int modifiers)
Change the modifiers for a KeyEvent.

NOTE: use of this method is not recommended, because many AWT implementations do not recognize modifier changes. This is especially true for KEY_TYPED events where the shift modifier is changed.

getKeyChar
 public char getKeyChar()
Returns the character associated with the key in this event. If no valid Unicode character exists for this key event, keyChar is CHAR_UNDEFINED.

getKeyText
 public static String getKeyText(int keyCode)
Returns a String describing the keyCode, such as "HOME", "F1" or "A". These strings can be localized by changing the awt.properties file.

getKeyModifiersText
 public static String getKeyModifiersText(int modifiers)
Returns a String describing the modifier key(s), such as "Shift", or "Ctrl+Shift". These strings can be localized by changing the awt.properties file.

isActionKey
 public boolean isActionKey()
Returns whether or not the key in this event is an "action" key, as defined in Event.java.

paramString
 public String paramString()
Overrides:
paramString in class ComponentEvent

Where Am I? Class Hierarchy (JDK) All Classes (JDK) All Fields and Methods (JDK)