@itwin/appui-abstract 3.6.0-dev.8 → 3.6.0

package/CHANGELOG.md

@@ -1,6 +1,38 @@
 # Change Log - @itwin/appui-abstract
 
-This log was last generated on Wed, 07 Dec 2022 19:12:36 GMT and should not be manually modified.
+This log was last generated on Wed, 08 Feb 2023 14:58:39 GMT and should not be manually modified.
+
+## 3.6.0
+Wed, 08 Feb 2023 14:58:39 GMT
+
+### Updates
+
+- Move AppUI specific types into @itwin/appui-react package.
+
+## 3.5.5
+Thu, 26 Jan 2023 22:53:27 GMT
+
+_Version update only_
+
+## 3.5.4
+Wed, 18 Jan 2023 15:27:15 GMT
+
+_Version update only_
+
+## 3.5.3
+Fri, 13 Jan 2023 17:23:07 GMT
+
+_Version update only_
+
+## 3.5.2
+Wed, 11 Jan 2023 16:46:29 GMT
+
+_Version update only_
+
+## 3.5.1
+Thu, 15 Dec 2022 16:38:28 GMT
+
+_Version update only_
 
 ## 3.5.0
 Wed, 07 Dec 2022 19:12:36 GMT

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2022 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2023 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

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

@@ -1,31 +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.
- * @public
- */
-export declare class BaseUiItemsProvider implements UiItemsProvider {
-    protected _providerId: string;
-    isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider | undefined) => boolean) | undefined;
-    constructor(_providerId: string, isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider | undefined) => 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>;
-}
+/** @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 | undefined) => boolean) | undefined;
+    constructor(_providerId: string, isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider | undefined) => 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.js

@@ -1,80 +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.
- * @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;
+"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

@@ -1 +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":["/*---------------------------------------------------------------------------------------------\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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module UiItemsProvider\r\n */\r\n\r\nimport { BackstageItem } from \"./backstage/BackstageItem\";\r\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\r\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\r\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\r\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\r\nimport { StageUsage } from \"./items/StageUsage\";\r\nimport { UiItemsProvider } from \"./UiItemsProvider\";\r\nimport { UiItemsManager } from \"./UiItemsManager\";\r\n\r\n/**\r\n * Base implementation of a UiItemsProvider. The base class allows the user to pass in a function that is used to determine if the\r\n * active stage should be provided items. Derived provider classes should override the `xxxInternal` methods to provide items.\r\n * @public\r\n */\r\nexport class BaseUiItemsProvider implements UiItemsProvider {\r\n  /*\r\n   * @param providerId - unique identifier for this instance of the provider. This is required in case separate packages want\r\n   * to set up custom stage with their own subset of standard tools.\r\n   * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and\r\n   * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.\r\n   */\r\n  constructor(protected _providerId: string, public isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider) => boolean) { }\r\n\r\n  public get id(): string { return this._providerId; }\r\n  public onUnregister(): void { }\r\n\r\n  public unregister() {\r\n    UiItemsManager.unregister(this._providerId);\r\n  }\r\n\r\n  /** Backstage items are not stage specific so no callback is used */\r\n  public provideBackstageItems(): BackstageItem[] {\r\n    return [];\r\n  }\r\n\r\n  public provideToolbarButtonItemsInternal(_stageId: string, _stageUsage: string, _toolbarUsage: ToolbarUsage, _toolbarOrientation: ToolbarOrientation, _stageAppData?: any): CommonToolbarItem[] {\r\n    return [];\r\n  }\r\n  public provideToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    return provideToStage ? this.provideToolbarButtonItemsInternal(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) : [];\r\n  }\r\n\r\n  public provideStatusBarItemsInternal(_stageId: string, _stageUsage: string, _stageAppData?: any): CommonStatusBarItem[] {\r\n    return [];\r\n  }\r\n  public provideStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    return provideToStage ? this.provideStatusBarItemsInternal(stageId, stageUsage, stageAppData) : [];\r\n  }\r\n\r\n  public provideWidgetsInternal(_stageId: string, _stageUsage: string, _location: StagePanelLocation, _section?: StagePanelSection, _zoneLocation?: AbstractZoneLocation, _stageAppData?: any): AbstractWidgetProps[] {\r\n    return [];\r\n  }\r\n\r\n  public provideWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection,\r\n    _zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    return provideToStage ? this.provideWidgetsInternal(stageId, stageUsage, location, section, _zoneLocation, stageAppData) : [];\r\n  }\r\n}\r\n"]}
+{"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"]}