Class ToolbarWidgetRegistry

Concrete implementation of IToolbarWidgetRegistry interface

Implements

IToolbarWidgetRegistry

Index

Constructors

Properties

_defaultFactory _factoryAdded _widgets

Accessors

defaultFactory factoryAdded

Methods

addFactory createWidget registerFactory

Constructors

constructor

new ToolbarWidgetRegistry(
options: ToolbarRegistry.IOptions,
): ToolbarWidgetRegistry
Parameters
- options: ToolbarRegistry.IOptions
Returns ToolbarWidgetRegistry
- Defined in packages/apputils/src/toolbar/registry.ts:20

Properties

`Protected`_defaultFactory

_defaultFactory: (
    widgetFactory: string,
    widget: Widget,
    toolbarItem: IWidget,
) => Widget

`Protected`_factoryAdded

_factoryAdded: Signal<ToolbarWidgetRegistry, string> = ...

`Protected`_widgets

_widgets: Map<string, Map<string, (main: Widget) => Widget>> = ...

Accessors

defaultFactory

get defaultFactory(): (
    widgetFactory: string,
    widget: Widget,
    toolbarItem: IWidget,
) => Widget
Default toolbar item factory

Returns (widgetFactory: string, widget: Widget, toolbarItem: IWidget) => Widget
Implementation of IToolbarWidgetRegistry.defaultFactory
- Defined in packages/apputils/src/toolbar/registry.ts:27
set defaultFactory(
    factory: (
        widgetFactory: string,
        widget: Widget,
        toolbarItem: IWidget,
    ) => Widget,
): void
Default toolbar item factory
Parameters
- factory: (widgetFactory: string, widget: Widget, toolbarItem: IWidget) => Widget
Returns void
Implementation of IToolbarWidgetRegistry.defaultFactory
- Defined in packages/apputils/src/toolbar/registry.ts:34

factoryAdded

get factoryAdded(): ISignal<this, string>
A signal emitted when a factory widget has been added.

Returns ISignal<this, string>
Implementation of IToolbarWidgetRegistry.factoryAdded
- Defined in packages/apputils/src/toolbar/registry.ts:47

Methods

addFactory

addFactory<T extends Widget = Widget>(
    widgetFactory: string,
    toolbarItemName: string,
    factory: (main: T) => Widget,
): undefined | (main: T) => Widget
Add a new toolbar item factory
Type Parameters
- T extends Widget = Widget
Parameters
- widgetFactory: string
  The widget factory name that creates the toolbar
- toolbarItemName: string
  The unique toolbar item
- factory: (main: T) => Widget
  The factory function that receives the widget containing the toolbar and returns the toolbar widget.
Returns undefined | (main: T) => Widget
The previously defined factory
Implementation of IToolbarWidgetRegistry.addFactory
- Defined in packages/apputils/src/toolbar/registry.ts:78

createWidget

createWidget(
    widgetFactory: string,
    widget: Widget,
    toolbarItem: IWidget,
): Widget
Create a toolbar item widget
Parameters
- widgetFactory: string
  The widget factory name that creates the toolbar
- widget: Widget
  The newly widget containing the toolbar
- toolbarItem: IWidget
  The toolbar item definition
Returns Widget
The widget to be inserted in the toolbar.
Implementation of IToolbarWidgetRegistry.createWidget
- Defined in packages/apputils/src/toolbar/registry.ts:59

registerFactory

registerFactory<T extends Widget = Widget>(
    widgetFactory: string,
    toolbarItemName: string,
    factory: (main: T) => Widget,
): undefined | (main: T) => Widget
Register a new toolbar item factory
Type Parameters
- T extends Widget = Widget
Parameters
- widgetFactory: string
  The widget factory name that creates the toolbar
- toolbarItemName: string
  The unique toolbar item
- factory: (main: T) => Widget
  The factory function that receives the widget containing the toolbar and returns the toolbar widget.
Returns undefined | (main: T) => Widget
The previously defined factory

Deprecated
since v4 use addFactory instead
Implementation of IToolbarWidgetRegistry.registerFactory
- Defined in packages/apputils/src/toolbar/registry.ts:104