Class MainCustomEditorModel

Implements

CustomEditorModel

Index

Constructors

constructor

new MainCustomEditorModel(
    proxy: CustomEditorsExt,
    viewType: string,
    editorResource: URI,
    editable: boolean,
    undoRedoService: UndoRedoService,
    fileService: FileService,
): MainCustomEditorModel
Parameters
- proxy: CustomEditorsExt
- viewType: string
- editorResource: URI
- editable: boolean
- undoRedoService: UndoRedoService
- fileService: FileService
Returns MainCustomEditorModel
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:260

Properties

`Readonly`onContentChanged

onContentChanged: Event<void> = ...

This event is fired when the content of the saveable changes. While onDirtyChanged is fired to notify the UI that the widget is dirty, onContentChanged is used for the auto save throttling.

`Readonly`onDirtyChanged

onDirtyChanged: Event<void> = ...

This event is fired when the content of the dirty variable changes.

`Readonly`viewType

viewType: string

Accessors

dirty

get dirty(): boolean
Returns boolean
Implementation of CustomEditorModel.dirty
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:275

readonly

get readonly(): boolean
Returns boolean
Implementation of CustomEditorModel.readonly
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:285

resource

get resource(): URI
Returns URI
Implementation of CustomEditorModel.resource
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:271

Methods

changeContent

changeContent(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:300

dispose

dispose(): void
Dispose this object.

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

pushEdit

pushEdit(editId: number, label: undefined | string): void
Parameters
- editId: number
- label: undefined | string
Returns void
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:306

redo

redo(): Promise<void>
Returns Promise<void>
Implementation of CustomEditorModel.redo
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:405

revert

revert(options?: RevertOptions): Promise<void>
Reverts dirty changes.
Parameters
- Optionaloptions: RevertOptions
Returns Promise<void>
Implementation of CustomEditorModel.revert
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:323

save

save(options?: SaveOptions): Promise<void>
Saves dirty changes.
Parameters
- Optionaloptions: SaveOptions
Returns Promise<void>
Implementation of CustomEditorModel.save
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:341

saveAs

saveAs(options: SaveAsOptions): Promise<void>
Performs the save operation with a new file name.
Parameters
- options: SaveAsOptions
Returns Promise<void>
Implementation of CustomEditorModel.saveAs
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:371

saveCustomEditor

saveCustomEditor(options?: SaveOptions): Promise<void>
Parameters
- Optionaloptions: SaveOptions
Returns Promise<void>
Implementation of CustomEditorModel.saveCustomEditor
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:345

saveCustomEditorAs

saveCustomEditorAs(
    resource: URI,
    targetResource: URI,
    options?: SaveOptions,
): Promise<void>
Parameters
- resource: URI
- targetResource: URI
- Optionaloptions: SaveOptions
Returns Promise<void>
Implementation of CustomEditorModel.saveCustomEditorAs
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:375

setProxy

setProxy(proxy: CustomEditorsExt): void
Parameters
- proxy: CustomEditorsExt
Returns void
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:289

undo

undo(): Promise<void>
Returns Promise<void>
Implementation of CustomEditorModel.undo
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:388

`Static`create

create(
    proxy: CustomEditorsExt,
    viewType: string,
    resource: URI,
    undoRedoService: UndoRedoService,
    fileService: FileService,
    cancellation: CancellationToken,
): Promise<MainCustomEditorModel>
Parameters
- proxy: CustomEditorsExt
- viewType: string
- resource: URI
- undoRedoService: UndoRedoService
- fileService: FileService
- cancellation: CancellationToken
Returns Promise<MainCustomEditorModel>
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:248

Class MainCustomEditorModel

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MainCustomEditorModel

Properties

ReadonlyonContentChanged

ReadonlyonDirtyChanged

ReadonlyviewType

Accessors

dirty

Returns boolean

readonly

Returns boolean

resource

Returns URI

Methods

changeContent

Returns void

dispose

Returns void

pushEdit

Parameters

Returns void

redo

Returns Promise<void>

revert

Parameters

Returns Promise<void>

save

Parameters

Returns Promise<void>

saveAs

Parameters

Returns Promise<void>

saveCustomEditor

Parameters

Returns Promise<void>

saveCustomEditorAs

Parameters

Returns Promise<void>

setProxy

Parameters

Returns void

undo

Returns Promise<void>

Staticcreate

Parameters

Returns Promise<MainCustomEditorModel>

Settings

On This Page

`Readonly`onContentChanged

`Readonly`onDirtyChanged

`Readonly`viewType

`Static`create