Class CustomEditorsExtImpl

Implements

CustomEditorsExt

Constructors

constructor

new CustomEditorsExtImpl(rpc, documentExt, webviewExt): CustomEditorsExtImpl
Parameters
- rpc: RPCProtocol
- documentExt: DocumentsExtImpl
- webviewExt: WebviewsExtImpl
Returns CustomEditorsExtImpl
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:39

Properties

`Private` `Readonly` documentExt

documentExt: DocumentsExtImpl

`Private` `Readonly` documents

documents: CustomDocumentStore = ...

`Private` `Readonly` editorProviders

editorProviders: EditorProviderStore = ...

`Private` `Readonly` proxy

proxy: CustomEditorsMain

`Private` `Readonly` webviewExt

webviewExt: WebviewsExtImpl

Methods

$createCustomDocument

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

$disposeCustomDocument

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

$disposeEdits

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

$onMoveCustomEditor

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

$onSave

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

$onSaveAs

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

$redo

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

$resolveWebviewEditor

$resolveWebviewEditor(resource, handler, viewType, title, position, options, cancellation): Promise<void>
Parameters
- resource: UriComponents
- handler: string
- viewType: string
- title: string
- position: number
- options: WebviewPanelOptions
- cancellation: CancellationToken
Returns Promise<void>
Implementation of CustomEditorsExt.$resolveWebviewEditor
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:118

$revert

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

$undo

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

getCustomDocumentEntry

getCustomDocumentEntry(viewType, resource): CustomDocumentStoreEntry
Parameters
- viewType: string
- resource: UriComponents
Returns CustomDocumentStoreEntry
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:151

`Private` getCustomEditorProvider

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

registerCustomEditorProvider

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

`Private` supportEditing

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

Class CustomEditorsExtImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CustomEditorsExtImpl

Properties

Private Readonly documentExt

Private Readonly documents

Private Readonly editorProviders

Private Readonly proxy

Private Readonly webviewExt

Methods

$createCustomDocument

Parameters

Returns Promise<{ editable: boolean; }>

$disposeCustomDocument

Parameters

Returns Promise<void>

$disposeEdits

Parameters

Returns void

$onMoveCustomEditor

Parameters

Returns Promise<void>

$onSave

Parameters

Returns Promise<void>

$onSaveAs

Parameters

Returns Promise<void>

$redo

Parameters

Returns Promise<void>

$resolveWebviewEditor

Parameters

Returns Promise<void>

$revert

Parameters

Returns Promise<void>

$undo

Parameters

Returns Promise<void>

getCustomDocumentEntry

Parameters

Returns CustomDocumentStoreEntry

Private getCustomEditorProvider

Parameters

Returns CustomEditorProvider<CustomDocument>

registerCustomEditorProvider

Parameters

Optional supportsMultipleEditorsPerDocument?: boolean

Optional webviewOptions?: WebviewPanelOptions

Returns Disposable

Private supportEditing

Parameters

Returns provider is CustomEditorProvider<CustomDocument>

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` documentExt

`Private` `Readonly` documents

`Private` `Readonly` editorProviders

`Private` `Readonly` proxy

`Private` `Readonly` webviewExt

Returns Promise<{
editable: boolean;
}>

`Private` getCustomEditorProvider

`Optional` supportsMultipleEditorsPerDocument?: boolean

`Optional` webviewOptions?: WebviewPanelOptions

`Private` supportEditing