Class CompositeSaveable

Implements

Saveable

Index

Constructors

Properties

isDirty onContentChangedEmitter onDirtyChangedEmitter saveablesMap toDispose

Accessors

dirty onContentChanged onDirtyChanged saveables

Methods

add dispose remove revert save

Constructors

constructor

new CompositeSaveable(): CompositeSaveable
Returns CompositeSaveable

Properties

`Protected`isDirty

isDirty: boolean = false

`Protected` `Readonly`onContentChangedEmitter

onContentChangedEmitter: Emitter<void> = ...

`Protected` `Readonly`onDirtyChangedEmitter

onDirtyChangedEmitter: Emitter<void> = ...

`Protected` `Readonly`saveablesMap

saveablesMap: Map<Saveable, Disposable> = ...

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

Accessors

dirty

get dirty(): boolean
Returns boolean
Implementation of Saveable.dirty
- Defined in packages/core/src/browser/saveable.ts:138

onContentChanged

get 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.

Returns Event<void>
Implementation of Saveable.onContentChanged
- Defined in packages/core/src/browser/saveable.ts:146

onDirtyChanged

get onDirtyChanged(): Event<void>
This event is fired when the content of the dirty variable changes.

Returns Event<void>
Implementation of Saveable.onDirtyChanged
- Defined in packages/core/src/browser/saveable.ts:142

saveables

get saveables(): readonly Saveable[]
Returns readonly Saveable[]
- Defined in packages/core/src/browser/saveable.ts:158

Methods

add

add(saveable: Saveable): void
Parameters
- saveable: Saveable
Returns void
- Defined in packages/core/src/browser/saveable.ts:162

dispose

dispose(): void
Returns void
- Defined in packages/core/src/browser/saveable.ts:194

remove

remove(saveable: Saveable): boolean
Parameters
- saveable: Saveable
Returns boolean
- Defined in packages/core/src/browser/saveable.ts:188

revert

revert(options?: RevertOptions): Promise<void>
Reverts dirty changes.
Parameters
- Optionaloptions: RevertOptions
Returns Promise<void>
Implementation of Saveable.revert
- Defined in packages/core/src/browser/saveable.ts:154

save

save(options?: SaveOptions): Promise<void>
Saves dirty changes.
Parameters
- Optionaloptions: SaveOptions
Returns Promise<void>
Implementation of Saveable.save
- Defined in packages/core/src/browser/saveable.ts:150