Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ToolbarWidgetRegistry

Concrete implementation of IToolbarWidgetRegistry interface

Hierarchy

  • ToolbarWidgetRegistry

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _defaultFactory

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

Type declaration

    • (widgetFactory: string, widget: Widget, toolbarItem: IWidget): Widget

    • Parameters

      • widgetFactory: string
      • widget: Widget
      • toolbarItem: IWidget

      Returns Widget

Protected _widgets

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

Accessors

defaultFactory

  • get defaultFactory(): (widgetFactory: string, widget: Widget, toolbarItem: IWidget) => Widget
  • set defaultFactory(factory: (widgetFactory: string, widget: Widget, toolbarItem: IWidget) => Widget): void

  • Default toolbar item factory

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

      • (widgetFactory: string, widget: Widget, toolbarItem: IWidget): Widget

      • Parameters

        • widgetFactory: string
        • widget: Widget
        • toolbarItem: IWidget

        Returns Widget

  • Default toolbar item factory

    Parameters

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

        • Parameters

          • widgetFactory: string
          • widget: Widget
          • toolbarItem: IWidget

          Returns Widget

    Returns void

Methods

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.

registerFactory

  • registerFactory<T>(widgetFactory: string, toolbarItemName: string, factory: (main: T) => Widget): (main: T) => Widget

  • Register a new toolbar item factory

    Type parameters

    • T: Widget<T> = 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.

        • (main: T): Widget

        • Parameters

          • main: T

          Returns Widget

    Returns (main: T) => Widget

    The previously defined factory

      • (main: T): Widget

      • Parameters

        • main: T

        Returns Widget

Generated using TypeDoc