com.hybris.cockpitng.keyboard.impl

Class DefaultKeyboardSupportService

java.lang.Object

com.hybris.cockpitng.keyboard.impl.DefaultKeyboardSupportService

All Implemented Interfaces:

KeyboardSupportService

public class DefaultKeyboardSupportService
extends Object
implements KeyboardSupportService

Default implementation of keyboard support service. KeyboardSupportService

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FUNCTION_KEYS
protected static Pattern	PATTERN Patter should find for given @0@b@#ins^1^c^#del$2$d$#bak#f10 following groups "@0", "@b", "@#ins", "^1", "^c", "^#del", "$2", "$d", "$#bak", "#f10".
protected static String	PREFIX_FUNCTION_KEYS
protected static Pattern	PREFIX_PATTERN Patter should check if prefix has only !^@ without duplicates
protected static String	PREFIX_SIMPLE_KEYS
protected static String	SIMPLE_KEYS

Fields inherited from interface com.hybris.cockpitng.keyboard.KeyboardSupportService

ALT_PREFIX, BACKSPACE, CTRL_PREFIX, DELETE, DOWN, END, F1, F10, F11, F12, F2, F3, F4, F5, F6, F7, F8, F9, HOME, INSERT, LEFT, PAGE_DOWN, PAGE_UP, RIGHT, SHIFT_PREFIX, UP

Constructor Summary

Constructors

Constructor and Description
DefaultKeyboardSupportService() Initialize binding between key codes and it's string representations

Method Summary

Modifier and Type	Method and Description
boolean	containsKeyEvent(String ctrlKeys, org.zkoss.zk.ui.event.KeyEvent keyEvent) Checks if given ctrlKeys contains given keyEvent
protected String	convertPrefix(String prefix)
protected String	convertToKeyEventCode(int key) Converts given key code to it's string representation.
String	convertToKeyEventCode(org.zkoss.zk.ui.event.KeyEvent keyEvent) Converts given keyEvent to string representation.
protected String	getLabel(String key)
String	getToolTip(String ctrlKeys) Returns a tool tip text for given ctrl keys
protected boolean	keyCodesMatch(String keyCodeOne, String keyCodeTwo) Tells if two keyCodes are equal where modifiers can be in random order.
String	mergeCtrlKeys(String... ctrlKeysArg) Merges given control keys into one string with no duplicates.
protected Set<String>	splitCtrlKeys(String ctrlKeys) Splits given triggerOnKeys in key codes
boolean	validateCtrlKeys(String ctrlKeys) Checks if all ctrl keys are valid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFIX_SIMPLE_KEYS

protected static final String PREFIX_SIMPLE_KEYS

See Also:

Constant Field Values

PREFIX_FUNCTION_KEYS

protected static final String PREFIX_FUNCTION_KEYS

See Also:

Constant Field Values

FUNCTION_KEYS

protected static final String FUNCTION_KEYS

See Also:

Constant Field Values

SIMPLE_KEYS

protected static final String SIMPLE_KEYS

See Also:

Constant Field Values

PATTERN

protected static final Pattern PATTERN

Patter should find for given @0@b@#ins^1^c^#del$2$d$#bak#f10 following groups "@0", "@b", "@#ins", "^1", "^c", "^#del", "$2", "$d", "$#bak", "#f10".

PREFIX_PATTERN

protected static final Pattern PREFIX_PATTERN

Patter should check if prefix has only !^@ without duplicates

Constructor Detail

DefaultKeyboardSupportService

public DefaultKeyboardSupportService()

Initialize binding between key codes and it's string representations

Method Detail

splitCtrlKeys

protected Set<String> splitCtrlKeys(String ctrlKeys)

Splits given triggerOnKeys in key codes

Parameters:

ctrlKeys - triggerOnKeys e.g. "@0^c$#del#f10"

Returns:

set with following values "@0", "^c","$#del", "#f10"

containsKeyEvent

public boolean containsKeyEvent(String ctrlKeys,
                                org.zkoss.zk.ui.event.KeyEvent keyEvent)

Description copied from interface: KeyboardSupportService

Checks if given ctrlKeys contains given keyEvent

Specified by:

containsKeyEvent in interface KeyboardSupportService

Parameters:

ctrlKeys - ctrl keys

keyEvent - key event

Returns:

true if ctrlKeys contains keyEventCode KeyboardSupportService.convertToKeyEventCode(KeyEvent)

keyCodesMatch

protected boolean keyCodesMatch(String keyCodeOne,
                                String keyCodeTwo)

Tells if two keyCodes are equal where modifiers can be in random order. E.g. @$^#del is equal to $@^#del

Parameters:

keyCodeOne - @$^#del

keyCodeTwo - $@^#del

Returns:

true

mergeCtrlKeys

public String mergeCtrlKeys(String... ctrlKeysArg)

Description copied from interface: KeyboardSupportService

Merges given control keys into one string with no duplicates. All ctrl keys are transformed to lowercase

Specified by:

mergeCtrlKeys in interface KeyboardSupportService

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

public boolean validateCtrlKeys(String ctrlKeys)

Description copied from interface: KeyboardSupportService

Checks if all ctrl keys are valid

Specified by:

validateCtrlKeys in interface KeyboardSupportService

Parameters:

ctrlKeys - ctrl keys valid.

Returns:

true if ctrl keys are valid.

convertToKeyEventCode

protected String convertToKeyEventCode(int key)

Converts given key code to it's string representation.

Parameters:

key - KeyEvent.DELETE which is represented by 46

Returns:

string representation of key e.g. #del

convertToKeyEventCode

public String convertToKeyEventCode(org.zkoss.zk.ui.event.KeyEvent keyEvent)

Description copied from interface: KeyboardSupportService

Converts given keyEvent to string representation. It will contain one of prefixes KeyboardSupportService.SHIFT_PREFIX, KeyboardSupportService.ALT_PREFIX or KeyboardSupportService.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

Specified by:

convertToKeyEventCode in interface KeyboardSupportService

Parameters:

keyEvent - key event

Returns:

string representation with modifier

getToolTip

public String getToolTip(String ctrlKeys)

Description copied from interface: KeyboardSupportService

Returns a tool tip text for given ctrl keys

Specified by:

getToolTip in interface KeyboardSupportService

Parameters:

ctrlKeys - control keys

Returns:

tool tip text

convertPrefix

protected String convertPrefix(String prefix)

getLabel

protected String getLabel(String key)