psdi.webclient.system.controller

Class Hotkeys

java.lang.Object

psdi.webclient.system.controller.Hotkeys

public class Hotkeys
extends java.lang.Object

Encapsulates a list of hotkeys that apply to a single application. Because a particular key can have different events depending on the Ctrl and Alt key combinations, a hashmap is used; the key is the javascript keycode and the value is the list of the events for that keycode, with the corresponding ctrl and alt values needed to generate that event. A hotkey event is represented by an array (List) of params as follows: param[0] = javascript keycode for the hotkey param[1] = boolean value of the ctrl key for the hotkey param[2] = boolean value of the alt key for the hotkey param[3] = id of the target for the hotkey event param[4] = method name of the hotkey event

Field Summary

Fields

Modifier and Type	Field and Description
static int	IDX_ALT
static int	IDX_CHAR
static int	IDX_CTRL
static int	IDX_EVENT
static int	IDX_KEYCODE
static int	IDX_TARGET

Constructor Summary

Constructors

Constructor and Description
Hotkeys()

Method Summary

Modifier and Type	Method and Description
java.lang.String	addHotkey(WebClientSession wcs, java.lang.String hotkey, java.lang.String target, java.lang.String eventname) Adds a single hotkey to the hotkeys hashmap
char	getAccessKey(java.lang.String hotkey)
boolean	getAltState(java.lang.String hotkey)
boolean	getCtrlState(java.lang.String hotkey)
java.util.List	getHotkeysForKeycode(int keycode)
java.util.Set	getKeycodes()
java.lang.String	localize(WebClientSession wcs, java.lang.String inkey)
void	reset() Initializes the array of hotkeys to an empty state.

Methods inherited from class java.lang.Object

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

Field Detail

IDX_KEYCODE

public static final int IDX_KEYCODE

See Also:

Constant Field Values

IDX_CTRL

public static final int IDX_CTRL

See Also:

Constant Field Values

IDX_ALT

public static final int IDX_ALT

See Also:

Constant Field Values

IDX_TARGET

public static final int IDX_TARGET

See Also:

Constant Field Values

IDX_EVENT

public static final int IDX_EVENT

See Also:

Constant Field Values

IDX_CHAR

public static final int IDX_CHAR

See Also:

Constant Field Values

Constructor Detail

Hotkeys

public Hotkeys()

Method Detail

reset

public void reset()

Initializes the array of hotkeys to an empty state.

addHotkey

public java.lang.String addHotkey(WebClientSession wcs,
                                  java.lang.String hotkey,
                                  java.lang.String target,
                                  java.lang.String eventname)

Adds a single hotkey to the hotkeys hashmap

Parameters:

hotkey - the combination of the keys that invokes the hotkey, e.g. "CTRL+ALT+L"

target - the id of the target for the hotkey event

eventname - the method name for the hotkey event

localize

public java.lang.String localize(WebClientSession wcs,
                                 java.lang.String inkey)

getKeycodes

public java.util.Set getKeycodes()

Returns:

Set of all the keycodes

getHotkeysForKeycode

public java.util.List getHotkeysForKeycode(int keycode)

Parameters:

keycode -

Returns:

list of all hotkeys for the specified keycode

getCtrlState

public boolean getCtrlState(java.lang.String hotkey)

getAltState

public boolean getAltState(java.lang.String hotkey)

getAccessKey

public char getAccessKey(java.lang.String hotkey)