Class: HotkeyService

Help4.service.HotkeyService(params)

new HotkeyService(params)

Parameters:
Name Type Description
params Help4.service.HotkeyService.Params
Source:

Extends

Members

(static) IGNORE_INPUT :Array.<string>

keys that are ignored while editing input fields
Type:
  • Array.<string>
Source:

Methods

destroy()

destroys the instance
Source:

disableHotkey(…keys) → {Help4.service.HotkeyService}

Parameters:
Name Type Attributes Description
keys string <repeatable>
Source:
Returns:
Type
Help4.service.HotkeyService

enableHotkey(…keys) → {Help4.service.HotkeyService}

Parameters:
Name Type Attributes Description
keys string <repeatable>
Source:
Returns:
Type
Help4.service.HotkeyService

getKey(event) → {string}

Parameters:
Name Type Description
event Object
Source:
Returns:
Type
string

hotkeyEnabled(key) → {boolean}

Parameters:
Name Type Description
key string
Source:
Returns:
Type
boolean

(static) cancelKeyEvent(event, keyMap) → {boolean}

Parameters:
Name Type Description
event Object
keyMap Object
Source:
Returns:
Type
boolean

(static) getActiveInputElement(eventopt) → (nullable) {Element}

Parameters:
Name Type Attributes Default Description
event Object <optional>
 {}
Source:
Returns:
Type
Element

(static) getKey(event) → (nullable) {string}

Parameters:
Name Type Description
event Object
Source:
Returns:
Type
string

(static) getShortcut(event) → (nullable) {string}

Parameters:
Name Type Description
event Object
Source:
Returns:
Type
string

Type Definitions

Params

Type:
Properties:
Name Type Description
crossOriginEngine Help4.engine.crossorigin.CoreEngine
crossOriginService Help4.service.CrossOriginMessageService
keyMap Object
hotkeyMap Object
Source: