UiItemsManager Class
Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
Methods
| Name | Description | |
|---|---|---|
| constructor(): UiItemsManager | ||
| getBackstageItems(): ReadonlyArray<ProviderItem<BackstageItem>> Static | Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields | |
| getStatusBarItems(stageId: string, stageUsage: string): ReadonlyArray<ProviderItem<StatusBarItem>> Static | Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields | |
| getToolbarButtonItems(stageId: string, stageUsage: string, usage: ToolbarUsage, orientation: ToolbarOrientation): ReadonlyArray<ProviderItem<ToolbarItem>> Static | Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute | |
| getUiItemsProvider(providerId: string): undefined | UiItemsProvider Static | Retrieves a previously loaded UiItemsProvider. | |
| getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<ProviderItem<Widget>> Static | Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets | |
| register(uiProvider: UiItemsProvider, overrides?: UiItemsProviderOverrides): void Static | Registers a UiItemsProvider with the UiItemsManager. | |
| unregister(providerId: string): void Static | Remove a specific UiItemsProvider from the list of available providers. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| hasRegisteredProviders Accessor Static ReadOnly | boolean | Return true if there is any registered UiProvider. | |
| onUiProviderRegisteredEvent Accessor Static ReadOnly | BeUiEvent<UiItemsProviderRegisteredEventArgs> | Event raised any time a UiProvider is registered or unregistered. | |
| registeredProviderIds Accessor Static ReadOnly | string[] | Return number of registered UiProvider. |
Defined in
Last Updated: 20 November, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.