@itwin/appui-react 3.6.1 → 3.7.0-dev.2

package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.js

@@ -1,273 +1,231 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module KeyboardShortcut
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyboardShortcutManager = exports.KeyboardShortcutContainer = exports.KeyboardShortcut = void 0;
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const CursorInformation_1 = require("../cursor/CursorInformation");
-const ItemDefBase_1 = require("../shared/ItemDefBase");
-const UiFramework_1 = require("../UiFramework");
-const KeyboardShortcutMenu_1 = require("./KeyboardShortcutMenu");
-const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
-/** Keyboard Shortcut used to execute an action
- * @public
- */
-class KeyboardShortcut extends ItemDefBase_1.ItemDefBase {
-    constructor(props) {
-        super(props);
-        this._isAltKeyRequired = false;
-        this._isCtrlKeyRequired = false;
-        this._isShiftKeyRequired = false;
-        this._isFunctionKey = false;
-        this._isSpecialKey = false;
-        this._key = props.key;
-        if (this._key in appui_abstract_1.FunctionKey)
-            this._isFunctionKey = true;
-        if (this._key in appui_abstract_1.SpecialKey)
-            this._isSpecialKey = true;
-        this._shortcuts = new KeyboardShortcutContainer();
-        if (props.item) {
-            this._item = props.item;
-            // Copy over icon, label & tooltip from the item
-            if (!this.iconSpec)
-                this.iconSpec = this._item.iconSpec;
-            if (!this.label)
-                this.setLabel(this._item.label);
-            if (!this.tooltip)
-                this.setTooltip(this._item.tooltip);
-            if (this.isDisabled === undefined)
-                this.isDisabled = this._item.isDisabled;
-            if (this.isHidden === undefined)
-                this.isHidden = this._item.isHidden;
-        }
-        else if (props.shortcuts) {
-            props.shortcuts.forEach((childProps) => {
-                const shortcut = new KeyboardShortcut(childProps);
-                this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);
-            });
-        }
-        else {
-            throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `Either 'item' or 'shortcuts' must be specified for '${props.key}' key.`);
-        }
-        if (props.isAltKeyRequired !== undefined)
-            this._isAltKeyRequired = props.isAltKeyRequired;
-        if (props.isCtrlKeyRequired !== undefined)
-            this._isCtrlKeyRequired = props.isCtrlKeyRequired;
-        if (props.isShiftKeyRequired !== undefined)
-            this._isShiftKeyRequired = props.isShiftKeyRequired;
-    }
-    /** Returns the id for this shortcut */
-    get id() { return this.keyMapKey; }
-    /** Returns the shortcut container */
-    get shortcutContainer() {
-        return this._shortcuts;
-    }
-    /** Finds a shortcut with a given key in the shortcut's container */
-    getShortcut(mapKey) {
-        return this._shortcuts.findKey(mapKey);
-    }
-    /** Returns the shortcut's key map key used as the id */
-    get keyMapKey() {
-        const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(this.key, this._isAltKeyRequired, this._isCtrlKeyRequired, this._isShiftKeyRequired);
-        return keyMapKey;
-    }
-    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
-    get item() {
-        return this._item;
-    }
-    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
-    itemPicked() {
-        if (this._shortcuts.areKeyboardShortcutsAvailable()) {
-            this._shortcuts.showShortcutsMenu();
-        }
-        else {
-            setTimeout(() => {
-                // istanbul ignore else
-                if (this._item)
-                    this._item.execute();
-            });
-        }
-    }
-    /** Gets the keyboard key */
-    get key() { return this._key; }
-    /** Gets whether the Alt key required. */
-    get isAltKeyRequired() { return this._isAltKeyRequired; }
-    /** Gets whether the Ctrl key required. */
-    get isCtrlKeyRequired() { return this._isCtrlKeyRequired; }
-    /** Gets whether the Shift key required. */
-    get isShiftKeyRequired() { return this._isShiftKeyRequired; }
-    /** Gets whether this is a Function key. */
-    get isFunctionKey() { return this._isFunctionKey; }
-    /** Gets whether this is a Special key. */
-    get isSpecialKey() { return this._isSpecialKey; }
-}
-exports.KeyboardShortcut = KeyboardShortcut;
-/** Keyboard Shortcut Container
- * @public
- */
-class KeyboardShortcutContainer {
-    constructor() {
-        this._keyMap = new Map();
-        this._keyArray = new Array();
-    }
-    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
-    registerKey(keyMapKey, inShortcut) {
-        let shortcut;
-        if ((shortcut = this.findKey(keyMapKey)) === undefined) {
-            shortcut = inShortcut;
-            this._keyArray.push(shortcut);
-        }
-        else {
-            const index = this._keyArray.findIndex((value) => {
-                return value.keyMapKey === keyMapKey;
-            });
-            // istanbul ignore else
-            if (index >= 0) {
-                shortcut = inShortcut;
-                this._keyArray[index] = shortcut;
-            }
-        }
-        // istanbul ignore else
-        if (shortcut)
-            this._keyMap.set(keyMapKey, shortcut);
-        return shortcut;
-    }
-    /** Finds a Keyboard Shortcut associated with a given key */
-    findKey(keyMapKey) {
-        return this._keyMap.get(keyMapKey);
-    }
-    /** Determines if any Keyboard Shortcuts are available in this container */
-    areKeyboardShortcutsAvailable() {
-        return this._keyMap.size !== 0;
-    }
-    /** Empties any Keyboard Shortcuts from this container */
-    emptyData() {
-        this._keyMap.clear();
-        this._keyArray.length = 0;
-    }
-    getAvailableKeyboardShortcuts() {
-        return this._keyArray.slice();
-    }
-    /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */
-    static generateKeyMapKey(keyboardKey, isAltKeyRequired, isCtrlKeyRequired, isShiftKeyRequired) {
-        let keyMapKey = keyboardKey;
-        if (isAltKeyRequired)
-            keyMapKey = `Alt+${keyMapKey}`;
-        if (isShiftKeyRequired)
-            keyMapKey = `Shift+${keyMapKey}`;
-        if (isCtrlKeyRequired)
-            keyMapKey = `Ctrl+${keyMapKey}`;
-        return keyMapKey;
-    }
-    /** Displays a menu for the Keyboard Shortcuts in this container */
-    showShortcutsMenu() {
-        const offset = 8;
-        KeyboardShortcutMenu_1.KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({
-            menuVisible: true,
-            menuX: KeyboardShortcutManager.cursorX - offset,
-            menuY: KeyboardShortcutManager.cursorY - offset,
-            shortcuts: this.getAvailableKeyboardShortcuts(),
-        });
-    }
-}
-exports.KeyboardShortcutContainer = KeyboardShortcutContainer;
-/** Keyboard Shortcut Manager
- * @public
- */
-class KeyboardShortcutManager {
-    /** Initialize the Keyboard Shortcut manager */
-    static initialize() {
-        SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(KeyboardShortcutManager._handleSyncUiEvent);
-    }
-    /** Loads Keyboard Shortcuts into the managed list */
-    static loadKeyboardShortcuts(shortcutList) {
-        shortcutList.forEach((shortcutProps) => {
-            this.loadKeyboardShortcut(shortcutProps);
-        });
-    }
-    /** Loads a Keyboard Shortcut into the managed list */
-    static loadKeyboardShortcut(shortcutProps) {
-        const shortcut = new KeyboardShortcut(shortcutProps);
-        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);
-    }
-    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
-    static processKey(keyboardKey, isAltKeyPressed = false, isCtrlKeyPressed = false, isShiftKeyPressed = false) {
-        const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);
-        const shortcut = this.getShortcut(keyMapKey);
-        if (shortcut) {
-            shortcut.itemPicked();
-            return true;
-        }
-        return false;
-    }
-    /** Returns the managed list of Keyboard Shortcuts */
-    static get shortcutContainer() {
-        return this._shortcuts;
-    }
-    /** Returns a Keyboard Shortcut from the managed lists */
-    static getShortcut(keyMapKey) {
-        return this._shortcuts.findKey(keyMapKey);
-    }
-    /** Determines if focus is set to Home */
-    static get isFocusOnHome() {
-        const element = document.activeElement;
-        return element && element === document.body;
-    }
-    /** Sets focus to Home */
-    static setFocusToHome() {
-        const element = document.activeElement;
-        if (element && element !== document.body) {
-            element.blur();
-            document.body.focus();
-        }
-    }
-    /** Displays the Keyboard Shortcuts menu at the cursor */
-    static displayShortcutsMenu() {
-        if (this._shortcuts.areKeyboardShortcutsAvailable()) {
-            this._shortcuts.showShortcutsMenu();
-        }
-    }
-    /** Closes the Keyboard Shortcuts menu */
-    static closeShortcutsMenu() {
-        KeyboardShortcutMenu_1.KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({
-            menuVisible: false,
-            menuX: 0,
-            menuY: 0,
-            shortcuts: undefined,
-        });
-    }
-    /** Returns the cursor X position, which is mouseEvent.pageX. */
-    static get cursorX() { return CursorInformation_1.CursorInformation.cursorX; }
-    /** Returns the cursor Y position, which is mouseEvent.pageY. */
-    static get cursorY() { return CursorInformation_1.CursorInformation.cursorY; }
-}
-exports.KeyboardShortcutManager = KeyboardShortcutManager;
-KeyboardShortcutManager._shortcuts = new KeyboardShortcutContainer();
-KeyboardShortcutManager._handleSyncUiEvent = (args) => {
-    const updateBooleanValue = (booleanValue) => {
-        if (SyncUiEventDispatcher_1.SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))
-            booleanValue.refresh();
-    };
-    const handleForSyncIds = (shortcut) => {
-        if (shortcut.isDisabled instanceof appui_abstract_1.ConditionalBooleanValue)
-            updateBooleanValue(shortcut.isDisabled);
-        if (shortcut.isHidden instanceof appui_abstract_1.ConditionalBooleanValue)
-            updateBooleanValue(shortcut.isHidden);
-    };
-    KeyboardShortcutManager._traverseShortcuts(KeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(), handleForSyncIds);
-};
-KeyboardShortcutManager._traverseShortcuts = (shortcuts, callback) => {
-    shortcuts.forEach((shortcut) => {
-        callback(shortcut);
-        if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {
-            const childShortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();
-            KeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);
-        }
-    });
-};
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyboardShortcutManager = exports.KeyboardShortcutContainer = exports.KeyboardShortcut = void 0;
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const ItemDefBase_1 = require("../shared/ItemDefBase");
+const UiFramework_1 = require("../UiFramework");
+const KeyboardShortcutMenu_1 = require("./KeyboardShortcutMenu");
+const InternalKeyboardShortcut_1 = require("./InternalKeyboardShortcut");
+/** Keyboard Shortcut used to execute an action
+ * @public
+ */
+class KeyboardShortcut extends ItemDefBase_1.ItemDefBase {
+    constructor(props) {
+        super(props);
+        this._isAltKeyRequired = false;
+        this._isCtrlKeyRequired = false;
+        this._isShiftKeyRequired = false;
+        this._isFunctionKey = false;
+        this._isSpecialKey = false;
+        this._key = props.key;
+        if (this._key in appui_abstract_1.FunctionKey)
+            this._isFunctionKey = true;
+        if (this._key in appui_abstract_1.SpecialKey)
+            this._isSpecialKey = true;
+        this._shortcuts = new KeyboardShortcutContainer();
+        if (props.item) {
+            this._item = props.item;
+            // Copy over icon, label & tooltip from the item
+            if (!this.iconSpec)
+                this.iconSpec = this._item.iconSpec;
+            if (!this.label)
+                this.setLabel(this._item.label);
+            if (!this.tooltip)
+                this.setTooltip(this._item.tooltip);
+            if (this.isDisabled === undefined)
+                this.isDisabled = this._item.isDisabled;
+            if (this.isHidden === undefined)
+                this.isHidden = this._item.isHidden;
+        }
+        else if (props.shortcuts) {
+            props.shortcuts.forEach((childProps) => {
+                const shortcut = new KeyboardShortcut(childProps);
+                this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);
+            });
+        }
+        else {
+            throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `Either 'item' or 'shortcuts' must be specified for '${props.key}' key.`);
+        }
+        if (props.isAltKeyRequired !== undefined)
+            this._isAltKeyRequired = props.isAltKeyRequired;
+        if (props.isCtrlKeyRequired !== undefined)
+            this._isCtrlKeyRequired = props.isCtrlKeyRequired;
+        if (props.isShiftKeyRequired !== undefined)
+            this._isShiftKeyRequired = props.isShiftKeyRequired;
+    }
+    /** Returns the id for this shortcut */
+    get id() { return this.keyMapKey; }
+    /** Returns the shortcut container */
+    get shortcutContainer() {
+        return this._shortcuts;
+    }
+    /** Finds a shortcut with a given key in the shortcut's container */
+    getShortcut(mapKey) {
+        return this._shortcuts.findKey(mapKey);
+    }
+    /** Returns the shortcut's key map key used as the id */
+    get keyMapKey() {
+        const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(this.key, this._isAltKeyRequired, this._isCtrlKeyRequired, this._isShiftKeyRequired);
+        return keyMapKey;
+    }
+    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
+    get item() {
+        return this._item;
+    }
+    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
+    itemPicked() {
+        if (this._shortcuts.areKeyboardShortcutsAvailable()) {
+            this._shortcuts.showShortcutsMenu();
+        }
+        else {
+            setTimeout(() => {
+                // istanbul ignore else
+                if (this._item)
+                    this._item.execute();
+            });
+        }
+    }
+    /** Gets the keyboard key */
+    get key() { return this._key; }
+    /** Gets whether the Alt key required. */
+    get isAltKeyRequired() { return this._isAltKeyRequired; }
+    /** Gets whether the Ctrl key required. */
+    get isCtrlKeyRequired() { return this._isCtrlKeyRequired; }
+    /** Gets whether the Shift key required. */
+    get isShiftKeyRequired() { return this._isShiftKeyRequired; }
+    /** Gets whether this is a Function key. */
+    get isFunctionKey() { return this._isFunctionKey; }
+    /** Gets whether this is a Special key. */
+    get isSpecialKey() { return this._isSpecialKey; }
+}
+exports.KeyboardShortcut = KeyboardShortcut;
+/** Keyboard Shortcut Container
+ * @public
+ */
+class KeyboardShortcutContainer {
+    constructor() {
+        this._keyMap = new Map();
+        this._keyArray = new Array();
+    }
+    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
+    registerKey(keyMapKey, inShortcut) {
+        let shortcut;
+        if ((shortcut = this.findKey(keyMapKey)) === undefined) {
+            shortcut = inShortcut;
+            this._keyArray.push(shortcut);
+        }
+        else {
+            const index = this._keyArray.findIndex((value) => {
+                return value.keyMapKey === keyMapKey;
+            });
+            // istanbul ignore else
+            if (index >= 0) {
+                shortcut = inShortcut;
+                this._keyArray[index] = shortcut;
+            }
+        }
+        // istanbul ignore else
+        if (shortcut)
+            this._keyMap.set(keyMapKey, shortcut);
+        return shortcut;
+    }
+    /** Finds a Keyboard Shortcut associated with a given key */
+    findKey(keyMapKey) {
+        return this._keyMap.get(keyMapKey);
+    }
+    /** Determines if any Keyboard Shortcuts are available in this container */
+    areKeyboardShortcutsAvailable() {
+        return this._keyMap.size !== 0;
+    }
+    /** Empties any Keyboard Shortcuts from this container */
+    emptyData() {
+        this._keyMap.clear();
+        this._keyArray.length = 0;
+    }
+    getAvailableKeyboardShortcuts() {
+        return this._keyArray.slice();
+    }
+    /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */
+    static generateKeyMapKey(keyboardKey, isAltKeyRequired, isCtrlKeyRequired, isShiftKeyRequired) {
+        let keyMapKey = keyboardKey;
+        if (isAltKeyRequired)
+            keyMapKey = `Alt+${keyMapKey}`;
+        if (isShiftKeyRequired)
+            keyMapKey = `Shift+${keyMapKey}`;
+        if (isCtrlKeyRequired)
+            keyMapKey = `Ctrl+${keyMapKey}`;
+        return keyMapKey;
+    }
+    /** Displays a menu for the Keyboard Shortcuts in this container */
+    showShortcutsMenu() {
+        const offset = 8;
+        KeyboardShortcutMenu_1.KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({
+            menuVisible: true,
+            menuX: UiFramework_1.UiFramework.keyboardShortcuts.cursorX - offset,
+            menuY: UiFramework_1.UiFramework.keyboardShortcuts.cursorY - offset,
+            shortcuts: this.getAvailableKeyboardShortcuts(),
+        });
+    }
+}
+exports.KeyboardShortcutContainer = KeyboardShortcutContainer;
+/** Keyboard Shortcut Manager
+ * @public
+ * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.
+ */
+class KeyboardShortcutManager {
+    /** Initialize the Keyboard Shortcut manager
+     * @deprecated in 3.7. This is called internally.
+    */
+    static initialize() {
+        InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.initialize();
+    }
+    /** Loads Keyboard Shortcuts into the managed list */
+    static loadKeyboardShortcuts(shortcutList) {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.loadShortcuts(shortcutList);
+    }
+    /** Loads a Keyboard Shortcut into the managed list */
+    static loadKeyboardShortcut(shortcutProps) {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.loadShortcut(shortcutProps);
+    }
+    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
+    static processKey(keyboardKey, isAltKeyPressed = false, isCtrlKeyPressed = false, isShiftKeyPressed = false) {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.processKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);
+    }
+    /** Returns the managed list of Keyboard Shortcuts */
+    static get shortcutContainer() {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.shortcutContainer;
+    }
+    /** Returns a Keyboard Shortcut from the managed lists */
+    static getShortcut(keyMapKey) {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.getShortcut(keyMapKey);
+    }
+    /** Determines if focus is set to Home */
+    static get isFocusOnHome() {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.isFocusOnHome;
+    }
+    /** Sets focus to Home */
+    static setFocusToHome() {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.setFocusToHome();
+    }
+    /** Displays the Keyboard Shortcuts menu at the cursor */
+    static displayShortcutsMenu() {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.displayMenu();
+    }
+    /** Closes the Keyboard Shortcuts menu */
+    static closeShortcutsMenu() {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.closeMenu();
+    }
+    /** Returns the cursor X position, which is mouseEvent.pageX. */
+    static get cursorX() { return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.cursorX; }
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    static get cursorY() { return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.cursorY; }
+}
+exports.KeyboardShortcutManager = KeyboardShortcutManager;
 //# sourceMappingURL=KeyboardShortcut.js.map

package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAmH;AACnH,mEAAgE;AAEhE,uDAAoD;AAEpD,gDAA6C;AAC7C,iEAA8D;AAC9D,2EAAwE;AAwBxE;;GAEG;AACH,MAAa,gBAAiB,SAAQ,yBAAW;IAY/C,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QAPP,sBAAiB,GAAY,KAAK,CAAC;QACnC,uBAAkB,GAAY,KAAK,CAAC;QACpC,wBAAmB,GAAY,KAAK,CAAC;QACrC,mBAAc,GAAY,KAAK,CAAC;QAChC,kBAAa,GAAY,KAAK,CAAC;QAKrC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC;QAEtB,IAAI,IAAI,CAAC,IAAI,IAAI,4BAAW;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,IAAI,IAAI,2BAAU;YACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAyB,EAAE,CAAC;QAElD,IAAI,KAAK,CAAC,IAAI,EAAE;YACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;YAExB,gDAAgD;YAChD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,KAAK;gBACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,OAAO;gBACf,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;gBAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;YAC1C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;SACvC;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE;YAC1B,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,UAAiC,EAAE,EAAE;gBAC5D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAClD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,IAAI,wBAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,uDAAuD,KAAK,CAAC,GAAG,QAAQ,CAAC,CAAC;SAC/H;QAED,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS;YACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAClD,IAAI,KAAK,CAAC,iBAAiB,KAAK,SAAS;YACvC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACpD,IAAI,KAAK,CAAC,kBAAkB,KAAK,SAAS;YACxC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACxD,CAAC;IAED,uCAAuC;IACvC,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAElD,qCAAqC;IACrC,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,wDAAwD;IACxD,IAAW,SAAS;QAClB,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACnJ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,wEAAwE;IACxE,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,uFAAuF;IAChF,UAAU;QACf,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;aAAM;YACL,UAAU,CAAC,GAAG,EAAE;gBACd,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK;oBACZ,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAW,GAAG,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,yCAAyC;IACzC,IAAW,gBAAgB,KAAc,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACzE,0CAA0C;IAC1C,IAAW,iBAAiB,KAAc,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3E,2CAA2C;IAC3C,IAAW,kBAAkB,KAAc,OAAO,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC7E,2CAA2C;IAC3C,IAAW,aAAa,KAAc,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IACnE,0CAA0C;IAC1C,IAAW,YAAY,KAAc,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;CAElE;AAzGD,4CAyGC;AAED;;GAEG;AACH,MAAa,yBAAyB;IAAtC;QACU,YAAO,GAAkC,IAAI,GAAG,EAA4B,CAAC;QAC7E,cAAS,GAAuB,IAAI,KAAK,EAAoB,CAAC;IAuExE,CAAC;IArEC,oFAAoF;IAC7E,WAAW,CAAC,SAAiB,EAAE,UAA4B;QAChE,IAAI,QAAsC,CAAC;QAE3C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,SAAS,EAAE;YACtD,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC/B;aAAM;YACL,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,KAAuB,EAAE,EAAE;gBACjE,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACvC,CAAC,CAAC,CAAC;YACH,uBAAuB;YACvB,IAAI,KAAK,IAAI,CAAC,EAAE;gBACd,QAAQ,GAAG,UAAU,CAAC;gBACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;aAClC;SACF;QAED,uBAAuB;QACvB,IAAI,QAAQ;YACV,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAExC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4DAA4D;IACrD,OAAO,CAAC,SAAiB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,2EAA2E;IACpE,6BAA6B;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,yDAAyD;IAClD,SAAS;QACd,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5B,CAAC;IAEM,6BAA6B;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,iBAAiB,CAAC,WAAmB,EAAE,gBAAyB,EAAE,iBAA0B,EAAE,kBAA2B;QACrI,IAAI,SAAS,GAAG,WAAW,CAAC;QAE5B,IAAI,gBAAgB;YAClB,SAAS,GAAG,OAAO,SAAS,EAAE,CAAC;QACjC,IAAI,kBAAkB;YACpB,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;QACnC,IAAI,iBAAiB;YACnB,SAAS,GAAG,QAAQ,SAAS,EAAE,CAAC;QAElC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mEAAmE;IAC5D,iBAAiB;QACtB,MAAM,MAAM,GAAG,CAAC,CAAC;QACjB,2CAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,uBAAuB,CAAC,OAAO,GAAG,MAAM;YAC/C,KAAK,EAAE,uBAAuB,CAAC,OAAO,GAAG,MAAM;YAC/C,SAAS,EAAE,IAAI,CAAC,6BAA6B,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAzED,8DAyEC;AAID;;GAEG;AACH,MAAa,uBAAuB;IAIlC,+CAA+C;IACxC,MAAM,CAAC,UAAU;QACtB,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC;IAC9F,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,qBAAqB,CAAC,YAAqC;QACvE,YAAY,CAAC,OAAO,CAAC,CAAC,aAAoC,EAAE,EAAE;YAC5D,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,oBAAoB,CAAC,aAAoC;QACrE,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,qEAAqE;IAC9D,MAAM,CAAC,UAAU,CAAC,WAAmB,EAAE,kBAA2B,KAAK,EAAE,mBAA4B,KAAK,EAAE,oBAA6B,KAAK;QACnJ,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAAC,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;QAEjI,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,iBAAiB;QACjC,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,yCAAyC;IAClC,MAAM,KAAK,aAAa;QAC7B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,OAAO,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,CAAC;IAC9C,CAAC;IAED,yBAAyB;IAClB,MAAM,CAAC,cAAc;QAC1B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,IAAI,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,EAAE;YACxC,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;SACvB;IACH,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,oBAAoB;QAChC,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;IACH,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB;QAC9B,2CAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,SAAS;SACrB,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,qCAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,qCAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;;AAhF3E,0DA4GC;AA1GgB,kCAAU,GAA8B,IAAI,yBAAyB,EAAE,CAAC;AAgFxE,0CAAkB,GAAG,CAAC,IAAqB,EAAE,EAAE;IAC5D,MAAM,kBAAkB,GAAG,CAAC,YAAqC,EAAE,EAAE;QACnE,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,YAAY,CAAC;YACpF,YAAY,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CAAC,QAA0B,EAAE,EAAE;QACtD,IAAI,QAAQ,CAAC,UAAU,YAAY,wCAAuB;YACxD,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,QAAQ,YAAY,wCAAuB;YACtD,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,uBAAuB,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,gBAAgB,CAAC,CAAC;AACnI,CAAC,CAAC;AAEa,0CAAkB,GAAG,CAAC,SAA6B,EAAE,QAAwB,EAAE,EAAE;IAC9F,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,EAAE;QAC/C,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEnB,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE;YAC9D,MAAM,cAAc,GAAG,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAClF,uBAAuB,CAAC,kBAAkB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;SACtE;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module KeyboardShortcut\r\n */\r\n\r\nimport { ConditionalBooleanValue, FunctionKey, SpecialKey, UiError, UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { CursorInformation } from \"../cursor/CursorInformation\";\r\nimport { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\r\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\r\nimport { ItemProps } from \"../shared/ItemProps\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\n\r\n/** Properties for a Keyboard Shortcut\r\n * @public\r\n */\r\nexport interface KeyboardShortcutProps extends ItemProps {\r\n  /** The key that invokes the shortcut.\r\n   * This is either an alphanumeric key, a function key or a special key.\r\n   */\r\n  key: string | FunctionKey | SpecialKey;\r\n\r\n  /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */\r\n  item?: ActionButtonItemDef;\r\n  /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */\r\n  shortcuts?: KeyboardShortcutProps[];\r\n\r\n  /** Indicates whether the Alt key required. Default - false */\r\n  isAltKeyRequired?: boolean;\r\n  /** Indicates whether the Ctrl key required. Default - false */\r\n  isCtrlKeyRequired?: boolean;\r\n  /** Indicates whether the Shift key required. Default - false */\r\n  isShiftKeyRequired?: boolean;\r\n}\r\n\r\n/** Keyboard Shortcut used to execute an action\r\n * @public\r\n */\r\nexport class KeyboardShortcut extends ItemDefBase {\r\n\r\n  private _key: string;\r\n  private _item?: ActionButtonItemDef;\r\n  private _shortcuts: KeyboardShortcutContainer;\r\n\r\n  private _isAltKeyRequired: boolean = false;\r\n  private _isCtrlKeyRequired: boolean = false;\r\n  private _isShiftKeyRequired: boolean = false;\r\n  private _isFunctionKey: boolean = false;\r\n  private _isSpecialKey: boolean = false;\r\n\r\n  constructor(props: KeyboardShortcutProps) {\r\n    super(props);\r\n\r\n    this._key = props.key;\r\n\r\n    if (this._key in FunctionKey)\r\n      this._isFunctionKey = true;\r\n    if (this._key in SpecialKey)\r\n      this._isSpecialKey = true;\r\n\r\n    this._shortcuts = new KeyboardShortcutContainer();\r\n\r\n    if (props.item) {\r\n      this._item = props.item;\r\n\r\n      // Copy over icon, label & tooltip from the item\r\n      if (!this.iconSpec)\r\n        this.iconSpec = this._item.iconSpec;\r\n      if (!this.label)\r\n        this.setLabel(this._item.label);\r\n      if (!this.tooltip)\r\n        this.setTooltip(this._item.tooltip);\r\n      if (this.isDisabled === undefined)\r\n        this.isDisabled = this._item.isDisabled;\r\n      if (this.isHidden === undefined)\r\n        this.isHidden = this._item.isHidden;\r\n    } else if (props.shortcuts) {\r\n      props.shortcuts.forEach((childProps: KeyboardShortcutProps) => {\r\n        const shortcut = new KeyboardShortcut(childProps);\r\n        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\r\n      });\r\n    } else {\r\n      throw new UiError(UiFramework.loggerCategory(this), `Either 'item' or 'shortcuts' must be specified for '${props.key}' key.`);\r\n    }\r\n\r\n    if (props.isAltKeyRequired !== undefined)\r\n      this._isAltKeyRequired = props.isAltKeyRequired;\r\n    if (props.isCtrlKeyRequired !== undefined)\r\n      this._isCtrlKeyRequired = props.isCtrlKeyRequired;\r\n    if (props.isShiftKeyRequired !== undefined)\r\n      this._isShiftKeyRequired = props.isShiftKeyRequired;\r\n  }\r\n\r\n  /** Returns the id for this shortcut */\r\n  public get id(): string { return this.keyMapKey; }\r\n\r\n  /** Returns the shortcut container */\r\n  public get shortcutContainer(): KeyboardShortcutContainer {\r\n    return this._shortcuts;\r\n  }\r\n\r\n  /** Finds a shortcut with a given key in the shortcut's container */\r\n  public getShortcut(mapKey: string): KeyboardShortcut | undefined {\r\n    return this._shortcuts.findKey(mapKey);\r\n  }\r\n\r\n  /** Returns the shortcut's key map key used as the id */\r\n  public get keyMapKey(): string {\r\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(this.key, this._isAltKeyRequired, this._isCtrlKeyRequired, this._isShiftKeyRequired);\r\n    return keyMapKey;\r\n  }\r\n\r\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\r\n  public get item(): ActionButtonItemDef | undefined {\r\n    return this._item;\r\n  }\r\n\r\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\r\n  public itemPicked(): void {\r\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\r\n      this._shortcuts.showShortcutsMenu();\r\n    } else {\r\n      setTimeout(() => {\r\n        // istanbul ignore else\r\n        if (this._item)\r\n          this._item.execute();\r\n      });\r\n    }\r\n  }\r\n\r\n  /** Gets the keyboard key */\r\n  public get key(): string { return this._key; }\r\n  /** Gets whether the Alt key required. */\r\n  public get isAltKeyRequired(): boolean { return this._isAltKeyRequired; }\r\n  /** Gets whether the Ctrl key required. */\r\n  public get isCtrlKeyRequired(): boolean { return this._isCtrlKeyRequired; }\r\n  /** Gets whether the Shift key required. */\r\n  public get isShiftKeyRequired(): boolean { return this._isShiftKeyRequired; }\r\n  /** Gets whether this is a Function key. */\r\n  public get isFunctionKey(): boolean { return this._isFunctionKey; }\r\n  /** Gets whether this is a Special key. */\r\n  public get isSpecialKey(): boolean { return this._isSpecialKey; }\r\n\r\n}\r\n\r\n/** Keyboard Shortcut Container\r\n * @public\r\n */\r\nexport class KeyboardShortcutContainer {\r\n  private _keyMap: Map<string, KeyboardShortcut> = new Map<string, KeyboardShortcut>();\r\n  private _keyArray: KeyboardShortcut[] = new Array<KeyboardShortcut>();\r\n\r\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\r\n  public registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined {\r\n    let shortcut: KeyboardShortcut | undefined;\r\n\r\n    if ((shortcut = this.findKey(keyMapKey)) === undefined) {\r\n      shortcut = inShortcut;\r\n      this._keyArray.push(shortcut);\r\n    } else {\r\n      const index = this._keyArray.findIndex((value: KeyboardShortcut) => {\r\n        return value.keyMapKey === keyMapKey;\r\n      });\r\n      // istanbul ignore else\r\n      if (index >= 0) {\r\n        shortcut = inShortcut;\r\n        this._keyArray[index] = shortcut;\r\n      }\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (shortcut)\r\n      this._keyMap.set(keyMapKey, shortcut);\r\n\r\n    return shortcut;\r\n  }\r\n\r\n  /** Finds a Keyboard Shortcut associated with a given key */\r\n  public findKey(keyMapKey: string): KeyboardShortcut | undefined {\r\n    return this._keyMap.get(keyMapKey);\r\n  }\r\n\r\n  /** Determines if any Keyboard Shortcuts are available in this container */\r\n  public areKeyboardShortcutsAvailable(): boolean {\r\n    return this._keyMap.size !== 0;\r\n  }\r\n\r\n  /** Empties any Keyboard Shortcuts from this container */\r\n  public emptyData(): void {\r\n    this._keyMap.clear();\r\n    this._keyArray.length = 0;\r\n  }\r\n\r\n  public getAvailableKeyboardShortcuts(): KeyboardShortcut[] {\r\n    return this._keyArray.slice();\r\n  }\r\n\r\n  /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */\r\n  public static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string {\r\n    let keyMapKey = keyboardKey;\r\n\r\n    if (isAltKeyRequired)\r\n      keyMapKey = `Alt+${keyMapKey}`;\r\n    if (isShiftKeyRequired)\r\n      keyMapKey = `Shift+${keyMapKey}`;\r\n    if (isCtrlKeyRequired)\r\n      keyMapKey = `Ctrl+${keyMapKey}`;\r\n\r\n    return keyMapKey;\r\n  }\r\n\r\n  /** Displays a menu for the Keyboard Shortcuts in this container */\r\n  public showShortcutsMenu() {\r\n    const offset = 8;\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\r\n      menuVisible: true,\r\n      menuX: KeyboardShortcutManager.cursorX - offset,\r\n      menuY: KeyboardShortcutManager.cursorY - offset,\r\n      shortcuts: this.getAvailableKeyboardShortcuts(),\r\n    });\r\n  }\r\n}\r\n\r\ntype OnShortcutFunc = (shortcut: KeyboardShortcut) => void;\r\n\r\n/** Keyboard Shortcut Manager\r\n * @public\r\n */\r\nexport class KeyboardShortcutManager {\r\n\r\n  private static _shortcuts: KeyboardShortcutContainer = new KeyboardShortcutContainer();\r\n\r\n  /** Initialize the Keyboard Shortcut manager */\r\n  public static initialize(): void {\r\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(KeyboardShortcutManager._handleSyncUiEvent);\r\n  }\r\n\r\n  /** Loads Keyboard Shortcuts into the managed list */\r\n  public static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]) {\r\n    shortcutList.forEach((shortcutProps: KeyboardShortcutProps) => {\r\n      this.loadKeyboardShortcut(shortcutProps);\r\n    });\r\n  }\r\n\r\n  /** Loads a Keyboard Shortcut into the managed list */\r\n  public static loadKeyboardShortcut(shortcutProps: KeyboardShortcutProps) {\r\n    const shortcut = new KeyboardShortcut(shortcutProps);\r\n    this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\r\n  }\r\n\r\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\r\n  public static processKey(keyboardKey: string, isAltKeyPressed: boolean = false, isCtrlKeyPressed: boolean = false, isShiftKeyPressed: boolean = false): boolean {\r\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);\r\n\r\n    const shortcut = this.getShortcut(keyMapKey);\r\n    if (shortcut) {\r\n      shortcut.itemPicked();\r\n      return true;\r\n    }\r\n\r\n    return false;\r\n  }\r\n\r\n  /** Returns the managed list of Keyboard Shortcuts */\r\n  public static get shortcutContainer(): KeyboardShortcutContainer {\r\n    return this._shortcuts;\r\n  }\r\n\r\n  /** Returns a Keyboard Shortcut from the managed lists */\r\n  public static getShortcut(keyMapKey: string): KeyboardShortcut | undefined {\r\n    return this._shortcuts.findKey(keyMapKey);\r\n  }\r\n\r\n  /** Determines if focus is set to Home */\r\n  public static get isFocusOnHome(): boolean {\r\n    const element = document.activeElement as HTMLElement;\r\n    return element && element === document.body;\r\n  }\r\n\r\n  /** Sets focus to Home */\r\n  public static setFocusToHome(): void {\r\n    const element = document.activeElement as HTMLElement;\r\n    if (element && element !== document.body) {\r\n      element.blur();\r\n      document.body.focus();\r\n    }\r\n  }\r\n\r\n  /** Displays the Keyboard Shortcuts menu at the cursor */\r\n  public static displayShortcutsMenu(): void {\r\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\r\n      this._shortcuts.showShortcutsMenu();\r\n    }\r\n  }\r\n\r\n  /** Closes the Keyboard Shortcuts menu */\r\n  public static closeShortcutsMenu(): void {\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\r\n      menuVisible: false,\r\n      menuX: 0,\r\n      menuY: 0,\r\n      shortcuts: undefined,\r\n    });\r\n  }\r\n\r\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\r\n  public static get cursorX(): number { return CursorInformation.cursorX; }\r\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\r\n  public static get cursorY(): number { return CursorInformation.cursorY; }\r\n\r\n  private static _handleSyncUiEvent = (args: UiSyncEventArgs) => {\r\n    const updateBooleanValue = (booleanValue: ConditionalBooleanValue) => {\r\n      if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))\r\n        booleanValue.refresh();\r\n    };\r\n    const handleForSyncIds = (shortcut: KeyboardShortcut) => {\r\n      if (shortcut.isDisabled instanceof ConditionalBooleanValue)\r\n        updateBooleanValue(shortcut.isDisabled);\r\n      if (shortcut.isHidden instanceof ConditionalBooleanValue)\r\n        updateBooleanValue(shortcut.isHidden);\r\n    };\r\n\r\n    KeyboardShortcutManager._traverseShortcuts(KeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(), handleForSyncIds);\r\n  };\r\n\r\n  private static _traverseShortcuts = (shortcuts: KeyboardShortcut[], callback: OnShortcutFunc) => {\r\n    shortcuts.forEach((shortcut: KeyboardShortcut) => {\r\n      callback(shortcut);\r\n\r\n      if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\r\n        const childShortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\r\n        KeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);\r\n      }\r\n    });\r\n  };\r\n\r\n}\r\n"]}
+{"version":3,"file":"KeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAyE;AAEzE,uDAAoD;AAEpD,gDAA6C;AAC7C,iEAA8D;AAC9D,yEAAyF;AAEzF;;GAEG;AACH,MAAa,gBAAiB,SAAQ,yBAAW;IAY/C,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QAPP,sBAAiB,GAAY,KAAK,CAAC;QACnC,uBAAkB,GAAY,KAAK,CAAC;QACpC,wBAAmB,GAAY,KAAK,CAAC;QACrC,mBAAc,GAAY,KAAK,CAAC;QAChC,kBAAa,GAAY,KAAK,CAAC;QAKrC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC;QAEtB,IAAI,IAAI,CAAC,IAAI,IAAI,4BAAW;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,IAAI,IAAI,2BAAU;YACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAyB,EAAE,CAAC;QAElD,IAAI,KAAK,CAAC,IAAI,EAAE;YACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;YAExB,gDAAgD;YAChD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,KAAK;gBACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,OAAO;gBACf,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;gBAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;YAC1C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;SACvC;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE;YAC1B,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,UAAiC,EAAE,EAAE;gBAC5D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAClD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,IAAI,wBAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,uDAAuD,KAAK,CAAC,GAAG,QAAQ,CAAC,CAAC;SAC/H;QAED,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS;YACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAClD,IAAI,KAAK,CAAC,iBAAiB,KAAK,SAAS;YACvC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACpD,IAAI,KAAK,CAAC,kBAAkB,KAAK,SAAS;YACxC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACxD,CAAC;IAED,uCAAuC;IACvC,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAElD,qCAAqC;IACrC,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,wDAAwD;IACxD,IAAW,SAAS;QAClB,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACnJ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,wEAAwE;IACxE,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,uFAAuF;IAChF,UAAU;QACf,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;aAAM;YACL,UAAU,CAAC,GAAG,EAAE;gBACd,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK;oBACZ,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAW,GAAG,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,yCAAyC;IACzC,IAAW,gBAAgB,KAAc,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACzE,0CAA0C;IAC1C,IAAW,iBAAiB,KAAc,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3E,2CAA2C;IAC3C,IAAW,kBAAkB,KAAc,OAAO,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC7E,2CAA2C;IAC3C,IAAW,aAAa,KAAc,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IACnE,0CAA0C;IAC1C,IAAW,YAAY,KAAc,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;CAElE;AAzGD,4CAyGC;AAED;;GAEG;AACH,MAAa,yBAAyB;IAAtC;QACU,YAAO,GAAkC,IAAI,GAAG,EAA4B,CAAC;QAC7E,cAAS,GAAuB,IAAI,KAAK,EAAoB,CAAC;IAuExE,CAAC;IArEC,oFAAoF;IAC7E,WAAW,CAAC,SAAiB,EAAE,UAA4B;QAChE,IAAI,QAAsC,CAAC;QAE3C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,SAAS,EAAE;YACtD,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC/B;aAAM;YACL,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,KAAuB,EAAE,EAAE;gBACjE,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACvC,CAAC,CAAC,CAAC;YACH,uBAAuB;YACvB,IAAI,KAAK,IAAI,CAAC,EAAE;gBACd,QAAQ,GAAG,UAAU,CAAC;gBACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;aAClC;SACF;QAED,uBAAuB;QACvB,IAAI,QAAQ;YACV,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAExC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4DAA4D;IACrD,OAAO,CAAC,SAAiB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,2EAA2E;IACpE,6BAA6B;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,yDAAyD;IAClD,SAAS;QACd,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5B,CAAC;IAEM,6BAA6B;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,iBAAiB,CAAC,WAAmB,EAAE,gBAAyB,EAAE,iBAA0B,EAAE,kBAA2B;QACrI,IAAI,SAAS,GAAG,WAAW,CAAC;QAE5B,IAAI,gBAAgB;YAClB,SAAS,GAAG,OAAO,SAAS,EAAE,CAAC;QACjC,IAAI,kBAAkB;YACpB,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;QACnC,IAAI,iBAAiB;YACnB,SAAS,GAAG,QAAQ,SAAS,EAAE,CAAC;QAElC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mEAAmE;IAC5D,iBAAiB;QACtB,MAAM,MAAM,GAAG,CAAC,CAAC;QACjB,2CAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,yBAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,KAAK,EAAE,yBAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,SAAS,EAAE,IAAI,CAAC,6BAA6B,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAzED,8DAyEC;AAED;;;GAGG;AACH,MAAa,uBAAuB;IAClC;;MAEE;IACK,MAAM,CAAC,UAAU;QACtB,0DAAQ,CAAC,UAAU,EAAE,CAAC;IACxB,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,qBAAqB,CAAC,YAAqC;QACvE,OAAO,0DAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,oBAAoB,CAAC,aAAoC;QACrE,OAAO,0DAAQ,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAC9C,CAAC;IAED,qEAAqE;IAC9D,MAAM,CAAC,UAAU,CAAC,WAAmB,EAAE,kBAA2B,KAAK,EAAE,mBAA4B,KAAK,EAAE,oBAA6B,KAAK;QACnJ,OAAO,0DAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;IAChG,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,iBAAiB;QACjC,OAAO,0DAAQ,CAAC,iBAAiB,CAAC;IACpC,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,OAAO,0DAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,yCAAyC;IAClC,MAAM,KAAK,aAAa;QAC7B,OAAO,0DAAQ,CAAC,aAAa,CAAC;IAChC,CAAC;IAED,yBAAyB;IAClB,MAAM,CAAC,cAAc;QAC1B,OAAO,0DAAQ,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,oBAAoB;QAChC,OAAO,0DAAQ,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB;QAC9B,OAAO,0DAAQ,CAAC,SAAS,EAAE,CAAC;IAC9B,CAAC;IAED,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,0DAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,0DAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CACjE;AAzDD,0DAyDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module KeyboardShortcut\n */\n\nimport { FunctionKey, SpecialKey, UiError } from \"@itwin/appui-abstract\";\nimport { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\nimport { KeyboardShortcutProps } from \"../framework/FrameworkKeyboardShortcuts\";\nimport { UiFramework } from \"../UiFramework\";\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\nimport { InternalKeyboardShortcutManager as internal } from \"./InternalKeyboardShortcut\";\n\n/** Keyboard Shortcut used to execute an action\n * @public\n */\nexport class KeyboardShortcut extends ItemDefBase {\n\n  private _key: string;\n  private _item?: ActionButtonItemDef;\n  private _shortcuts: KeyboardShortcutContainer;\n\n  private _isAltKeyRequired: boolean = false;\n  private _isCtrlKeyRequired: boolean = false;\n  private _isShiftKeyRequired: boolean = false;\n  private _isFunctionKey: boolean = false;\n  private _isSpecialKey: boolean = false;\n\n  constructor(props: KeyboardShortcutProps) {\n    super(props);\n\n    this._key = props.key;\n\n    if (this._key in FunctionKey)\n      this._isFunctionKey = true;\n    if (this._key in SpecialKey)\n      this._isSpecialKey = true;\n\n    this._shortcuts = new KeyboardShortcutContainer();\n\n    if (props.item) {\n      this._item = props.item;\n\n      // Copy over icon, label & tooltip from the item\n      if (!this.iconSpec)\n        this.iconSpec = this._item.iconSpec;\n      if (!this.label)\n        this.setLabel(this._item.label);\n      if (!this.tooltip)\n        this.setTooltip(this._item.tooltip);\n      if (this.isDisabled === undefined)\n        this.isDisabled = this._item.isDisabled;\n      if (this.isHidden === undefined)\n        this.isHidden = this._item.isHidden;\n    } else if (props.shortcuts) {\n      props.shortcuts.forEach((childProps: KeyboardShortcutProps) => {\n        const shortcut = new KeyboardShortcut(childProps);\n        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\n      });\n    } else {\n      throw new UiError(UiFramework.loggerCategory(this), `Either 'item' or 'shortcuts' must be specified for '${props.key}' key.`);\n    }\n\n    if (props.isAltKeyRequired !== undefined)\n      this._isAltKeyRequired = props.isAltKeyRequired;\n    if (props.isCtrlKeyRequired !== undefined)\n      this._isCtrlKeyRequired = props.isCtrlKeyRequired;\n    if (props.isShiftKeyRequired !== undefined)\n      this._isShiftKeyRequired = props.isShiftKeyRequired;\n  }\n\n  /** Returns the id for this shortcut */\n  public get id(): string { return this.keyMapKey; }\n\n  /** Returns the shortcut container */\n  public get shortcutContainer(): KeyboardShortcutContainer {\n    return this._shortcuts;\n  }\n\n  /** Finds a shortcut with a given key in the shortcut's container */\n  public getShortcut(mapKey: string): KeyboardShortcut | undefined {\n    return this._shortcuts.findKey(mapKey);\n  }\n\n  /** Returns the shortcut's key map key used as the id */\n  public get keyMapKey(): string {\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(this.key, this._isAltKeyRequired, this._isCtrlKeyRequired, this._isShiftKeyRequired);\n    return keyMapKey;\n  }\n\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\n  public get item(): ActionButtonItemDef | undefined {\n    return this._item;\n  }\n\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\n  public itemPicked(): void {\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\n      this._shortcuts.showShortcutsMenu();\n    } else {\n      setTimeout(() => {\n        // istanbul ignore else\n        if (this._item)\n          this._item.execute();\n      });\n    }\n  }\n\n  /** Gets the keyboard key */\n  public get key(): string { return this._key; }\n  /** Gets whether the Alt key required. */\n  public get isAltKeyRequired(): boolean { return this._isAltKeyRequired; }\n  /** Gets whether the Ctrl key required. */\n  public get isCtrlKeyRequired(): boolean { return this._isCtrlKeyRequired; }\n  /** Gets whether the Shift key required. */\n  public get isShiftKeyRequired(): boolean { return this._isShiftKeyRequired; }\n  /** Gets whether this is a Function key. */\n  public get isFunctionKey(): boolean { return this._isFunctionKey; }\n  /** Gets whether this is a Special key. */\n  public get isSpecialKey(): boolean { return this._isSpecialKey; }\n\n}\n\n/** Keyboard Shortcut Container\n * @public\n */\nexport class KeyboardShortcutContainer {\n  private _keyMap: Map<string, KeyboardShortcut> = new Map<string, KeyboardShortcut>();\n  private _keyArray: KeyboardShortcut[] = new Array<KeyboardShortcut>();\n\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\n  public registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined {\n    let shortcut: KeyboardShortcut | undefined;\n\n    if ((shortcut = this.findKey(keyMapKey)) === undefined) {\n      shortcut = inShortcut;\n      this._keyArray.push(shortcut);\n    } else {\n      const index = this._keyArray.findIndex((value: KeyboardShortcut) => {\n        return value.keyMapKey === keyMapKey;\n      });\n      // istanbul ignore else\n      if (index >= 0) {\n        shortcut = inShortcut;\n        this._keyArray[index] = shortcut;\n      }\n    }\n\n    // istanbul ignore else\n    if (shortcut)\n      this._keyMap.set(keyMapKey, shortcut);\n\n    return shortcut;\n  }\n\n  /** Finds a Keyboard Shortcut associated with a given key */\n  public findKey(keyMapKey: string): KeyboardShortcut | undefined {\n    return this._keyMap.get(keyMapKey);\n  }\n\n  /** Determines if any Keyboard Shortcuts are available in this container */\n  public areKeyboardShortcutsAvailable(): boolean {\n    return this._keyMap.size !== 0;\n  }\n\n  /** Empties any Keyboard Shortcuts from this container */\n  public emptyData(): void {\n    this._keyMap.clear();\n    this._keyArray.length = 0;\n  }\n\n  public getAvailableKeyboardShortcuts(): KeyboardShortcut[] {\n    return this._keyArray.slice();\n  }\n\n  /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */\n  public static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string {\n    let keyMapKey = keyboardKey;\n\n    if (isAltKeyRequired)\n      keyMapKey = `Alt+${keyMapKey}`;\n    if (isShiftKeyRequired)\n      keyMapKey = `Shift+${keyMapKey}`;\n    if (isCtrlKeyRequired)\n      keyMapKey = `Ctrl+${keyMapKey}`;\n\n    return keyMapKey;\n  }\n\n  /** Displays a menu for the Keyboard Shortcuts in this container */\n  public showShortcutsMenu() {\n    const offset = 8;\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\n      menuVisible: true,\n      menuX: UiFramework.keyboardShortcuts.cursorX - offset,\n      menuY: UiFramework.keyboardShortcuts.cursorY - offset,\n      shortcuts: this.getAvailableKeyboardShortcuts(),\n    });\n  }\n}\n\n/** Keyboard Shortcut Manager\n * @public\n * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.\n */\nexport class KeyboardShortcutManager {\n  /** Initialize the Keyboard Shortcut manager\n   * @deprecated in 3.7. This is called internally.\n  */\n  public static initialize(): void {\n    internal.initialize();\n  }\n\n  /** Loads Keyboard Shortcuts into the managed list */\n  public static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]) {\n    return internal.loadShortcuts(shortcutList);\n  }\n\n  /** Loads a Keyboard Shortcut into the managed list */\n  public static loadKeyboardShortcut(shortcutProps: KeyboardShortcutProps) {\n    return internal.loadShortcut(shortcutProps);\n  }\n\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\n  public static processKey(keyboardKey: string, isAltKeyPressed: boolean = false, isCtrlKeyPressed: boolean = false, isShiftKeyPressed: boolean = false): boolean {\n    return internal.processKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);\n  }\n\n  /** Returns the managed list of Keyboard Shortcuts */\n  public static get shortcutContainer(): KeyboardShortcutContainer {\n    return internal.shortcutContainer;\n  }\n\n  /** Returns a Keyboard Shortcut from the managed lists */\n  public static getShortcut(keyMapKey: string): KeyboardShortcut | undefined {\n    return internal.getShortcut(keyMapKey);\n  }\n\n  /** Determines if focus is set to Home */\n  public static get isFocusOnHome(): boolean {\n    return internal.isFocusOnHome;\n  }\n\n  /** Sets focus to Home */\n  public static setFocusToHome(): void {\n    return internal.setFocusToHome();\n  }\n\n  /** Displays the Keyboard Shortcuts menu at the cursor */\n  public static displayShortcutsMenu(): void {\n    return internal.displayMenu();\n  }\n\n  /** Closes the Keyboard Shortcuts menu */\n  public static closeShortcutsMenu(): void {\n    return internal.closeMenu();\n  }\n\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\n  public static get cursorX(): number { return internal.cursorX; }\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\n  public static get cursorY(): number { return internal.cursorY; }\n}\n\n"]}