Class KeyEvent

The only char with no valid Unicode interpretation. This is used for key pressed and key released events which do not have a valid keyChar.

This is the first id in the range of event ids used by this class.

This is the last id in the range of event ids used by this class.

Indicates the key is on the left side of the keyboard, such as the left shift.

Since: 1.4

Indicates the key is on the numeric pad, such as the numpad 0.

Since: 1.4

Indicates the key is on the right side of the keyboard, such as the right shift.

Since: 1.4

Indicates a standard key location, with no left/right variants and not on the numeric pad.

Since: 1.4

Indicates unknown or irrelavent key location. This is also used for key typed events, which do not need a location.

Since: 1.4

This event id indicates a key was pressed.

This event it indicates a key was released.

This event id indicates a key was typed, which is a key press followed by a key release to generate an actual Unicode character. It may take several key presses to generate one key typed event, and some action keys have no corresponding key typed.

The virtual key VK_0.

The virtual key VK_1.

The virtual key VK_2.

The virtual key VK_3.

The virtual key VK_4.

The virtual key VK_5.

The virtual key VK_6.

The virtual key VK_7.

The virtual key VK_8.

The virtual key VK_9.

The virtual key VK_A.

The virtual key VK_ACCEPT.

The virtual key VK_ADD.

The virtual key VK_AGAIN.

Since: 1.2

The virtual key VK_ALL_CANDIDATES.

Since: 1.2

The virtual key VK_ALPHANUMERIC.

Since: 1.2

The virtual key VK_ALT.

The virtual key VK_ALT_GRAPH.

Since: 1.2

The virtual key VK_AMPERSAND.

Since: 1.2

The virtual key VK_ASTERISK.

Since: 1.2

The virtual key VK_AT.

Since: 1.2

The virtual key VK_B.

The virtual key VK_BACK_QUOTE.

The virtual key VK_BACK_SLASH.

The virtual key Backspace, which will always map to '\b'.

The 'begin' key VK_BEGIN

Since: 1.5

The virtual key VK_BRACELEFT.

Since: 1.2

The virtual key VK_BRACERIGHT.

Since: 1.2

The virtual key VK_C.

The virtual key Cancel.

The virtual key VK_CAPS_LOCK.

The virtual key VK_CIRCUMFLEX.

Since: 1.2

The virtual key VK_CLEAR.

The virtual key VK_CLOSE_BRACKET.

The virtual key VK_CODE_INPUT.

Since: 1.2

The virtual key VK_COLON.

Since: 1.2

The virtual key VK_COMMA.

The virtual key VK_COMPOSE.

Since: 1.2

The context-menu key VK_CONTEXT_MENU

Since: 1.5

The virtual key VK_CONTROL.

The virtual key VK_CONVERT.

The virtual key VK_COPY.

Since: 1.2

The virtual key VK_CUT.

Since: 1.2

The virtual key VK_D.

The virtual key VK_DEAD_ABOVEDOT.

Since: 1.2

The virtual key VK_DEAD_ABOVERING.

Since: 1.2

The virtual key VK_DEAD_ACUTE.

Since: 1.2

The virtual key VK_DEAD_BREVE.

Since: 1.2

The virtual key VK_DEAD_CARON.

Since: 1.2

The virtual key VK_DEAD_CEDILLA.

Since: 1.2

The virtual key VK_DEAD_CIRCUMFLEX.

Since: 1.2

The virtual key VK_DEAD_DIAERESIS.

Since: 1.2

The virtual key VK_DEAD_DOUBLEACUTE.

Since: 1.2

The virtual key VK_DEAD_GRAVE.

Since: 1.2

The virtual key VK_DEAD_IOTA.

Since: 1.2

The virtual key VK_DEAD_MACRON.

Since: 1.2

The virtual key VK_DEAD_OGONEK.

Since: 1.2

The virtual key VK_DEAD_SEMIVOICED_SOUND.

Since: 1.2

The virtual key VK_DEAD_TILDE.

Since: 1.2

The virtual key VK_DEAD_VOICED_SOUND.

Since: 1.2

The virtual key VK_DECIMAL.

The virtual key VK_DELETE.

The virtual key VK_DIVIDE.

The virtual key VK_DOLLAR.

Since: 1.2

The virtual key for the non-numpad VK_DOWN.

See Also: VK_KP_DOWN

The virtual key VK_E.

The virtual key VK_END.

The virtual key Enter, which will always map to '\n'.

The virtual key VK_EQUALS.

The virtual key VK_ESCAPE.

The virtual key VK_EURO_SIGN.

Since: 1.2

The virtual key VK_EXCLAMATION_MARK.

Since: 1.2

The virtual key VK_F.

The virtual key VK_F1.

The virtual key VK_F10.

The virtual key VK_F11.

The virtual key VK_F12.

The virtual key VK_F13.

Since: 1.2

The virtual key VK_F14.

Since: 1.2

The virtual key VK_F15.

Since: 1.2

The virtual key VK_F16.

Since: 1.2

The virtual key VK_F17.

Since: 1.2

The virtual key VK_F18.

Since: 1.2

The virtual key VK_F19.

Since: 1.2

The virtual key VK_F2.

The virtual key VK_F20.

Since: 1.2

The virtual key VK_F21.

Since: 1.2

The virtual key VK_F22.

Since: 1.2

The virtual key VK_F23.

Since: 1.2

The virtual key VK_F24.

Since: 1.2

The virtual key VK_F3.

The virtual key VK_F4.

The virtual key VK_F5.

The virtual key VK_F6.

The virtual key VK_F7.

The virtual key VK_F8.

The virtual key VK_F9.

The virtual key VK_FINAL.

The virtual key VK_FIND.

Since: 1.2

The virtual key VK_FULL_WIDTH.

Since: 1.2

The virtual key VK_G.

The virtual key VK_GREATER.

Since: 1.2

The virtual key VK_H.

The virtual key VK_HALF_WIDTH.

Since: 1.2

The virtual key VK_HELP.

The virtual key VK_HIRAGANA.

Since: 1.2

The virtual key VK_HOME.

The virtual key VK_I.

The virtual key VK_INPUT_METHOD_ON_OFF.

Since: 1.3

The virtual key VK_INSERT.

The virtual key VK_INVERTED_EXCLAMATION_MARK.

Since: 1.2

The virtual key VK_J.

The virtual key VK_JAPANESE_HIRAGANA.

Since: 1.2

The virtual key VK_JAPANESE_KATAKANA.

Since: 1.2

The virtual key VK_JAPANESE_ROMAN.

Since: 1.2

The virtual key VK_K.

The virtual key VK_KANA.

The virtual key VK_KANA_LOCK.

Since: 1.3

The virtual key VK_KANJI.

The virtual key VK_KATAKANA.

Since: 1.2

The virtual key for the numpad VK_KP_DOWN.

Since: 1.2

See Also: VK_DOWN

The virtual key for the numpad VK_KP_LEFT.

Since: 1.2

See Also: VK_LEFT

The virtual key for the numpad VK_KP_RIGHT.

Since: 1.2

See Also: VK_RIGHT

The virtual key for the numpad VK_KP_UP.

Since: 1.2

See Also: VK_UP

The virtual key VK_L.

The virtual key for the non-numpad VK_LEFT.

See Also: VK_KP_LEFT

The virtual key VK_LEFT_PARENTHESIS.

Since: 1.2

The virtual key VK_LESS.

Since: 1.2

The virtual key VK_M.

The virtual key VK_META.

The virtual key VK_MINUS.

Since: 1.2

The virtual key VK_MODECHANGE.

The virtual key VK_MULTIPLY.

The virtual key VK_N.

The virtual key VK_NONCONVERT.

The virtual key VK_NUMBER_SIGN.

Since: 1.2

The virtual key VK_NUMPAD0.

The virtual key VK_NUMPAD1.

The virtual key VK_NUMPAD2.

The virtual key VK_NUMPAD3.

The virtual key VK_NUMPAD4.

The virtual key VK_NUMPAD5.

The virtual key VK_NUMPAD6.

The virtual key VK_NUMPAD7.

The virtual key VK_NUMPAD8.

The virtual key VK_NUMPAD9.

The virtual key VK_NUM_LOCK.

The virtual key VK_O.

The virtual key VK_OPEN_BRACKET.

The virtual key VK_P.

The virtual key VK_PAGE_DOWN.

The virtual key VK_PAGE_UP.

The virtual key VK_PASTE.

Since: 1.2

The virtual key VK_PAUSE.

The virtual key VK_PERIOD.

The virtual key VK_PLUS.

Since: 1.2

The virtual key VK_PREVIOUS_CANDIDATE.

Since: 1.2

The virtual key VK_PRINTSCREEN.

The virtual key VK_PROPS.

Since: 1.2

The virtual key VK_Q.

The virtual key VK_QUOTE.

The virtual key VK_QUOTEDBL.

Since: 1.2

The virtual key VK_R.

The virtual key for the non-numpad VK_RIGHT.

See Also: VK_KP_RIGHT

The virtual key VK_RIGHT_PARENTHESIS.

Since: 1.2

The virtual key VK_ROMAN_CHARACTERS.

Since: 1.2

The virtual key VK_S.

The virtual key VK_SCROLL_LOCK.

The virtual key VK_SEMICOLON.

Deprecated: use {@link #VK_SEPARATOR}

The virtual key VK_SEPARATOR, handily mispelled for those who can't figure it out.

The virtual key VK_SEPARATOR.

Since: 1.4

The virtual key VK_SHIFT.

The virtual key VK_SLASH.

The virtual key VK_SPACE.

The virtual key VK_STOP.

Since: 1.2

The virtual key VK_SUBTRACT.

The virtual key VK_T.

The virtual key Tab, which will always map to '\t'.

The virtual key VK_U.

The virtual key VK_UNDEFINED. This is used for key typed events, which do not have a virtual key.

The virtual key VK_UNDERSCORE.

Since: 1.2

The virtual key VK_UNDO.

Since: 1.2

The virtual key for the non-numpad VK_UP.

See Also: VK_KP_UP

The virtual key VK_V.

The virtual key VK_W.

The 'Windows' key VK_WINDOWS

Since: 1.5

The virtual key VK_X.

The virtual key VK_Y.

The virtual key VK_Z.

Initializes a new instance of KeyEvent with the specified information. Note that an invalid id leads to unspecified results.

Parameters: source the component that generated this event id the event id when the timestamp when the even occurred modifiers the modifier keys during the event, in old or new style keyCode the integer constant for the virtual key type keyChar the Unicode value of the key keyLocation the location of the key

Throws: IllegalArgumentException if source is null, if keyLocation is invalid, or if (id == KEY_TYPED && (keyCode != VK_UNDEFINED || keyChar == CHAR_UNDEFINED))

Initializes a new instance of KeyEvent with the specified information. Note that an invalid id leads to unspecified results.

Parameters: source the component that generated this event id the event id when the timestamp when the even occurred modifiers the modifier keys during the event, in old or new style keyCode the integer constant for the virtual key type keyChar the Unicode value of the key

Throws: IllegalArgumentException if source is null, or if (id == KEY_TYPED && (keyCode != VK_UNDEFINED || keyChar == CHAR_UNDEFINED))

Deprecated:

Initializes a new instance of KeyEvent with the specified information. Note that an invalid id leads to unspecified results.

Parameters: source the component that generated this event id the event id when the timestamp when the even occurred modifiers the modifier keys during the event, in old or new style keyCode the integer constant for the virtual key type

Throws: IllegalArgumentException if source is null, or if id == KEY_TYPED but keyCode != VK_UNDEFINED

Returns the Unicode value for the event key. This will be CHAR_UNDEFINED if there is no Unicode equivalent for this key, usually when this is a KEY_PRESSED or KEY_RELEASED event.

Returns: the Unicode character for this event

Returns the key code for the event key. This will be one of the VK_* constants defined in this class. If the event type is KEY_TYPED, the result will be VK_UNDEFINED.

Returns: the key code for this event

Returns the keyboard location of the key that generated this event. This provides a way to distinguish between keys like left and right shift which share a common key code. The result will be one of {@link #KEY_LOCATION_UNKNOWN}, {@link #KEY_LOCATION_STANDARD}, {@link #KEY_LOCATION_LEFT}, {@link #KEY_LOCATION_RIGHT}, or {@link #KEY_LOCATION_NUMPAD}.

Returns: the key location

Since: 1.4

Returns a string describing the modifiers, such as "Shift" or "Ctrl+Button1". XXX Sun claims this can be localized via the awt.properties file - how do we implement that?

Parameters: modifiers the old-style modifiers to convert to text

Returns: a string representation of the modifiers in this bitmask

Returns the text name of key code, such as "HOME", "F1", or "A". XXX Sun claims this can be localized via the awt.properties file - how do we implement that?

Returns: the text name of the key code

Tests whether or not this key is an action key. An action key typically does not fire a KEY_TYPED event, and is not a modifier.

Returns: true if this is an action key

Returns a string identifying the event. This is formatted as the field name of the id type, followed by the keyCode, then the keyChar, modifiers (if any), extModifiers (if any), and keyLocation.

Returns: a string identifying the event

Sets the Unicode character for this event to the specified value.

Parameters: keyChar the new Unicode character for this event

Sets the key code for this event. This must be one of the VK_* constants defined in this class.

Parameters: keyCode the new key code for this event

Deprecated:

Sets the modifier keys to the specified value. This should be a union of the bit mask constants from InputEvent. The use of this method is not recommended, particularly for KEY_TYPED events, which do not check if the modifiers were changed.

Parameters: modifiers the new modifier value, in either old or new style

See Also: