@itwin/appui-abstract 4.0.0-dev.48 → 4.0.0-dev.51

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

@@ -1,114 +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 declare 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>;
-}
+/** @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 declare 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/esm/appui-abstract/UiItemsManager.js

@@ -1,190 +1,190 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { BeEvent, Logger } from "@itwin/core-bentley";
-import { loggerCategory } from "./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.
- */
-export 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 || (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
- */
-export 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)) {
-            Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);
-        }
-        else {
-            UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
-            Logger.logInfo(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);
-        Logger.logInfo(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 BeEvent();
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { BeEvent, Logger } from "@itwin/core-bentley";
+import { loggerCategory } from "./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.
+ */
+export 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 || (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
+ */
+export 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)) {
+            Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);
+        }
+        else {
+            UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
+            Logger.logInfo(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);
+        Logger.logInfo(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 BeEvent();
 //# sourceMappingURL=UiItemsManager.js.map