dots.vscode.custom-editor-provider
Provider for editable custom editors that use a custom document model.
Custom editors use {@linkcode CustomDocument } as their document model instead of a {@linkcode TextDocument }. This gives extensions full control over actions such as edit, save, and backup.
You should use this type of custom editor when dealing with binary files or more complex scenarios. For simple text based documents, use {@linkcode CustomTextEditorProvider } instead.
Provider for editable custom editors that use a custom document model.
Custom editors use {@linkcode CustomDocument } as their document model instead of a {@linkcode TextDocument }.
This gives extensions full control over actions such as edit, save, and backup.
You should use this type of custom editor when dealing with binary files or more complex scenarios. For simple
text based documents, use {@linkcode CustomTextEditorProvider } instead.backup-custom-documentcljs
(backup-custom-document custom-editor-provider document context cancellation)Back up a dirty custom document.
Backups are used for hot exit and to prevent data loss. Your backup method should persist the resource in
its current state, i.e. with the edits applied. Most commonly this means saving the resource to disk in
the ExtensionContext.storagePath. When the editor reloads and your custom editor is opened for a resource,
your extension should first check to see if any backups exist for the resource. If there is a backup, your
extension should load the file contents from there instead of from the resource in the workspace.
backup is triggered approximately one second after the user stops editing the document. If the user
rapidly edits the document, backup will not be invoked until the editing stops.
backup is not invoked when auto save is enabled (since auto save already persists the resource).
Parameters:
document:T- Document to backup.context:CustomDocumentBackupContext- Information that can be used to backup the document.cancellation:CancellationToken- Token that signals the current backup since a new backup is coming in. It is up to your extension to decided how to respond to cancellation. If for example your extension is backing up a large file in an operation that takes time to complete, your extension may decide to finish the ongoing backup rather than cancelling it to ensure that the editor has some valid backup.
Returns: Thenable<CustomDocumentBackup>
Back up a dirty custom document. Backups are used for hot exit and to prevent data loss. Your `backup` method should persist the resource in its current state, i.e. with the edits applied. Most commonly this means saving the resource to disk in the `ExtensionContext.storagePath`. When the editor reloads and your custom editor is opened for a resource, your extension should first check to see if any backups exist for the resource. If there is a backup, your extension should load the file contents from there instead of from the resource in the workspace. `backup` is triggered approximately one second after the user stops editing the document. If the user rapidly edits the document, `backup` will not be invoked until the editing stops. `backup` is not invoked when `auto save` is enabled (since auto save already persists the resource). **Parameters:** - `document`: `T` - Document to backup. - `context`: `CustomDocumentBackupContext` - Information that can be used to backup the document. - `cancellation`: `CancellationToken` - Token that signals the current backup since a new backup is coming in. It is up to your extension to decided how to respond to cancellation. If for example your extension is backing up a large file in an operation that takes time to complete, your extension may decide to finish the ongoing backup rather than cancelling it to ensure that the editor has some valid backup. **Returns:** `Thenable<CustomDocumentBackup>`
on-did-change-custom-documentcljs
(on-did-change-custom-document custom-editor-provider)Signal that an edit has occurred inside a custom editor.
This event must be fired by your extension whenever an edit happens in a custom editor. An edit can be anything from changing some text, to cropping an image, to reordering a list. Your extension is free to define what an edit is and what data is stored on each edit.
Firing onDidChange causes the editors to be marked as being dirty. This is cleared when the user either
saves or reverts the file.
Editors that support undo/redo must fire a CustomDocumentEditEvent whenever an edit happens. This allows
users to undo and redo the edit using the editor's standard keyboard shortcuts. The editor will also mark
the editor as no longer being dirty if the user undoes all edits to the last saved state.
Editors that support editing but cannot use the editor's standard undo/redo mechanism must fire a CustomDocumentContentChangeEvent.
The only way for a user to clear the dirty state of an editor that does not support undo/redo is to either
save or revert the file.
An editor should only ever fire CustomDocumentEditEvent events, or only ever fire CustomDocumentContentChangeEvent events.
Signal that an edit has occurred inside a custom editor. This event must be fired by your extension whenever an edit happens in a custom editor. An edit can be anything from changing some text, to cropping an image, to reordering a list. Your extension is free to define what an edit is and what data is stored on each edit. Firing `onDidChange` causes the editors to be marked as being dirty. This is cleared when the user either saves or reverts the file. Editors that support undo/redo must fire a `CustomDocumentEditEvent` whenever an edit happens. This allows users to undo and redo the edit using the editor's standard keyboard shortcuts. The editor will also mark the editor as no longer being dirty if the user undoes all edits to the last saved state. Editors that support editing but cannot use the editor's standard undo/redo mechanism must fire a `CustomDocumentContentChangeEvent`. The only way for a user to clear the dirty state of an editor that does not support undo/redo is to either `save` or `revert` the file. An editor should only ever fire `CustomDocumentEditEvent` events, or only ever fire `CustomDocumentContentChangeEvent` events.
open-custom-documentcljs
(open-custom-document custom-editor-provider uri open-context token)Create a new document for a given resource.
openCustomDocument is called when the first time an editor for a given resource is opened. The opened
document is then passed to resolveCustomEditor so that the editor can be shown to the user.
Already opened CustomDocument are re-used if the user opened additional editors. When all editors for a
given resource are closed, the CustomDocument is disposed of. Opening an editor at this point will
trigger another call to openCustomDocument.
Parameters:
uri:Uri- Uri of the document to open.open-context:CustomDocumentOpenContext- Additional information about the opening custom document.token:CancellationToken- A cancellation token that indicates the result is no longer needed.
Returns: T | Thenable<T> - The custom document.
Create a new document for a given resource. `openCustomDocument` is called when the first time an editor for a given resource is opened. The opened document is then passed to `resolveCustomEditor` so that the editor can be shown to the user. Already opened `CustomDocument` are re-used if the user opened additional editors. When all editors for a given resource are closed, the `CustomDocument` is disposed of. Opening an editor at this point will trigger another call to `openCustomDocument`. **Parameters:** - `uri`: `Uri` - Uri of the document to open. - `open-context`: `CustomDocumentOpenContext` - Additional information about the opening custom document. - `token`: `CancellationToken` - A cancellation token that indicates the result is no longer needed. **Returns:** `T | Thenable<T>` - The custom document.
resolve-custom-editorcljs
(resolve-custom-editor custom-editor-provider document webview-panel token)Resolve a custom editor for a given resource.
This is called whenever the user opens a new editor for this CustomEditorProvider.
Parameters:
document:T- Document for the resource being resolved.webview-panel: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 {@linkcode WebviewPanel } for additional details.
token:CancellationToken- A cancellation token that indicates the result is no longer needed.
Returns: void | Thenable<void> - Optional thenable indicating that the custom editor has been resolved.
Resolve a custom editor for a given resource.
This is called whenever the user opens a new editor for this `CustomEditorProvider`.
**Parameters:**
- `document`: `T` - Document for the resource being resolved.
- `webview-panel`: `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 {@linkcode WebviewPanel } for additional details.
- `token`: `CancellationToken` - A cancellation token that indicates the result is no longer needed.
**Returns:** `void | Thenable<void>` - Optional thenable indicating that the custom editor has been resolved.revert-custom-documentcljs
(revert-custom-document custom-editor-provider document cancellation)Revert a custom document to its last saved state.
This method is invoked by the editor when the user triggers File: Revert File in a custom editor. (Note that
this is only used using the editor's File: Revert File command and not on a git revert of the file).
To implement revert, the implementer must make sure all editor instances (webviews) for document
are displaying the document in the same state is saved in. This usually means reloading the file from the
workspace.
Parameters:
document:T- Document to revert.cancellation:CancellationToken- Token that signals the revert is no longer required.
Returns: Thenable<void> - Thenable signaling that the change has completed.
Revert a custom document to its last saved state. This method is invoked by the editor when the user triggers `File: Revert File` in a custom editor. (Note that this is only used using the editor's `File: Revert File` command and not on a `git revert` of the file). To implement `revert`, the implementer must make sure all editor instances (webviews) for `document` are displaying the document in the same state is saved in. This usually means reloading the file from the workspace. **Parameters:** - `document`: `T` - Document to revert. - `cancellation`: `CancellationToken` - Token that signals the revert is no longer required. **Returns:** `Thenable<void>` - Thenable signaling that the change has completed.
save-custom-documentcljs
(save-custom-document custom-editor-provider document cancellation)Save a custom document.
This method is invoked by the editor when the user saves a custom editor. This can happen when the user
triggers save while the custom editor is active, by commands such as save all, or by auto save if enabled.
To implement save, the implementer must persist the custom editor. This usually means writing the
file data for the custom document to disk. After save completes, any associated editor instances will
no longer be marked as dirty.
Parameters:
document:T- Document to save.cancellation:CancellationToken- Token that signals the save is no longer required (for example, if another save was triggered).
Returns: Thenable<void> - Thenable signaling that saving has completed.
Save a custom document. This method is invoked by the editor when the user saves a custom editor. This can happen when the user triggers save while the custom editor is active, by commands such as `save all`, or by auto save if enabled. To implement `save`, the implementer must persist the custom editor. This usually means writing the file data for the custom document to disk. After `save` completes, any associated editor instances will no longer be marked as dirty. **Parameters:** - `document`: `T` - Document to save. - `cancellation`: `CancellationToken` - Token that signals the save is no longer required (for example, if another save was triggered). **Returns:** `Thenable<void>` - Thenable signaling that saving has completed.
save-custom-document-ascljs
(save-custom-document-as custom-editor-provider
document
destination
cancellation)Save a custom document to a different location.
This method is invoked by the editor when the user triggers 'save as' on a custom editor. The implementer must
persist the custom editor to destination.
When the user accepts save as, the current editor is be replaced by an non-dirty editor for the newly saved file.
Parameters:
document:T- Document to save.destination:Uri- Location to save to.cancellation:CancellationToken- Token that signals the save is no longer required.
Returns: Thenable<void> - Thenable signaling that saving has completed.
Save a custom document to a different location. This method is invoked by the editor when the user triggers 'save as' on a custom editor. The implementer must persist the custom editor to `destination`. When the user accepts save as, the current editor is be replaced by an non-dirty editor for the newly saved file. **Parameters:** - `document`: `T` - Document to save. - `destination`: `Uri` - Location to save to. - `cancellation`: `CancellationToken` - Token that signals the save is no longer required. **Returns:** `Thenable<void>` - Thenable signaling that saving has completed.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close