Class CustomEditorsExtImpl

Hierarchy

CustomEditorsExtImpl

Implements

CustomEditorsExt

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CustomEditorsExtImpl(rpc: RPCProtocol, documentExt: DocumentsExtImpl, webviewExt: WebviewsExtImpl, workspace: WorkspaceExtImpl): CustomEditorsExtImpl

- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:39
Parameters
- rpc: RPCProtocol
- documentExt: DocumentsExtImpl
- webviewExt: WebviewsExtImpl
- workspace: WorkspaceExtImpl
Returns CustomEditorsExtImpl

Properties

Private Readonly documents

documents: CustomDocumentStore = ...

Private Readonly editorProviders

editorProviders: EditorProviderStore = ...

Private Readonly proxy

proxy: CustomEditorsMain

Methods

$createCustomDocument

$createCustomDocument(resource: UriComponents, viewType: string, openContext: CustomDocumentOpenContext, cancellation: CancellationToken): Promise<{ editable: boolean }>

Implementation of CustomEditorsExt.$createCustomDocument
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:84
Parameters
- resource: UriComponents
- viewType: string
- openContext: CustomDocumentOpenContext
- cancellation: CancellationToken
Returns Promise<{ editable: boolean }>

$disposeCustomDocument

$disposeCustomDocument(resource: UriComponents, viewType: string): Promise<void>

Implementation of CustomEditorsExt.$disposeCustomDocument
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:103
Parameters
- resource: UriComponents
- viewType: string
Returns Promise<void>

$disposeEdits

$disposeEdits(resourceComponents: UriComponents, viewType: string, editIds: number[]): void

Implementation of CustomEditorsExt.$disposeEdits
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:161
Parameters
- resourceComponents: UriComponents
- viewType: string
- editIds: number[]
Returns void

$onMoveCustomEditor

$onMoveCustomEditor(handle: string, newResourceComponents: UriComponents, viewType: string): Promise<void>

Implementation of CustomEditorsExt.$onMoveCustomEditor
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:166
Parameters
- handle: string
- newResourceComponents: UriComponents
- viewType: string
Returns Promise<void>

$onSave

$onSave(resourceComponents: UriComponents, viewType: string, cancellation: CancellationToken): Promise<void>

Implementation of CustomEditorsExt.$onSave
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:203
Parameters
- resourceComponents: UriComponents
- viewType: string
- cancellation: CancellationToken
Returns Promise<void>

$onSaveAs

$onSaveAs(resourceComponents: UriComponents, viewType: string, targetResource: UriComponents, cancellation: CancellationToken): Promise<void>

Implementation of CustomEditorsExt.$onSaveAs
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:209
Parameters
- resourceComponents: UriComponents
- viewType: string
- targetResource: UriComponents
- cancellation: CancellationToken
Returns Promise<void>

$redo

$redo(resourceComponents: UriComponents, viewType: string, editId: number, isDirty: boolean): Promise<void>

Implementation of CustomEditorsExt.$redo
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:192
Parameters
- resourceComponents: UriComponents
- viewType: string
- editId: number
- isDirty: boolean
Returns Promise<void>

$resolveWebviewEditor

$resolveWebviewEditor<T>(resource: UriComponents, handler: string, viewType: string, title: string, widgetOpenerOptions: undefined | T, options: WebviewPanelOptions & WebviewOptions, cancellation: CancellationToken): Promise<void>

Implementation of CustomEditorsExt.$resolveWebviewEditor
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:119
Type Parameters
- T
Parameters
- resource: UriComponents
- handler: string
- viewType: string
- title: string
- widgetOpenerOptions: undefined | T
- options: WebviewPanelOptions & WebviewOptions
- cancellation: CancellationToken
Returns Promise<void>

$revert

$revert(resourceComponents: UriComponents, viewType: string, cancellation: CancellationToken): Promise<void>

Implementation of CustomEditorsExt.$revert
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:197
Parameters
- resourceComponents: UriComponents
- viewType: string
- cancellation: CancellationToken
Returns Promise<void>

$undo

$undo(resourceComponents: UriComponents, viewType: string, editId: number, isDirty: boolean): Promise<void>

Implementation of CustomEditorsExt.$undo
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:187
Parameters
- resourceComponents: UriComponents
- viewType: string
- editId: number
- isDirty: boolean
Returns Promise<void>

getCustomDocumentEntry

getCustomDocumentEntry(viewType: string, resource: UriComponents): CustomDocumentStoreEntry

- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:153
Parameters
- viewType: string
- resource: UriComponents
Returns CustomDocumentStoreEntry

Private getCustomEditorProvider

getCustomEditorProvider(viewType: string): CustomEditorProvider<CustomDocument>

- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:215
Parameters
- viewType: string
Returns CustomEditorProvider<CustomDocument>

registerCustomEditorProvider

registerCustomEditorProvider(viewType: string, provider: CustomReadonlyEditorProvider<CustomDocument> | CustomTextEditorProvider, options: { supportsMultipleEditorsPerDocument?: boolean; webviewOptions?: WebviewPanelOptions }, plugin: Plugin): Disposable

- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:46
Parameters
- viewType: string
- provider: CustomReadonlyEditorProvider<CustomDocument> | CustomTextEditorProvider
- options: { supportsMultipleEditorsPerDocument?: boolean; webviewOptions?: WebviewPanelOptions }
  - Optional supportsMultipleEditorsPerDocument?: boolean
  - Optional webviewOptions?: WebviewPanelOptions
- plugin: Plugin
Returns Disposable

Private supportEditing

supportEditing(provider: CustomReadonlyEditorProvider<CustomDocument> | CustomTextEditorProvider | CustomEditorProvider<CustomDocument>): provider is CustomEditorProvider<CustomDocument>

- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:224
Parameters
- provider: CustomReadonlyEditorProvider<CustomDocument> | CustomTextEditorProvider | CustomEditorProvider<CustomDocument>
Returns provider is CustomEditorProvider<CustomDocument>