Class SaveableService

Hierarchy (View Summary)

SaveableService
- FilesystemSaveableService

Implements

FrontendApplicationContribution

Constructors

constructor

new SaveableService(): SaveableService
Returns SaveableService

Properties

`Protected` `Readonly`errorCheckers

errorCheckers: ContributionProvider<SaveErrorChecker>

`Protected` `Readonly`onDidAutoSaveChangeEmitter

onDidAutoSaveChangeEmitter: Emitter<AutoSaveMode> = ...

`Protected` `Readonly`onDidAutoSaveConditionsChangeEmitter

onDidAutoSaveConditionsChangeEmitter: Emitter<void> = ...

`Protected` `Readonly`onDidAutoSaveDelayChangeEmitter

onDidAutoSaveDelayChangeEmitter: Emitter<number> = ...

`Protected`saveDelay

saveDelay: number = 1000

`Protected`saveMode

saveMode: AutoSaveMode = 'off'

`Protected`saveThrottles

saveThrottles: Map<Widget, AutoSaveThrottle> = ...

`Protected`saveWhenNoErrors

saveWhenNoErrors: boolean = false

`Protected`shell

shell: ApplicationShell

`Protected` `Readonly`windowFocusService

windowFocusService: WindowFocusService

Accessors

autoSave

get autoSave(): AutoSaveMode
Returns AutoSaveMode
- Defined in packages/core/src/browser/saveable-service.ts:78
set autoSave(value: AutoSaveMode): void
Parameters
- value: AutoSaveMode
Returns void
- Defined in packages/core/src/browser/saveable-service.ts:82

autoSaveDelay

get autoSaveDelay(): number
Returns number
- Defined in packages/core/src/browser/saveable-service.ts:86
set autoSaveDelay(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/core/src/browser/saveable-service.ts:90

autoSaveWhenNoErrors

get autoSaveWhenNoErrors(): boolean
Returns boolean
- Defined in packages/core/src/browser/saveable-service.ts:94
set autoSaveWhenNoErrors(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/core/src/browser/saveable-service.ts:98

onDidAutoSaveChange

get onDidAutoSaveChange(): Event<AutoSaveMode>
Returns Event<AutoSaveMode>
- Defined in packages/core/src/browser/saveable-service.ts:66

onDidAutoSaveConditionsChange

get onDidAutoSaveConditionsChange(): Event<void>
Returns Event<void>
- Defined in packages/core/src/browser/saveable-service.ts:74

onDidAutoSaveDelayChange

get onDidAutoSaveDelayChange(): Event<number>
Returns Event<number>
- Defined in packages/core/src/browser/saveable-service.ts:70

Methods

`Protected`applySaveableWidget

applySaveableWidget(widget: Widget, saveable: Saveable): void
Parameters
- widget: Widget
- saveable: Saveable
Returns void
- Defined in packages/core/src/browser/saveable-service.ts:229

canSave

canSave(widget?: Widget): widget is Widget & (Saveable | SaveableSource)
Indicate if the document can be saved ('Save' command should be disable if not).
Parameters
- Optionalwidget: Widget
Returns widget is Widget & (Saveable | SaveableSource)
- Defined in packages/core/src/browser/saveable-service.ts:316

canSaveAs

canSaveAs(saveable?: Widget): saveable is Widget & SaveableSource & Navigatable
Parameters
- Optionalsaveable: Widget
Returns saveable is Widget & SaveableSource & Navigatable
- Defined in packages/core/src/browser/saveable-service.ts:339

canSaveNotSaveAs

canSaveNotSaveAs(
widget?: Widget,
): widget is Widget & (Saveable | SaveableSource)
Parameters
- Optionalwidget: Widget
Returns widget is Widget & (Saveable | SaveableSource)
- Defined in packages/core/src/browser/saveable-service.ts:320

`Protected`closeWithoutSaving

closeWithoutSaving(
widget: PostCreationSaveableWidget,
doRevert?: boolean,
): Promise<void>
Parameters
- widget: PostCreationSaveableWidget
- doRevert: boolean = true
Returns Promise<void>
- Defined in packages/core/src/browser/saveable-service.ts:304

`Protected`closeWithSaving

closeWithSaving(
widget: PostCreationSaveableWidget,
options?: SaveableWidget.CloseOptions,
): Promise<void>
Parameters
- widget: PostCreationSaveableWidget
- Optionaloptions: SaveableWidget.CloseOptions
Returns Promise<void>
- Defined in packages/core/src/browser/saveable-service.ts:265

`Protected`createCloseWithSaving

createCloseWithSaving(): (
this: SaveableWidget,
options?: SaveableWidget.CloseOptions,
) => Promise<void>
Returns (this: SaveableWidget, options?: SaveableWidget.CloseOptions) => Promise<void>
- Defined in packages/core/src/browser/saveable-service.ts:249

onDidInitializeLayout

onDidInitializeLayout(app: FrontendApplication): void
An event is emitted when a layout is initialized, but before the shell is attached.
Parameters
- app: FrontendApplication
Returns void
Implementation of FrontendApplicationContribution.onDidInitializeLayout
- Defined in packages/core/src/browser/saveable-service.ts:102

registerSaveable

registerSaveable(widget: Widget, saveable: Saveable): Disposable
Parameters
- widget: Widget
- saveable: Saveable
Returns Disposable
- Defined in packages/core/src/browser/saveable-service.ts:195

save

save(
widget: undefined | Widget,
options?: SaveOptions,
): Promise<undefined | URI>
Saves the document

No op if the widget is not saveable.
Parameters
- widget: undefined | Widget
- Optionaloptions: SaveOptions
Returns Promise<undefined | URI>
- Defined in packages/core/src/browser/saveable-service.ts:330

saveAs

saveAs(
sourceWidget: Widget & SaveableSource & Navigatable,
options?: SaveOptions,
): Promise<undefined | URI>
Parameters
- sourceWidget: Widget & SaveableSource & Navigatable
- Optionaloptions: SaveOptions
Returns Promise<undefined | URI>
- Defined in packages/core/src/browser/saveable-service.ts:343

`Protected`saveOnWindowBlur

saveOnWindowBlur(): void
Save all dirty saveables when the application window loses focus. Triggered for both onFocusChange and onWindowChange auto-save modes, matching VSCode's behavior where a window focus loss is a superset of editor focus loss.

Returns void
- Defined in packages/core/src/browser/saveable-service.ts:152

`Protected`shouldAutoSave

shouldAutoSave(widget: Widget, saveable: Saveable): boolean
Parameters
- widget: Widget
- saveable: Saveable
Returns boolean
- Defined in packages/core/src/browser/saveable-service.ts:212

`Protected`shouldSaveWidget

shouldSaveWidget(
widget: PostCreationSaveableWidget,
options?: SaveableWidget.CloseOptions,
): Promise<undefined | boolean>
Parameters
- widget: PostCreationSaveableWidget
- Optionaloptions: SaveableWidget.CloseOptions
Returns Promise<undefined | boolean>
- Defined in packages/core/src/browser/saveable-service.ts:281

`Protected`updateAutoSaveDelay

updateAutoSaveDelay(delay: number): void
Parameters
- delay: number
Returns void
- Defined in packages/core/src/browser/saveable-service.ts:190

`Protected`updateAutoSaveMode

updateAutoSaveMode(mode: AutoSaveMode): void
Parameters
- mode: AutoSaveMode
Returns void
- Defined in packages/core/src/browser/saveable-service.ts:169

Class SaveableService

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SaveableService

Properties

Protected ReadonlyerrorCheckers

Protected ReadonlyonDidAutoSaveChangeEmitter

Protected ReadonlyonDidAutoSaveConditionsChangeEmitter

Protected ReadonlyonDidAutoSaveDelayChangeEmitter

ProtectedsaveDelay

ProtectedsaveMode

ProtectedsaveThrottles

ProtectedsaveWhenNoErrors

Protectedshell

Protected ReadonlywindowFocusService

Accessors

autoSave

Returns AutoSaveMode

Parameters

Returns void

autoSaveDelay

Returns number

Parameters

Returns void

autoSaveWhenNoErrors

Returns boolean

Parameters

Returns void

onDidAutoSaveChange

Returns Event<AutoSaveMode>

onDidAutoSaveConditionsChange

Returns Event<void>

onDidAutoSaveDelayChange

Returns Event<number>

Methods

ProtectedapplySaveableWidget

Parameters

Returns void

canSave

Parameters

Returns widget is Widget & (Saveable | SaveableSource)

canSaveAs

Parameters

Returns saveable is Widget & SaveableSource & Navigatable

canSaveNotSaveAs

Parameters

Returns widget is Widget & (Saveable | SaveableSource)

ProtectedcloseWithoutSaving

Parameters

Returns Promise<void>

ProtectedcloseWithSaving

Parameters

Returns Promise<void>

ProtectedcreateCloseWithSaving

Returns (this: SaveableWidget, options?: SaveableWidget.CloseOptions) => Promise<void>

onDidInitializeLayout

Parameters

Returns void

registerSaveable

Parameters

Returns Disposable

save

Parameters

Returns Promise<undefined | URI>

saveAs

Parameters

Returns Promise<undefined | URI>

ProtectedsaveOnWindowBlur

Returns void

ProtectedshouldAutoSave

Parameters

Returns boolean

ProtectedshouldSaveWidget

`Protected` `Readonly`errorCheckers

`Protected` `Readonly`onDidAutoSaveChangeEmitter

`Protected` `Readonly`onDidAutoSaveConditionsChangeEmitter

`Protected` `Readonly`onDidAutoSaveDelayChangeEmitter

`Protected`saveDelay

`Protected`saveMode

`Protected`saveThrottles

`Protected`saveWhenNoErrors

`Protected`shell

`Protected` `Readonly`windowFocusService

`Protected`applySaveableWidget

`Protected`closeWithoutSaving

`Protected`closeWithSaving

`Protected`createCloseWithSaving

`Protected`saveOnWindowBlur

`Protected`shouldAutoSave

`Protected`shouldSaveWidget

`Protected`updateAutoSaveDelay

`Protected`updateAutoSaveMode