Class NavigatableWidgetOpenHandler<W>`Abstract`

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

Type Parameters

W extends NavigatableWidget

Hierarchy (View Summary)

WidgetOpenHandler<W>
- NavigatableWidgetOpenHandler

Index

Constructors

constructor

new NavigatableWidgetOpenHandler<W extends NavigatableWidget>(): NavigatableWidgetOpenHandler<
W,
>
Type Parameters
- W extends NavigatableWidget
Returns NavigatableWidgetOpenHandler<W>
Inherited from WidgetOpenHandler.constructor

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.
Inherited from WidgetOpenHandler.all
- 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>
Inherited from WidgetOpenHandler.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.
Inherited from WidgetOpenHandler.closeAll
- Defined in packages/core/src/browser/widget-open-handler.ts:165

`Protected`createWidgetOptions

createWidgetOptions(
uri: URI,
options?: WidgetOpenerOptions,
): NavigatableWidgetOptions
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns NavigatableWidgetOptions
Overrides WidgetOpenHandler.createWidgetOptions
- Defined in packages/core/src/browser/navigatable.ts:24

`Protected`doOpen

doOpen(widget: W, uri: URI, options?: WidgetOpenerOptions): Promise<void>
Parameters
- widget: W
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<void>
Inherited from WidgetOpenHandler.doOpen
- 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.
Inherited from WidgetOpenHandler.getByUri
- 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.
Inherited from WidgetOpenHandler.getOrCreateByUri
- 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>
Inherited from WidgetOpenHandler.getOrCreateWidget
- 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>
Inherited from WidgetOpenHandler.getWidget
- Defined in packages/core/src/browser/widget-open-handler.ts:147

`Protected`init

init(): void
Returns void
Inherited from WidgetOpenHandler.init
- 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.
Inherited from WidgetOpenHandler.open
- Defined in packages/core/src/browser/widget-open-handler.ts:91

`Protected`serializeUri

serializeUri(uri: URI): string
Parameters
- uri: URI
Returns string
- Defined in packages/core/src/browser/navigatable.ts:31

`Protected`tryGetPendingWidget

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

Class NavigatableWidgetOpenHandler<W>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns NavigatableWidgetOpenHandler<W>

Properties

Abstract Readonlyid

Implementation

ReadonlyonCreated

Protected ReadonlyonCreatedEmitter

Protected Readonlyshell

Protected ReadonlywidgetManager

Accessors

all

Returns W[]

Methods

AbstractcanHandle

Parameters

Returns MaybePromise<number>

closeAll

Parameters

Returns Promise<W[]>

ProtectedcreateWidgetOptions

Parameters

Returns NavigatableWidgetOptions

ProtecteddoOpen

Parameters

Returns Promise<void>

getByUri

Parameters

Returns Promise<undefined | W>

getOrCreateByUri

Parameters

Returns Promise<W>

ProtectedgetOrCreateWidget

Parameters

Returns Promise<W>

ProtectedgetWidget

Parameters

Returns Promise<undefined | W>

Protectedinit

Returns void

open

Parameters

Returns Promise<W>

ProtectedserializeUri

Parameters

Returns string

ProtectedtryGetPendingWidget

Parameters

Returns undefined | MaybePromise<W>

Settings

On This Page

Class NavigatableWidgetOpenHandler<W>`Abstract`

`Abstract` `Readonly`id

`Readonly`onCreated

`Protected` `Readonly`onCreatedEmitter

`Protected` `Readonly`shell

`Protected` `Readonly`widgetManager

`Abstract`canHandle

`Protected`createWidgetOptions

`Protected`doOpen

`Protected`getOrCreateWidget

`Protected`getWidget

`Protected`init

`Protected`serializeUri

`Protected`tryGetPendingWidget