de.hybris.platform.cscockpit.session.impl

Class DefaultCsWidgetHotKeyHandler

java.lang.Object

de.hybris.platform.cockpit.session.impl.DefaultHotKeyHandler

de.hybris.platform.cockpit.session.impl.AbstractWidgetHotKeyHandler

de.hybris.platform.cscockpit.session.impl.DefaultCsWidgetHotKeyHandler

All Implemented Interfaces:

CockpitHotKeyHandler

public class DefaultCsWidgetHotKeyHandler
extends AbstractWidgetHotKeyHandler

Constructor Summary

Constructors

Constructor and Description
DefaultCsWidgetHotKeyHandler()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,HotKeyCommand>	getBrowserCommandMap()
protected java.util.Map<java.lang.String,HotKeyCommand>	getCommandMap()
protected java.lang.String	getFocusedBrowserCode()
protected java.lang.String	getFocusedWidgetCode()
protected WidgetBrowserModel	getWidgetBrowserModel()
void	handleHotKey(java.lang.Object data) Called when a registered hot key is pressed.
boolean	isBusyListener() Returns whether busy listener mechanism should be used when handling keyboard shortcut events or not.
protected boolean	resolveAndExecuteCommand(java.util.Map<java.lang.String,HotKeyCommand> cmdMap, java.lang.String key, java.lang.String keyCode)
void	setBrowserCommandMap(java.util.Map<java.lang.String,HotKeyCommand> browserCmdMap) Sets the mappings for browser (tab) wide hot key commands.
void	setCommandMap(java.util.Map<java.lang.String,HotKeyCommand> commandMap) Sets the mappings for widget wide hot key commands.

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractWidgetHotKeyHandler

focusWidget

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCsWidgetHotKeyHandler

public DefaultCsWidgetHotKeyHandler()

Method Detail

getFocusedWidgetCode

protected java.lang.String getFocusedWidgetCode()

getFocusedBrowserCode

protected java.lang.String getFocusedBrowserCode()

getWidgetBrowserModel

protected WidgetBrowserModel getWidgetBrowserModel()

handleHotKey

public void handleHotKey(java.lang.Object data)

Description copied from interface: CockpitHotKeyHandler

Called when a registered hot key is pressed.

Specified by:

handleHotKey in interface CockpitHotKeyHandler

Overrides:

handleHotKey in class DefaultHotKeyHandler

Parameters:

data - hot key information - typically a String representing the action code

resolveAndExecuteCommand

protected boolean resolveAndExecuteCommand(java.util.Map<java.lang.String,HotKeyCommand> cmdMap,
                                           java.lang.String key,
                                           java.lang.String keyCode)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getBrowserCommandMap

protected java.util.Map<java.lang.String,HotKeyCommand> getBrowserCommandMap()

setBrowserCommandMap

public void setBrowserCommandMap(java.util.Map<java.lang.String,HotKeyCommand> browserCmdMap)

Sets the mappings for browser (tab) wide hot key commands.

Parameters:

browserCmdMap - hot key command mappings - browserCode => command

getCommandMap

protected java.util.Map<java.lang.String,HotKeyCommand> getCommandMap()

setCommandMap

public void setCommandMap(java.util.Map<java.lang.String,HotKeyCommand> commandMap)

Sets the mappings for widget wide hot key commands.

Parameters:

commandMap - hot key command mappings - widgetCode => command

isBusyListener

public boolean isBusyListener()

Description copied from interface: CockpitHotKeyHandler

Returns whether busy listener mechanism should be used when handling keyboard shortcut events or not.

Specified by:

isBusyListener in interface CockpitHotKeyHandler

Overrides:

isBusyListener in class DefaultHotKeyHandler

Returns:

true if busy listener should be used, false otherwise