@itwin/appui-abstract 4.0.0-dev.52 → 4.0.0-dev.55

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.
- * @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>;
-}
+/** @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

@@ -1 +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,6CAAiC,OAAO;gBAA/I,WAAW,EAAE,MAAM,EAAS,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,6CAAiC,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"}
+{"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

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