Class CustomEditorOpener

constructor

• new CustomEditorOpener(
      editor: CustomEditor,
      shell: ApplicationShell,
      widgetManager: WidgetManager,
      editorRegistry: PluginCustomEditorRegistry,
      preferenceService: PreferenceService,
  ): CustomEditorOpener

  Parameters

  • editor: CustomEditor
  • shell: ApplicationShell
  • widgetManager: WidgetManager
  • editorRegistry: PluginCustomEditorRegistry
  • preferenceService: PreferenceService

  Returns CustomEditorOpener

Readonlyid

Readonlylabel

ReadonlyonDidOpenCustomEditor

canHandle

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

  Returns number

canOpenWith

• canOpenWith(uri: URI): number

  Parameters

  • uri: URI

  Returns number

getPriority

• getPriority(): number

  Returns number

matches

• matches(selectors: CustomEditorSelector[], resource: URI): boolean

  Parameters

  • selectors: CustomEditorSelector[]
  • resource: URI

  Returns boolean

open

• open(uri: URI, options?: WidgetOpenerOptions): Promise<undefined | Widget>

  Open a widget for the given URI and options. Resolve to an opened widget or undefined, e.g. if a page is opened. Never reject if canHandle return a positive number; otherwise should reject.

  Parameters

  • uri: URI
  • Optionaloptions: WidgetOpenerOptions

  Returns Promise<undefined | Widget>

selectorMatches

• selectorMatches(selector: CustomEditorSelector, resource: URI): boolean

  Parameters

  • selector: CustomEditorSelector
  • resource: URI

  Returns boolean

StatictoCustomEditorId

• toCustomEditorId(editorViewType: string): string

  Parameters

  • editorViewType: string

  Returns string