Class NotebookOpenHandler

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

Hierarchy (View Summary)

NavigatableWidgetOpenHandler<NotebookEditorWidget>
- NotebookOpenHandler

Constructors

constructor

new NotebookOpenHandler(): NotebookOpenHandler
Returns NotebookOpenHandler
Inherited from NavigatableWidgetOpenHandler.constructor

Properties

`Readonly`id

id: "notebook" = NotebookEditorWidget.ID

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.

`Protected`notebookTypes

notebookTypes: NotebookTypeDescriptor[] = []

`Readonly`onCreated

onCreated: Event<NotebookEditorWidget>

Emit when a new widget is created.

`Protected` `Readonly`onCreatedEmitter

onCreatedEmitter: Emitter<NotebookEditorWidget>

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`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 NavigatableWidgetOpenHandler.all
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:79

Methods

`Protected`calculatePriority

calculatePriority(notebookType: undefined | NotebookTypeDescriptor): number
Parameters
- notebookType: undefined | NotebookTypeDescriptor
Returns number
- Defined in packages/notebook/src/browser/notebook-open-handler.ts:62

canHandle

canHandle(uri: URI, options?: NotebookWidgetOpenerOptions): 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: NotebookWidgetOpenerOptions
Returns MaybePromise<number>
Overrides NavigatableWidgetOpenHandler.canHandle
- Defined in packages/notebook/src/browser/notebook-open-handler.ts:46

canHandleType

canHandleType(
    uri: URI,
    notebookType?: NotebookTypeDescriptor,
    defaultHandler?: string,
): number
Parameters
- uri: URI
- OptionalnotebookType: NotebookTypeDescriptor
- OptionaldefaultHandler: string
Returns number
- Defined in packages/notebook/src/browser/notebook-open-handler.ts:54

closeAll

closeAll(
options?: ApplicationShell.CloseOptions,
): Promise<NotebookEditorWidget[]>
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<NotebookEditorWidget[]>
a promise of all closed widgets that resolves after they have been closed.
Inherited from NavigatableWidgetOpenHandler.closeAll
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:90

`Protected`createWidgetOptions

createWidgetOptions(
uri: URI,
options?: NotebookWidgetOpenerOptions,
): NotebookEditorWidgetOptions
Parameters
- uri: URI
- Optionaloptions: NotebookWidgetOpenerOptions
Returns NotebookEditorWidgetOptions
Overrides NavigatableWidgetOpenHandler.createWidgetOptions
- Defined in packages/notebook/src/browser/notebook-open-handler.ts:92

`Protected`doOpen

doOpen(
    widget: NotebookEditorWidget,
    uri: URI,
    options?: WidgetOpenerOptions,
): Promise<void>
Parameters
- widget: NotebookEditorWidget
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<void>
Inherited from NavigatableWidgetOpenHandler.doOpen
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:57

`Protected`findHighestPriorityType

findHighestPriorityType(uri: URI): undefined | NotebookTypeDescriptor
Parameters
- uri: URI
Returns undefined | NotebookTypeDescriptor
- Defined in packages/notebook/src/browser/notebook-open-handler.ts:69

getByUri

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

getOrCreateByUri

getOrCreateByUri(uri: URI): Promise<NotebookEditorWidget>
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<NotebookEditorWidget>
a promise of the existing or newly created widget.
Inherited from NavigatableWidgetOpenHandler.getOrCreateByUri
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:73

`Protected`getOrCreateWidget

getOrCreateWidget(
uri: URI,
options?: WidgetOpenerOptions,
): Promise<NotebookEditorWidget>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<NotebookEditorWidget>
Inherited from NavigatableWidgetOpenHandler.getOrCreateWidget
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:82

`Protected`getWidget

getWidget(
uri: URI,
options?: WidgetOpenerOptions,
): Promise<undefined | NotebookEditorWidget>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<undefined | NotebookEditorWidget>
Inherited from NavigatableWidgetOpenHandler.getWidget
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:81

`Protected`init

init(): void
Returns void
Inherited from NavigatableWidgetOpenHandler.init
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:37

`Protected`matches

matches(selectors: readonly NotebookFileSelector[], resource: URI): boolean
Parameters
- selectors: readonly NotebookFileSelector[]
- resource: URI
Returns boolean
- Defined in packages/notebook/src/browser/notebook-open-handler.ts:112

open

open(
uri: URI,
options?: NotebookWidgetOpenerOptions,
): Promise<NotebookEditorWidget>
Override for better options typing
Parameters
- uri: URI
- Optionaloptions: NotebookWidgetOpenerOptions
Returns Promise<NotebookEditorWidget>
Overrides NavigatableWidgetOpenHandler.open
- Defined in packages/notebook/src/browser/notebook-open-handler.ts:88

registerNotebookType

registerNotebookType(notebookType: NotebookTypeDescriptor): Disposable
Parameters
- notebookType: NotebookTypeDescriptor
Returns Disposable
- Defined in packages/notebook/src/browser/notebook-open-handler.ts:39

`Protected`selectorMatches

selectorMatches(selector: NotebookFileSelector, resource: URI): boolean
Parameters
- selector: NotebookFileSelector
- resource: URI
Returns boolean
- Defined in packages/notebook/src/browser/notebook-open-handler.ts:116

`Protected`serializeUri

serializeUri(uri: URI): string
Parameters
- uri: URI
Returns string
Inherited from NavigatableWidgetOpenHandler.serializeUri
- Defined in packages/core/lib/browser/navigatable.d.ts:7

`Protected`tryGetPendingWidget

tryGetPendingWidget(
uri: URI,
options?: WidgetOpenerOptions,
): undefined | MaybePromise<NotebookEditorWidget>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns undefined | MaybePromise<NotebookEditorWidget>
Inherited from NavigatableWidgetOpenHandler.tryGetPendingWidget
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:80

Class NotebookOpenHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns NotebookOpenHandler

Properties

Readonlyid

Implementation

ProtectednotebookTypes

ReadonlyonCreated

Protected ReadonlyonCreatedEmitter

Protected ReadonlypreferenceService

Protected Readonlyshell

Protected ReadonlywidgetManager

Accessors

all

Returns W[]

Methods

ProtectedcalculatePriority

Parameters

Returns number

canHandle

Parameters

Returns MaybePromise<number>

canHandleType

Parameters

Returns number

closeAll

Parameters

Returns Promise<NotebookEditorWidget[]>

ProtectedcreateWidgetOptions

Parameters

Returns NotebookEditorWidgetOptions

ProtecteddoOpen

Parameters

Returns Promise<void>

ProtectedfindHighestPriorityType

Parameters

Returns undefined | NotebookTypeDescriptor

getByUri

Parameters

Returns Promise<undefined | NotebookEditorWidget>

getOrCreateByUri

Parameters

Returns Promise<NotebookEditorWidget>

ProtectedgetOrCreateWidget

Parameters

Returns Promise<NotebookEditorWidget>

ProtectedgetWidget

Parameters

Returns Promise<undefined | NotebookEditorWidget>

Protectedinit

Returns void

Protectedmatches

Parameters

Returns boolean

open

Parameters

Returns Promise<NotebookEditorWidget>

registerNotebookType

Parameters

Returns Disposable

ProtectedselectorMatches

Parameters

Returns boolean

ProtectedserializeUri

Parameters

Returns string

ProtectedtryGetPendingWidget

Parameters

Returns undefined | MaybePromise<NotebookEditorWidget>

Settings

On This Page

`Readonly`id

`Protected`notebookTypes

`Readonly`onCreated

`Protected` `Readonly`onCreatedEmitter

`Protected` `Readonly`preferenceService

`Protected` `Readonly`shell

`Protected` `Readonly`widgetManager

`Protected`calculatePriority

`Protected`createWidgetOptions

`Protected`doOpen

`Protected`findHighestPriorityType

`Protected`getOrCreateWidget

`Protected`getWidget

`Protected`init

`Protected`matches

`Protected`selectorMatches

`Protected`serializeUri

`Protected`tryGetPendingWidget