Class PreviewContribution

The command contribution should be implemented to register custom commands and handler.

Hierarchy (View Summary)

NavigatableWidgetOpenHandler<PreviewWidget>
- PreviewContribution

Implements

Constructors

constructor

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

Properties

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Readonly`id

id: "code-editor-preview" = PreviewUri.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.

`Readonly`label

label: string = ...

`Readonly`onCreated

onCreated: Event<PreviewWidget>

Emit when a new widget is created.

`Protected` `Readonly`onCreatedEmitter

onCreatedEmitter: Emitter<PreviewWidget>

`Protected` `Readonly`preferences

preferences: PreviewPreferences

`Protected` `Readonly`previewHandlerProvider

previewHandlerProvider: PreviewHandlerProvider

`Protected`scrollSyncLockOn

scrollSyncLockOn: undefined | "preview" | "editor" = undefined

`Protected`scrollSyncLockTimeout

scrollSyncLockTimeout: undefined | number

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`synchronizedUris

synchronizedUris: Set<string> = ...

`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

`Protected`openByDefault

get openByDefault(): boolean
Returns boolean
- Defined in packages/preview/src/browser/preview-contribution.ts:189

Methods

canHandle

canHandle(uri: URI): 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
Returns number
Overrides NavigatableWidgetOpenHandler.canHandle
- Defined in packages/preview/src/browser/preview-contribution.ts:175

`Protected`canHandleEditorUri

canHandleEditorUri(widget?: Widget): boolean
Parameters
- Optionalwidget: Widget
Returns boolean
- Defined in packages/preview/src/browser/preview-contribution.ts:244

closeAll

closeAll(options?: ApplicationShell.CloseOptions): Promise<PreviewWidget[]>
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<PreviewWidget[]>
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?: WidgetOpenerOptions,
): NavigatableWidgetOptions
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns NavigatableWidgetOptions
Inherited from NavigatableWidgetOpenHandler.createWidgetOptions
- Defined in packages/core/lib/browser/navigatable.d.ts:6

`Protected`doOpen

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

getByUri

getByUri(uri: URI): Promise<undefined | PreviewWidget>
Tries to get an existing widget for the given uri.
Parameters
- uri: URI
  the uri of the widget.
Returns Promise<undefined | PreviewWidget>
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

`Protected`getCurrentEditor

getCurrentEditor(widget?: Widget): undefined | EditorWidget
Parameters
- Optionalwidget: Widget
Returns undefined | EditorWidget
- Defined in packages/preview/src/browser/preview-contribution.ts:254

`Protected`getCurrentEditorUri

getCurrentEditorUri(widget?: Widget): undefined | URI
Parameters
- Optionalwidget: Widget
Returns undefined | URI
- Defined in packages/preview/src/browser/preview-contribution.ts:249

getOrCreateByUri

getOrCreateByUri(uri: URI): Promise<PreviewWidget>
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<PreviewWidget>
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<PreviewWidget>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<PreviewWidget>
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 | PreviewWidget>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<undefined | PreviewWidget>
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`lockScrollSync

lockScrollSync(on: "preview" | "editor", delay?: number): Promise<void>
Parameters
- on: "preview" | "editor"
- delay: number = 50
Returns Promise<void>
- Defined in packages/preview/src/browser/preview-contribution.ts:86

onStart

onStart(): void
Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously.

Returns void
Implementation of FrontendApplicationContribution.onStart
- Defined in packages/preview/src/browser/preview-contribution.ts:76

open

open(uri: URI, options?: PreviewOpenerOptions): Promise<PreviewWidget>
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: PreviewOpenerOptions
  the widget opener options.
Returns Promise<PreviewWidget>
promise of the widget that resolves when the widget has been opened.
Overrides NavigatableWidgetOpenHandler.open
- Defined in packages/preview/src/browser/preview-contribution.ts:193

`Protected`openForEditor

openForEditor(widget?: Widget): Promise<void>
Parameters
- Optionalwidget: Widget
Returns Promise<void>
- Defined in packages/preview/src/browser/preview-contribution.ts:259

`Protected`openSource

openSource(ref: PreviewWidget): Promise<EditorWidget>
Parameters
- ref: PreviewWidget
Returns Promise<EditorWidget>
- Defined in packages/preview/src/browser/preview-contribution.ts:270

registerCommands

registerCommands(registry: CommandRegistry): void
Register commands and handlers.
Parameters
- registry: CommandRegistry
Returns void
Implementation of CommandContribution.registerCommands
- Defined in packages/preview/src/browser/preview-contribution.ts:212

`Protected`registerEditorAndPreviewSync

registerEditorAndPreviewSync(
source: PreviewWidget | EditorWidget,
): Promise<void>
Parameters
- source: PreviewWidget | EditorWidget
Returns Promise<void>
- Defined in packages/preview/src/browser/preview-contribution.ts:96

registerMenus

registerMenus(menus: MenuModelRegistry): void
Registers menus.
Parameters
- menus: MenuModelRegistry
  the menu model registry.
Returns void
Implementation of MenuContribution.registerMenus
- Defined in packages/preview/src/browser/preview-contribution.ts:225

`Protected`registerOpenOnDoubleClick

registerOpenOnDoubleClick(ref: PreviewWidget): void
Parameters
- ref: PreviewWidget
Returns void
- Defined in packages/preview/src/browser/preview-contribution.ts:162

registerToolbarItems

registerToolbarItems(registry: TabBarToolbarRegistry): void
Registers toolbar items.
Parameters
- registry: TabBarToolbarRegistry
  the tabbar toolbar registry.
Returns void
Implementation of TabBarToolbarContribution.registerToolbarItems
- Defined in packages/preview/src/browser/preview-contribution.ts:231

`Protected`resolveOpenerOptions

resolveOpenerOptions(
options?: PreviewOpenerOptions,
): Promise<PreviewOpenerOptions>
Parameters
- Optionaloptions: PreviewOpenerOptions
Returns Promise<PreviewOpenerOptions>
- Defined in packages/preview/src/browser/preview-contribution.ts:201

`Protected`revealSourceLineInPreview

revealSourceLineInPreview(
previewWidget: PreviewWidget,
position: Position,
): void
Parameters
- previewWidget: PreviewWidget
- position: Position
Returns void
- Defined in packages/preview/src/browser/preview-contribution.ts:137

`Protected`serializeUri

serializeUri(uri: URI): string
Parameters
- uri: URI
Returns string
Overrides NavigatableWidgetOpenHandler.serializeUri
- Defined in packages/preview/src/browser/preview-contribution.ts:197

`Protected`synchronizeScrollToEditor

synchronizeScrollToEditor(
previewWidget: PreviewWidget,
editor: TextEditor,
): Disposable
Parameters
- previewWidget: PreviewWidget
- editor: TextEditor
Returns Disposable
- Defined in packages/preview/src/browser/preview-contribution.ts:141

`Protected`tryGetPendingWidget

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

Class PreviewContribution

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PreviewContribution

Properties

Protected ReadonlyeditorManager

Readonlyid

Implementation

Readonlylabel

ReadonlyonCreated

Protected ReadonlyonCreatedEmitter

Protected Readonlypreferences

Protected ReadonlypreviewHandlerProvider

ProtectedscrollSyncLockOn

ProtectedscrollSyncLockTimeout

Protected Readonlyshell

Protected ReadonlysynchronizedUris

Protected ReadonlywidgetManager

Accessors

all

Returns W[]

ProtectedopenByDefault

Returns boolean

Methods

canHandle

Parameters

Returns number

ProtectedcanHandleEditorUri

Parameters

Returns boolean

closeAll

Parameters

Returns Promise<PreviewWidget[]>

ProtectedcreateWidgetOptions

Parameters

Returns NavigatableWidgetOptions

ProtecteddoOpen

Parameters

Returns Promise<void>

getByUri

Parameters

Returns Promise<undefined | PreviewWidget>

ProtectedgetCurrentEditor

Parameters

Returns undefined | EditorWidget

ProtectedgetCurrentEditorUri

Parameters

Returns undefined | URI

getOrCreateByUri

Parameters

Returns Promise<PreviewWidget>

ProtectedgetOrCreateWidget

Parameters

Returns Promise<PreviewWidget>

ProtectedgetWidget

Parameters

Returns Promise<undefined | PreviewWidget>

Protectedinit

Returns void

ProtectedlockScrollSync

Parameters

Returns Promise<void>

onStart

Returns void

open

Parameters

Returns Promise<PreviewWidget>

ProtectedopenForEditor

Parameters

Returns Promise<void>

ProtectedopenSource

Parameters

Returns Promise<EditorWidget>

`Protected` `Readonly`editorManager

`Readonly`id

`Readonly`label

`Readonly`onCreated

`Protected` `Readonly`onCreatedEmitter

`Protected` `Readonly`preferences

`Protected` `Readonly`previewHandlerProvider

`Protected`scrollSyncLockOn

`Protected`scrollSyncLockTimeout

`Protected` `Readonly`shell

`Protected` `Readonly`synchronizedUris

`Protected` `Readonly`widgetManager

`Protected`openByDefault

`Protected`canHandleEditorUri

`Protected`createWidgetOptions

`Protected`doOpen

`Protected`getCurrentEditor

`Protected`getCurrentEditorUri

`Protected`getOrCreateWidget

`Protected`getWidget

`Protected`init

`Protected`lockScrollSync

`Protected`openForEditor

`Protected`openSource

`Protected`registerEditorAndPreviewSync

`Protected`registerOpenOnDoubleClick

`Protected`resolveOpenerOptions

`Protected`revealSourceLineInPreview

`Protected`serializeUri

`Protected`synchronizeScrollToEditor

`Protected`tryGetPendingWidget