Class WidgetOpenHandler<W>`Abstract`

Generic base class for OpenHandlers that are opening a widget for a given URI.

Type Parameters

W extends BaseWidget

Hierarchy (View Summary)

WidgetOpenHandler
- NavigatableWidgetOpenHandler
- VSXExtensionEditorManager

Implements

OpenHandler

Index

Constructors

Properties

id onCreated onCreatedEmitter shell widgetManager

Accessors

Methods

canHandle closeAll createWidgetOptions doOpen getByUri getOrCreateByUri getOrCreateWidget getWidget init open tryGetPendingWidget

Constructors

constructor

new WidgetOpenHandler<W extends BaseWidget>(): WidgetOpenHandler<W>
Type Parameters
- W extends BaseWidget
Returns WidgetOpenHandler<W>

Properties

`Abstract` `Readonly`id

id: string

The widget open handler id.

Implementation

A widget factory for this id should be registered.
Subclasses should not implement WidgetFactory to avoid exposing capabilities to create a widget outside of WidgetManager.

`Readonly`onCreated

onCreated: Event<W> = ...

Emit when a new widget is created.

`Protected` `Readonly`onCreatedEmitter

onCreatedEmitter: Emitter<W> = ...

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

Accessors

all

get all(): W[]
Retrieves all open widgets that have been opened by this handler.

Returns W[]
all open widgets for this open handler.
- Defined in packages/core/src/browser/widget-open-handler.ts:138

Methods

`Abstract`canHandle

canHandle(uri: URI, options?: WidgetOpenerOptions): MaybePromise<number>
Test whether this handler can open the given URI for given options. Return a nonzero number if this handler can open; otherwise it cannot. Never reject.

A returned value indicating a priority of this handler.
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns MaybePromise<number>
Implementation of OpenHandler.canHandle
- Defined in packages/core/src/browser/widget-open-handler.ts:81

closeAll

closeAll(options?: ApplicationShell.CloseOptions): Promise<W[]>
Closes all widgets that have been opened by this open handler.
Parameters
- Optionaloptions: ApplicationShell.CloseOptions
  the close options that should be applied to all widgets.
Returns Promise<W[]>
a promise of all closed widgets that resolves after they have been closed.
- Defined in packages/core/src/browser/widget-open-handler.ts:165

`Protected` `Abstract`createWidgetOptions

createWidgetOptions(uri: URI, options?: WidgetOpenerOptions): Object
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Object
- Defined in packages/core/src/browser/widget-open-handler.ts:157

`Protected`doOpen

doOpen(widget: W, uri: URI, options?: WidgetOpenerOptions): Promise<void>
Parameters
- widget: W
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<void>
- Defined in packages/core/src/browser/widget-open-handler.ts:96

getByUri

getByUri(uri: URI): Promise<undefined | W>
Tries to get an existing widget for the given uri.
Parameters
- uri: URI
  the uri of the widget.
Returns Promise<undefined | W>
a promise that resolves to the existing widget or undefined if no widget for the given uri exists.
- Defined in packages/core/src/browser/widget-open-handler.ts:117

getOrCreateByUri

getOrCreateByUri(uri: URI): Promise<W>
Return an existing widget for the given uri or creates a new one.

It does not open a widget, use WidgetOpenHandler#open instead.
Parameters
- uri: URI
  uri of the widget.
Returns Promise<W>
a promise of the existing or newly created widget.
- Defined in packages/core/src/browser/widget-open-handler.ts:129

`Protected`getOrCreateWidget

getOrCreateWidget(uri: URI, options?: WidgetOpenerOptions): Promise<W>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<W>
- Defined in packages/core/src/browser/widget-open-handler.ts:152

`Protected`getWidget

getWidget(uri: URI, options?: WidgetOpenerOptions): Promise<undefined | W>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<undefined | W>
- Defined in packages/core/src/browser/widget-open-handler.ts:147

`Protected`init

init(): void
Returns void
- Defined in packages/core/src/browser/widget-open-handler.ts:64

open

open(uri: URI, options?: WidgetOpenerOptions): Promise<W>
Open a widget for the given uri and options. Reject if the given options are not widget options or a widget cannot be opened.
Parameters
- uri: URI
  the uri of the resource that should be opened.
- Optionaloptions: WidgetOpenerOptions
  the widget opener options.
Returns Promise<W>
promise of the widget that resolves when the widget has been opened.
Implementation of OpenHandler.open
- Defined in packages/core/src/browser/widget-open-handler.ts:91

`Protected`tryGetPendingWidget

tryGetPendingWidget(
uri: URI,
options?: WidgetOpenerOptions,
): undefined | MaybePromise<W>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns undefined | MaybePromise<W>
- Defined in packages/core/src/browser/widget-open-handler.ts:142