Class DelegatingSaveable

constructor

• new DelegatingSaveable(): DelegatingSaveable

  Returns DelegatingSaveable

dirty

delegate

• set delegate(delegate: Saveable): void

  Parameters

  • delegate: Saveable

  Returns void

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>

onDirtyChanged

• get onDirtyChanged(): Event<void>

  This event is fired when the content of the dirty variable changes.

  Returns Event<void>

OptionalapplySnapshot

• applySnapshot?(snapshot: object): void

  Applies the given snapshot to the dirty state.

  Parameters

  • snapshot: object

  Returns void

OptionalcreateSnapshot

• createSnapshot?(): Saveable.Snapshot

  Creates a snapshot of the dirty state. See also Saveable.Snapshot.

  Returns Saveable.Snapshot

Optionalrevert

• revert?(options?: RevertOptions): Promise<void>

  Reverts dirty changes.

  Parameters

  • Optionaloptions: RevertOptions

  Returns Promise<void>

save

• save(options?: SaveOptions): Promise<void>

  Saves dirty changes.

  Parameters

  • Optionaloptions: SaveOptions

  Returns Promise<void>

OptionalsaveAs

• saveAs?(options: SaveAsOptions): MaybePromise<void>

  Performs the save operation with a new file name.

  Parameters

  • options: SaveAsOptions

  Returns MaybePromise<void>

Optionalserialize

• serialize?(): Promise<BinaryBuffer>

  Serializes the full state of the saveable item to a binary buffer.

  Returns Promise<BinaryBuffer>