@itwin/appui-react 3.7.2 → 3.7.3

package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.d.ts

@@ -1,97 +1,97 @@
-/** @packageDocumentation
- * @module KeyboardShortcut
- */
-import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
-import { ItemDefBase } from "../shared/ItemDefBase";
-import { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
-/** Keyboard Shortcut used to execute an action
- * @public
- */
-export declare class KeyboardShortcut extends ItemDefBase {
-    private _key;
-    private _item?;
-    private _shortcuts;
-    private _isAltKeyRequired;
-    private _isCtrlKeyRequired;
-    private _isShiftKeyRequired;
-    private _isFunctionKey;
-    private _isSpecialKey;
-    constructor(props: KeyboardShortcutProps);
-    /** Returns the id for this shortcut */
-    get id(): string;
-    /** Returns the shortcut container */
-    get shortcutContainer(): KeyboardShortcutContainer;
-    /** Finds a shortcut with a given key in the shortcut's container */
-    getShortcut(mapKey: string): KeyboardShortcut | undefined;
-    /** Returns the shortcut's key map key used as the id */
-    get keyMapKey(): string;
-    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
-    get item(): ActionButtonItemDef | undefined;
-    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
-    itemPicked(): void;
-    /** Gets the keyboard key */
-    get key(): string;
-    /** Gets whether the Alt key required. */
-    get isAltKeyRequired(): boolean;
-    /** Gets whether the Ctrl key required. */
-    get isCtrlKeyRequired(): boolean;
-    /** Gets whether the Shift key required. */
-    get isShiftKeyRequired(): boolean;
-    /** Gets whether this is a Function key. */
-    get isFunctionKey(): boolean;
-    /** Gets whether this is a Special key. */
-    get isSpecialKey(): boolean;
-}
-/** Keyboard Shortcut Container
- * @public
- */
-export declare class KeyboardShortcutContainer {
-    private _keyMap;
-    private _keyArray;
-    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
-    registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined;
-    /** Finds a Keyboard Shortcut associated with a given key */
-    findKey(keyMapKey: string): KeyboardShortcut | undefined;
-    /** Determines if any Keyboard Shortcuts are available in this container */
-    areKeyboardShortcutsAvailable(): boolean;
-    /** Empties any Keyboard Shortcuts from this container */
-    emptyData(): void;
-    getAvailableKeyboardShortcuts(): KeyboardShortcut[];
-    /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */
-    static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string;
-    /** Displays a menu for the Keyboard Shortcuts in this container */
-    showShortcutsMenu(): void;
-}
-/** Keyboard Shortcut Manager
- * @public
- * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.
- */
-export declare class KeyboardShortcutManager {
-    /** Initialize the Keyboard Shortcut manager
-     * @deprecated in 3.7. This is called internally.
-    */
-    static initialize(): void;
-    /** Loads Keyboard Shortcuts into the managed list */
-    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
-    /** Loads a Keyboard Shortcut into the managed list */
-    static loadKeyboardShortcut(shortcutProps: KeyboardShortcutProps): void;
-    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
-    static processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;
-    /** Returns the managed list of Keyboard Shortcuts */
-    static get shortcutContainer(): KeyboardShortcutContainer;
-    /** Returns a Keyboard Shortcut from the managed lists */
-    static getShortcut(keyMapKey: string): KeyboardShortcut | undefined;
-    /** Determines if focus is set to Home */
-    static get isFocusOnHome(): boolean;
-    /** Sets focus to Home */
-    static setFocusToHome(): void;
-    /** Displays the Keyboard Shortcuts menu at the cursor */
-    static displayShortcutsMenu(): void;
-    /** Closes the Keyboard Shortcuts menu */
-    static closeShortcutsMenu(): void;
-    /** Returns the cursor X position, which is mouseEvent.pageX. */
-    static get cursorX(): number;
-    /** Returns the cursor Y position, which is mouseEvent.pageY. */
-    static get cursorY(): number;
-}
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
+import { ItemDefBase } from "../shared/ItemDefBase";
+import { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
+/** Keyboard Shortcut used to execute an action
+ * @public
+ */
+export declare class KeyboardShortcut extends ItemDefBase {
+    private _key;
+    private _item?;
+    private _shortcuts;
+    private _isAltKeyRequired;
+    private _isCtrlKeyRequired;
+    private _isShiftKeyRequired;
+    private _isFunctionKey;
+    private _isSpecialKey;
+    constructor(props: KeyboardShortcutProps);
+    /** Returns the id for this shortcut */
+    get id(): string;
+    /** Returns the shortcut container */
+    get shortcutContainer(): KeyboardShortcutContainer;
+    /** Finds a shortcut with a given key in the shortcut's container */
+    getShortcut(mapKey: string): KeyboardShortcut | undefined;
+    /** Returns the shortcut's key map key used as the id */
+    get keyMapKey(): string;
+    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
+    get item(): ActionButtonItemDef | undefined;
+    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
+    itemPicked(): void;
+    /** Gets the keyboard key */
+    get key(): string;
+    /** Gets whether the Alt key required. */
+    get isAltKeyRequired(): boolean;
+    /** Gets whether the Ctrl key required. */
+    get isCtrlKeyRequired(): boolean;
+    /** Gets whether the Shift key required. */
+    get isShiftKeyRequired(): boolean;
+    /** Gets whether this is a Function key. */
+    get isFunctionKey(): boolean;
+    /** Gets whether this is a Special key. */
+    get isSpecialKey(): boolean;
+}
+/** Keyboard Shortcut Container
+ * @public
+ */
+export declare class KeyboardShortcutContainer {
+    private _keyMap;
+    private _keyArray;
+    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
+    registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined;
+    /** Finds a Keyboard Shortcut associated with a given key */
+    findKey(keyMapKey: string): KeyboardShortcut | undefined;
+    /** Determines if any Keyboard Shortcuts are available in this container */
+    areKeyboardShortcutsAvailable(): boolean;
+    /** Empties any Keyboard Shortcuts from this container */
+    emptyData(): void;
+    getAvailableKeyboardShortcuts(): KeyboardShortcut[];
+    /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */
+    static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string;
+    /** Displays a menu for the Keyboard Shortcuts in this container */
+    showShortcutsMenu(): void;
+}
+/** Keyboard Shortcut Manager
+ * @public
+ * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.
+ */
+export declare class KeyboardShortcutManager {
+    /** Initialize the Keyboard Shortcut manager
+     * @deprecated in 3.7. This is called internally.
+    */
+    static initialize(): void;
+    /** Loads Keyboard Shortcuts into the managed list */
+    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
+    /** Loads a Keyboard Shortcut into the managed list */
+    static loadKeyboardShortcut(shortcutProps: KeyboardShortcutProps): void;
+    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
+    static processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;
+    /** Returns the managed list of Keyboard Shortcuts */
+    static get shortcutContainer(): KeyboardShortcutContainer;
+    /** Returns a Keyboard Shortcut from the managed lists */
+    static getShortcut(keyMapKey: string): KeyboardShortcut | undefined;
+    /** Determines if focus is set to Home */
+    static get isFocusOnHome(): boolean;
+    /** Sets focus to Home */
+    static setFocusToHome(): void;
+    /** Displays the Keyboard Shortcuts menu at the cursor */
+    static displayShortcutsMenu(): void;
+    /** Closes the Keyboard Shortcuts menu */
+    static closeShortcutsMenu(): void;
+    /** Returns the cursor X position, which is mouseEvent.pageX. */
+    static get cursorX(): number;
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    static get cursorY(): number;
+}
 //# sourceMappingURL=KeyboardShortcut.d.ts.map

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

@@ -1,231 +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 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;
+"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