Interface CustomTextEditorProvider

Provider for text based custom editors.

Text based custom editors use a TextDocument as their data model. This considerably simplifies implementing a custom editor as it allows Theia to handle many common operations such as undo and backup. The provider is responsible for synchronizing text changes between the webview and the TextDocument.

interface CustomTextEditorProvider {
    moveCustomTextEditor?(newDocument, existingWebviewPanel, token): Thenable<void>;
    resolveCustomTextEditor(document, webviewPanel, token): void | Thenable<void>;
}

Methods

moveCustomTextEditor? resolveCustomTextEditor

Methods

Optional moveCustomTextEditor

  • moveCustomTextEditor(newDocument, existingWebviewPanel, token): Thenable<void>

  • Handle when the underlying resource for a custom editor is renamed.

    This allows the webview for the editor be preserved throughout the rename. If this method is not implemented, the editor will destroy the previous custom editor and create a replacement one.

    Parameters

    • newDocument: TextDocument

      New text document to use for the custom editor.

    • existingWebviewPanel: WebviewPanel

      Webview panel for the custom editor.

    • token: CancellationToken

      A cancellation token that indicates the result is no longer needed.

    Returns Thenable<void>

    Thenable indicating that the webview editor has been moved.

resolveCustomTextEditor

  • resolveCustomTextEditor(document, webviewPanel, token): void | Thenable<void>

  • Resolve a custom editor for a given text resource.

    This is called when a user first opens a resource for a CustomTextEditorProvider, or if they reopen an existing editor using this CustomTextEditorProvider.

    Parameters

    • document: TextDocument

      Document for the resource to resolve.

    • webviewPanel: WebviewPanel

      The webview panel used to display the editor UI for this resource.

      During resolve, the provider must fill in the initial html for the content webview panel and hook up all the event listeners on it that it is interested in. The provider can also hold onto the WebviewPanel to use later for example in a command. See WebviewPanel for additional details.

    • token: CancellationToken

      A cancellation token that indicates the result is no longer needed.

    Returns void | Thenable<void>

    Thenable indicating that the custom editor has been resolved.

Settings

Member Visibility

Theme

On This Page

moveCustomTextEditorresolveCustomTextEditor