All Packages  Class Hierarchy  This Package  Previous  Next  Index

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

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

Constructor Index

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

Method Index

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

Variables

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

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

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

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

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

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

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

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

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

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

o 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

o 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
o KeyEvent 
 public KeyEvent(Component source,
                 int id,
                 long when,
                 int modifiers,
                 int keyCode)

Methods

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

o setKeyCode 
 public void setKeyCode(int keyCode)
o setKeyChar 
 public void setKeyChar(char keyChar)
o 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.

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

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

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

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

o paramString 
 public String paramString()
Overrides:
paramString in class ComponentEvent 
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature