Class SaveableService

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): 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): 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, saveable): Disposable
Parameters
- widget: Widget
- saveable: Saveable
Returns Disposable
- Defined in packages/core/src/browser/saveable-service.ts:134

`Protected` applySaveableWidget

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

canSave

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

canSaveAs

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

canSaveNotSaveAs

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

`Protected` closeWithSaving

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

`Protected` closeWithoutSaving

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

`Protected` createCloseWithSaving

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

onDidInitializeLayout

onDidInitializeLayout(app): 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, saveable): Disposable
Parameters
- widget: Widget
- saveable: Saveable
Returns Disposable
- Defined in packages/core/src/browser/saveable-service.ts:116

save

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

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

saveAs

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

`Protected` shouldAutoSave

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

`Protected` shouldSaveWidget

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

`Protected` updateAutoSaveDelay

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

`Protected` updateAutoSaveMode

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

`Protected` windowHasFocus

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