@itwin/appui-abstract 4.1.0-dev.4 → 4.1.0-dev.40

package/CHANGELOG.md

@@ -1,6 +1,25 @@
 # Change Log - @itwin/appui-abstract
 
-This log was last generated on Tue, 25 Apr 2023 17:50:35 GMT and should not be manually modified.
+This log was last generated on Mon, 22 May 2023 15:34:14 GMT and should not be manually modified.
+
+## 4.0.0
+Mon, 22 May 2023 15:34:14 GMT
+
+### Updates
+
+- Update to eslint@8
+- Promote `PropertyDescription.hideCompositePropertyLabel` to `@public`
+- Update @deprecated comments.
+
+## 3.7.6
+Mon, 15 May 2023 18:23:40 GMT
+
+_Version update only_
+
+## 3.7.5
+Thu, 04 May 2023 19:43:18 GMT
+
+_Version update only_
 
 ## 3.7.4
 Tue, 25 Apr 2023 17:50:35 GMT

package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts

@@ -0,0 +1,31 @@
+/** @packageDocumentation
+ * @module UiItemsProvider
+ */
+import { BackstageItem } from "./backstage/BackstageItem";
+import { CommonStatusBarItem } from "./statusbar/StatusBarItem";
+import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from "./toolbars/ToolbarItem";
+import { AbstractWidgetProps } from "./widget/AbstractWidgetProps";
+import { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
+import { UiItemsProvider } from "./UiItemsProvider";
+/** Base implementation of a UiItemsProvider. The base class allows the user to pass in a function that is used to determine if the
+ * active stage should be provided items. Derived provider classes should override the `xxxInternal` methods to provide items.
+ * @deprecated in 3.6. Use [BaseUiItemsProvider]($appui-react) instead.
+ * @public
+ */
+export declare class BaseUiItemsProvider implements UiItemsProvider {
+    protected _providerId: string;
+    isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider) => boolean) | undefined;
+    constructor(_providerId: string, isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider) => boolean) | undefined);
+    get id(): string;
+    onUnregister(): void;
+    unregister(): void;
+    /** Backstage items are not stage specific so no callback is used */
+    provideBackstageItems(): BackstageItem[];
+    provideToolbarButtonItemsInternal(_stageId: string, _stageUsage: string, _toolbarUsage: ToolbarUsage, _toolbarOrientation: ToolbarOrientation, _stageAppData?: any): CommonToolbarItem[];
+    provideToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[];
+    provideStatusBarItemsInternal(_stageId: string, _stageUsage: string, _stageAppData?: any): CommonStatusBarItem[];
+    provideStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[];
+    provideWidgetsInternal(_stageId: string, _stageUsage: string, _location: StagePanelLocation, _section?: StagePanelSection, _zoneLocation?: AbstractZoneLocation, _stageAppData?: any): AbstractWidgetProps[];
+    provideWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, _zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps>;
+}
+//# sourceMappingURL=BaseUiItemsProvider.d.ts.map

package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseUiItemsProvider.d.ts","sourceRoot":"","sources":["../../../src/appui-abstract/BaseUiItemsProvider.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAElG,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;;;GAIG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IAO7C,SAAS,CAAC,WAAW,EAAE,MAAM;IAAS,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,aAAa,eAAe,KAAK,OAAO;gBAA/I,WAAW,EAAE,MAAM,EAAS,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,aAAa,eAAe,KAAK,OAAO,aAAA;IAErK,IAAW,EAAE,IAAI,MAAM,CAA6B;IAC7C,YAAY,IAAI,IAAI;IAEpB,UAAU;IAIjB,oEAAoE;IAC7D,qBAAqB,IAAI,aAAa,EAAE;IAIxC,iCAAiC,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAGxL,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAY3K,6BAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAGhH,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAYrG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,QAAQ,CAAC,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,oBAAoB,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAI5M,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAClH,aAAa,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAWhG"}

package/lib/cjs/appui-abstract/BaseUiItemsProvider.js

@@ -0,0 +1,80 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module UiItemsProvider
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseUiItemsProvider = void 0;
+const StageUsage_1 = require("./items/StageUsage");
+const UiItemsManager_1 = require("./UiItemsManager");
+/** Base implementation of a UiItemsProvider. The base class allows the user to pass in a function that is used to determine if the
+ * active stage should be provided items. Derived provider classes should override the `xxxInternal` methods to provide items.
+ * @deprecated in 3.6. Use [BaseUiItemsProvider]($appui-react) instead.
+ * @public
+ */
+class BaseUiItemsProvider {
+    /*
+     * @param providerId - unique identifier for this instance of the provider. This is required in case separate packages want
+     * to set up custom stage with their own subset of standard tools.
+     * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and
+     * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.
+     */
+    constructor(_providerId, isSupportedStage) {
+        this._providerId = _providerId;
+        this.isSupportedStage = isSupportedStage;
+    }
+    get id() { return this._providerId; }
+    onUnregister() { }
+    unregister() {
+        UiItemsManager_1.UiItemsManager.unregister(this._providerId);
+    }
+    /** Backstage items are not stage specific so no callback is used */
+    provideBackstageItems() {
+        return [];
+    }
+    provideToolbarButtonItemsInternal(_stageId, _stageUsage, _toolbarUsage, _toolbarOrientation, _stageAppData) {
+        return [];
+    }
+    provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) {
+        let provideToStage = false;
+        if (this.isSupportedStage) {
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);
+        }
+        else {
+            provideToStage = (stageUsage === StageUsage_1.StageUsage.General);
+        }
+        return provideToStage ? this.provideToolbarButtonItemsInternal(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) : [];
+    }
+    provideStatusBarItemsInternal(_stageId, _stageUsage, _stageAppData) {
+        return [];
+    }
+    provideStatusBarItems(stageId, stageUsage, stageAppData) {
+        let provideToStage = false;
+        if (this.isSupportedStage) {
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);
+        }
+        else {
+            provideToStage = (stageUsage === StageUsage_1.StageUsage.General);
+        }
+        return provideToStage ? this.provideStatusBarItemsInternal(stageId, stageUsage, stageAppData) : [];
+    }
+    provideWidgetsInternal(_stageId, _stageUsage, _location, _section, _zoneLocation, _stageAppData) {
+        return [];
+    }
+    provideWidgets(stageId, stageUsage, location, section, _zoneLocation, stageAppData) {
+        let provideToStage = false;
+        if (this.isSupportedStage) {
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);
+        }
+        else {
+            provideToStage = (stageUsage === StageUsage_1.StageUsage.General);
+        }
+        return provideToStage ? this.provideWidgetsInternal(stageId, stageUsage, location, section, _zoneLocation, stageAppData) : [];
+    }
+}
+exports.BaseUiItemsProvider = BaseUiItemsProvider;
+//# sourceMappingURL=BaseUiItemsProvider.js.map

package/lib/cjs/appui-abstract/BaseUiItemsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseUiItemsProvider.js","sourceRoot":"","sources":["../../../src/appui-abstract/BaseUiItemsProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAOH,mDAAgD;AAEhD,qDAAkD;AAElD;;;;GAIG;AACH,MAAa,mBAAmB;IAC9B;;;;;OAKG;IACH,YAAsB,WAAmB,EAAS,gBAAmH;QAA/I,gBAAW,GAAX,WAAW,CAAQ;QAAS,qBAAgB,GAAhB,gBAAgB,CAAmG;IAAI,CAAC;IAE1K,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7C,YAAY,KAAW,CAAC;IAExB,UAAU;QACf,+BAAc,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED,oEAAoE;IAC7D,qBAAqB;QAC1B,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,iCAAiC,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAA2B,EAAE,mBAAuC,EAAE,aAAmB;QACvK,OAAO,EAAE,CAAC;IACZ,CAAC;IACM,yBAAyB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EAAE,kBAAsC,EAAE,YAAkB;QAC1J,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;SACjF;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,uBAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3I,CAAC;IAEM,6BAA6B,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAAmB;QAC7F,OAAO,EAAE,CAAC;IACZ,CAAC;IACM,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QAClF,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;SACjF;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,uBAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrG,CAAC;IAEM,sBAAsB,CAAC,QAAgB,EAAE,WAAmB,EAAE,SAA6B,EAAE,QAA4B,EAAE,aAAoC,EAAE,aAAmB;QACzL,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,cAAc,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAClH,aAAoC,EAAE,YAAkB;QACxD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;SACjF;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,uBAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAChI,CAAC;CACF;AAnED,kDAmEC","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/* eslint-disable deprecation/deprecation */\n/** @packageDocumentation\n * @module UiItemsProvider\n */\n\nimport { BackstageItem } from \"./backstage/BackstageItem\";\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\nimport { StageUsage } from \"./items/StageUsage\";\nimport { UiItemsProvider } from \"./UiItemsProvider\";\nimport { UiItemsManager } from \"./UiItemsManager\";\n\n/** Base implementation of a UiItemsProvider. The base class allows the user to pass in a function that is used to determine if the\n * active stage should be provided items. Derived provider classes should override the `xxxInternal` methods to provide items.\n * @deprecated in 3.6. Use [BaseUiItemsProvider]($appui-react) instead.\n * @public\n */\nexport class BaseUiItemsProvider implements UiItemsProvider {\n  /*\n   * @param providerId - unique identifier for this instance of the provider. This is required in case separate packages want\n   * to set up custom stage with their own subset of standard tools.\n   * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and\n   * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.\n   */\n  constructor(protected _providerId: string, public isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider) => boolean) { }\n\n  public get id(): string { return this._providerId; }\n  public onUnregister(): void { }\n\n  public unregister() {\n    UiItemsManager.unregister(this._providerId);\n  }\n\n  /** Backstage items are not stage specific so no callback is used */\n  public provideBackstageItems(): BackstageItem[] {\n    return [];\n  }\n\n  public provideToolbarButtonItemsInternal(_stageId: string, _stageUsage: string, _toolbarUsage: ToolbarUsage, _toolbarOrientation: ToolbarOrientation, _stageAppData?: any): CommonToolbarItem[] {\n    return [];\n  }\n  public provideToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\n    let provideToStage = false;\n\n    if (this.isSupportedStage) {\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);\n    } else {\n      provideToStage = (stageUsage === StageUsage.General);\n    }\n\n    return provideToStage ? this.provideToolbarButtonItemsInternal(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) : [];\n  }\n\n  public provideStatusBarItemsInternal(_stageId: string, _stageUsage: string, _stageAppData?: any): CommonStatusBarItem[] {\n    return [];\n  }\n  public provideStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\n    let provideToStage = false;\n\n    if (this.isSupportedStage) {\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);\n    } else {\n      provideToStage = (stageUsage === StageUsage.General);\n    }\n\n    return provideToStage ? this.provideStatusBarItemsInternal(stageId, stageUsage, stageAppData) : [];\n  }\n\n  public provideWidgetsInternal(_stageId: string, _stageUsage: string, _location: StagePanelLocation, _section?: StagePanelSection, _zoneLocation?: AbstractZoneLocation, _stageAppData?: any): AbstractWidgetProps[] {\n    return [];\n  }\n\n  public provideWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection,\n    _zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\n    let provideToStage = false;\n\n    if (this.isSupportedStage) {\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);\n    } else {\n      provideToStage = (stageUsage === StageUsage.General);\n    }\n\n    return provideToStage ? this.provideWidgetsInternal(stageId, stageUsage, location, section, _zoneLocation, stageAppData) : [];\n  }\n}\n"]}

package/lib/cjs/appui-abstract/UiAdmin.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiAdmin.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiAdmin.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgD;AAWhD,uCAA8C;AAE9C,6CAA0C;AA+B1C;;GAEG;AACH,MAAa,cAAe,SAAQ,wBAA6B;CAAI;AAArE,wCAAqE;AAUrE;;GAEG;AACH,MAAa,OAAO;IAApB;QACU,kBAAa,GAAY,EAAE,CAAC;IA+OtC,CAAC;IA5OC,qDAAqD;IAC9C,MAAM,KAAK,gBAAgB;QAChC,IAAI,CAAC,OAAO,CAAC,iBAAiB;YAC5B,MAAM,IAAI,iBAAO,CAAC,IAAA,qBAAc,EAAC,IAAI,CAAC,EAAE,kCAAkC,CAAC,CAAC;QAC9E,OAAO,OAAO,CAAC,iBAAiB,CAAC;IACnC,CAAC;IACM,MAAM,KAAK,gBAAgB,CAAC,EAAoB;QACrD,OAAO,CAAC,iBAAiB,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,kDAAkD;IACtF,CAAC;IAEM,kBAAkB,CAAC,OAAgB;QACxC,IAAI,CAAC,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;IAC7D,CAAC;IAED,gBAAgB;IACT,aAAa,KAAK,CAAC;IAE1B,uCAAuC;IACvC,IAAW,cAAc,KAAiB,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAElE,kCAAkC;IAC3B,WAAW,CAAC,CAAS,EAAE,CAAS,IAAgB,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzE,yCAAyC;IACzC,IAAW,aAAa,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAErD,yBAAyB;IAClB,cAAc,KAAW,CAAC;IAEjC;;;;;OAKG;IACI,eAAe,CAAC,eAAwC,EAAE,SAAqB,EAAE,YAA0B;QAChH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAChB,aAAmC,EAAE,SAAqB,EAAE,OAAmB,EAAE,eAAmC,EAAE,SAAuB,EAC7I,iBAAoC,EAAE,YAA0B;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yBAAyB;IAClB,WAAW,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE/C;;;;;;OAMG;IACI,cAAc,CAAC,GAAW,EAAE,eAAwC,EAAE,SAAqB,EAAE,YAA0B;QAC5H,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,GAAW,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE7D;;;;;;;;OAQG;IACI,cAAc,CAAC,aAAqB,EAAE,WAAmB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACzK,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4BAA4B;IACrB,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAElD;;;;;;;OAOG;IACI,eAAe,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACrJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACtJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACtJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CAAC,aAA+B,EAAE,oBAAyC,EAAE,SAAqB,EAAE,SAA4B,EAAE,SAAuB,EAAE,YAA0B;QACzM,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;OAQG;IACI,eAAe,CACpB,eAA4B,EAAE,SAAqB,EAAE,OAAmB,EAAE,SAAuB,EACjG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;;;;OAWG;IACI,QAAQ,CACb,QAAqB,EAAE,MAA2C,EAAE,aAA+C,EACnH,SAAqB,EAAE,OAAmB,EAAE,eAAmC,EAAE,SAAuB,EACxG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACf,QAAQ,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACI,qBAAqB,CAC1B,aAA6B,EAAE,SAAqB,EAAE,OAAmB,EAAE,SAAuB,EAClG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,sBAAsB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACI,gBAAgB,CAAC,YAA0B,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE9E,+BAA+B;IACxB,gBAAgB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEpD,sBAAsB;IACf,MAAM,CAAC,WAAW,CAAC,IAAwB;QAChD,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;OAOG;IACI,UAAU,CAAC,eAAyC,EAAE,MAAc,EAAE,QAAiB,EAAE,GAAW,EACzG,cAA4B;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,WAAW,CAAC,SAAiB,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;;AAjBhE,sBAAsB;AACC,wBAAgB,GAAG,IAAI,cAAc,EAAE,AAAvB,CAAwB;AA/NpD,0BAAO","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 UiAdmin\r\n */\r\n\r\nimport { BeUiEvent } from \"@itwin/core-bentley\";\r\nimport { AbstractMenuItemProps } from \"./items/AbstractMenuItemProps\";\r\nimport { AbstractToolbarProps } from \"./items/AbstractToolbarProps\";\r\nimport { RelativePosition } from \"./items/RelativePosition\";\r\nimport { PropertyDescription } from \"./properties/Description\";\r\nimport { Primitives } from \"./properties/PrimitiveTypes\";\r\nimport { OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc } from \"./utils/callbacks\";\r\nimport { PropertyRecord } from \"./properties/Record\";\r\nimport { UiDataProvider } from \"./dialogs/UiDataProvider\";\r\nimport { DialogLayoutDataProvider } from \"./dialogs/UiLayoutDataProvider\";\r\nimport { PointProps } from \"./utils/PointProps\";\r\nimport { loggerCategory } from \"./utils/misc\";\r\nimport { MessagePresenter } from \"./notification/MessagePresenter\";\r\nimport { UiError } from \"./utils/UiError\";\r\n\r\n/** The Generic UI Event args contains information useful for any UI message\r\n * @public\r\n */\r\nexport interface GenericUiEventArgs {\r\n  uiComponentId: string;\r\n}\r\n\r\n/** Optional props to pass to the Dialog control that is generated.\r\n * @public\r\n */\r\nexport interface DialogProps {\r\n  /** Indicates whether the user can resize dialog with cursor. */\r\n  resizable?: boolean;\r\n  /** Indicates whether the user can move dialog with cursor.*/\r\n  movable?: boolean;\r\n  /** Initial width of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  width?: string | number;\r\n  /** Initial height of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  height?: string | number;\r\n  /** Minimum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  minWidth?: string | number;\r\n  /** Minimum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  minHeight?: string | number;\r\n  /** Maximum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  maxWidth?: string | number;\r\n  /** Maximum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  maxHeight?: string | number;\r\n}\r\n\r\n/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.\r\n * @public\r\n */\r\nexport class GenericUiEvent extends BeUiEvent<GenericUiEventArgs> { }\r\n\r\n/** Flags that control enabling/disabling certain UI features\r\n * @public\r\n */\r\nexport interface UiFlags {\r\n  /** if true then Ctrl+F2 will show popup key-in palette */\r\n  allowKeyinPalette?: boolean;\r\n}\r\n\r\n/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.\r\n * @public\r\n */\r\nexport class UiAdmin {\r\n  private _featureFlags: UiFlags = {};\r\n  private static _messagePresenter?: MessagePresenter;\r\n\r\n  /** The MessagePresenter used to display messages. */\r\n  public static get messagePresenter(): MessagePresenter {\r\n    if (!UiAdmin._messagePresenter)\r\n      throw new UiError(loggerCategory(this), \"UiAdmin.messagePresenter not set\");\r\n    return UiAdmin._messagePresenter;\r\n  }\r\n  public static set messagePresenter(mp: MessagePresenter) {\r\n    UiAdmin._messagePresenter = mp;\r\n  }\r\n\r\n  public get featureFlags(): UiFlags {\r\n    return { ...this._featureFlags }; // return copy so no direct access to modify value\r\n  }\r\n\r\n  public updateFeatureFlags(uiFlags: UiFlags) {\r\n    this._featureFlags = { ...this._featureFlags, ...uiFlags };\r\n  }\r\n\r\n  /** @internal */\r\n  public onInitialized() { }\r\n\r\n  /** Get the cursor X and Y position. */\r\n  public get cursorPosition(): PointProps { return { x: 0, y: 0 }; }\r\n\r\n  /** Create a PointProps object. */\r\n  public createXAndY(x: number, y: number): PointProps { return { x, y }; }\r\n\r\n  /** Determines if focus is set to Home */\r\n  public get isFocusOnHome(): boolean { return false; }\r\n\r\n  /** Sets focus to Home */\r\n  public setFocusToHome(): void { }\r\n\r\n  /** Show a context menu at a particular location.\r\n   * @param _menuItemsProps Properties of the menu items to display.\r\n   * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the menu was displayed, false if the menu could not be displayed.\r\n   */\r\n  public showContextMenu(_menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show a Toolbar at a particular location.\r\n   * @param _toolbarProps Properties of the Toolbar to display.\r\n   * @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.\r\n   * @param _offset Offset of the Toolbar from the location.\r\n   * @param _onItemExecuted Function invoked after a Toolbar item is executed\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\r\n   * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\r\n   */\r\n  public showToolbar(\r\n    _toolbarProps: AbstractToolbarProps, _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the toolbar. */\r\n  public hideToolbar(): boolean { return false; }\r\n\r\n  /** Show a menu button at a particular location. A menu button opens a context menu.\r\n   * @param _id Id of the menu button. Multiple menu buttons may be displayed.\r\n   * @param _menuItemsProps Properties of the menu items to display.\r\n   * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the button was displayed, false if the button could not be displayed.\r\n   */\r\n  public showMenuButton(_id: string, _menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides a menu button.\r\n   * @param _id Id of the menu button. Multiple menu buttons may be displayed.\r\n   * @return true if the menu was hidden, false if the menu could not be hidden.\r\n   */\r\n  public hideMenuButton(_id: string): boolean { return false; }\r\n\r\n  /** Show a calculator at a particular location.\r\n   * @param _initialValue Value initially displayed in the calculator.\r\n   * @param _resultIcon Icon displayed to the left of the value.\r\n   * @param _location Location of the calculator, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the calculator was displayed, false if the calculator could not be displayed.\r\n   */\r\n  public showCalculator(_initialValue: number, _resultIcon: string, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the calculator. */\r\n  public hideCalculator(): boolean { return false; }\r\n\r\n  /** Show an input editor for an angle value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showAngleEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show an input editor for a length value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showLengthEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show an input editor for a height value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showHeightEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show an input editor for a primitive value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _propertyDescription Description of the primitive value property.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showInputEditor(_initialValue: Primitives.Value, _propertyDescription: PropertyDescription, _location: PointProps, _onCommit: OnValueCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the input editor. */\r\n  public hideInputEditor(): boolean { return false; }\r\n\r\n  /** Show an HTML element at a particular location.\r\n   * @param _displayElement The HTMLElement to display\r\n   * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\r\n   * @param _offset Offset of the display element from the location\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\r\n   * @return true if the display element was displayed, false if the display element could not be displayed.\r\n   */\r\n  public showHTMLElement(\r\n    _displayElement: HTMLElement, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the HTML Element. */\r\n  public hideHTMLElement(): boolean { return false; }\r\n\r\n  /** Show a Card containing content, a title and a toolbar at a particular location.\r\n   * @param _content The HTMLElement of the content to display\r\n   * @param _title Title to display at the top of the card.\r\n   * @param _toolbarProps Properties of the Toolbar to display.\r\n   * @param _location Location of the Card, relative to the origin of anchorElement or the window.\r\n   * @param _offset Offset of the Card from the location.\r\n   * @param _onItemExecuted Function invoked after a Toolbar item is executed\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\r\n   * @return true if the Card was displayed, false if the Card could not be displayed.\r\n   */\r\n  public showCard(\r\n    _content: HTMLElement, _title: string | PropertyRecord | undefined, _toolbarProps: AbstractToolbarProps | undefined,\r\n    _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the Card. */\r\n  public hideCard(): boolean { return false; }\r\n\r\n  /** Opens a Tool Settings Ui popup at a particular location.\r\n   * @param _dataProvider The UiDataProvider for the tool settings\r\n   * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\r\n   * @param _offset Offset of the tool settings from the location\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\r\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\r\n   */\r\n  public openToolSettingsPopup(\r\n    _dataProvider: UiDataProvider, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Closes the Tool Settings Ui popup. */\r\n  public closeToolSettingsPopup(): boolean { return false; }\r\n\r\n  /** Show the Keyin Palette to display all support Tool key-ins.\r\n   * @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.\r\n   * @return true if the Keyin Palette was displayed, false if it could not be displayed.\r\n   */\r\n  public showKeyinPalette(_htmlElement?: HTMLElement): boolean { return false; }\r\n\r\n  /** Hides the Keyin Palette. */\r\n  public hideKeyinPalette(): boolean { return false; }\r\n\r\n  /** Send a UI event */\r\n  public static sendUiEvent(args: GenericUiEventArgs) {\r\n    UiAdmin.onGenericUiEvent.emit(args);\r\n  }\r\n  /** GenericUiEvent  */\r\n  public static readonly onGenericUiEvent = new GenericUiEvent();\r\n\r\n  /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\r\n   * @param _uiDataProvider The DialogLayoutDataProvider for the dialog\r\n   * @param _title Specify title for dialog.\r\n   * @param _isModal Specify if the dialog is opened as a modal or modeless.\r\n   * @param _id Id of the dialog that is used to close it.\r\n   * @param _optionalProps Optional props for Dialog construction.\r\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\r\n   */\r\n  public openDialog(_uiDataProvider: DialogLayoutDataProvider, _title: string, _isModal: boolean, _id: string,\r\n    _optionalProps?: DialogProps): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Closes the Dialog with a given Id. */\r\n  public closeDialog(_dialogId: string): boolean { return false; }\r\n}\r\n"]}
+{"version":3,"file":"UiAdmin.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiAdmin.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgD;AAWhD,uCAA8C;AAE9C,6CAA0C;AA+B1C;;GAEG;AACH,MAAa,cAAe,SAAQ,wBAA6B;CAAI;AAArE,wCAAqE;AAUrE;;GAEG;AACH,MAAa,OAAO;IAApB;QACU,kBAAa,GAAY,EAAE,CAAC;IA+OtC,CAAC;IA5OC,qDAAqD;IAC9C,MAAM,KAAK,gBAAgB;QAChC,IAAI,CAAC,OAAO,CAAC,iBAAiB;YAC5B,MAAM,IAAI,iBAAO,CAAC,IAAA,qBAAc,EAAC,IAAI,CAAC,EAAE,kCAAkC,CAAC,CAAC;QAC9E,OAAO,OAAO,CAAC,iBAAiB,CAAC;IACnC,CAAC;IACM,MAAM,KAAK,gBAAgB,CAAC,EAAoB;QACrD,OAAO,CAAC,iBAAiB,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,kDAAkD;IACtF,CAAC;IAEM,kBAAkB,CAAC,OAAgB;QACxC,IAAI,CAAC,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;IAC7D,CAAC;IAED,gBAAgB;IACT,aAAa,KAAK,CAAC;IAE1B,uCAAuC;IACvC,IAAW,cAAc,KAAiB,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAElE,kCAAkC;IAC3B,WAAW,CAAC,CAAS,EAAE,CAAS,IAAgB,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzE,yCAAyC;IACzC,IAAW,aAAa,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAErD,yBAAyB;IAClB,cAAc,KAAW,CAAC;IAEjC;;;;;OAKG;IACI,eAAe,CAAC,eAAwC,EAAE,SAAqB,EAAE,YAA0B;QAChH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAChB,aAAmC,EAAE,SAAqB,EAAE,OAAmB,EAAE,eAAmC,EAAE,SAAuB,EAC7I,iBAAoC,EAAE,YAA0B;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yBAAyB;IAClB,WAAW,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE/C;;;;;;OAMG;IACI,cAAc,CAAC,GAAW,EAAE,eAAwC,EAAE,SAAqB,EAAE,YAA0B;QAC5H,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,GAAW,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE7D;;;;;;;;OAQG;IACI,cAAc,CAAC,aAAqB,EAAE,WAAmB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACzK,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4BAA4B;IACrB,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAElD;;;;;;;OAOG;IACI,eAAe,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACrJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACtJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACtJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CAAC,aAA+B,EAAE,oBAAyC,EAAE,SAAqB,EAAE,SAA4B,EAAE,SAAuB,EAAE,YAA0B;QACzM,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;OAQG;IACI,eAAe,CACpB,eAA4B,EAAE,SAAqB,EAAE,OAAmB,EAAE,SAAuB,EACjG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;;;;OAWG;IACI,QAAQ,CACb,QAAqB,EAAE,MAA2C,EAAE,aAA+C,EACnH,SAAqB,EAAE,OAAmB,EAAE,eAAmC,EAAE,SAAuB,EACxG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACf,QAAQ,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACI,qBAAqB,CAC1B,aAA6B,EAAE,SAAqB,EAAE,OAAmB,EAAE,SAAuB,EAClG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,sBAAsB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACI,gBAAgB,CAAC,YAA0B,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE9E,+BAA+B;IACxB,gBAAgB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEpD,sBAAsB;IACf,MAAM,CAAC,WAAW,CAAC,IAAwB;QAChD,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;OAOG;IACI,UAAU,CAAC,eAAyC,EAAE,MAAc,EAAE,QAAiB,EAAE,GAAW,EACzG,cAA4B;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,WAAW,CAAC,SAAiB,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;;AAjBhE,sBAAsB;AACC,wBAAgB,GAAG,IAAI,cAAc,EAAE,AAAvB,CAAwB;AA/NpD,0BAAO","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 UiAdmin\n */\n\nimport { BeUiEvent } from \"@itwin/core-bentley\";\nimport { AbstractMenuItemProps } from \"./items/AbstractMenuItemProps\";\nimport { AbstractToolbarProps } from \"./items/AbstractToolbarProps\";\nimport { RelativePosition } from \"./items/RelativePosition\";\nimport { PropertyDescription } from \"./properties/Description\";\nimport { Primitives } from \"./properties/PrimitiveTypes\";\nimport { OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc } from \"./utils/callbacks\";\nimport { PropertyRecord } from \"./properties/Record\";\nimport { UiDataProvider } from \"./dialogs/UiDataProvider\";\nimport { DialogLayoutDataProvider } from \"./dialogs/UiLayoutDataProvider\";\nimport { PointProps } from \"./utils/PointProps\";\nimport { loggerCategory } from \"./utils/misc\";\nimport { MessagePresenter } from \"./notification/MessagePresenter\";\nimport { UiError } from \"./utils/UiError\";\n\n/** The Generic UI Event args contains information useful for any UI message\n * @public\n */\nexport interface GenericUiEventArgs {\n  uiComponentId: string;\n}\n\n/** Optional props to pass to the Dialog control that is generated.\n * @public\n */\nexport interface DialogProps {\n  /** Indicates whether the user can resize dialog with cursor. */\n  resizable?: boolean;\n  /** Indicates whether the user can move dialog with cursor.*/\n  movable?: boolean;\n  /** Initial width of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n  width?: string | number;\n  /** Initial height of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n  height?: string | number;\n  /** Minimum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n  minWidth?: string | number;\n  /** Minimum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n  minHeight?: string | number;\n  /** Maximum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n  maxWidth?: string | number;\n  /** Maximum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n  maxHeight?: string | number;\n}\n\n/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.\n * @public\n */\nexport class GenericUiEvent extends BeUiEvent<GenericUiEventArgs> { }\n\n/** Flags that control enabling/disabling certain UI features\n * @public\n */\nexport interface UiFlags {\n  /** if true then Ctrl+F2 will show popup key-in palette */\n  allowKeyinPalette?: boolean;\n}\n\n/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.\n * @public\n */\nexport class UiAdmin {\n  private _featureFlags: UiFlags = {};\n  private static _messagePresenter?: MessagePresenter;\n\n  /** The MessagePresenter used to display messages. */\n  public static get messagePresenter(): MessagePresenter {\n    if (!UiAdmin._messagePresenter)\n      throw new UiError(loggerCategory(this), \"UiAdmin.messagePresenter not set\");\n    return UiAdmin._messagePresenter;\n  }\n  public static set messagePresenter(mp: MessagePresenter) {\n    UiAdmin._messagePresenter = mp;\n  }\n\n  public get featureFlags(): UiFlags {\n    return { ...this._featureFlags }; // return copy so no direct access to modify value\n  }\n\n  public updateFeatureFlags(uiFlags: UiFlags) {\n    this._featureFlags = { ...this._featureFlags, ...uiFlags };\n  }\n\n  /** @internal */\n  public onInitialized() { }\n\n  /** Get the cursor X and Y position. */\n  public get cursorPosition(): PointProps { return { x: 0, y: 0 }; }\n\n  /** Create a PointProps object. */\n  public createXAndY(x: number, y: number): PointProps { return { x, y }; }\n\n  /** Determines if focus is set to Home */\n  public get isFocusOnHome(): boolean { return false; }\n\n  /** Sets focus to Home */\n  public setFocusToHome(): void { }\n\n  /** Show a context menu at a particular location.\n   * @param _menuItemsProps Properties of the menu items to display.\n   * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the menu was displayed, false if the menu could not be displayed.\n   */\n  public showContextMenu(_menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Show a Toolbar at a particular location.\n   * @param _toolbarProps Properties of the Toolbar to display.\n   * @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.\n   * @param _offset Offset of the Toolbar from the location.\n   * @param _onItemExecuted Function invoked after a Toolbar item is executed\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\n   * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\n   */\n  public showToolbar(\n    _toolbarProps: AbstractToolbarProps, _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\n    _relativePosition?: RelativePosition, _htmlElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Hides the toolbar. */\n  public hideToolbar(): boolean { return false; }\n\n  /** Show a menu button at a particular location. A menu button opens a context menu.\n   * @param _id Id of the menu button. Multiple menu buttons may be displayed.\n   * @param _menuItemsProps Properties of the menu items to display.\n   * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the button was displayed, false if the button could not be displayed.\n   */\n  public showMenuButton(_id: string, _menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Hides a menu button.\n   * @param _id Id of the menu button. Multiple menu buttons may be displayed.\n   * @return true if the menu was hidden, false if the menu could not be hidden.\n   */\n  public hideMenuButton(_id: string): boolean { return false; }\n\n  /** Show a calculator at a particular location.\n   * @param _initialValue Value initially displayed in the calculator.\n   * @param _resultIcon Icon displayed to the left of the value.\n   * @param _location Location of the calculator, relative to the origin of htmlElement or the window.\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the calculator was displayed, false if the calculator could not be displayed.\n   */\n  public showCalculator(_initialValue: number, _resultIcon: string, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Hides the calculator. */\n  public hideCalculator(): boolean { return false; }\n\n  /** Show an input editor for an angle value at a particular location.\n   * @param _initialValue Value initially displayed in the editor.\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public showAngleEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Show an input editor for a length value at a particular location.\n   * @param _initialValue Value initially displayed in the editor.\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public showLengthEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Show an input editor for a height value at a particular location.\n   * @param _initialValue Value initially displayed in the editor.\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public showHeightEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Show an input editor for a primitive value at a particular location.\n   * @param _initialValue Value initially displayed in the editor.\n   * @param _propertyDescription Description of the primitive value property.\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public showInputEditor(_initialValue: Primitives.Value, _propertyDescription: PropertyDescription, _location: PointProps, _onCommit: OnValueCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Hides the input editor. */\n  public hideInputEditor(): boolean { return false; }\n\n  /** Show an HTML element at a particular location.\n   * @param _displayElement The HTMLElement to display\n   * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\n   * @param _offset Offset of the display element from the location\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\n   * @return true if the display element was displayed, false if the display element could not be displayed.\n   */\n  public showHTMLElement(\n    _displayElement: HTMLElement, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc,\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Hides the HTML Element. */\n  public hideHTMLElement(): boolean { return false; }\n\n  /** Show a Card containing content, a title and a toolbar at a particular location.\n   * @param _content The HTMLElement of the content to display\n   * @param _title Title to display at the top of the card.\n   * @param _toolbarProps Properties of the Toolbar to display.\n   * @param _location Location of the Card, relative to the origin of anchorElement or the window.\n   * @param _offset Offset of the Card from the location.\n   * @param _onItemExecuted Function invoked after a Toolbar item is executed\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n   * @return true if the Card was displayed, false if the Card could not be displayed.\n   */\n  public showCard(\n    _content: HTMLElement, _title: string | PropertyRecord | undefined, _toolbarProps: AbstractToolbarProps | undefined,\n    _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Hides the Card. */\n  public hideCard(): boolean { return false; }\n\n  /** Opens a Tool Settings Ui popup at a particular location.\n   * @param _dataProvider The UiDataProvider for the tool settings\n   * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\n   * @param _offset Offset of the tool settings from the location\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n   */\n  public openToolSettingsPopup(\n    _dataProvider: UiDataProvider, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc,\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\n    return false;\n  }\n\n  /** Closes the Tool Settings Ui popup. */\n  public closeToolSettingsPopup(): boolean { return false; }\n\n  /** Show the Keyin Palette to display all support Tool key-ins.\n   * @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.\n   * @return true if the Keyin Palette was displayed, false if it could not be displayed.\n   */\n  public showKeyinPalette(_htmlElement?: HTMLElement): boolean { return false; }\n\n  /** Hides the Keyin Palette. */\n  public hideKeyinPalette(): boolean { return false; }\n\n  /** Send a UI event */\n  public static sendUiEvent(args: GenericUiEventArgs) {\n    UiAdmin.onGenericUiEvent.emit(args);\n  }\n  /** GenericUiEvent  */\n  public static readonly onGenericUiEvent = new GenericUiEvent();\n\n  /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\n   * @param _uiDataProvider The DialogLayoutDataProvider for the dialog\n   * @param _title Specify title for dialog.\n   * @param _isModal Specify if the dialog is opened as a modal or modeless.\n   * @param _id Id of the dialog that is used to close it.\n   * @param _optionalProps Optional props for Dialog construction.\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n   */\n  public openDialog(_uiDataProvider: DialogLayoutDataProvider, _title: string, _isModal: boolean, _id: string,\n    _optionalProps?: DialogProps): boolean {\n    return false;\n  }\n\n  /** Closes the Dialog with a given Id. */\n  public closeDialog(_dialogId: string): boolean { return false; }\n}\n"]}

package/lib/cjs/appui-abstract/UiItemsManager.d.ts

@@ -0,0 +1,114 @@
+/** @packageDocumentation
+ * @module UiItemsProvider
+ */
+import { BeEvent, MarkRequired } from "@itwin/core-bentley";
+import { BackstageItem } from "./backstage/BackstageItem";
+import { CommonStatusBarItem } from "./statusbar/StatusBarItem";
+import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from "./toolbars/ToolbarItem";
+import { AbstractWidgetProps } from "./widget/AbstractWidgetProps";
+import { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
+import { UiItemsProvider } from "./UiItemsProvider";
+/** Action taken by the application on item provided by a UiItemsProvider
+ * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.
+ */
+export declare enum UiItemsApplicationAction {
+    /** Allow the change to the item */
+    Allow = 0,
+    /** Disallow the change to the item */
+    Disallow = 1,
+    /** Update the item during the change */
+    Update = 2
+}
+/** UIProvider Registered Event Args interface.
+ * @deprecated in 3.6. Use [UiItemsProviderRegisteredEventArgs]($appui-react) instead.
+ * @public
+ */
+export interface UiItemProviderRegisteredEventArgs {
+    providerId: string;
+}
+/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items
+ * @deprecated in 3.6. Use [AllowedUiItemsProviderOverrides]($appui-react) instead.
+ * @public
+ */
+export interface AllowedUiItemProviderOverrides {
+    /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages
+     * @beta
+     */
+    providerId?: string;
+    /** if specified then the current stage's Usage will be compared before allowing any items to be provided
+     * @beta
+     */
+    stageUsages?: string[];
+    /** if specified then the current stage's Id will be compared before allowing any items to be provided
+     * @beta
+    */
+    stageIds?: string[];
+}
+/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.
+ * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's
+ * items are allowed.
+ * @deprecated in 3.6. Use [UiItemsProviderOverrides]($appui-react) instead.
+ * @public
+ */
+export type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, "providerId" | "stageUsages"> | MarkRequired<AllowedUiItemProviderOverrides, "providerId" | "stageIds"> | // eslint-disable-line @typescript-eslint/indent
+MarkRequired<AllowedUiItemProviderOverrides, "stageIds"> | // eslint-disable-line @typescript-eslint/indent
+MarkRequired<AllowedUiItemProviderOverrides, "stageUsages"> | // eslint-disable-line @typescript-eslint/indent
+MarkRequired<AllowedUiItemProviderOverrides, "providerId" | "stageUsages" | "stageIds">;
+/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
+ * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.
+ * @public
+ */
+export declare class UiItemsManager {
+    private static _registeredUiItemsProviders;
+    /** For use in unit testing
+     * @internal */
+    static clearAllProviders(): void;
+    /** Event raised any time a UiProvider is registered or unregistered. */
+    static readonly onUiProviderRegisteredEvent: BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>;
+    /** Return number of registered UiProvider. */
+    static get registeredProviderIds(): string[];
+    /** Return true if there is any registered UiProvider. */
+    static get hasRegisteredProviders(): boolean;
+    /**
+     * Retrieves a previously loaded UiItemsProvider.
+     * @param providerId id of the UiItemsProvider to get
+     */
+    static getUiItemsProvider(providerId: string): UiItemsProvider | undefined;
+    private static sendRegisteredEvent;
+    /**
+     * Registers a UiItemsProvider with the UiItemsManager.
+     * @param uiProvider the UI items provider to register.
+     */
+    static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void;
+    /** Remove a specific UiItemsProvider from the list of available providers. */
+    static unregister(uiProviderId: string): void;
+    private static allowItemsFromProvider;
+    /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
+     * an action or specify a registered ToolId into toolbar.
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param toolbarUsage usage of the toolbar
+     * @param toolbarOrientation orientation of the toolbar
+     * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
+     */
+    static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[];
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
+     */
+    static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[];
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
+     */
+    static getBackstageItems(): BackstageItem[];
+    /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param location the location within the stage.
+     * @param section the section within location.
+     * @returns An array of AbstractWidgetProps that will be used to create widgets.
+     */
+    static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps>;
+}
+//# sourceMappingURL=UiItemsManager.d.ts.map

package/lib/cjs/appui-abstract/UiItemsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAU,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAElG,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,oBAAY,wBAAwB;IAClC,mCAAmC;IACnC,KAAK,IAAA;IACL,sCAAsC;IACtC,QAAQ,IAAA;IACR,wCAAwC;IACxC,MAAM,IAAA;CACP;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;MAEE;IACF,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,YAAY,CAAC,8BAA8B,EAAE,YAAY,GAAG,aAAa,CAAC,GAC9G,YAAY,CAAC,8BAA8B,EAAE,YAAY,GAAG,UAAU,CAAC,GAAmC,gDAAgD;AAC1J,YAAY,CAAC,8BAA8B,EAAE,UAAU,CAAC,GAAkD,gDAAgD;AAC1J,YAAY,CAAC,8BAA8B,EAAE,aAAa,CAAC,GAA+C,gDAAgD;AAC1J,YAAY,CAAC,8BAA8B,EAAE,YAAY,GAAG,aAAa,GAAG,UAAU,CAAC,CAAC;AAQ1F;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAA4E;IAEtH;mBACe;WACD,iBAAiB;IAI/B,wEAAwE;IACxE,gBAAuB,2BAA2B,eAAoB,iCAAiC,KAAK,IAAI,EAAI;IAEpH,8CAA8C;IAC9C,WAAkB,qBAAqB,aAGtC;IAED,yDAAyD;IACzD,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIjF,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;OAGG;WACW,QAAQ,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,uBAAuB,GAAG,IAAI;IAa9F,8EAA8E;WAChE,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAcpD,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAUrC;;;;;;;OAOG;WACW,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EACjG,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAsBlF;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAwB/G;;OAEG;WACW,iBAAiB,IAAI,aAAa,EAAE;IAuBlD;;;;;;OAMG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAuBtN"}

package/lib/cjs/appui-abstract/UiItemsManager.js

@@ -0,0 +1,194 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module UiItemsProvider
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiItemsManager = exports.UiItemsApplicationAction = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const misc_1 = require("./utils/misc");
+/** Action taken by the application on item provided by a UiItemsProvider
+ * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.
+ */
+var UiItemsApplicationAction;
+(function (UiItemsApplicationAction) {
+    /** Allow the change to the item */
+    UiItemsApplicationAction[UiItemsApplicationAction["Allow"] = 0] = "Allow";
+    /** Disallow the change to the item */
+    UiItemsApplicationAction[UiItemsApplicationAction["Disallow"] = 1] = "Disallow";
+    /** Update the item during the change */
+    UiItemsApplicationAction[UiItemsApplicationAction["Update"] = 2] = "Update";
+})(UiItemsApplicationAction = exports.UiItemsApplicationAction || (exports.UiItemsApplicationAction = {}));
+/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
+ * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.
+ * @public
+ */
+class UiItemsManager {
+    /** For use in unit testing
+     * @internal */
+    static clearAllProviders() {
+        UiItemsManager._registeredUiItemsProviders.clear();
+    }
+    /** Return number of registered UiProvider. */
+    static get registeredProviderIds() {
+        const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];
+        return ids;
+    }
+    /** Return true if there is any registered UiProvider. */
+    static get hasRegisteredProviders() {
+        return this._registeredUiItemsProviders.size > 0;
+    }
+    /**
+     * Retrieves a previously loaded UiItemsProvider.
+     * @param providerId id of the UiItemsProvider to get
+     */
+    static getUiItemsProvider(providerId) {
+        return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;
+    }
+    static sendRegisteredEvent(ev) {
+        UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);
+    }
+    /**
+     * Registers a UiItemsProvider with the UiItemsManager.
+     * @param uiProvider the UI items provider to register.
+     */
+    static register(uiProvider, overrides) {
+        const providerId = overrides?.providerId ?? uiProvider.id;
+        if (UiItemsManager.getUiItemsProvider(providerId)) {
+            core_bentley_1.Logger.logInfo((0, misc_1.loggerCategory)(this), `UiItemsProvider (${providerId}) is already loaded`);
+        }
+        else {
+            UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
+            core_bentley_1.Logger.logInfo((0, misc_1.loggerCategory)(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);
+            UiItemsManager.sendRegisteredEvent({ providerId });
+        }
+    }
+    /** Remove a specific UiItemsProvider from the list of available providers. */
+    static unregister(uiProviderId) {
+        const provider = UiItemsManager.getUiItemsProvider(uiProviderId);
+        if (!provider)
+            return;
+        provider.onUnregister && provider.onUnregister();
+        UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);
+        core_bentley_1.Logger.logInfo((0, misc_1.loggerCategory)(this), `UiItemsProvider (${uiProviderId}) unloaded`);
+        // trigger a refresh of the ui
+        UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId });
+    }
+    static allowItemsFromProvider(entry, stageId, stageUsage) {
+        // istanbul ignore else
+        const overrides = entry.overrides;
+        if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value) => value === stageId)))
+            return false;
+        if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value) => value === stageUsage)))
+            return false;
+        return true;
+    }
+    /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
+     * an action or specify a registered ToolId into toolbar.
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param toolbarUsage usage of the toolbar
+     * @param toolbarOrientation orientation of the toolbar
+     * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
+     */
+    static getToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) {
+        const buttonItems = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return buttonItems;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            const uiProvider = entry.provider;
+            const providerId = entry.overrides?.providerId ?? uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)
+                    .forEach((spec) => {
+                    // ignore duplicate ids
+                    if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))
+                        buttonItems.push({ ...spec, providerId });
+                });
+            }
+        });
+        return buttonItems;
+    }
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
+     */
+    static getStatusBarItems(stageId, stageUsage, stageAppData) {
+        const statusBarItems = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return statusBarItems;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            const uiProvider = entry.provider;
+            const providerId = entry.overrides?.providerId ?? uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)
+                    .forEach((item) => {
+                    // ignore duplicate ids
+                    if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))
+                        statusBarItems.push({ ...item, providerId });
+                });
+            }
+        });
+        return statusBarItems;
+    }
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
+     */
+    static getBackstageItems() {
+        const backstageItems = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return backstageItems;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            const uiProvider = entry.provider;
+            const providerId = entry.overrides?.providerId ?? uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items
+                uiProvider.provideBackstageItems() //       should not be considered stage specific. If they need to be hidden
+                    .forEach((item) => {
+                    // ignore duplicate ids
+                    if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))
+                        backstageItems.push({ ...item, providerId });
+                });
+            }
+        });
+        return backstageItems;
+    }
+    /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param location the location within the stage.
+     * @param section the section within location.
+     * @returns An array of AbstractWidgetProps that will be used to create widgets.
+     */
+    static getWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData) {
+        const widgets = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return widgets;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            const uiProvider = entry.provider;
+            const providerId = entry.overrides?.providerId ?? uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)
+                    .forEach((widget) => {
+                    // ignore duplicate ids
+                    if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))
+                        widgets.push({ ...widget, providerId });
+                });
+            }
+        });
+        return widgets;
+    }
+}
+UiItemsManager._registeredUiItemsProviders = new Map();
+/** Event raised any time a UiProvider is registered or unregistered. */
+UiItemsManager.onUiProviderRegisteredEvent = new core_bentley_1.BeEvent();
+exports.UiItemsManager = UiItemsManager;
+//# sourceMappingURL=UiItemsManager.js.map

package/lib/cjs/appui-abstract/UiItemsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,sDAAoE;AAMpE,uCAA8C;AAG9C;;GAEG;AACH,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,mCAAmC;IACnC,yEAAK,CAAA;IACL,sCAAsC;IACtC,+EAAQ,CAAA;IACR,wCAAwC;IACxC,2EAAM,CAAA;AACR,CAAC,EAPW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAOnC;AA+CD;;;GAGG;AACH,MAAa,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QACjD,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,EAAqC;QACtE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B,EAAE,SAAmC;QACrF,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACjD,qBAAM,CAAC,OAAO,CAAC,IAAA,qBAAc,EAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,qBAAqB,CAAC,CAAC;SAC3F;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YAChG,qBAAM,CAAC,OAAO,CAAC,IAAA,qBAAc,EAAC,IAAI,CAAC,EAAE,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAAC,CAAC;YAEtG,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAuC,CAAC,CAAC;SACzF;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,YAAoB;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAChE,qBAAM,CAAC,OAAO,CAAC,IAAA,qBAAc,EAAC,IAAI,CAAC,EAAE,oBAAoB,YAAY,YAAY,CAAC,CAAC;QAEnF,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAuC,CAAC,CAAC;IACxG,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,KAA0B,EAAE,OAAgB,EAAE,UAAmB;QACrG,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,EAAE,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC;YAClH,OAAO,KAAK,CAAC;QACf,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,EAAE,WAAW,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EACjG,kBAAsC,EAAE,YAAkB;QAC1D,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,WAAW,CAAC;QAErB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,uBAAuB;YACvB,IAAI,UAAU,CAAC,yBAAyB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACnG,UAAU,CAAC,yBAAyB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC;qBACtG,OAAO,CAAC,CAAC,IAAuB,EAAE,EAAE;oBACnC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAC7E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QAEjD,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBAC/F,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;qBAChE,OAAO,CAAC,CAAC,IAAyB,EAAE,EAAE;oBACrC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,cAAc,GAAoB,EAAE,CAAC;QAE3C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE,EAAE,2EAA2E;gBACjH,UAAU,CAAC,qBAAqB,EAAE,CAAI,2EAA2E;qBAC9G,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAAE,YAAmC,EAAE,YAAkB;QAC9K,MAAM,OAAO,GAA0B,EAAE,CAAC;QAE1C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,OAAO,CAAC;QAEjB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACxF,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;qBAC1F,OAAO,CAAC,CAAC,MAA2B,EAAE,EAAE;oBACvC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAC3E,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;;AA9Lc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AAQtH,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,sBAAO,EAAmD,CAAC;AAVzG,wCAAc","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/* eslint-disable deprecation/deprecation */\n/** @packageDocumentation\n * @module UiItemsProvider\n */\n\nimport { BeEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\nimport { BackstageItem } from \"./backstage/BackstageItem\";\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\nimport { loggerCategory } from \"./utils/misc\";\nimport { UiItemsProvider } from \"./UiItemsProvider\";\n\n/** Action taken by the application on item provided by a UiItemsProvider\n * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.\n */\nexport enum UiItemsApplicationAction {\n  /** Allow the change to the item */\n  Allow,\n  /** Disallow the change to the item */\n  Disallow,\n  /** Update the item during the change */\n  Update,\n}\n\n/** UIProvider Registered Event Args interface.\n * @deprecated in 3.6. Use [UiItemsProviderRegisteredEventArgs]($appui-react) instead.\n * @public\n */\nexport interface UiItemProviderRegisteredEventArgs {\n  providerId: string;\n}\n\n/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items\n * @deprecated in 3.6. Use [AllowedUiItemsProviderOverrides]($appui-react) instead.\n * @public\n */\nexport interface AllowedUiItemProviderOverrides {\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages\n   * @beta\n   */\n  providerId?: string;\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided\n   * @beta\n   */\n  stageUsages?: string[];\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided\n   * @beta\n  */\n  stageIds?: string[];\n}\n\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\n * items are allowed.\n * @deprecated in 3.6. Use [UiItemsProviderOverrides]($appui-react) instead.\n * @public\n */\nexport type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\"> |\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageIds\"> |                                 // eslint-disable-line @typescript-eslint/indent\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageIds\"> |                                                // eslint-disable-line @typescript-eslint/indent\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageUsages\"> |                                             // eslint-disable-line @typescript-eslint/indent\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">;                  // eslint-disable-line @typescript-eslint/indent\n\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\ninterface UiItemProviderEntry {\n  provider: UiItemsProvider;\n  overrides?: UiItemProviderOverrides;\n}\n\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\n * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.\n * @public\n */\nexport class UiItemsManager {\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\n\n  /** For use in unit testing\n   * @internal */\n  public static clearAllProviders() {\n    UiItemsManager._registeredUiItemsProviders.clear();\n  }\n\n  /** Event raised any time a UiProvider is registered or unregistered. */\n  public static readonly onUiProviderRegisteredEvent = new BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>();\n\n  /** Return number of registered UiProvider. */\n  public static get registeredProviderIds() {\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\n    return ids;\n  }\n\n  /** Return true if there is any registered UiProvider. */\n  public static get hasRegisteredProviders(): boolean {\n    return this._registeredUiItemsProviders.size > 0;\n  }\n\n  /**\n   * Retrieves a previously loaded UiItemsProvider.\n   * @param providerId id of the UiItemsProvider to get\n   */\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\n  }\n\n  private static sendRegisteredEvent(ev: UiItemProviderRegisteredEventArgs) {\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);\n  }\n\n  /**\n   * Registers a UiItemsProvider with the UiItemsManager.\n   * @param uiProvider the UI items provider to register.\n   */\n  public static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void {\n    const providerId = overrides?.providerId ?? uiProvider.id;\n\n    if (UiItemsManager.getUiItemsProvider(providerId)) {\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);\n    } else {\n      UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\n\n      UiItemsManager.sendRegisteredEvent({ providerId } as UiItemProviderRegisteredEventArgs);\n    }\n  }\n\n  /** Remove a specific UiItemsProvider from the list of available providers. */\n  public static unregister(uiProviderId: string): void {\n    const provider = UiItemsManager.getUiItemsProvider(uiProviderId);\n    if (!provider)\n      return;\n\n    provider.onUnregister && provider.onUnregister();\n\n    UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);\n    Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);\n\n    // trigger a refresh of the ui\n    UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId } as UiItemProviderRegisteredEventArgs);\n  }\n\n  private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\n    // istanbul ignore else\n    const overrides = entry.overrides;\n    if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\n      return false;\n    if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\n      return false;\n    return true;\n  }\n\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\n   * an action or specify a registered ToolId into toolbar.\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param toolbarUsage usage of the toolbar\n   * @param toolbarOrientation orientation of the toolbar\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\n   */\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage,\n    toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\n    const buttonItems: CommonToolbarItem[] = [];\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\n      return buttonItems;\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n      // istanbul ignore else\n      if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)\n          .forEach((spec: CommonToolbarItem) => {\n            // ignore duplicate ids\n            if (-1 === buttonItems.findIndex((existingItem)=> spec.id === existingItem.id ))\n              buttonItems.push({ ...spec, providerId });\n          });\n      }\n    });\n\n    return buttonItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\n   */\n  public static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\n    const statusBarItems: CommonStatusBarItem[] = [];\n\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\n      return statusBarItems;\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)\n          .forEach((item: CommonStatusBarItem) => {\n            // ignore duplicate ids\n            if (-1 === statusBarItems.findIndex((existingItem)=> item.id === existingItem.id ))\n              statusBarItems.push({ ...item, providerId });\n          });\n      }\n    });\n\n    return statusBarItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\n   */\n  public static getBackstageItems(): BackstageItem[] {\n    const backstageItems: BackstageItem[] = [];\n\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\n      return backstageItems;\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\n        uiProvider.provideBackstageItems()    //       should not be considered stage specific. If they need to be hidden\n          .forEach((item: BackstageItem) => { //       the isHidden property should be set to a ConditionalBooleanValue\n            // ignore duplicate ids\n            if (-1 === backstageItems.findIndex((existingItem)=> item.id === existingItem.id ))\n              backstageItems.push({ ...item, providerId });\n          });\n      }\n    });\n    return backstageItems;\n  }\n\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param location the location within the stage.\n   * @param section the section within location.\n   * @returns An array of AbstractWidgetProps that will be used to create widgets.\n   */\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\n    const widgets: AbstractWidgetProps[] = [];\n\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\n      return widgets;\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)\n          .forEach((widget: AbstractWidgetProps) => {\n            // ignore duplicate ids\n            if (-1 === widgets.findIndex((existingItem)=> widget.id === existingItem.id ))\n              widgets.push({ ...widget, providerId });\n          });\n      }\n    });\n    return widgets;\n  }\n\n}\n"]}