Class CustomTextEditorModel

copied from https://github.com/microsoft/vscode/blob/53eac52308c4611000a171cc7bf1214293473c78/src/vs/workbench/contrib/customEditor/common/customTextEditorModel.ts

Implements

CustomEditorModel

Index

Constructors

constructor

new CustomTextEditorModel(
    viewType: string,
    editorResource: URI,
    model: Reference<MonacoEditorModel>,
): CustomTextEditorModel
Parameters
- viewType: string
- editorResource: URI
- model: Reference<MonacoEditorModel>
Returns CustomTextEditorModel
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:465

Properties

`Readonly`editorResource

editorResource: URI

`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:493

editorTextModel

get editorTextModel(): MonacoEditorModel
Returns MonacoEditorModel
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:501

readonly

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

resource

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

Methods

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:484

redo

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

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:505

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:509

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:517

serialize

serialize(): Promise<BinaryBuffer>
Serializes the full state of the saveable item to a binary buffer.

Returns Promise<BinaryBuffer>
Implementation of CustomEditorModel.serialize
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:513

undo

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

`Static`create

create(
    viewType: string,
    resource: URI,
    editorModelService: EditorModelService,
): Promise<CustomTextEditorModel>
Parameters
- viewType: string
- resource: URI
- editorModelService: EditorModelService
Returns Promise<CustomTextEditorModel>
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editors-main.ts:455

Class CustomTextEditorModel

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CustomTextEditorModel

Properties

ReadonlyeditorResource

ReadonlyonContentChanged

ReadonlyonDirtyChanged

ReadonlyviewType

Accessors

dirty

Returns boolean

editorTextModel

Returns MonacoEditorModel

readonly

Returns boolean

resource

Returns URI

Methods

dispose

Returns void

redo

Returns void

revert

Parameters

Returns Promise<void>

save

Parameters

Returns Promise<void>

saveCustomEditor

Parameters

Returns Promise<void>

serialize

Returns Promise<BinaryBuffer>

undo

Returns void

Staticcreate

Parameters

Returns Promise<CustomTextEditorModel>

Settings

On This Page

`Readonly`editorResource

`Readonly`onContentChanged

`Readonly`onDirtyChanged

`Readonly`viewType

`Static`create