WidgetManager | Theia TypeDoc

The WidgetManager is the common component responsible for creating and managing widgets. Additional widget factories can be registered by using the WidgetFactory contribution point. To identify a widget, created by a factory, the factory id and the creation options are used. This key is commonly referred to as description of the widget.

Hierarchy

WidgetManager

Index

Constructors

constructor

Properties

Accessors

factories

Methods

Constructors

constructor

new WidgetManager(): WidgetManager

Returns WidgetManager

Properties

Protected _cachedFactories

_cachedFactories: Map<string, WidgetFactory>

Protected Readonly factoryProvider

factoryProvider: ContributionProvider<WidgetFactory>

Protected Readonly logger

logger: ILogger

Readonly onDidCreateWidget

onDidCreateWidget: Event<DidCreateWidgetEvent> = ...

Protected Readonly onDidCreateWidgetEmitter

onDidCreateWidgetEmitter: Emitter<DidCreateWidgetEvent> = ...

Readonly onWillCreateWidget

onWillCreateWidget: Event<WillCreateWidgetEvent> = ...

An event can be used to participate in the widget creation. Listeners may not dispose the given widget.

Protected Readonly onWillCreateWidgetEmitter

onWillCreateWidgetEmitter: Emitter<WillCreateWidgetEvent> = ...

Protected Readonly pendingWidgetPromises

pendingWidgetPromises: Map<string, MaybePromise<Widget>> = ...

Protected Readonly widgetPromises

widgetPromises: Map<string, MaybePromise<Widget>> = ...

Protected Readonly widgets

widgets: Map<string, Widget> = ...

Accessors

Protected factories

get factories(): Map<string, WidgetFactory>

- Defined in packages/core/src/browser/widget-manager.ts:272
Returns Map<string, WidgetFactory>

Methods

Protected doGetWidget

doGetWidget<T>(key: string): undefined | T | PromiseLike<T>

- Defined in packages/core/src/browser/widget-manager.ts:194
Type parameters
- T: Widget<T>
Parameters
- key: string
Returns undefined | T | PromiseLike<T>

Protected fromKey

fromKey(key: string): WidgetConstructionOptions

- Defined in packages/core/src/browser/widget-manager.ts:268
Convert the key into the widget construction options object.

Parameters
- key: string
  
  the key.
Returns WidgetConstructionOptions

the widget construction options object.

getDescription

getDescription(widget: Widget): undefined | WidgetConstructionOptions

- Defined in packages/core/src/browser/widget-manager.ts:243
Get the widget construction options.

Parameters
- widget: Widget
  
  the widget.
Returns undefined | WidgetConstructionOptions

the widget construction options if the widget was created through the manager, else undefined.

getOrCreateWidget

getOrCreateWidget<T>(factoryId: string, options?: any): Promise<T>

- Defined in packages/core/src/browser/widget-manager.ts:209
Creates a new widget or returns the existing widget for the given description.

Type parameters
- T: Widget<T>
Parameters
- factoryId: string
  
  the widget factory id.
- Optional options: any
  
  the widget factory specific information.
Returns Promise<T>

a promise resolving to the widget.

getWidget

getWidget<T>(factoryId: string, options?: any): Promise<undefined | T>

- Defined in packages/core/src/browser/widget-manager.ts:187
Get the widget for the given description.

Type parameters
- T: Widget<T>
Parameters
- factoryId: string
  
  The widget factory id.
- Optional options: any
  
  The widget factory specific information.
Returns Promise<undefined | T>

a promise resolving to the widget if available, else undefined.

getWidgets

getWidgets(factoryId: string): Widget[]

- Defined in packages/core/src/browser/widget-manager.ts:142
Get the list of widgets created by the given widget factory.

Parameters
- factoryId: string
  
  the widget factory id.
Returns Widget[]

the list of widgets created by the factory with the given id.

Protected toKey

toKey(options: WidgetConstructionOptions): string

- Defined in packages/core/src/browser/widget-manager.ts:258
Convert the widget construction options to string.

Parameters
- options: WidgetConstructionOptions
  
  the widget construction options.
Returns string

the widget construction options represented as a string.

tryGetPendingWidget

tryGetPendingWidget<T>(factoryId: string, options?: any): undefined | T | PromiseLike<T>

- Defined in packages/core/src/browser/widget-manager.ts:175
Try to get the existing widget for the given description.

Type parameters
- T: Widget<T>
Parameters
- factoryId: string
  
  The widget factory id.
- Optional options: any
  
  The widget factory specific information.
Returns undefined | T | PromiseLike<T>

A promise that resolves to the widget, if any exists. The promise may be pending, so be cautious when assuming that it will not reject.

tryGetWidget

tryGetWidget<T>(factoryId: string, options?: any): undefined | T

- Defined in packages/core/src/browser/widget-manager.ts:159
Try to get the existing widget for the given description.

Type parameters
- T: Widget<T>
Parameters
- factoryId: string
  
  The widget factory id.
- Optional options: any
  
  The widget factory specific information.
Returns undefined | T

the widget if available, else undefined.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WidgetManager

Properties

Protected _cachedFactories

Protected Readonly factoryProvider

Protected Readonly logger

Readonly onDidCreateWidget

Protected Readonly onDidCreateWidgetEmitter

Readonly onWillCreateWidget

Protected Readonly onWillCreateWidgetEmitter

Protected Readonly pendingWidgetPromises

Protected Readonly widgetPromises

Protected Readonly widgets

Accessors

Protected factories

Returns Map<string, WidgetFactory>

Methods

Protected doGetWidget

Type parameters

T: Widget<T>

Parameters

key: string

Returns undefined | T | PromiseLike<T>

Protected fromKey

Parameters

key: string

Returns WidgetConstructionOptions

getDescription

Parameters

widget: Widget

Returns undefined | WidgetConstructionOptions

getOrCreateWidget

Type parameters

T: Widget<T>

Parameters

factoryId: string

Optional options: any

Returns Promise<T>

getWidget

Type parameters

T: Widget<T>

Parameters

factoryId: string

Optional options: any

Returns Promise<undefined | T>

getWidgets

Parameters

factoryId: string

Returns Widget[]

Protected toKey

Parameters

options: WidgetConstructionOptions

Returns string

tryGetPendingWidget

Type parameters

T: Widget<T>

Parameters

factoryId: string

Optional options: any

Returns undefined | T | PromiseLike<T>

tryGetWidget

Type parameters

T: Widget<T>

Parameters

factoryId: string

Optional options: any

Returns undefined | T