Class EditorPreviewManager

Readonlylabel

ReadonlyonActiveEditorChanged

ReadonlyonCreated

ReadonlyonCurrentEditorChanged

activeEditor

• get activeEditor(): undefined | EditorWidget

  The active editor. If there is an active editor (one that has focus), active and current are the same.

  Returns undefined | EditorWidget

all

• get all(): W[]

  Retrieves all open widgets that have been opened by this handler.

  Returns W[]

  all open widgets for this open handler.

currentEditor

• get currentEditor(): undefined | EditorWidget

  The most recently activated editor (which might not have the focus anymore, hence it is not active). If no editor has focus, e.g. when a context menu is shown, the active editor is undefined, but current might be the editor that was active before the menu popped up.

  Returns undefined | EditorWidget

canHandle

• canHandle(uri: URI, options?: WidgetOpenerOptions): 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 number

closeAll

• closeAll(options?: ApplicationShell.CloseOptions): Promise<EditorWidget[]>

  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<EditorWidget[]>

  a promise of all closed widgets that resolves after they have been closed.

createByUri

• createByUri(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget>

  Parameters

  • uri: URI
  • Optionaloptions: EditorOpenerOptions

  Returns Promise<EditorWidget>

getByUri

• getByUri(
      uri: URI,
      options?: EditorOpenerOptions,
  ): Promise<undefined | EditorWidget>

  Tries to get an existing widget for the given uri.

  Parameters

  • uri: URI

    the uri of the widget.

  • Optionaloptions: EditorOpenerOptions

  Returns Promise<undefined | EditorWidget>

  a promise that resolves to the existing widget or undefined if no widget for the given uri exists.

getOrCreateByUri

• getOrCreateByUri(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget>

  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.

  • Optionaloptions: EditorOpenerOptions

  Returns Promise<EditorWidget>

  a promise of the existing or newly created widget.

open

• open(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget>

  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: EditorOpenerOptions

    the widget opener options.

  Returns Promise<EditorWidget>

  promise of the widget that resolves when the widget has been opened.

openToSide

• openToSide(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget>

  Opens an editor to the side of the current editor. Defaults to opening to the right. To modify direction, pass options with {widgetOptions: {mode: ...}}

  Parameters

  • uri: URI
  • Optionaloptions: EditorOpenerOptions

  Returns Promise<EditorWidget>

registerSelectionResolver

• registerSelectionResolver(resolver: EditorSelectionResolver): Disposable

  Registers a dynamic selection resolver. The resolver is added to the sorted list of selection resolvers and can later be disposed to remove it.

  Parameters

  • resolver: EditorSelectionResolver

    The selection resolver to register.

  Returns Disposable

  A Disposable that unregisters the resolver when disposed.