Class CustomEditorsExtImpl

Implements

CustomEditorsExt

Index

Constructors

Methods

$createCustomDocument $disposeCustomDocument $disposeEdits $onMoveCustomEditor $redo $resolveWebviewEditor $revert $save $saveAs $undo getCustomDocumentEntry registerCustomEditorProvider

Constructors

constructor

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

Methods

$createCustomDocument

$createCustomDocument(
    resource: UriComponents,
    viewType: string,
    openContext: CustomDocumentOpenContext,
    cancellation: CancellationToken,
): 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: UriComponents, viewType: string): 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: UriComponents,
    viewType: string,
    editIds: number[],
): 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: string,
    newResourceComponents: UriComponents,
    viewType: string,
): Promise<void>
$backup(resource: UriComponents, viewType: string, cancellation: CancellationToken): Promise;
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

$redo

$redo(
    resourceComponents: UriComponents,
    viewType: string,
    editId: number,
    isDirty: boolean,
): 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: UriComponents,
    handler: string,
    viewType: string,
    title: string,
    position: number,
    options: WebviewPanelOptions,
    cancellation: CancellationToken,
): 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: UriComponents,
    viewType: string,
    cancellation: CancellationToken,
): 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

$save

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

$saveAs

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

$undo

$undo(
    resourceComponents: UriComponents,
    viewType: string,
    editId: number,
    isDirty: boolean,
): 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: string,
resource: UriComponents,
): CustomDocumentStoreEntry
Parameters
- viewType: string
- resource: UriComponents
Returns CustomDocumentStoreEntry
- Defined in packages/plugin-ext/src/plugin/custom-editors.ts:151

registerCustomEditorProvider

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

Class CustomEditorsExtImpl

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CustomEditorsExtImpl

Methods

$createCustomDocument

Parameters

Returns Promise<{ editable: boolean }>

$disposeCustomDocument

Parameters

Returns Promise<void>

$disposeEdits

Parameters

Returns void

$onMoveCustomEditor

Parameters

Returns Promise<void>

$redo

Parameters

Returns Promise<void>

$resolveWebviewEditor

Parameters

Returns Promise<void>

$revert

Parameters

Returns Promise<void>

$save

Parameters

Returns Promise<void>

$saveAs

Parameters

Returns Promise<void>

$undo

Parameters

Returns Promise<void>

getCustomDocumentEntry

Parameters

Returns CustomDocumentStoreEntry

registerCustomEditorProvider

Parameters

Returns Disposable

Settings

On This Page