Class NotebookOpenHandler

Hierarchy

NavigatableWidgetOpenHandler<NotebookEditorWidget>
- NotebookOpenHandler

Index

Constructors

Properties

id notebookTypes preferenceService

Methods

calculatePriority canHandle canHandleType createWidgetOptions findHighestPriorityType matches open registerNotebookType selectorMatches

Constructors

constructor

new NotebookOpenHandler(): NotebookOpenHandler
Returns NotebookOpenHandler
Inherited from NavigatableWidgetOpenHandler<NotebookEditorWidget>.constructor

Properties

`Readonly` id

id: "notebook" = NotebookEditorWidget.ID

`Protected` notebookTypes

notebookTypes: NotebookTypeDescriptor[] = []

`Protected` `Readonly` preferenceService

preferenceService: PreferenceService

Methods

`Protected` calculatePriority

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

canHandle

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

canHandleType

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

`Protected` createWidgetOptions

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

`Protected` findHighestPriorityType

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

`Protected` matches

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

open

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

registerNotebookType

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

`Protected` selectorMatches

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