JavaScript Data GridPlugin: ShortcutManager

On this page

• Description
• Methods
  • addContext
  • destroy
  • getActiveContextName
  • getContext
  • isCtrlPressed
  • releasePressedKeys
  • setActiveContextName

Description

The ShortcutManager API lets you store and manage keyboard shortcut contexts (ShortcutContext).

Each ShortcutManager object:

• Stores and manages its own set of keyboard shortcut contexts.
• Listens to the KeyboardEvent (opens new window) events and runs actions for them.

Methods

addContext

Source code

shortcutManager.addContext(contextName, [scope]) ⇒ object

Create a new ShortcutContext object.

Param	Type	Default	Description
contextName	string		The name of the new shortcut context
[scope]	string	"table"	optional The scope of the shortcut: 'table' or 'global'

destroy

Source code

shortcutManager.destroy() : function

Destroy a context manager instance.

getActiveContextName

Source code

shortcutManager.getActiveContextName() ⇒ string

Get the ID of the active ShortcutContext.

getContext

Source code

shortcutManager.getContext(contextName) ⇒ object | undefined

Get a keyboard shortcut context by its name.

Param	Type	Description
contextName	string	The name of the shortcut context

Returns: object | undefined - A ShortcutContext object that stores registered shortcuts

isCtrlPressed

Source code

shortcutManager.isCtrlPressed() ⇒ boolean

Returns whether control or meta keys are pressed.

releasePressedKeys

Source code

shortcutManager.releasePressedKeys() : function

Release every previously pressed key.

setActiveContextName

Source code

shortcutManager.setActiveContextName(contextName)

Start listening to keyboard shortcuts within a given ShortcutContext.

Param	Type	Description
contextName	string	The name of the shortcut context