Package com.vaadin.flow.component

Interface Key

All Superinterfaces:
Serializable
All Known Implementing Classes:
KeyModifier
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface Key extends Serializable
An interface to represent keyboard keys.

While the Key values defined here consist of multiple values in order to account for variability in browsers, the Key values that come from the client only consist of the single value known to the client's Browser.

Some of the Key values map only to event.key values while other Key values contain values for both event.key and event.code, and some only contain a event.code value. In cases where a Key containing only event.code value is a subset of a Key based on event.key value, the event.code is included in the latter Key only.

For example, Key ALT consists of values [Alt, AltLeft] and ALT_LEFT is a key itself. See the documentation of the Key instance for more information about its relation to event.key and event.code values.

See https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values for event.key values and https://w3c.github.io/uievents-code/ for event.code values.

Since:
1.0
Author:
Vaadin Ltd.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Key
    ABORT
    This value matches DOM's KeyboardEvent's event.code.
    static final Key
    ACCEPT
    The Accept, Commit, or OK key or button.
    static final Key
    ADD
    The numeric keypad's addition key, +.
    static final Key
    AGAIN
    The Again key.
    static final Key
    ALL_CANDIDATES
    The All Candidates key, which starts multi-candidate mode, in which multiple candidates are displayed for the ongoing input.
    static final Key
    ALPHANUMERIC
    The Alphanumeric key.
    static final Key
    ALT
    The Alt (Alternative) key.
    static final Key
    ALT_GRAPH
    The AltGr or AltGraph (Alternate Graphics) key.
    static final Key
    ALT_LEFT
    Alt , Option or ⌥ .
    static final Key
    ALT_RIGHT
    Alt , Option or ⌥ .This is labelled AltGr key on many keyboard layouts.
    static final Key
    APP_SWITCH
    Presents a list of recently-used applications which lets the user change apps quickly.
    static final Key
    ARROW_DOWN
    The down arrow key (↓).
    static final Key
    ARROW_LEFT
    The left arrow key (←).
    static final Key
    ARROW_RIGHT
    The right arrow key (→).
    static final Key
    ARROW_UP
    The up arrow key (↑).
    static final Key
    ATTN
    The Attn (Attention) key.
    static final Key
    AUDIO_BALANCE_LEFT
    Adjusts audio balance toward the left.
    static final Key
    AUDIO_BALANCE_RIGHT
    Adjusts audio balance toward the right.
    static final Key
    AUDIO_BASS_BOOST_DOWN
    Reduces bass boosting or cycles downward through bass boost modes or states.
    static final Key
    AUDIO_BASS_BOOST_TOGGLE
    Toggles bass boosting on and off.
    static final Key
    AUDIO_BASS_BOOST_UP
    Increases the amount of bass boosting, or cycles upward through a set of bass boost modes or states.
    static final Key
    AUDIO_BASS_DOWN
    Decreases the amount of bass.
    static final Key
    AUDIO_BASS_UP
    Increases the amount of bass.
    static final Key
    AUDIO_FADER_FRONT
    Adjusts the audio fader toward the front.
    static final Key
    AUDIO_FADER_REAR
    Adjusts the audio fader toward the rear.
    static final Key
    AUDIO_SURROUND_MODE_NEXT
    Selects the next available surround sound mode.
    static final Key
    AUDIO_TREBLE_DOWN
    Decreases the amount of treble.
    static final Key
    AUDIO_TREBLE_UP
    Increases the amount of treble.
    static final Key
    AUDIO_VOLUME_DOWN
    Decreases the audio volume.
    static final Key
    AUDIO_VOLUME_MUTE
    Mutes the audio.
    static final Key
    AUDIO_VOLUME_UP
    Increases the audio volume.
    static final Key
    AVR_INPUT
    Changes the input mode on an external audio/video receiver (AVR) unit.
    static final Key
    AVR_POWER
    Toggles the power on an external AVR unit.
    static final Key
    BACKQUOTE
    `~ on a US keyboard.
    static final Key
    BACKSLASH
    Used for both the US \| (on the 101-key layout) and also for the keylocated between the " and Enter keys on row C of the 102-, 104- and 106-key layouts.
    static final Key
    BACKSPACE
    Backspace or ⌫.
    static final Key
    BRACKET_LEFT
    [{ on a US keyboard.
    static final Key
    BRACKET_RIGHT
    ]} on a US keyboard.
    static final Key
    BRIGHTNESS_DOWN
    The Brightness Down key.
    static final Key
    BRIGHTNESS_UP
    The Brightness Up key.
    static final Key
    BROWSER_BACK
    Navigates to the previous content or page in the current Web view's history.
    static final Key
    BROWSER_FAVORITES
    Opens the user's list of bookmarks/favorites.
    static final Key
    BROWSER_FORWARD
    Navigates to the next content or page in the current Web view's history.
    static final Key
    BROWSER_HOME
    Navigates to the user's preferred home page.
    static final Key
    BROWSER_REFRESH
    Refreshes the current page or content.
    static final Key
    BROWSER_SEARCH
    Activates the user's preferred search engine or the search interface within their browser.
    static final Key
    BROWSER_STOP
    Stops loading the currently displayed Web view or content.
    static final Key
    CALL
    The Call key; dials the number which has been entered.
    static final Key
    CAMERA
    The Camera key; activates the camera.
    static final Key
    CAMERA_FOCUS
    The Focus key; focuses the camera.
    static final Key
    CANCEL
    The Cancel key.
    static final Key
    CAPS_LOCK
    The CapsLock or ⇪ key.
    static final Key
    CHANNEL_DOWN
    Switches to the previous channel.
    static final Key
    CHANNEL_UP
    Switches to the next channel.
    static final Key
    CLEAR
    The Clear key.
    static final Key
    CLOSE
    Closes the current document or message.
    static final Key
    CLOSED_CAPTION_TOGGLE
    Toggles closed captioning on and off.
    static final Key
    CODE_INPUT
    The Code Input key, which enables code input mode, which lets the user enter characters by typing their code points (their Unicode character numbers, typically).
    static final Key
    COLOR_F0_RED
    General-purpose media function key, color-coded red; this has index 0 among the colored keys.
    static final Key
    COLOR_F1_GREEN
    General-purpose media function key, color-coded green; this has index 1 among the colored keys.
    static final Key
    COLOR_F2_YELLOW
    General-purpose media function key, color-coded yellow; this has index 2 among the colored keys.
    static final Key
    COLOR_F3_BLUE
    General-purpose media function key, color-coded blue; this has index 3 among the colored keys.
    static final Key
    COLOR_F4_GREY
    General-purpose media function key, color-coded grey; this has index 4 among the colored keys.
    static final Key
    COLOR_F5_BROWN
    General-purpose media function key, color-coded brown; this has index 5 among the colored keys.
    static final Key
    COMMA
    ,< on a US keyboard.
    static final Key
    COMPOSE
    The Compose key.
    static final Key
    CONTEXT_MENU
    Shows the context menu.
    static final Key
    CONTROL
    The Control, Ctrl, or Ctl key.
    static final Key
    CONTROL_LEFT
    Control or ⌃
    static final Key
    CONTROL_RIGHT
    Control or ⌃
    static final Key
    CONVERT
    The Convert key, which instructs the IME to convert the current input method sequence into the resulting character.
    static final Key
    COPY
    The Copy key (on certain extended keyboards).
    static final Key
    CR_SEL
    The Cursor Select key, CrSel.
    static final Key
    CUT
    The Cut key (on certain extended keyboards).
    static final Key
    DEAD
    A dead "combining" key; that is, a key which is used in tandem with other keys to generate accented and other modified characters.
    static final Key
    DECIMAL
    The decimal point key (typically . or ,) depending on the region.
    static final Key
    DELETE
    The Delete key, Del, and ⌦ .
    static final Key
    DIGIT_0
    0) on a US keyboard.
    static final Key
    DIGIT_1
    1! on a US keyboard.
    static final Key
    DIGIT_2
    2@ on a US keyboard.
    static final Key
    DIGIT_3
    3# on a US keyboard.
    static final Key
    DIGIT_4
    4$ on a US keyboard.
    static final Key
    DIGIT_5
    5% on a US keyboard.
    static final Key
    DIGIT_6
    6^ on a US keyboard.
    static final Key
    DIGIT_7
    7& on a US keyboard.
    static final Key
    DIGIT_8
    8* on a US keyboard.
    static final Key
    DIGIT_9
    9( on a US keyboard.
    static final Key
    DIMMER
    Adjusts the brightness of the device by toggling between two brightness levels or by cycling among multiple brightness levels.
    static final Key
    DISPLAY_SWAP
    Cycles among video sources.
    static final Key
    DIVIDE
    The numeric keypad's division key, /.
    static final Key
    DVR
    Switches the input source to the Digital Video Recorder (DVR).
    static final Key
    EISU
    The Eisu key.
    static final Key
    EJECT
    The Eject or ⏏ key.
    static final Key
    END
    The End key.
    static final Key
    END_CALL
    The End Call or Hang Up button.
    static final Key
    ENTER
    The Enter or ↵ key.
    static final Key
    EQUAL
    =+ on a US keyboard.
    static final Key
    ERASE_EOF
    Erase to End of Field.
    static final Key
    ESCAPE
    The Esc (Escape) or ⎋ key.
    static final Key
    EX_SEL
    The ExSel (Extend Selection) key.
    static final Key
    EXECUTE
    The Execute key.
    static final Key
    EXIT
    The Exit button, which exits the current application or menu.
    static final Key
    F1
    The first general-purpose function key, F1.
    static final Key
    F10
    The F10 key.
    static final Key
    F11
    The F11 key.
    static final Key
    F12
    The F12 key.
    static final Key
    F13
    The F13 key.
    static final Key
    F14
    The F14 key.
    static final Key
    F15
    The F15 key.
    static final Key
    F16
    The F16 key.
    static final Key
    F17
    The F17 key.
    static final Key
    F18
    The F18 key.
    static final Key
    F19
    The F19 key.
    static final Key
    F2
    The F2 key.
    static final Key
    F20
    The F20 key.
    static final Key
    F3
    The F3 key.
    static final Key
    F4
    The F4 key.
    static final Key
    F5
    The F5 key.
    static final Key
    F6
    The F6 key.
    static final Key
    F7
    The F7 key.
    static final Key
    F8
    The F8 key.
    static final Key
    F9
    The F9 key.
    static final Key
    FAVORITE_CLEAR0
    Clears the program or content stored in the first favorites list slot.
    static final Key
    FAVORITE_CLEAR1
    Clears the program or content stored in the second favorites list slot.
    static final Key
    FAVORITE_CLEAR2
    Clears the program or content stored in the third favorites list slot.
    static final Key
    FAVORITE_CLEAR3
    Clears the program or content stored in the fourth favorites list slot.
    static final Key
    FAVORITE_RECALL0
    Selects (recalls) the program or content stored in the first favorites list slot.
    static final Key
    FAVORITE_RECALL1
    Selects (recalls) the program or content stored in the second favorites list slot.
    static final Key
    FAVORITE_RECALL2
    Selects (recalls) the program or content stored in the third favorites list slot.
    static final Key
    FAVORITE_RECALL3
    Selects (recalls) the program or content stored in the fourth favorites list slot.
    static final Key
    FAVORITE_STORE0
    Stores the current program or content into the first favorites list slot.
    static final Key
    FAVORITE_STORE1
    Stores the current program or content into the second favorites list slot.
    static final Key
    FAVORITE_STORE2
    Stores the current program or content into the third favorites list slot.
    static final Key
    FAVORITE_STORE3
    Stores the current program or content into the fourth favorites list slot.
    static final Key
    FINAL_MODE
    The Final (Final Mode) key is used on some Asian keyboards to enter final mode when using IMEs.
    static final Key
    FIND
    The Find key.
    static final Key
    FINISH
    The Finish key.
    static final Key
    FN
    The Fn (Function modifier) key.
    static final Key
    FN_LOCK
    The FnLock or F-Lock (Function Lock) key.
    static final Key
    GO_BACK
    The Back button.
    static final Key
    GO_HOME
    The Home button, which takes the user to the phone's main screen (usually an application launcher).
    static final Key
    GROUP_FIRST
    Switches to the first character group on an ISO/IEC 9995 keyboard.
    static final Key
    GROUP_LAST
    Switches to the last character group on an ISO/IEC 9995 keyboard.
    static final Key
    GROUP_NEXT
    Switches to the next character group on an ISO/IEC 9995 keyboard.
    static final Key
    GROUP_PREVIOUS
    Switches to the previous character group on an ISO/IEC 9995 keyboard.
    static final Key
    GUIDE
    Toggles the display of the program or content guide.
    static final Key
    GUIDE_NEXT_DAY
    If the guide is currently displayed, this button tells the guide to display the next day's content.
    static final Key
    GUIDE_PREVIOUS_DAY
    If the guide is currently displayed, this button tells the guide to display the previous day's content.
    static final Key
    HANGUL_MODE
    The Hangul (Korean character set) mode key, which toggles between Hangul and English entry modes.
    static final Key
    HANJA_MODE
    Selects the Hanja mode, for converting Hangul characters to the more specific Hanja characters.
    static final Key
    HANKAKU
    The Hankaku (half-width characters) key.
    static final Key
    HEADSET_HOOK
    The Headset Hook key.
    static final Key
    HELP
    The Help key.
    static final Key
    HIBERNATE
    The Hibernate key.
    static final Key
    HIRAGANA
    The Hiragana key.
    static final Key
    HIRAGANA_KATAKANA
    Toggles between the Hiragana and Katakana writing systems.
    static final Key
    HOME
    The Home or ↖ key.
    static final Key
    HYPER
    The Hyper key.
    static final Key
    INFO
    Toggles the display of information about the currently selected content, program, or media.
    static final Key
    INSERT
    The Insert key, Ins.
    static final Key
    INSTANT_REPLAY
    Tells the device to perform an instant replay (typically some form of jumping back a short amount of time then playing it again, possibly but not usually in slow motion).
    static final Key
    INTL_BACKSLASH
    Located between the left Shift and Z keys.Labelled \| on a UK keyboard.
    static final Key
    INTL_RO
    Located between the / and right Shift keys.Labelled \ろ ( ro ) on a Japanese keyboard.
    static final Key
    INTL_YEN
    Located between the = and Backspace keys.Labelled ¥ ( yen ) on a Japanese keyboard.
    static final Key
    JUNJA_MODE
    Selects the Junja mode, in which Korean is represented using single-byte Latin characters.
    static final Key
    KANA_MODE
    The Kana Mode (Kana Lock) key.
    static final Key
    KANJI_MODE
    The Kanji Mode key.
    static final Key
    KATAKANA
    The Katakana key.
    static final Key
    KEY_A
    a on a US keyboard.Labelled q on an AZERTY (e.g., French) keyboard.
    static final Key
    KEY_B
    b on a US keyboard.
    static final Key
    KEY_C
    c on a US keyboard.
    static final Key
    KEY_D
    d on a US keyboard.
    static final Key
    KEY_E
    e on a US keyboard.
    static final Key
    KEY_F
    f on a US keyboard.
    static final Key
    KEY_G
    g on a US keyboard.
    static final Key
    KEY_H
    h on a US keyboard.
    static final Key
    KEY_I
    i on a US keyboard.
    static final Key
    KEY_J
    j on a US keyboard.
    static final Key
    KEY_K
    k on a US keyboard.
    static final Key
    KEY_L
    l on a US keyboard.
    static final Key
    KEY_M
    m on a US keyboard.
    static final Key
    KEY_N
    n on a US keyboard.
    static final Key
    KEY_O
    o on a US keyboard.
    static final Key
    KEY_P
    p on a US keyboard.
    static final Key
    KEY_Q
    q on a US keyboard.Labelled a on an AZERTY (e.g., French) keyboard.
    static final Key
    KEY_R
    r on a US keyboard.
    static final Key
    KEY_S
    s on a US keyboard.
    static final Key
    KEY_T
    t on a US keyboard.
    static final Key
    KEY_U
    u on a US keyboard.
    static final Key
    KEY_V
    v on a US keyboard.
    static final Key
    KEY_W
    w on a US keyboard.Labelled z on an AZERTY (e.g., French) keyboard.
    static final Key
    KEY_X
    x on a US keyboard.
    static final Key
    KEY_Y
    y on a US keyboard.Labelled z on a QWERTZ (e.g., German) keyboard.
    static final Key
    KEY_Z
    z on a US keyboard.Labelled w on an AZERTY (e.g., French) keyboard, and y on a QWERTZ (e.g., German) keyboard.
    static final Key
    KEY11
    The 11 key found on certain media numeric keypads.
    static final Key
    KEY12
    The 12 key found on certain media numeric keypads.
    static final Key
    LANG_1
    Korean: HangulMode 한/영 ( han/yeong ) Japanese (Mac keyboard): かな ( kana )
    static final Key
    LANG_2
    Korean: Hanja 한자 ( hanja ) Japanese (Mac keyboard): 英数 ( eisu )
    static final Key
    LANG_3
    Japanese (word-processing keyboard): Katakana
    static final Key
    LANG_4
    Japanese (word-processing keyboard): Hiragana
    static final Key
    LANG_5
    Japanese (word-processing keyboard): Zenkaku/Hankaku
    static final Key
    LAST_NUMBER_REDIAL
    The Redial button, which redials the last-called number.
    static final Key
    LAUNCH_APP_1
    Sometimes labelled My Computer on the keyboard
    static final Key
    LAUNCH_APP_2
    Sometimes labelled Calculator on the keyboard
    static final Key
    LAUNCH_APPLICATION1
    The first generic application launcher button.
    static final Key
    LAUNCH_APPLICATION10
    The 10th generic application launcher button.
    static final Key
    LAUNCH_APPLICATION11
    The 11th generic application launcher button.
    static final Key
    LAUNCH_APPLICATION12
    The 12th generic application launcher button.
    static final Key
    LAUNCH_APPLICATION13
    The 13th generic application launcher button.
    static final Key
    LAUNCH_APPLICATION14
    The 14th generic application launcher button.
    static final Key
    LAUNCH_APPLICATION15
    The 15th generic application launcher button.
    static final Key
    LAUNCH_APPLICATION16
    The 16th generic application launcher button.
    static final Key
    LAUNCH_APPLICATION2
    The second generic application launcher button.
    static final Key
    LAUNCH_APPLICATION3
    The third generic application launcher button.
    static final Key
    LAUNCH_APPLICATION4
    The fourth generic application launcher button.
    static final Key
    LAUNCH_APPLICATION5
    The fifth generic application launcher button.
    static final Key
    LAUNCH_APPLICATION6
    The sixth generic application launcher button.
    static final Key
    LAUNCH_APPLICATION7
    The seventh generic application launcher button.
    static final Key
    LAUNCH_APPLICATION8
    The eighth generic application launcher button.
    static final Key
    LAUNCH_APPLICATION9
    The ninth generic application launcher button.
    static final Key
    LAUNCH_CALCULATOR
    The Calculator key.
    static final Key
    LAUNCH_CALENDAR
    The Calendar key.
    static final Key
    LAUNCH_CONTACTS
    The Contacts key.
    static final Key
    LAUNCH_MAIL
    The Mail key.
    static final Key
    LAUNCH_MEDIA_PLAYER
    The Media Player key.
    static final Key
    LAUNCH_MUSIC_PLAYER
    The Music Player key.
    static final Key
    LAUNCH_MY_COMPUTER
    The My Computer key on Windows keyboards.
    static final Key
    LAUNCH_PHONE
    The Phone key, to open the phone dialer application if one is present.
    static final Key
    LAUNCH_SCREEN_SAVER
    The Screen Saver key.
    static final Key
    LAUNCH_SPREADSHEET
    The Spreadsheet key.
    static final Key
    LAUNCH_WEB_BROWSER
    The Web Browser key.
    static final Key
    LAUNCH_WEB_CAM
    The WebCam key.
    static final Key
    LAUNCH_WORD_PROCESSOR
    The Word Processor key.
    static final Key
    LINK
    Opens content linked to the current program, if available and possible.
    static final Key
    LIST_PROGRAM
    Lists the current program.
    static final Key
    LIVE_CONTENT
    Toggles a display listing currently available live content or programs.
    static final Key
    LOCK
    Locks or unlocks the currently selected content or program.
    static final Key
    LOG_OFF
    The LogOff key.
    static final Key
    MAIL_FORWARD
    Opens the user interface to forward a message.
    static final Key
    MAIL_REPLY
    Opens the user interface to reply to a message.
    static final Key
    MAIL_SEND
    Sends the current message.
    static final Key
    MANNER_MODE
    A button which cycles among the notification modes: silent, vibrate, ring, and so forth.
    static final Key
    MEDIA_APPS
    Presents a list of media applications, such as photo viewers, audio and video players, and games.
    static final Key
    MEDIA_AUDIO_TRACK
    The Audio Track key.
    static final Key
    MEDIA_FAST_FORWARD
    Starts, continues, or increases the speed of fast forwarding the media.
    static final Key
    MEDIA_LAST
    Jumps back to the last-viewed content, program, or other media.
    static final Key
    MEDIA_PAUSE
    Pauses the currently playing media.
    static final Key
    MEDIA_PLAY
    Starts or continues playing media at normal speed, if not already doing so.
    static final Key
    MEDIA_PLAY_PAUSE
    Toggles between playing and pausing the current media.
    static final Key
    MEDIA_RECORD
    Starts or resumes recording media.
    static final Key
    MEDIA_REWIND
    Starts, continues, or increases the speed of rewinding the media.
    static final Key
    MEDIA_SELECT
    This value matches DOM's KeyboardEvent's event.code.
    static final Key
    MEDIA_SKIP_BACKWARD
    Skips backward to the previous content or program.
    static final Key
    MEDIA_SKIP_FORWARD
    Skips forward to the next content or program.
    static final Key
    MEDIA_STEP_BACKWARD
    Steps backward to the previous content or program.
    static final Key
    MEDIA_STEP_FORWARD
    Steps forward to the next content or program.
    static final Key
    MEDIA_STOP
    Stops the current media activity (such as playing, recording, pausing, forwarding, or rewinding).
    static final Key
    MEDIA_TOP_MENU
    Top Menu button; opens the media's main menu, such as on a DVD or Blu-Ray disc.
    static final Key
    MEDIA_TRACK_NEXT
    Seeks to the next media or program track.
    static final Key
    MEDIA_TRACK_PREVIOUS
    Seeks to the previous media or program track.
    static final Key
    META
    The Meta key.
    static final Key
    META_LEFT
    The Windows, ⌘ , Command or other OS symbol key.
    static final Key
    META_RIGHT
    The Windows, ⌘ , Command or other OS symbol key.
    static final Key
    MICROPHONE_TOGGLE
    Toggles the microphone on and off.
    static final Key
    MICROPHONE_VOLUME_DOWN
    Decreases the microphone's input volume.
    static final Key
    MICROPHONE_VOLUME_MUTE
    Mutes the microphone input.
    static final Key
    MICROPHONE_VOLUME_UP
    Increases the microphone's input volume.
    static final Key
    MINUS
    -_ on a US keyboard.
    static final Key
    MODE_CHANGE
    The Mode Change key.
    static final Key
    MULTIPLY
    The numeric keypad's multiplication key, *.
    static final Key
    NAVIGATE_IN
    Navigates into a submenu or option.
    static final Key
    NAVIGATE_NEXT
    Navigates to the next item.
    static final Key
    NAVIGATE_OUT
    Navigates out of the current screen or menu.
    static final Key
    NAVIGATE_PREVIOUS
    Navigates to the previous item.
    static final Key
    NEW
    Creates a new document or message.
    static final Key
    NEXT_CANDIDATE
    The Next Candidate function key.
    static final Key
    NEXT_FAVORITE_CHANNEL
    Cycles to the next channel in the favorites list.
    static final Key
    NEXT_USER_PROFILE
    Cycles to the next saved user profile, if this feature is supported and multiple profiles exist.
    static final Key
    NON_CONVERT
    The NonConvert ("Don't convert") key.
    static final Key
    NONE
    This value is reserved for corner cases of no key value present in event e.g.
    static final Key
    NOTIFICATION
    The Notification key.
    static final Key
    NUM_LOCK
    The NumLock (Number Lock) key.
    static final Key
    NUMPAD_0
    0 Ins on a keyboard 0 on a phone or remote control
    static final Key
    NUMPAD_1
    1 End on a keyboard 1 or 1 QZ on a phone orremote control
    static final Key
    NUMPAD_2
    2 ↓ on a keyboard 2 ABC on a phone or remote control
    static final Key
    NUMPAD_3
    3 PgDn on a keyboard 3 DEF on a phone or remote control
    static final Key
    NUMPAD_4
    4 ← on a keyboard 4 GHI on a phone or remote control
    static final Key
    NUMPAD_5
    5 on a keyboard 5 JKL on a phone or remote control
    static final Key
    NUMPAD_6
    6 → on a keyboard 6 MNO on a phone or remote control
    static final Key
    NUMPAD_7
    7 Home on a keyboard 7 PQRS or 7 PRS on a phoneor remote control
    static final Key
    NUMPAD_8
    8 ↑ on a keyboard 8 TUV on a phone or remote control
    static final Key
    NUMPAD_9
    9 PgUp on a keyboard 9 WXYZ or 9 WXY on a phoneor remote control
    static final Key
    NUMPAD_ADD
    +
    static final Key
    NUMPAD_BACKSPACE
    Found on the Microsoft Natural Keyboard.
    static final Key
    NUMPAD_CLEAR
    C or AC (All Clear).
    static final Key
    NUMPAD_CLEAR_ENTRY
    CE (Clear Entry)
    static final Key
    NUMPAD_COMMA
    , (thousands separator).
    static final Key
    NUMPAD_DECIMAL
    .
    static final Key
    NUMPAD_DIVIDE
    /
    static final Key
    NUMPAD_ENTER
    This value matches DOM's KeyboardEvent's event.code.
    static final Key
    NUMPAD_EQUAL
    =
    static final Key
    NUMPAD_HASH
    # on a phone or remote control device.
    static final Key
    NUMPAD_MEMORY_ADD
    M+ Add current entry to the value stored in memory.
    static final Key
    NUMPAD_MEMORY_CLEAR
    MC Clear the value stored in memory.
    static final Key
    NUMPAD_MEMORY_RECALL
    MR Replace the current entry with the value stored in memory.
    static final Key
    NUMPAD_MEMORY_STORE
    MS Replace the value stored in memory with the current entry.
    static final Key
    NUMPAD_MEMORY_SUBTRACT
    M- Subtract current entry from the value stored in memory.
    static final Key
    NUMPAD_MULTIPLY
    * on a keyboard.
    static final Key
    NUMPAD_PAREN_LEFT
    ( Found on the Microsoft Natural Keyboard.
    static final Key
    NUMPAD_PAREN_RIGHT
    ) Found on the Microsoft Natural Keyboard.
    static final Key
    NUMPAD_STAR
    * on a phone or remote control device.This key is typically found below the 7 key and to the left of the 0 key.
    static final Key
    NUMPAD_SUBTRACT
    -
    static final Key
    ON_DEMAND
    Opens the user interface for selecting on demand content or programs to watch.
    static final Key
    OPEN
    Opens an existing document or message.
    static final Key
    PAGE_DOWN
    The Page Down (or PgDn) key.
    static final Key
    PAGE_UP
    The Page Up (or PgUp) key.
    static final Key
    PAIRING
    Starts the process of pairing the remote with a device to be controlled.
    static final Key
    PASTE
    Paste from the clipboard.
    static final Key
    PAUSE
    The Pause key.
    static final Key
    PERIOD
    .> on a US keyboard.
    static final Key
    PINP_DOWN
    A button to move the picture-in-picture view downward.
    static final Key
    PINP_MOVE
    A button to control moving the picture-in-picture view.
    static final Key
    PINP_TOGGLE
    Toggles display of the picture-in-picture view on and off.
    static final Key
    PINP_UP
    A button to move the picture-in-picture view upward.
    static final Key
    PLAY
    The Play key.
    static final Key
    PLAY_SPEED_DOWN
    Decreases the media playback rate.
    static final Key
    PLAY_SPEED_RESET
    Returns the media playback rate to normal.
    static final Key
    PLAY_SPEED_UP
    Increases the media playback rate.
    static final Key
    POWER
    The Power button or key, to toggle power on and off.
    static final Key
    POWER_OFF
    The PowerOff or PowerDown key.
    static final Key
    PREVIOUS_CANDIDATE
    The Previous Candidate key.
    static final Key
    PRINT
    Prints the current document or message.
    static final Key
    PRINT_SCREEN
    The PrintScreen or PrtScr key.
    static final Key
    PROCESS
    The Process key.
    static final Key
    PROPS
    The Props (Properties) key.
    static final Key
    QUOTE
    '" on a US keyboard.
    static final Key
    RANDOM_TOGGLE
    Toggles random media (also known as "shuffle mode") on and off.
    static final Key
    RC_LOW_BATTERY
    A code sent when the remote control's battery is low.
    static final Key
    RECORD_SPEED_NEXT
    Cycles among the available media recording speeds.
    static final Key
    REDO
    Redo the last action.
    static final Key
    RESUME
    This value matches DOM's KeyboardEvent's event.code.
    static final Key
    RF_BYPASS
    Toggles radio frequency (RF) input bypass mode on and off.
    static final Key
    ROMAJI
    The Romaji key; selects the Roman character set.
    static final Key
    SAVE
    Saves the current document or message.
    static final Key
    SCAN_CHANNELS_TOGGLE
    Toggles the channel scan mode on and off; this is a mode which flips through channels automatically until the user stops the scan.
    static final Key
    SCREEN_MODE_NEXT
    Cycles through the available screen display modes.
    static final Key
    SCROLL_LOCK
    The Scroll Lock key.
    static final Key
    SELECT
    The Select key.
    static final Key
    SEMICOLON
    ;: on a US keyboard.
    static final Key
    SEPARATOR
    The numeric keypad's places separator character (in the United States, this is a comma, but elsewhere it is frequently a period).
    static final Key
    SETTINGS
    Toggles display of the device's settings screen on and off.
    static final Key
    SHIFT
    The Shift key.
    static final Key
    SHIFT_LEFT
    Shift or ⇧
    static final Key
    SHIFT_RIGHT
    Shift or ⇧
    static final Key
    SINGLE_CANDIDATE
    The Single Candidate key.
    static final Key
    SLASH
    /? on a US keyboard.
    static final Key
    SLEEP
    This value matches DOM's KeyboardEvent's event.code.
    static final Key
    SOFT1
    The first general-purpose virtual function key.
    static final Key
    SOFT2
    The second general-purpose virtual function key.
    static final Key
    SOFT3
    The third general-purpose virtual function key.
    static final Key
    SOFT4
    The fourth general-purpose virtual function key.
    static final Key
    SPACE
    The space key, Space Bar.
    static final Key
    SPEECH_CORRECTION_LIST
    Presents a list of possible corrections for a word which was incorrectly identified.
    static final Key
    SPEECH_INPUT_TOGGLE
    Toggles between dictation mode and command/control mode.
    static final Key
    SPELL_CHECK
    Starts spell checking the current document.
    static final Key
    SPLIT_SCREEN_TOGGLE
    Toggles split screen display mode on and off.
    static final Key
    STANDBY
    The Standby key; also known as Suspend or Sleep.
    static final Key
    STB_INPUT
    Cycles among input modes on an external set-top box (STB).
    static final Key
    STB_POWER
    Toggles on and off an external STB.
    static final Key
    SUBTITLE
    Toggles the display of subtitles on and off if they're available.
    static final Key
    SUBTRACT
    The numeric keypad's subtraction key, -.
    static final Key
    SUPER
    The Super key.
    static final Key
    SUSPEND
    This value matches DOM's KeyboardEvent's event.code.
    static final Key
    SYMBOL
    The Symbol modifier key (found on certain virtual keyboards).
    static final Key
    SYMBOL_LOCK
    The Symbol Lock key.
    static final Key
    TAB
    Tab or ⇥
    static final Key
    TELETEXT
    Toggles display of teletext, if available.
    static final Key
    TURBO
    This value matches DOM's KeyboardEvent's event.code.
    static final Key
    TV
    Switches into TV viewing mode.
    static final Key
    TV_3D_MODE
    Toggles 3D TV mode on and off.
    static final Key
    TV_ANTENNA_CABLE
    Toggles between antenna and cable inputs.
    static final Key
    TV_AUDIO_DESCRIPTION
    Toggles audio description mode on and off.
    static final Key
    TV_AUDIO_DESCRIPTION_MIX_DOWN
    Decreases the audio description's mixing volume; reduces the volume of the audio descriptions relative to the program sound.
    static final Key
    TV_AUDIO_DESCRIPTION_MIX_UP
    Increases the audio description's mixing volume; increases the volume of the audio descriptions relative to the program sound.
    static final Key
    TV_CONTENTS_MENU
    Displays or hides the media contents available for playback (this may be a channel guide showing the currently airing programs, or a list of media files to play).
    static final Key
    TV_DATA_SERVICE
    Displays or hides the TV's data service menu.
    static final Key
    TV_INPUT
    Cycles the input mode on an external TV.
    static final Key
    TV_INPUT_COMPONENT1
    Switches to the input "Component 1."
    static final Key
    TV_INPUT_COMPONENT2
    Switches to the input "Component 2."
    static final Key
    TV_INPUT_COMPOSITE1
    Switches to the input "Composite 1."
    static final Key
    TV_INPUT_COMPOSITE2
    Switches to the input "Composite 2."
    static final Key
    TV_INPUT_HDMI1
    Switches to the input "HDMI 1."
    static final Key
    TV_INPUT_HDMI2
    Switches to the input "HDMI 2."
    static final Key
    TV_INPUT_HDMI3
    Switches to the input "HDMI 3."
    static final Key
    TV_INPUT_HDMI4
    Switches to the input "HDMI 4."
    static final Key
    TV_INPUT_VGA1
    Switches to the input "VGA 1."
    static final Key
    TV_MEDIA_CONTEXT
    The Media Context menu key.
    static final Key
    TV_NETWORK
    Toggle the TV's network connection on and off.
    static final Key
    TV_NUMBER_ENTRY
    Put the TV into number entry mode.
    static final Key
    TV_POWER
    The device's power button.
    static final Key
    TV_RADIO_SERVICE
    Radio button.
    static final Key
    TV_SATELLITE
    Satellite button.
    static final Key
    TV_SATELLITE_BS
    Broadcast Satellite button.
    static final Key
    TV_SATELLITE_CS
    Communication Satellite button.
    static final Key
    TV_SATELLITE_TOGGLE
    Toggles among available satellites.
    static final Key
    TV_TERRESTRIAL_ANALOG
    Selects analog terrestrial television service (analog cable or antenna reception).
    static final Key
    TV_TERRESTRIAL_DIGITAL
    Selects digital terrestrial television service (digital cable or antenna reception).
    static final Key
    TV_TIMER
    Timer programming button.
    static final Key
    UNDO
    Undo the last action.
    static final Key
    UNIDENTIFIED
    The user agent wasn't able to map the event's virtual keycode to a specific key value.
    static final Key
    VIDEO_MODE_NEXT
    Cycles through the available video modes.
    static final Key
    VOICE_DIAL
    The Voice Dial key.
    static final Key
    WAKE_UP
    The WakeUp key; used to wake the computer from the hibernation or standby modes.
    static final Key
    WINK
    Causes the device to identify itself in some fashion, such as by flashing a light, briefly changing the brightness of indicator lights, or emitting a tone.
    static final Key
    ZENKAKU
    The Zenkaku (full width) characters key.
    static final Key
    ZENKAKU_HANAKU
    The Zenkaku/Hankaku (full width/half width) toggle key.
    static final Key
    ZOOM_IN
    The ZoomIn key.
    static final Key
    ZOOM_OUT
    The ZoomOut key.
    static final Key
    ZOOM_TOGGLE
    Toggles between full-screen and scaled content display, or otherwise change the magnification level.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getKeys()
    Returns the list (with at least one element) of printable representations of the key, which should reflect the key property in the JavaScript KeyboardEvent.
    static boolean
    isModifier(Key key)
    Returns whether the specified key is a modifier or not.
    default boolean
    matches(String key)
    Checks if key is a printable representation for this instance.
    static Key
    of(String key, String... additionalKeys)
    Returns a Key instance for a printable representation of the key.

  • Field Details

    • UNIDENTIFIED

      static final Key UNIDENTIFIED
      The user agent wasn't able to map the event's virtual keycode to a specific key value. This can happen due to hardware or software constraints, or because of constraints around the platform on which the user agent is running.

      In the case of event.code values, this value code should be used when no other value given in this specification is appropriate.

      This value matches DOM's KeyboardEvent's event.code.

    • ALT

      static final Key ALT
      The Alt (Alternative) key.

      The second value matches DOM's KeyboardEvent's event.code.

      See Also:

    • ALT_GRAPH

      static final Key ALT_GRAPH
      The AltGr or AltGraph (Alternate Graphics) key. Enables the ISO Level 3 shift modifier (where Shift is the level 2 modifier).

      The second value matches DOM's KeyboardEvent's event.code.

      See Also:

    • CAPS_LOCK

      static final Key CAPS_LOCK
      The CapsLock or ⇪ key. Toggles the capital character lock on and off for subsequent input.

      This value matches DOM's KeyboardEvent's event.code.

    • CONTROL

      static final Key CONTROL
      The Control, Ctrl, or Ctl key. Allows typing control characters.

      The second and third values match DOM's KeyboardEvent's event.code.

      See Also:

    • FN

      static final Key FN
      The Fn (Function modifier) key. Used to allow generating function key (F1-F15, for instance) characters on keyboards without a dedicated function key area. Often handled in hardware so that events aren't generated for this key.

      This value matches DOM's KeyboardEvent's event.code.

    • FN_LOCK

      static final Key FN_LOCK
      The FnLock or F-Lock (Function Lock) key. Toggles the function key mode described by "Fn" on and off. Often handled in hardware so that events aren't generated for this key. Found on the Microsoft Natural Keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • HYPER

      static final Key HYPER
      The Hyper key.

      This value matches DOM's KeyboardEvent's event.code.

    • META

      static final Key META
      The Meta key. Allows issuing special command inputs. This is the Windows logo key, or the Command or ⌘ key on Mac keyboards.

    • NUM_LOCK

      static final Key NUM_LOCK
      The NumLock (Number Lock) key. Toggles the numeric keypad between number entry some other mode (often directional arrows).

      On the Mac, the " NumLock " code should be used for the numpad Clear key.

      This value matches DOM's KeyboardEvent's event.code.

    • SCROLL_LOCK

      static final Key SCROLL_LOCK
      The Scroll Lock key. Toggles between scrolling and cursor movement modes.

      This value matches DOM's KeyboardEvent's event.code.

    • SHIFT

      static final Key SHIFT
      The Shift key. Modifies keystrokes to allow typing upper (or other) case letters, and to support typing punctuation and other special characters.

      The second and third values match DOM's KeyboardEvent's event.code.

      See Also:

    • SUPER

      static final Key SUPER
      The Super key.

      This value matches DOM's KeyboardEvent's event.code.

    • SYMBOL

      static final Key SYMBOL
      The Symbol modifier key (found on certain virtual keyboards).

    • SYMBOL_LOCK

      static final Key SYMBOL_LOCK
      The Symbol Lock key.

    • ENTER

      static final Key ENTER
      The Enter or ↵ key. Labelled Return on Apple keyboards.

      This value matches DOM's KeyboardEvent's event.code.

    • TAB

      static final Key TAB
      Tab or ⇥

      This value matches DOM's KeyboardEvent's event.code.

    • SPACE

      static final Key SPACE
      The space key, Space Bar.

      The second value matches DOM's KeyboardEvent's event.code.

    • ARROW_DOWN

      static final Key ARROW_DOWN
      The down arrow key (↓).

      This value matches DOM's KeyboardEvent's event.code.

    • ARROW_LEFT

      static final Key ARROW_LEFT
      The left arrow key (←).

      This value matches DOM's KeyboardEvent's event.code.

    • ARROW_RIGHT

      static final Key ARROW_RIGHT
      The right arrow key (→).

      This value matches DOM's KeyboardEvent's event.code.

    • ARROW_UP

      static final Key ARROW_UP
      The up arrow key (↑).

      This value matches DOM's KeyboardEvent's event.code.

    • END

      static final Key END
      The End key. Moves to the end of content.

      In case of a event.code in the case of event.key the name may be Page Down , End or ↘.

      This value matches DOM's KeyboardEvent's event.code.

    • HOME

      static final Key HOME
      The Home or ↖ key. Moves to the start of content.

      This value matches DOM's KeyboardEvent's event.code.

    • PAGE_DOWN

      static final Key PAGE_DOWN
      The Page Down (or PgDn) key. Scrolls down or displays the next page of content.

      This value matches DOM's KeyboardEvent's event.code.

    • PAGE_UP

      static final Key PAGE_UP
      The Page Up (or PgUp) key. Scrolls up or displays the previous page of content.

      This value matches DOM's KeyboardEvent's event.code.

    • BACKSPACE

      static final Key BACKSPACE
      Backspace or ⌫. Labelled Delete on Apple keyboards.

      This value matches DOM's KeyboardEvent's event.code.

    • CLEAR

      static final Key CLEAR
      The Clear key. Removes the currently selected input.

    • COPY

      static final Key COPY
      The Copy key (on certain extended keyboards).

      This value matches DOM's KeyboardEvent's event.code.

    • CR_SEL

      static final Key CR_SEL
      The Cursor Select key, CrSel.

    • CUT

      static final Key CUT
      The Cut key (on certain extended keyboards).

      This value matches DOM's KeyboardEvent's event.code.

    • DELETE

      static final Key DELETE
      The Delete key, Del, and ⌦ . The forward delete key. Note that on Apple keyboards, the key labelled Delete on the main part of the keyboard should be encoded as " Backspace " .

      This first value matches DOM's KeyboardEvent's event.code.

    • ERASE_EOF

      static final Key ERASE_EOF
      Erase to End of Field. Deletes all characters from the current cursor position to the end of the current field.

    • EX_SEL

      static final Key EX_SEL
      The ExSel (Extend Selection) key.

    • INSERT

      static final Key INSERT
      The Insert key, Ins. Toggles  between inserting and overwriting text. Not present on Apple keyboards.

      This value matches DOM's KeyboardEvent's event.code.

    • PASTE

      static final Key PASTE
      Paste from the clipboard.

      This value matches DOM's KeyboardEvent's event.code.

    • REDO

      static final Key REDO
      Redo the last action.

    • UNDO

      static final Key UNDO
      Undo the last action.

      This value matches DOM's KeyboardEvent's event.code.

    • ACCEPT

      static final Key ACCEPT
      The Accept, Commit, or OK key or button. Accepts the currently selected option or input method sequence conversion.

    • AGAIN

      static final Key AGAIN
      The Again key. Redoes or repeats a previous action. Found on Sun’s USB keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • ATTN

      static final Key ATTN
      The Attn (Attention) key.

    • CANCEL

      static final Key CANCEL
      The Cancel key.

    • CONTEXT_MENU

      static final Key CONTEXT_MENU
      Shows the context menu. Typically found between the Windows (or OS) key and the Control key on the right side of the keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • ESCAPE

      static final Key ESCAPE
      The Esc (Escape) or ⎋ key. Typically used as an exit, cancel, or "escape this operation" button. Historically, the Escape character was used to signal the start of a special control sequence of characters called an "escape sequence."

      The first value matches DOM's KeyboardEvent's event.code.

    • EXECUTE

      static final Key EXECUTE
      The Execute key.

    • FIND

      static final Key FIND
      The Find key. Opens an interface (typically a dialog box) for performing a find/search operation.

      This value matches DOM's KeyboardEvent's event.code.

    • FINISH

      static final Key FINISH
      The Finish key.

    • HELP

      static final Key HELP
      The Help key. Opens or toggles the display of help information. Not present on standard PC keyboards.

      This value matches DOM's KeyboardEvent's event.code.

    • PAUSE

      static final Key PAUSE
      The Pause key. Pauses the current application or state, if applicable. Note: This shouldn't be confused with the "MediaPause" key value, which is used for media controllers, rather than to control applications and processes.

      This value matches DOM's KeyboardEvent's event.code.

    • PLAY

      static final Key PLAY
      The Play key. Resumes a previously paused application, if applicable. Note: This shouldn't be confused with the "MediaPlay" key value, which is used for media controllers, rather than to control applications and processes.

    • PROPS

      static final Key PROPS
      The Props (Properties) key.

      This value matches DOM's KeyboardEvent's event.code.

    • SELECT

      static final Key SELECT
      The Select key.

      This value matches DOM's KeyboardEvent's event.code.

    • ZOOM_IN

      static final Key ZOOM_IN
      The ZoomIn key.

    • ZOOM_OUT

      static final Key ZOOM_OUT
      The ZoomOut key.

    • BRIGHTNESS_DOWN

      static final Key BRIGHTNESS_DOWN
      The Brightness Down key. Typically used to reduce the brightness of the display.

    • BRIGHTNESS_UP

      static final Key BRIGHTNESS_UP
      The Brightness Up key. Typically increases the brightness of the display.

    • EJECT

      static final Key EJECT
      The Eject or ⏏ key. Ejects removable media (or toggles an optical storage device tray open and closed).

      This value matches DOM's KeyboardEvent's event.code.

    • LOG_OFF

      static final Key LOG_OFF
      The LogOff key.

    • POWER

      static final Key POWER
      The Power button or key, to toggle power on and off.

      Note: Not all systems pass this key through to the user agent.

      This value matches DOM's KeyboardEvent's event.code.

    • POWER_OFF

      static final Key POWER_OFF
      The PowerOff or PowerDown key. Shuts off the system.

    • HIBERNATE

      static final Key HIBERNATE
      The Hibernate key. This saves the state of the computer to disk and then shuts down; the computer can be returned to its previous state by restoring the saved state information.

    • STANDBY

      static final Key STANDBY
      The Standby key; also known as Suspend or Sleep. This turns off the display and puts the computer in a low power consumption mode, without completely powering off.

    • WAKE_UP

      static final Key WAKE_UP
      The WakeUp key; used to wake the computer from the hibernation or standby modes.

      This value matches DOM's KeyboardEvent's event.code.

    • ALL_CANDIDATES

      static final Key ALL_CANDIDATES
      The All Candidates key, which starts multi-candidate mode, in which multiple candidates are displayed for the ongoing input.

    • ALPHANUMERIC

      static final Key ALPHANUMERIC
      The Alphanumeric key.

    • CODE_INPUT

      static final Key CODE_INPUT
      The Code Input key, which enables code input mode, which lets the user enter characters by typing their code points (their Unicode character numbers, typically).

    • COMPOSE

      static final Key COMPOSE
      The Compose key.

    • CONVERT

      static final Key CONVERT
      The Convert key, which instructs the IME to convert the current input method sequence into the resulting character.

      Japanese: 変換 ( henkan )

      This value matches DOM's KeyboardEvent's event.code.

    • DEAD

      static final Key DEAD
      A dead "combining" key; that is, a key which is used in tandem with other keys to generate accented and other modified characters.

    • FINAL_MODE

      static final Key FINAL_MODE
      The Final (Final Mode) key is used on some Asian keyboards to enter final mode when using IMEs.

    • GROUP_FIRST

      static final Key GROUP_FIRST
      Switches to the first character group on an ISO/IEC 9995 keyboard. Each key may have multiple groups of characters, each in its own column. Pressing this key instructs the device to interpret keypresses as coming from the first column on subsequent keystrokes.

    • GROUP_LAST

      static final Key GROUP_LAST
      Switches to the last character group on an ISO/IEC 9995 keyboard.

    • GROUP_NEXT

      static final Key GROUP_NEXT
      Switches to the next character group on an ISO/IEC 9995 keyboard.

    • GROUP_PREVIOUS

      static final Key GROUP_PREVIOUS
      Switches to the previous character group on an ISO/IEC 9995 keyboard.

    • MODE_CHANGE

      static final Key MODE_CHANGE
      The Mode Change key. Toggles or cycles among input modes of IMEs.

    • NEXT_CANDIDATE

      static final Key NEXT_CANDIDATE
      The Next Candidate function key. Selects the next possible match for the ongoing input.

    • NON_CONVERT

      static final Key NON_CONVERT
      The NonConvert ("Don't convert") key. This accepts the current input method sequence without running conversion when using an IME.

      Japanese: 無変換 ( muhenkan )

      This value matches DOM's KeyboardEvent's event.code.

    • PREVIOUS_CANDIDATE

      static final Key PREVIOUS_CANDIDATE
      The Previous Candidate key. Selects the previous possible match for the ongoing input.

    • PROCESS

      static final Key PROCESS
      The Process key. Instructs the IME to process the conversion.

    • SINGLE_CANDIDATE

      static final Key SINGLE_CANDIDATE
      The Single Candidate key. Enables single candidate mode (as opposed to multi-candidate mode); in this mode, only one candidate is displayed at a time.

    • HANGUL_MODE

      static final Key HANGUL_MODE
      The Hangul (Korean character set) mode key, which toggles between Hangul and English entry modes.

    • HANJA_MODE

      static final Key HANJA_MODE
      Selects the Hanja mode, for converting Hangul characters to the more specific Hanja characters.

    • JUNJA_MODE

      static final Key JUNJA_MODE
      Selects the Junja mode, in which Korean is represented using single-byte Latin characters.

    • EISU

      static final Key EISU
      The Eisu key. This key's purpose is defined by the IME, but may be used to close the IME.

    • HANKAKU

      static final Key HANKAKU
      The Hankaku (half-width characters) key.

    • HIRAGANA

      static final Key HIRAGANA
      The Hiragana key. Use for dedicated ひらがな key found on some Japanese word processing keyboards.

      This value matches DOM's KeyboardEvent's event.code.

    • HIRAGANA_KATAKANA

      static final Key HIRAGANA_KATAKANA
      Toggles between the Hiragana and Katakana writing systems.

    • KANA_MODE

      static final Key KANA_MODE
      The Kana Mode (Kana Lock) key.

      Japanese: カタカナ/ひらがな/ローマ字 ( katakana/hiragana/romaji )

      This value matches DOM's KeyboardEvent's event.code.

    • KANJI_MODE

      static final Key KANJI_MODE
      The Kanji Mode key. Enables entering Japanese text using the ideographic characters of Chinese origin.

    • KATAKANA

      static final Key KATAKANA
      The Katakana key. Use for dedicated カタカナ key found on some Japanese word processing keyboards.

      This value matches DOM's KeyboardEvent's event.code.

    • ROMAJI

      static final Key ROMAJI
      The Romaji key; selects the Roman character set.

    • ZENKAKU

      static final Key ZENKAKU
      The Zenkaku (full width) characters key.

    • ZENKAKU_HANAKU

      static final Key ZENKAKU_HANAKU
      The Zenkaku/Hankaku (full width/half width) toggle key.

    • F1

      static final Key F1
      The first general-purpose function key, F1.

      This value matches DOM's KeyboardEvent's event.code.

    • F2

      static final Key F2
      The F2 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F3

      static final Key F3
      The F3 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F4

      static final Key F4
      The F4 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F5

      static final Key F5
      The F5 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F6

      static final Key F6
      The F6 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F7

      static final Key F7
      The F7 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F8

      static final Key F8
      The F8 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F9

      static final Key F9
      The F9 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F10

      static final Key F10
      The F10 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F11

      static final Key F11
      The F11 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F12

      static final Key F12
      The F12 key.

      This value matches DOM's KeyboardEvent's event.code.

    • F13

      static final Key F13
      The F13 key.

    • F14

      static final Key F14
      The F14 key.

    • F15

      static final Key F15
      The F15 key.

    • F16

      static final Key F16
      The F16 key.

    • F17

      static final Key F17
      The F17 key.

    • F18

      static final Key F18
      The F18 key.

    • F19

      static final Key F19
      The F19 key.

    • F20

      static final Key F20
      The F20 key.

    • SOFT1

      static final Key SOFT1
      The first general-purpose virtual function key.

    • SOFT2

      static final Key SOFT2
      The second general-purpose virtual function key.

    • SOFT3

      static final Key SOFT3
      The third general-purpose virtual function key.

    • SOFT4

      static final Key SOFT4
      The fourth general-purpose virtual function key.

    • APP_SWITCH

      static final Key APP_SWITCH
      Presents a list of recently-used applications which lets the user change apps quickly.

    • CALL

      static final Key CALL
      The Call key; dials the number which has been entered.

    • CAMERA

      static final Key CAMERA
      The Camera key; activates the camera.

    • CAMERA_FOCUS

      static final Key CAMERA_FOCUS
      The Focus key; focuses the camera.

    • END_CALL

      static final Key END_CALL
      The End Call or Hang Up button.

    • GO_BACK

      static final Key GO_BACK
      The Back button.

    • GO_HOME

      static final Key GO_HOME
      The Home button, which takes the user to the phone's main screen (usually an application launcher).

    • HEADSET_HOOK

      static final Key HEADSET_HOOK
      The Headset Hook key. This is typically actually a button on the headset which is used to hang up calls and play or pause media.

    • LAST_NUMBER_REDIAL

      static final Key LAST_NUMBER_REDIAL
      The Redial button, which redials the last-called number.

    • NOTIFICATION

      static final Key NOTIFICATION
      The Notification key.

    • MANNER_MODE

      static final Key MANNER_MODE
      A button which cycles among the notification modes: silent, vibrate, ring, and so forth.

    • VOICE_DIAL

      static final Key VOICE_DIAL
      The Voice Dial key. Initiates voice dialing.

    • CHANNEL_DOWN

      static final Key CHANNEL_DOWN
      Switches to the previous channel.

    • CHANNEL_UP

      static final Key CHANNEL_UP
      Switches to the next channel.

    • MEDIA_FAST_FORWARD

      static final Key MEDIA_FAST_FORWARD
      Starts, continues, or increases the speed of fast forwarding the media.

    • MEDIA_PAUSE

      static final Key MEDIA_PAUSE
      Pauses the currently playing media. Some older applications use simply "Pause" but this is not correct.

    • MEDIA_PLAY

      static final Key MEDIA_PLAY
      Starts or continues playing media at normal speed, if not already doing so. Has no effect otherwise.

    • MEDIA_PLAY_PAUSE

      static final Key MEDIA_PLAY_PAUSE
      Toggles between playing and pausing the current media.

      This value matches DOM's KeyboardEvent's event.code.

    • MEDIA_RECORD

      static final Key MEDIA_RECORD
      Starts or resumes recording media.

    • MEDIA_REWIND

      static final Key MEDIA_REWIND
      Starts, continues, or increases the speed of rewinding the media.

    • MEDIA_STOP

      static final Key MEDIA_STOP
      Stops the current media activity (such as playing, recording, pausing, forwarding, or rewinding). Has no effect if the media is currently stopped already.

      This value matches DOM's KeyboardEvent's event.code.

    • MEDIA_TRACK_NEXT

      static final Key MEDIA_TRACK_NEXT
      Seeks to the next media or program track.

      This value matches DOM's KeyboardEvent's event.code.

    • MEDIA_TRACK_PREVIOUS

      static final Key MEDIA_TRACK_PREVIOUS
      Seeks to the previous media or program track.

      This value matches DOM's KeyboardEvent's event.code.

    • AUDIO_BALANCE_LEFT

      static final Key AUDIO_BALANCE_LEFT
      Adjusts audio balance toward the left.

    • AUDIO_BALANCE_RIGHT

      static final Key AUDIO_BALANCE_RIGHT
      Adjusts audio balance toward the right.

    • AUDIO_BASS_DOWN

      static final Key AUDIO_BASS_DOWN
      Decreases the amount of bass.

    • AUDIO_BASS_BOOST_DOWN

      static final Key AUDIO_BASS_BOOST_DOWN
      Reduces bass boosting or cycles downward through bass boost modes or states.

    • AUDIO_BASS_BOOST_TOGGLE

      static final Key AUDIO_BASS_BOOST_TOGGLE
      Toggles bass boosting on and off.

    • AUDIO_BASS_BOOST_UP

      static final Key AUDIO_BASS_BOOST_UP
      Increases the amount of bass boosting, or cycles upward through a set of bass boost modes or states.

    • AUDIO_BASS_UP

      static final Key AUDIO_BASS_UP
      Increases the amount of bass.

    • AUDIO_FADER_FRONT

      static final Key AUDIO_FADER_FRONT
      Adjusts the audio fader toward the front.

    • AUDIO_FADER_REAR

      static final Key AUDIO_FADER_REAR
      Adjusts the audio fader toward the rear.

    • AUDIO_SURROUND_MODE_NEXT

      static final Key AUDIO_SURROUND_MODE_NEXT
      Selects the next available surround sound mode.

    • AUDIO_TREBLE_DOWN

      static final Key AUDIO_TREBLE_DOWN
      Decreases the amount of treble.

    • AUDIO_TREBLE_UP

      static final Key AUDIO_TREBLE_UP
      Increases the amount of treble.

    • AUDIO_VOLUME_DOWN

      static final Key AUDIO_VOLUME_DOWN
      Decreases the audio volume.

      This value matches DOM's KeyboardEvent's event.code.

    • AUDIO_VOLUME_MUTE

      static final Key AUDIO_VOLUME_MUTE
      Mutes the audio.

      This value matches DOM's KeyboardEvent's event.code.

    • AUDIO_VOLUME_UP

      static final Key AUDIO_VOLUME_UP
      Increases the audio volume.

      This value matches DOM's KeyboardEvent's event.code.

    • MICROPHONE_TOGGLE

      static final Key MICROPHONE_TOGGLE
      Toggles the microphone on and off.

    • MICROPHONE_VOLUME_DOWN

      static final Key MICROPHONE_VOLUME_DOWN
      Decreases the microphone's input volume.

    • MICROPHONE_VOLUME_MUTE

      static final Key MICROPHONE_VOLUME_MUTE
      Mutes the microphone input.

    • MICROPHONE_VOLUME_UP

      static final Key MICROPHONE_VOLUME_UP
      Increases the microphone's input volume.

    • TV

      static final Key TV
      Switches into TV viewing mode.

    • TV_3D_MODE

      static final Key TV_3D_MODE
      Toggles 3D TV mode on and off.

    • TV_ANTENNA_CABLE

      static final Key TV_ANTENNA_CABLE
      Toggles between antenna and cable inputs.

    • TV_AUDIO_DESCRIPTION

      static final Key TV_AUDIO_DESCRIPTION
      Toggles audio description mode on and off.

    • TV_AUDIO_DESCRIPTION_MIX_DOWN

      static final Key TV_AUDIO_DESCRIPTION_MIX_DOWN
      Decreases the audio description's mixing volume; reduces the volume of the audio descriptions relative to the program sound.

    • TV_AUDIO_DESCRIPTION_MIX_UP

      static final Key TV_AUDIO_DESCRIPTION_MIX_UP
      Increases the audio description's mixing volume; increases the volume of the audio descriptions relative to the program sound.

    • TV_CONTENTS_MENU

      static final Key TV_CONTENTS_MENU
      Displays or hides the media contents available for playback (this may be a channel guide showing the currently airing programs, or a list of media files to play).

    • TV_DATA_SERVICE

      static final Key TV_DATA_SERVICE
      Displays or hides the TV's data service menu.

    • TV_INPUT

      static final Key TV_INPUT
      Cycles the input mode on an external TV.

    • TV_INPUT_COMPONENT1

      static final Key TV_INPUT_COMPONENT1
      Switches to the input "Component 1."

    • TV_INPUT_COMPONENT2

      static final Key TV_INPUT_COMPONENT2
      Switches to the input "Component 2."

    • TV_INPUT_COMPOSITE1

      static final Key TV_INPUT_COMPOSITE1
      Switches to the input "Composite 1."

    • TV_INPUT_COMPOSITE2

      static final Key TV_INPUT_COMPOSITE2
      Switches to the input "Composite 2."

    • TV_INPUT_HDMI1

      static final Key TV_INPUT_HDMI1
      Switches to the input "HDMI 1."

    • TV_INPUT_HDMI2

      static final Key TV_INPUT_HDMI2
      Switches to the input "HDMI 2."

    • TV_INPUT_HDMI3

      static final Key TV_INPUT_HDMI3
      Switches to the input "HDMI 3."

    • TV_INPUT_HDMI4

      static final Key TV_INPUT_HDMI4
      Switches to the input "HDMI 4."

    • TV_INPUT_VGA1

      static final Key TV_INPUT_VGA1
      Switches to the input "VGA 1."

    • TV_MEDIA_CONTEXT

      static final Key TV_MEDIA_CONTEXT
      The Media Context menu key.

    • TV_NETWORK

      static final Key TV_NETWORK
      Toggle the TV's network connection on and off.

    • TV_NUMBER_ENTRY

      static final Key TV_NUMBER_ENTRY
      Put the TV into number entry mode.

    • TV_POWER

      static final Key TV_POWER
      The device's power button.

    • TV_RADIO_SERVICE

      static final Key TV_RADIO_SERVICE
      Radio button.

    • TV_SATELLITE

      static final Key TV_SATELLITE
      Satellite button.

    • TV_SATELLITE_BS

      static final Key TV_SATELLITE_BS
      Broadcast Satellite button.

    • TV_SATELLITE_CS

      static final Key TV_SATELLITE_CS
      Communication Satellite button.

    • TV_SATELLITE_TOGGLE

      static final Key TV_SATELLITE_TOGGLE
      Toggles among available satellites.

    • TV_TERRESTRIAL_ANALOG

      static final Key TV_TERRESTRIAL_ANALOG
      Selects analog terrestrial television service (analog cable or antenna reception).

    • TV_TERRESTRIAL_DIGITAL

      static final Key TV_TERRESTRIAL_DIGITAL
      Selects digital terrestrial television service (digital cable or antenna reception).

    • TV_TIMER

      static final Key TV_TIMER
      Timer programming button.

    • AVR_INPUT

      static final Key AVR_INPUT
      Changes the input mode on an external audio/video receiver (AVR) unit.

    • AVR_POWER

      static final Key AVR_POWER
      Toggles the power on an external AVR unit.

    • COLOR_F0_RED

      static final Key COLOR_F0_RED
      General-purpose media function key, color-coded red; this has index 0 among the colored keys.

    • COLOR_F1_GREEN

      static final Key COLOR_F1_GREEN
      General-purpose media function key, color-coded green; this has index 1 among the colored keys.

    • COLOR_F2_YELLOW

      static final Key COLOR_F2_YELLOW
      General-purpose media function key, color-coded yellow; this has index 2 among the colored keys.

    • COLOR_F3_BLUE

      static final Key COLOR_F3_BLUE
      General-purpose media function key, color-coded blue; this has index 3 among the colored keys.

    • COLOR_F4_GREY

      static final Key COLOR_F4_GREY
      General-purpose media function key, color-coded grey; this has index 4 among the colored keys.

    • COLOR_F5_BROWN

      static final Key COLOR_F5_BROWN
      General-purpose media function key, color-coded brown; this has index 5 among the colored keys.

    • CLOSED_CAPTION_TOGGLE

      static final Key CLOSED_CAPTION_TOGGLE
      Toggles closed captioning on and off.

    • DIMMER

      static final Key DIMMER
      Adjusts the brightness of the device by toggling between two brightness levels or by cycling among multiple brightness levels.

    • DISPLAY_SWAP

      static final Key DISPLAY_SWAP
      Cycles among video sources.

    • DVR

      static final Key DVR
      Switches the input source to the Digital Video Recorder (DVR).

    • EXIT

      static final Key EXIT
      The Exit button, which exits the current application or menu.

    • FAVORITE_CLEAR0

      static final Key FAVORITE_CLEAR0
      Clears the program or content stored in the first favorites list slot.

    • FAVORITE_CLEAR1

      static final Key FAVORITE_CLEAR1
      Clears the program or content stored in the second favorites list slot.

    • FAVORITE_CLEAR2

      static final Key FAVORITE_CLEAR2
      Clears the program or content stored in the third favorites list slot.

    • FAVORITE_CLEAR3

      static final Key FAVORITE_CLEAR3
      Clears the program or content stored in the fourth favorites list slot.

    • FAVORITE_RECALL0

      static final Key FAVORITE_RECALL0
      Selects (recalls) the program or content stored in the first favorites list slot.

    • FAVORITE_RECALL1

      static final Key FAVORITE_RECALL1
      Selects (recalls) the program or content stored in the second favorites list slot.

    • FAVORITE_RECALL2

      static final Key FAVORITE_RECALL2
      Selects (recalls) the program or content stored in the third favorites list slot.

    • FAVORITE_RECALL3

      static final Key FAVORITE_RECALL3
      Selects (recalls) the program or content stored in the fourth favorites list slot.

    • FAVORITE_STORE0

      static final Key FAVORITE_STORE0
      Stores the current program or content into the first favorites list slot.

    • FAVORITE_STORE1

      static final Key FAVORITE_STORE1
      Stores the current program or content into the second favorites list slot.

    • FAVORITE_STORE2

      static final Key FAVORITE_STORE2
      Stores the current program or content into the third favorites list slot.

    • FAVORITE_STORE3

      static final Key FAVORITE_STORE3
      Stores the current program or content into the fourth favorites list slot.

    • GUIDE

      static final Key GUIDE
      Toggles the display of the program or content guide.

    • GUIDE_NEXT_DAY

      static final Key GUIDE_NEXT_DAY
      If the guide is currently displayed, this button tells the guide to display the next day's content.

    • GUIDE_PREVIOUS_DAY

      static final Key GUIDE_PREVIOUS_DAY
      If the guide is currently displayed, this button tells the guide to display the previous day's content.

    • INFO

      static final Key INFO
      Toggles the display of information about the currently selected content, program, or media.

    • INSTANT_REPLAY

      static final Key INSTANT_REPLAY
      Tells the device to perform an instant replay (typically some form of jumping back a short amount of time then playing it again, possibly but not usually in slow motion).

    • LIST_PROGRAM

      static final Key LIST_PROGRAM
      Lists the current program.

    • LIVE_CONTENT

      static final Key LIVE_CONTENT
      Toggles a display listing currently available live content or programs.

    • LOCK

      static final Key LOCK
      Locks or unlocks the currently selected content or program.

    • MEDIA_APPS

      static final Key MEDIA_APPS
      Presents a list of media applications, such as photo viewers, audio and video players, and games.

    • MEDIA_AUDIO_TRACK

      static final Key MEDIA_AUDIO_TRACK
      The Audio Track key.

    • MEDIA_LAST

      static final Key MEDIA_LAST
      Jumps back to the last-viewed content, program, or other media.

    • MEDIA_SKIP_BACKWARD

      static final Key MEDIA_SKIP_BACKWARD
      Skips backward to the previous content or program.

    • MEDIA_SKIP_FORWARD

      static final Key MEDIA_SKIP_FORWARD
      Skips forward to the next content or program.

    • MEDIA_STEP_BACKWARD

      static final Key MEDIA_STEP_BACKWARD
      Steps backward to the previous content or program.

    • MEDIA_STEP_FORWARD

      static final Key MEDIA_STEP_FORWARD
      Steps forward to the next content or program.

    • MEDIA_TOP_MENU

      static final Key MEDIA_TOP_MENU
      Top Menu button; opens the media's main menu, such as on a DVD or Blu-Ray disc.

    • NEXT_FAVORITE_CHANNEL

      static final Key NEXT_FAVORITE_CHANNEL
      Cycles to the next channel in the favorites list.

    • NEXT_USER_PROFILE

      static final Key NEXT_USER_PROFILE
      Cycles to the next saved user profile, if this feature is supported and multiple profiles exist.

    • ON_DEMAND

      static final Key ON_DEMAND
      Opens the user interface for selecting on demand content or programs to watch.

    • PAIRING

      static final Key PAIRING
      Starts the process of pairing the remote with a device to be controlled.

    • PINP_DOWN

      static final Key PINP_DOWN
      A button to move the picture-in-picture view downward.

    • PINP_MOVE

      static final Key PINP_MOVE
      A button to control moving the picture-in-picture view.

    • PINP_TOGGLE

      static final Key PINP_TOGGLE
      Toggles display of the picture-in-picture view on and off.

    • PINP_UP

      static final Key PINP_UP
      A button to move the picture-in-picture view upward.

    • PLAY_SPEED_DOWN

      static final Key PLAY_SPEED_DOWN
      Decreases the media playback rate.

    • PLAY_SPEED_RESET

      static final Key PLAY_SPEED_RESET
      Returns the media playback rate to normal.

    • PLAY_SPEED_UP

      static final Key PLAY_SPEED_UP
      Increases the media playback rate.

    • RANDOM_TOGGLE

      static final Key RANDOM_TOGGLE
      Toggles random media (also known as "shuffle mode") on and off.

    • RC_LOW_BATTERY

      static final Key RC_LOW_BATTERY
      A code sent when the remote control's battery is low. This doesn't actually correspond to a physical key at all.

    • RECORD_SPEED_NEXT

      static final Key RECORD_SPEED_NEXT
      Cycles among the available media recording speeds.

    • RF_BYPASS

      static final Key RF_BYPASS
      Toggles radio frequency (RF) input bypass mode on and off. RF bypass mode passes RF input directly to the RF output without any processing or filtering.

    • SCAN_CHANNELS_TOGGLE

      static final Key SCAN_CHANNELS_TOGGLE
      Toggles the channel scan mode on and off; this is a mode which flips through channels automatically until the user stops the scan.

    • SCREEN_MODE_NEXT

      static final Key SCREEN_MODE_NEXT
      Cycles through the available screen display modes.

    • SETTINGS

      static final Key SETTINGS
      Toggles display of the device's settings screen on and off.

    • SPLIT_SCREEN_TOGGLE

      static final Key SPLIT_SCREEN_TOGGLE
      Toggles split screen display mode on and off.

    • STB_INPUT

      static final Key STB_INPUT
      Cycles among input modes on an external set-top box (STB).

    • STB_POWER

      static final Key STB_POWER
      Toggles on and off an external STB.

    • SUBTITLE

      static final Key SUBTITLE
      Toggles the display of subtitles on and off if they're available.

    • TELETEXT

      static final Key TELETEXT
      Toggles display of teletext, if available.

    • VIDEO_MODE_NEXT

      static final Key VIDEO_MODE_NEXT
      Cycles through the available video modes.

    • WINK

      static final Key WINK
      Causes the device to identify itself in some fashion, such as by flashing a light, briefly changing the brightness of indicator lights, or emitting a tone.

    • ZOOM_TOGGLE

      static final Key ZOOM_TOGGLE
      Toggles between full-screen and scaled content display, or otherwise change the magnification level.

    • SPEECH_CORRECTION_LIST

      static final Key SPEECH_CORRECTION_LIST
      Presents a list of possible corrections for a word which was incorrectly identified.

    • SPEECH_INPUT_TOGGLE

      static final Key SPEECH_INPUT_TOGGLE
      Toggles between dictation mode and command/control mode. This lets the speech engine know whether to interpret spoken words as input text or as commands.

    • CLOSE

      static final Key CLOSE
      Closes the current document or message. Must not exit the application.

    • NEW

      static final Key NEW
      Creates a new document or message.

    • OPEN

      static final Key OPEN
      Opens an existing document or message.

      This value matches DOM's KeyboardEvent's event.code.

    • PRINT

      static final Key PRINT
      Prints the current document or message.

    • SAVE

      static final Key SAVE
      Saves the current document or message.

    • SPELL_CHECK

      static final Key SPELL_CHECK
      Starts spell checking the current document.

    • MAIL_FORWARD

      static final Key MAIL_FORWARD
      Opens the user interface to forward a message.

    • MAIL_REPLY

      static final Key MAIL_REPLY
      Opens the user interface to reply to a message.

    • MAIL_SEND

      static final Key MAIL_SEND
      Sends the current message.

    • LAUNCH_CALCULATOR

      static final Key LAUNCH_CALCULATOR
      The Calculator key. This is often used as a generic application launcher key (APPCOMMAND_LAUNCH_APP2).

    • LAUNCH_CALENDAR

      static final Key LAUNCH_CALENDAR
      The Calendar key.

    • LAUNCH_CONTACTS

      static final Key LAUNCH_CONTACTS
      The Contacts key.

    • LAUNCH_MAIL

      static final Key LAUNCH_MAIL
      The Mail key.

      This value matches DOM's KeyboardEvent's event.code.

    • LAUNCH_MEDIA_PLAYER

      static final Key LAUNCH_MEDIA_PLAYER
      The Media Player key.

    • LAUNCH_MUSIC_PLAYER

      static final Key LAUNCH_MUSIC_PLAYER
      The Music Player key.

    • LAUNCH_MY_COMPUTER

      static final Key LAUNCH_MY_COMPUTER
      The My Computer key on Windows keyboards. This is often used as a generic application launcher key (APPCOMMAND_LAUNCH_APP1).

    • LAUNCH_PHONE

      static final Key LAUNCH_PHONE
      The Phone key, to open the phone dialer application if one is present.

    • LAUNCH_SCREEN_SAVER

      static final Key LAUNCH_SCREEN_SAVER
      The Screen Saver key.

    • LAUNCH_SPREADSHEET

      static final Key LAUNCH_SPREADSHEET
      The Spreadsheet key.

    • LAUNCH_WEB_BROWSER

      static final Key LAUNCH_WEB_BROWSER
      The Web Browser key.

    • LAUNCH_WEB_CAM

      static final Key LAUNCH_WEB_CAM
      The WebCam key. Opens the webcam application.

    • LAUNCH_WORD_PROCESSOR

      static final Key LAUNCH_WORD_PROCESSOR
      The Word Processor key. This may be an icon of a specific word processor application, or a generic document icon.

    • LAUNCH_APPLICATION1

      static final Key LAUNCH_APPLICATION1
      The first generic application launcher button.

    • LAUNCH_APPLICATION2

      static final Key LAUNCH_APPLICATION2
      The second generic application launcher button.

    • LAUNCH_APPLICATION3

      static final Key LAUNCH_APPLICATION3
      The third generic application launcher button.

    • LAUNCH_APPLICATION4

      static final Key LAUNCH_APPLICATION4
      The fourth generic application launcher button.

    • LAUNCH_APPLICATION5

      static final Key LAUNCH_APPLICATION5
      The fifth generic application launcher button.

    • LAUNCH_APPLICATION6

      static final Key LAUNCH_APPLICATION6
      The sixth generic application launcher button.

    • LAUNCH_APPLICATION7

      static final Key LAUNCH_APPLICATION7
      The seventh generic application launcher button.

    • LAUNCH_APPLICATION8

      static final Key LAUNCH_APPLICATION8
      The eighth generic application launcher button.

    • LAUNCH_APPLICATION9

      static final Key LAUNCH_APPLICATION9
      The ninth generic application launcher button.

    • LAUNCH_APPLICATION10

      static final Key LAUNCH_APPLICATION10
      The 10th generic application launcher button.

    • LAUNCH_APPLICATION11

      static final Key LAUNCH_APPLICATION11
      The 11th generic application launcher button.

    • LAUNCH_APPLICATION12

      static final Key LAUNCH_APPLICATION12
      The 12th generic application launcher button.

    • LAUNCH_APPLICATION13

      static final Key LAUNCH_APPLICATION13
      The 13th generic application launcher button.

    • LAUNCH_APPLICATION14

      static final Key LAUNCH_APPLICATION14
      The 14th generic application launcher button.

    • LAUNCH_APPLICATION15

      static final Key LAUNCH_APPLICATION15
      The 15th generic application launcher button.

    • LAUNCH_APPLICATION16

      static final Key LAUNCH_APPLICATION16
      The 16th generic application launcher button.

    • BROWSER_BACK

      static final Key BROWSER_BACK
      Navigates to the previous content or page in the current Web view's history. Some laptops place this key to the left of the ↑ key.

      This value matches DOM's KeyboardEvent's event.code.

    • BROWSER_FAVORITES

      static final Key BROWSER_FAVORITES
      Opens the user's list of bookmarks/favorites.

      This value matches DOM's KeyboardEvent's event.code.

    • BROWSER_FORWARD

      static final Key BROWSER_FORWARD
      Navigates to the next content or page in the current Web view's history. Some laptops place this key to the right of the ↑ key.

      This value matches DOM's KeyboardEvent's event.code.

    • BROWSER_HOME

      static final Key BROWSER_HOME
      Navigates to the user's preferred home page.

      This value matches DOM's KeyboardEvent's event.code.

    • BROWSER_REFRESH

      static final Key BROWSER_REFRESH
      Refreshes the current page or content.

      This value matches DOM's KeyboardEvent's event.code.

    • BROWSER_STOP

      static final Key BROWSER_STOP
      Stops loading the currently displayed Web view or content.

      This value matches DOM's KeyboardEvent's event.code.

    • DECIMAL

      static final Key DECIMAL
      The decimal point key (typically . or ,) depending on the region.

    • KEY11

      static final Key KEY11
      The 11 key found on certain media numeric keypads.

    • KEY12

      static final Key KEY12
      The 12 key found on certain media numeric keypads.

    • MULTIPLY

      static final Key MULTIPLY
      The numeric keypad's multiplication key, *.

    • ADD

      static final Key ADD
      The numeric keypad's addition key, +.

    • DIVIDE

      static final Key DIVIDE
      The numeric keypad's division key, /.

    • SUBTRACT

      static final Key SUBTRACT
      The numeric keypad's subtraction key, -.

    • SEPARATOR

      static final Key SEPARATOR
      The numeric keypad's places separator character (in the United States, this is a comma, but elsewhere it is frequently a period).

    • BACKQUOTE

      static final Key BACKQUOTE
      `~ on a US keyboard. This is the 半角/全角/漢字 ( hankaku/zenkaku/kanji ) key on Japanese keyboards

      This value matches DOM's KeyboardEvent's event.code.

    • BACKSLASH

      static final Key BACKSLASH
      Used for both the US \| (on the 101-key layout) and also for the keylocated between the " and Enter keys on row C of the 102-, 104- and 106-key layouts. Labelled #~ on a UK (102) keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • BRACKET_LEFT

      static final Key BRACKET_LEFT
      [{ on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • BRACKET_RIGHT

      static final Key BRACKET_RIGHT
      ]} on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • COMMA

      static final Key COMMA
      ,< on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_0

      static final Key DIGIT_0
      0) on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_1

      static final Key DIGIT_1
      1! on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_2

      static final Key DIGIT_2
      2@ on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_3

      static final Key DIGIT_3
      3# on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_4

      static final Key DIGIT_4
      4$ on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_5

      static final Key DIGIT_5
      5% on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_6

      static final Key DIGIT_6
      6^ on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_7

      static final Key DIGIT_7
      7& on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_8

      static final Key DIGIT_8
      8* on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • DIGIT_9

      static final Key DIGIT_9
      9( on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • EQUAL

      static final Key EQUAL
      =+ on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • INTL_BACKSLASH

      static final Key INTL_BACKSLASH
      Located between the left Shift and Z keys.Labelled \| on a UK keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • INTL_RO

      static final Key INTL_RO
      Located between the / and right Shift keys.Labelled \ろ ( ro ) on a Japanese keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • INTL_YEN

      static final Key INTL_YEN
      Located between the = and Backspace keys.Labelled ¥ ( yen ) on a Japanese keyboard. \/ on a Russian keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_A

      static final Key KEY_A
      a on a US keyboard.Labelled q on an AZERTY (e.g., French) keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_B

      static final Key KEY_B
      b on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_C

      static final Key KEY_C
      c on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_D

      static final Key KEY_D
      d on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_E

      static final Key KEY_E
      e on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_F

      static final Key KEY_F
      f on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_G

      static final Key KEY_G
      g on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_H

      static final Key KEY_H
      h on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_I

      static final Key KEY_I
      i on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_J

      static final Key KEY_J
      j on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_K

      static final Key KEY_K
      k on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_L

      static final Key KEY_L
      l on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_M

      static final Key KEY_M
      m on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_N

      static final Key KEY_N
      n on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_O

      static final Key KEY_O
      o on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_P

      static final Key KEY_P
      p on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_Q

      static final Key KEY_Q
      q on a US keyboard.Labelled a on an AZERTY (e.g., French) keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_R

      static final Key KEY_R
      r on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_S

      static final Key KEY_S
      s on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_T

      static final Key KEY_T
      t on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_U

      static final Key KEY_U
      u on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_V

      static final Key KEY_V
      v on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_W

      static final Key KEY_W
      w on a US keyboard.Labelled z on an AZERTY (e.g., French) keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_X

      static final Key KEY_X
      x on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_Y

      static final Key KEY_Y
      y on a US keyboard.Labelled z on a QWERTZ (e.g., German) keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • KEY_Z

      static final Key KEY_Z
      z on a US keyboard.Labelled w on an AZERTY (e.g., French) keyboard, and y on a QWERTZ (e.g., German) keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • MINUS

      static final Key MINUS
      -_ on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • PERIOD

      static final Key PERIOD
      .> on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • QUOTE

      static final Key QUOTE
      '" on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • SEMICOLON

      static final Key SEMICOLON
      ;: on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • SLASH

      static final Key SLASH
      /? on a US keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • ALT_LEFT

      static final Key ALT_LEFT
      Alt , Option or ⌥ .

      This value matches DOM's KeyboardEvent's event.code.

    • ALT_RIGHT

      static final Key ALT_RIGHT
      Alt , Option or ⌥ .This is labelled AltGr key on many keyboard layouts.

      This value matches DOM's KeyboardEvent's event.code.

    • CONTROL_LEFT

      static final Key CONTROL_LEFT
      Control or ⌃

      This value matches DOM's KeyboardEvent's event.code.

    • CONTROL_RIGHT

      static final Key CONTROL_RIGHT
      Control or ⌃

      This value matches DOM's KeyboardEvent's event.code.

    • META_LEFT

      static final Key META_LEFT
      The Windows, ⌘ , Command or other OS symbol key.

      This value matches DOM's KeyboardEvent's event.code.

    • META_RIGHT

      static final Key META_RIGHT
      The Windows, ⌘ , Command or other OS symbol key.

      This value matches DOM's KeyboardEvent's event.code.

    • SHIFT_LEFT

      static final Key SHIFT_LEFT
      Shift or ⇧

      This value matches DOM's KeyboardEvent's event.code.

    • SHIFT_RIGHT

      static final Key SHIFT_RIGHT
      Shift or ⇧

      This value matches DOM's KeyboardEvent's event.code.

    • LANG_1

      static final Key LANG_1
      Korean: HangulMode 한/영 ( han/yeong ) Japanese (Mac keyboard): かな ( kana )

      This value matches DOM's KeyboardEvent's event.code.

    • LANG_2

      static final Key LANG_2
      Korean: Hanja 한자 ( hanja ) Japanese (Mac keyboard): 英数 ( eisu )

      This value matches DOM's KeyboardEvent's event.code.

    • LANG_3

      static final Key LANG_3
      Japanese (word-processing keyboard): Katakana

      This value matches DOM's KeyboardEvent's event.code.

    • LANG_4

      static final Key LANG_4
      Japanese (word-processing keyboard): Hiragana

      This value matches DOM's KeyboardEvent's event.code.

    • LANG_5

      static final Key LANG_5
      Japanese (word-processing keyboard): Zenkaku/Hankaku

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_0

      static final Key NUMPAD_0
      0 Ins on a keyboard 0 on a phone or remote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_1

      static final Key NUMPAD_1
      1 End on a keyboard 1 or 1 QZ on a phone orremote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_2

      static final Key NUMPAD_2
      2 ↓ on a keyboard 2 ABC on a phone or remote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_3

      static final Key NUMPAD_3
      3 PgDn on a keyboard 3 DEF on a phone or remote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_4

      static final Key NUMPAD_4
      4 ← on a keyboard 4 GHI on a phone or remote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_5

      static final Key NUMPAD_5
      5 on a keyboard 5 JKL on a phone or remote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_6

      static final Key NUMPAD_6
      6 → on a keyboard 6 MNO on a phone or remote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_7

      static final Key NUMPAD_7
      7 Home on a keyboard 7 PQRS or 7 PRS on a phoneor remote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_8

      static final Key NUMPAD_8
      8 ↑ on a keyboard 8 TUV on a phone or remote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_9

      static final Key NUMPAD_9
      9 PgUp on a keyboard 9 WXYZ or 9 WXY on a phoneor remote control

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_ADD

      static final Key NUMPAD_ADD
      +

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_BACKSPACE

      static final Key NUMPAD_BACKSPACE
      Found on the Microsoft Natural Keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_CLEAR

      static final Key NUMPAD_CLEAR
      C or AC (All Clear). Also for use with numpads that have a Clear key that is separate from the NumLock key. On the Mac, the numpad Clear key should always be encoded as " NumLock " .

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_CLEAR_ENTRY

      static final Key NUMPAD_CLEAR_ENTRY
      CE (Clear Entry)

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_COMMA

      static final Key NUMPAD_COMMA
      , (thousands separator). For locales where the thousands separatoris a "." (e.g., Brazil), this key may generate a . .

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_DECIMAL

      static final Key NUMPAD_DECIMAL
      . Del . For locales where the decimal separator is "," (e.g.,Brazil), this key may generate a , .

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_DIVIDE

      static final Key NUMPAD_DIVIDE
      /

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_ENTER

      static final Key NUMPAD_ENTER
      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_EQUAL

      static final Key NUMPAD_EQUAL
      =

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_HASH

      static final Key NUMPAD_HASH
      # on a phone or remote control device. This key is typically foundbelow the 9 key and to the right of the 0 key.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_MEMORY_ADD

      static final Key NUMPAD_MEMORY_ADD
      M+ Add current entry to the value stored in memory.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_MEMORY_CLEAR

      static final Key NUMPAD_MEMORY_CLEAR
      MC Clear the value stored in memory.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_MEMORY_RECALL

      static final Key NUMPAD_MEMORY_RECALL
      MR Replace the current entry with the value stored in memory.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_MEMORY_STORE

      static final Key NUMPAD_MEMORY_STORE
      MS Replace the value stored in memory with the current entry.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_MEMORY_SUBTRACT

      static final Key NUMPAD_MEMORY_SUBTRACT
      M- Subtract current entry from the value stored in memory.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_MULTIPLY

      static final Key NUMPAD_MULTIPLY
      * on a keyboard. For use with numpads that provide mathematicaloperations ( + , - , * and / ). Use " NumpadStar " for the * key on phones and remote controls.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_PAREN_LEFT

      static final Key NUMPAD_PAREN_LEFT
      ( Found on the Microsoft Natural Keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_PAREN_RIGHT

      static final Key NUMPAD_PAREN_RIGHT
      ) Found on the Microsoft Natural Keyboard.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_STAR

      static final Key NUMPAD_STAR
      * on a phone or remote control device.This key is typically found below the 7 key and to the left of the 0 key. Use " NumpadMultiply " for the * key on numeric keypads.

      This value matches DOM's KeyboardEvent's event.code.

    • NUMPAD_SUBTRACT

      static final Key NUMPAD_SUBTRACT
      -

      This value matches DOM's KeyboardEvent's event.code.

    • LAUNCH_APP_1

      static final Key LAUNCH_APP_1
      Sometimes labelled My Computer on the keyboard

      This value matches DOM's KeyboardEvent's event.code.

    • LAUNCH_APP_2

      static final Key LAUNCH_APP_2
      Sometimes labelled Calculator on the keyboard

      This value matches DOM's KeyboardEvent's event.code.

    • MEDIA_SELECT

      static final Key MEDIA_SELECT
      This value matches DOM's KeyboardEvent's event.code.

    • SLEEP

      static final Key SLEEP
      This value matches DOM's KeyboardEvent's event.code.

    • TURBO

      static final Key TURBO
      This value matches DOM's KeyboardEvent's event.code.

    • ABORT

      static final Key ABORT
      This value matches DOM's KeyboardEvent's event.code.

    • RESUME

      static final Key RESUME
      This value matches DOM's KeyboardEvent's event.code.

    • SUSPEND

      static final Key SUSPEND
      This value matches DOM's KeyboardEvent's event.code.

    • NONE

      static final Key NONE
      This value is reserved for corner cases of no key value present in event e.g. when browser autosuggest is used.

  • Method Details

    • of

      static Key of(String key, String... additionalKeys)
      Returns a Key instance for a printable representation of the key.

      The optional additionalKeys parameter can be used to create an instance which will match additional printable representations of the same key, in the rare cases where browsers don't agree.

      See https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key

      Parameters:
      key - the printable representation of the key, not null nor empty
      additionalKeys - additional printable representations of the same key
      Returns:
      the Key instance

    • getKeys

      List<String> getKeys()
      Returns the list (with at least one element) of printable representations of the key, which should reflect the key property in the JavaScript KeyboardEvent.

      See https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key

      Returns:
      the list of printable representations of the key

    • matches

      default boolean matches(String key)
      Checks if key is a printable representation for this instance.
      Parameters:
      key - a printable representation of a key
      Returns:
      true, if key is a printable representation for this instance

    • isModifier

      static boolean isModifier(Key key)
      Returns whether the specified key is a modifier or not.
      Parameters:
      key - a Key instance.
      Returns:
      true if the key argument is a modifier, otherwise false.
      See Also: