Uses of Interface
com.vaadin.flow.component.Key

Packages that use Key
Package
Description
com.vaadin.flow.component
 
com.vaadin.flow.component.button
 
com.vaadin.flow.component.internal
 
com.vaadin.testbench.unit
 

  • Uses of Key in com.vaadin.flow.component

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

  • Uses of Key in com.vaadin.flow.component.button

    Methods in com.vaadin.flow.component.button with parameters of type Key
    Modifier and Type
    Method
    Description
    ShortcutRegistration
    Button.addFocusShortcut(Key key, KeyModifier... keyModifiers)
    Adds a shortcut which focuses the Component which implements Focusable interface.

  • Uses of Key in com.vaadin.flow.component.internal

    Methods in com.vaadin.flow.component.internal that return Key
    Modifier and Type
    Method
    Description
    Key
    KeyboardEvent.getKey()
    Gets the key of the event.
    Methods in com.vaadin.flow.component.internal that return types with arguments of type Key
    Modifier and Type
    Method
    Description
    Optional<Key>
    KeyboardEvent.getCode()
    Gets the code of the event.

  • Uses of Key in com.vaadin.testbench.unit

    Methods in com.vaadin.testbench.unit with parameters of type Key
    Modifier and Type
    Method
    Description
    void
    BaseUIUnitTest.fireShortcut(Key key, KeyModifier... modifiers)
    Simulates a keyboard shortcut performed on the browser.