Class SaveableService

Hierarchy (View Summary)

SaveableService
- FilesystemSaveableService

Implements

FrontendApplicationContribution

Constructors

constructor

new SaveableService(): SaveableService
Returns SaveableService

Properties

`Protected` `Readonly`onDidAutoSaveChangeEmitter

onDidAutoSaveChangeEmitter: Emitter<AutoSaveMode> = ...

`Protected` `Readonly`onDidAutoSaveDelayChangeEmitter

onDidAutoSaveDelayChangeEmitter: Emitter<number> = ...

`Protected`saveDelay

saveDelay: number = 1000

`Protected`saveMode

saveMode: AutoSaveMode = 'off'

`Protected`saveThrottles

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

`Protected`shell

shell: ApplicationShell

Accessors

autoSave

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

autoSaveDelay

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

onDidAutoSaveChange

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

onDidAutoSaveDelayChange

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

Methods

`Protected`addBlurListener

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

`Protected`applySaveableWidget

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

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

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

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

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

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

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

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

registerSaveable

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

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

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

`Protected`shouldAutoSave

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

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

`Protected`updateAutoSaveDelay

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

`Protected`updateAutoSaveMode

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

`Protected`windowHasFocus

windowHasFocus(document: Document): boolean
Parameters
- document: Document
Returns boolean
- Defined in packages/core/src/browser/saveable-service.ts:153