Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKeyboardShortcut

interface

IKeyboardShortcut

Hierarchy

  • IKeyboardShortcut

Index

Properties

Methods

Properties

name

name: string

Keyboard shortcut name/action

type

{string}

Methods

clearOverride

  • clearOverride(): void

  • Resets any existing override, reverting the shortcut back to its original function

    Returns void

disable

  • disable(): void

  • Makes the keyboard shortcut listener inactive

    Returns void

enable

  • enable(): void

  • Makes the keyboard shortcut listener active

    Returns void

rebindShortcuts

  • rebindShortcuts(): void

  • Re-bind shortcuts. Primarily used by keyboard shortcut manager to bind shortcuts when a new IFrame has been added to the mousetrap collection

    Returns void

setOverride

  • setOverride(overrideSource: string, overrideFn: function): void

  • Sets the specified action to be performed in place of the default action when the shortcut is triggered

    Parameters

    • overrideSource: string

      Identifier indicating the source of the override

    • overrideFn: function

      The action to be performed instead of the default action.

        • (): any

        • Returns any

    Returns void