Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PreviewContribution

Hierarchy

  • NavigatableWidgetOpenHandler<PreviewWidget>
    • PreviewContribution

Implements

  • CommandContribution
  • MenuContribution
  • FrontendApplicationContribution
  • TabBarToolbarContribution

Index

Constructors

constructor

  • Returns PreviewContribution

Properties

Protected Readonly editorManager

editorManager: EditorManager

Readonly id

id: "code-editor-preview" = ...

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: PreferenceProxy<PreviewConfiguration>

Protected Readonly previewHandlerProvider

previewHandlerProvider: PreviewHandlerProvider

Protected scrollSyncLockOn

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

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.

Protected openByDefault

  • get openByDefault(): boolean

Methods

canHandle

  • canHandle(uri: default): number

Protected canHandleEditorUri

  • canHandleEditorUri(widget?: Widget): boolean

closeAll

  • Closes all widgets that have been opened by this open handler.

    Parameters

    • Optional options: 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.

Protected createWidgetOptions

  • createWidgetOptions(uri: default, options?: WidgetOpenerOptions): NavigatableWidgetOptions
  • Parameters

    • uri: default
    • Optional options: WidgetOpenerOptions

    Returns NavigatableWidgetOptions

Protected doOpen

  • doOpen(widget: PreviewWidget, options?: WidgetOpenerOptions): Promise<void>
  • Parameters

    Returns Promise<void>

getByUri

  • Tries to get an existing widget for the given uri.

    Parameters

    • uri: default

      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.

Protected getCurrentEditor

  • getCurrentEditor(widget?: Widget): undefined | EditorWidget

Protected getCurrentEditorUri

  • getCurrentEditorUri(widget?: Widget): undefined | default

getOrCreateByUri

  • Return an existing widget for the given uri or creates a new one.

    It does not open a widget, use {@link WidgetOpenHandler#open} instead.

    Parameters

    • uri: default

      uri of the widget.

    Returns Promise<PreviewWidget>

    a promise of the existing or newly created widget.

Protected getOrCreateWidget

  • getOrCreateWidget(uri: default, options?: WidgetOpenerOptions): Promise<PreviewWidget>
  • Parameters

    • uri: default
    • Optional options: WidgetOpenerOptions

    Returns Promise<PreviewWidget>

Protected getWidget

  • getWidget(uri: default, options?: WidgetOpenerOptions): Promise<undefined | PreviewWidget>
  • Parameters

    • uri: default
    • Optional options: WidgetOpenerOptions

    Returns Promise<undefined | PreviewWidget>

Protected init

  • init(): void
  • Returns void

Protected lockScrollSync

  • lockScrollSync(on: "preview" | "editor", delay?: number): Promise<void>

onStart

  • onStart(): void

open

Protected openForEditor

  • openForEditor(widget?: Widget): Promise<void>

Protected openSource

registerCommands

  • registerCommands(registry: CommandRegistry): void

Protected registerEditorAndPreviewSync

  • registerEditorAndPreviewSync(source: PreviewWidget | EditorWidget): Promise<void>

registerMenus

  • registerMenus(menus: MenuModelRegistry): void

Protected registerOpenOnDoubleClick

registerToolbarItems

  • registerToolbarItems(registry: TabBarToolbarRegistry): void

Protected resolveOpenerOptions

Protected revealSourceLineInPreview

  • revealSourceLineInPreview(previewWidget: PreviewWidget, position: Position): void

Protected serializeUri

  • serializeUri(uri: default): string

Protected synchronizeScrollToEditor

  • synchronizeScrollToEditor(previewWidget: PreviewWidget, editor: TextEditor): Disposable

Protected tryGetPendingWidget

  • Parameters

    • uri: default
    • Optional options: WidgetOpenerOptions

    Returns undefined | PreviewWidget | PromiseLike<PreviewWidget>