Class CustomEditorsMainImpl

Implements

Constructors

constructor

new CustomEditorsMainImpl(
    rpc: RPCProtocol,
    container: Container,
    webviewsMain: WebviewsMainImpl,
): CustomEditorsMainImpl
Parameters
- rpc: RPCProtocol
- container: Container
- webviewsMain: WebviewsMainImpl
Returns CustomEditorsMainImpl
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:65

Properties

`Protected` `Readonly`customEditorRegistry

customEditorRegistry: PluginCustomEditorRegistry

`Protected` `Readonly`customEditorService

customEditorService: CustomEditorService

`Protected` `Readonly`editorPreferences

editorPreferences: EditorPreferences

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`undoRedoService

undoRedoService: UndoRedoService

`Readonly`webviewsMain

webviewsMain: WebviewsMainImpl

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

Methods

$onContentChange

$onContentChange(
resourceComponents: UriComponents,
viewType: string,
): Promise<void>
Parameters
- resourceComponents: UriComponents
- viewType: string
Returns Promise<void>
Implementation of CustomEditorsMain.$onContentChange
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:214

$onDidEdit

$onDidEdit(
    resourceComponents: UriComponents,
    viewType: string,
    editId: number,
    label: undefined | string,
): Promise<void>
Parameters
- resourceComponents: UriComponents
- viewType: string
- editId: number
- label: undefined | string
Returns Promise<void>
Implementation of CustomEditorsMain.$onDidEdit
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:209

$registerCustomEditorProvider

$registerCustomEditorProvider(
    viewType: string,
    options: WebviewPanelOptions,
    supportsMultipleEditorsPerDocument: boolean,
): void
Parameters
- viewType: string
- options: WebviewPanelOptions
- supportsMultipleEditorsPerDocument: boolean
Returns void
Implementation of CustomEditorsMain.$registerCustomEditorProvider
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:94

$registerTextEditorProvider

$registerTextEditorProvider(
    viewType: string,
    options: WebviewPanelOptions,
    capabilities: CustomTextEditorCapabilities,
): void
Parameters
- viewType: string
- options: WebviewPanelOptions
- capabilities: CustomTextEditorCapabilities
Returns void
Implementation of CustomEditorsMain.$registerTextEditorProvider
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:89

$unregisterEditorProvider

$unregisterEditorProvider(viewType: string): void
Parameters
- viewType: string
Returns void
Implementation of CustomEditorsMain.$unregisterEditorProvider
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:165

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:82

`Protected`getCustomEditorModel

getCustomEditorModel(
resourceComponents: UriComponents,
viewType: string,
): Promise<MainCustomEditorModel>
Parameters
- resourceComponents: UriComponents
- viewType: string
Returns Promise<MainCustomEditorModel>
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:200

`Protected`getOrCreateCustomEditorModel

getOrCreateCustomEditorModel(
    modelType: CustomEditorModelType,
    resource: URI,
    viewType: string,
    cancellationToken: CancellationToken,
): Promise<Reference<CustomEditorModel>>
Parameters
- modelType: CustomEditorModelType
- resource: URI
- viewType: string
- cancellationToken: CancellationToken
Returns Promise<Reference<CustomEditorModel>>
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:177

`Protected`registerEditorProvider

registerEditorProvider(
    modelType: CustomEditorModelType,
    viewType: string,
    options: WebviewPanelOptions,
    capabilities: CustomTextEditorCapabilities,
    supportsMultipleEditorsPerDocument: boolean,
): Promise<void>
Parameters
- modelType: CustomEditorModelType
- viewType: string
- options: WebviewPanelOptions
- capabilities: CustomTextEditorCapabilities
- supportsMultipleEditorsPerDocument: boolean
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:98

Class CustomEditorsMainImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CustomEditorsMainImpl

Properties

Protected ReadonlycustomEditorRegistry

Protected ReadonlycustomEditorService

Protected ReadonlyeditorPreferences

Protected ReadonlyfileService

Protected ReadonlylabelProvider

Protected ReadonlypluginService

Protected Readonlyshell

Protected ReadonlytextModelService

Protected ReadonlyundoRedoService

ReadonlywebviewsMain

Protected ReadonlywidgetManager

Methods

$onContentChange

Parameters

Returns Promise<void>

$onDidEdit

Parameters

Returns Promise<void>

$registerCustomEditorProvider

Parameters

Returns void

$registerTextEditorProvider

Parameters

Returns void

$unregisterEditorProvider

Parameters

Returns void

dispose

Returns void

ProtectedgetCustomEditorModel

Parameters

Returns Promise<MainCustomEditorModel>

ProtectedgetOrCreateCustomEditorModel

Parameters

Returns Promise<Reference<CustomEditorModel>>

ProtectedregisterEditorProvider

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`customEditorRegistry

`Protected` `Readonly`customEditorService

`Protected` `Readonly`editorPreferences

`Protected` `Readonly`fileService

`Protected` `Readonly`labelProvider

`Protected` `Readonly`pluginService

`Protected` `Readonly`shell

`Protected` `Readonly`textModelService

`Protected` `Readonly`undoRedoService

`Readonly`webviewsMain

`Protected` `Readonly`widgetManager

`Protected`getCustomEditorModel

`Protected`getOrCreateCustomEditorModel

`Protected`registerEditorProvider