KeyboardSupportService (cockpitng 18.08.0-RC7 API)

All Known Implementing Classes:

DefaultKeyboardSupportService
```
public interface KeyboardSupportService
```
Keyboard support service

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`ALT_PREFIX`
`static String`	`BACKSPACE`
`static char`	`CTRL_PREFIX`
`static String`	`DELETE`
`static String`	`DOWN`
`static String`	`END`
`static String`	`F1`
`static String`	`F10`
`static String`	`F11`
`static String`	`F12`
`static String`	`F2`
`static String`	`F3`
`static String`	`F4`
`static String`	`F5`
`static String`	`F6`
`static String`	`F7`
`static String`	`F8`
`static String`	`F9`
`static String`	`HOME`
`static String`	`INSERT`
`static String`	`LEFT`
`static String`	`PAGE_DOWN`
`static String`	`PAGE_UP`
`static String`	`RIGHT`
`static char`	`SHIFT_PREFIX`
`static String`	`UP`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`containsKeyEvent(String ctrlKeys, org.zkoss.zk.ui.event.KeyEvent keyEvent)` Checks if given ctrlKeys contains given keyEvent
`String`	`convertToKeyEventCode(org.zkoss.zk.ui.event.KeyEvent keyEvent)` Converts given keyEvent to string representation.
`String`	`getToolTip(String ctrlKeys)` Returns a tool tip text for given ctrl keys
`String`	`mergeCtrlKeys(String... ctrlKeysArg)` Merges given control keys into one string with no duplicates.
`boolean`	`validateCtrlKeys(String ctrlKeys)` Checks if all ctrl keys are valid

- Field Detail
  - SHIFT_PREFIX
```
static final char SHIFT_PREFIX
```
    See Also:
    
    Constant Field Values
  - ALT_PREFIX
```
static final char ALT_PREFIX
```
    See Also:
    
    Constant Field Values
  - CTRL_PREFIX
```
static final char CTRL_PREFIX
```
    See Also:
    
    Constant Field Values
  - F1
```
static final String F1
```
    See Also:
    
    Constant Field Values
  - F2
```
static final String F2
```
    See Also:
    
    Constant Field Values
  - F3
```
static final String F3
```
    See Also:
    
    Constant Field Values
  - F4
```
static final String F4
```
    See Also:
    
    Constant Field Values
  - F5
```
static final String F5
```
    See Also:
    
    Constant Field Values
  - F6
```
static final String F6
```
    See Also:
    
    Constant Field Values
  - F7
```
static final String F7
```
    See Also:
    
    Constant Field Values
  - F8
```
static final String F8
```
    See Also:
    
    Constant Field Values
  - F9
```
static final String F9
```
    See Also:
    
    Constant Field Values
  - F10
```
static final String F10
```
    See Also:
    
    Constant Field Values
  - F11
```
static final String F11
```
    See Also:
    
    Constant Field Values
  - F12
```
static final String F12
```
    See Also:
    
    Constant Field Values
  - PAGE_UP
```
static final String PAGE_UP
```
    See Also:
    
    Constant Field Values
  - PAGE_DOWN
```
static final String PAGE_DOWN
```
    See Also:
    
    Constant Field Values
  - END
```
static final String END
```
    See Also:
    
    Constant Field Values
  - HOME
```
static final String HOME
```
    See Also:
    
    Constant Field Values
  - LEFT
```
static final String LEFT
```
    See Also:
    
    Constant Field Values
  - UP
```
static final String UP
```
    See Also:
    
    Constant Field Values
  - RIGHT
```
static final String RIGHT
```
    See Also:
    
    Constant Field Values
  - DOWN
```
static final String DOWN
```
    See Also:
    
    Constant Field Values
  - BACKSPACE
```
static final String BACKSPACE
```
    See Also:
    
    Constant Field Values
  - INSERT
```
static final String INSERT
```
    See Also:
    
    Constant Field Values
  - DELETE
```
static final String DELETE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - containsKeyEvent
```
boolean containsKeyEvent(String ctrlKeys,
                         org.zkoss.zk.ui.event.KeyEvent keyEvent)
```
    Checks if given ctrlKeys contains given keyEvent
    
    Parameters:
    
    ctrlKeys - ctrl keys
    
    keyEvent - key event
    
    Returns:
    
    true if ctrlKeys contains keyEventCode convertToKeyEventCode(KeyEvent)
  - mergeCtrlKeys
```
String mergeCtrlKeys(String... ctrlKeysArg)
```
    Merges given control keys into one string with no duplicates. All ctrl keys are transformed to lowercase
    
    Parameters:
    
    ctrlKeysArg - list of triggerOnKeys e.g. @0@b@#ins and @1@c@#ins
    
    Returns:
    
    merged control keys e.g. @0@b@#ins@1@c
  - validateCtrlKeys
```
boolean validateCtrlKeys(String ctrlKeys)
```
    Checks if all ctrl keys are valid
    
    Parameters:
    
    ctrlKeys - ctrl keys valid.
    
    Returns:
    
    true if ctrl keys are valid.
  - convertToKeyEventCode
```
String convertToKeyEventCode(org.zkoss.zk.ui.event.KeyEvent keyEvent)
```
    Converts given keyEvent to string representation. It will contain one of prefixes SHIFT_PREFIX, ALT_PREFIX or CTRL_PREFIX depending on modifiers in KeyEvent.isShiftKey(), KeyEvent.isAltKey(), KeyEvent.isCtrlKey()
    e.g. KeyEvent.DELETE which is represented by 46 and SHIFT pressed it should return $#del
    
    Parameters:
    
    keyEvent - key event
    
    Returns:
    
    string representation with modifier
  - getToolTip
```
String getToolTip(String ctrlKeys)
```
    Returns a tool tip text for given ctrl keys
    
    Parameters:
    
    ctrlKeys - control keys
    
    Returns:
    
    tool tip text

Interface KeyboardSupportService

Field Summary

Method Summary

Field Detail

SHIFT_PREFIX

ALT_PREFIX

CTRL_PREFIX

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

PAGE_UP

PAGE_DOWN

END

HOME

LEFT

UP

RIGHT

DOWN

BACKSPACE

INSERT

DELETE

Method Detail

containsKeyEvent

mergeCtrlKeys

validateCtrlKeys

convertToKeyEventCode

getToolTip