editor › Globals › UndoEngine

Class: UndoEngine

Provides Undo and Redo functionality

Hierarchy

• UndoEngine

Index

Constructors

• constructor

Properties

• editor
• enabled
• modelHistory

Methods

• _modelRollback
• disable
• enable
• getSerializationHistory
• isEnabled
• redo
• reset
• takeSnapshot
• undo

Constructors

constructor

+ new UndoEngine(editorInstance: Editor): UndoEngine

Defined in src/history/UndoEngine.ts:14

Parameters:

Name	Type
editorInstance	Editor

Returns: UndoEngine

Properties

Private editor

• editor: Editor

Defined in src/history/UndoEngine.ts:11

---

Private enabled

• enabled: boolean = true

Defined in src/history/UndoEngine.ts:14

---

Private modelHistory

• modelHistory: SerializationHistory‹CompositeModel› = new SerializationHistory(this._modelRollback.bind(this))

Defined in src/history/UndoEngine.ts:13

Methods

Private _modelRollback

▸ _modelRollback(rolledBackModel: CompositeModel): void

Defined in src/history/UndoEngine.ts:71

Updates the editor's primary model

Parameters:

Name	Type
rolledBackModel	CompositeModel

Returns: void

---

disable

▸ disable(): void

Defined in src/history/UndoEngine.ts:27

Returns: void

---

enable

▸ enable(): void

Defined in src/history/UndoEngine.ts:23

Enables the UndoEngine. If Config.get('interaction.undoEngineEnabled') if disabled, it will still be disabled.

Returns: void

---

getSerializationHistory

▸ getSerializationHistory(): SerializationHistory‹CompositeModel‹››

Defined in src/history/UndoEngine.ts:64

Returns: SerializationHistory‹CompositeModel‹››

---

isEnabled

▸ isEnabled(): boolean

Defined in src/history/UndoEngine.ts:31

Returns: boolean

---

redo

▸ redo(skipSkippableSteps: boolean): boolean

Defined in src/history/UndoEngine.ts:56

Parameters:

Name	Type	Default
skipSkippableSteps	boolean	false

Returns: boolean

---

reset

▸ reset(): boolean

Defined in src/history/UndoEngine.ts:60

Returns: boolean

---

takeSnapshot

▸ takeSnapshot(skipOnUserUndo?: boolean, metadata?: any): void

Defined in src/history/UndoEngine.ts:41

Can be called whenever a undo/redo snapshot should be performed

Parameters:

Name	Type	Description
skipOnUserUndo?	boolean	If true, the snapshot saved with this call will be skipped when undoing/redoing. This allows you to make snapshots that are not exposed to the user.
metadata?	any	An object, that is attached to the history entry

Returns: void

---

undo

▸ undo(skipSkippableSteps: boolean): boolean

Defined in src/history/UndoEngine.ts:52

Parameters:

Name	Type	Default
skipSkippableSteps	boolean	false

Returns: boolean