CustomEditorProvider<T extends CustomDocument> class

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.

Implemented types
Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

CustomEditorProvider({OnDidChangeCustomDocument? onDidChangeCustomDocument, Future saveCustomDocument(CustomDocument, CancellationToken)?, Future saveCustomDocumentAs(CustomDocument, Uri, CancellationToken)?, Future revertCustomDocument(CustomDocument, CancellationToken)?, Future backupCustomDocument(CustomDocument, CustomDocumentBackupContext, CancellationToken)?, FutureOr<CustomDocument> openCustomDocument(Uri, CustomDocumentOpenContext, CancellationToken)?, FutureOr<void> resolveCustomEditor(CustomDocument, WebviewPanel, CancellationToken)?})
factory

Properties

backupCustomDocument ↔ Future Function(T, CustomDocumentBackupContext, CancellationToken)

Available on CustomEditorProvider<T>, provided by the CustomEditorProvider$Typings extension

getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
onDidChangeCustomDocument → OnDidChangeCustomDocument

Available on CustomEditorProvider<T>, provided by the CustomEditorProvider$Typings extension

Signal that an edit has occurred inside a custom editor.
no setter
openCustomDocument ↔ FutureOr<T> Function(Uri, CustomDocumentOpenContext, CancellationToken)

Available on CustomReadonlyEditorProvider<T>, provided by the CustomReadonlyEditorProvider$Typings extension

getter/setter pair
resolveCustomEditor ↔ FutureOr<void> Function(T, WebviewPanel, CancellationToken)

Available on CustomReadonlyEditorProvider<T>, provided by the CustomReadonlyEditorProvider$Typings extension

getter/setter pair
revertCustomDocument ↔ Future Function(T, CancellationToken)

Available on CustomEditorProvider<T>, provided by the CustomEditorProvider$Typings extension

getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
saveCustomDocument ↔ Future Function(T, CancellationToken)

Available on CustomEditorProvider<T>, provided by the CustomEditorProvider$Typings extension

getter/setter pair
saveCustomDocumentAs ↔ Future Function(T, Uri, CancellationToken)

Available on CustomEditorProvider<T>, provided by the CustomEditorProvider$Typings extension

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited