Class AbstractHistory

Abstract class for all history implementations.

Hierarchy

AbstractHistory

Implements

History

Index

Constructors

Properties

_commands config? editor historyDisabled idCounter lastCmdTime redos timeDifferenceLimit undos

Methods

addSerializableCommand clear clearRedos enableSerialization execute fromJSON goToState redo test toJSON undo

Constructors

constructor

new AbstractHistory(editor): AbstractHistory
Parameters
- editor: Editor
Returns AbstractHistory
- Defined in src/history/AbstractHistory.ts:33

Properties

`Private` _commands

_commands: Record<string, typeof EmptyCommand> = {}

`Optional` config

config?: Config

editor

editor: Editor

historyDisabled

historyDisabled: boolean

idCounter

idCounter: number

lastCmdTime

lastCmdTime: number

redos

redos: Command[]

timeDifferenceLimit

timeDifferenceLimit: number

The time difference limit between two commands to be considered as a single command.

Default

undos

undos: Command[]

Methods

addSerializableCommand

addSerializableCommand(command): void
Parameters
- command: typeof EmptyCommand
Returns void
Implementation of History.addSerializableCommand
- Defined in src/history/AbstractHistory.ts:157

clear

clear(): void
Returns void
Implementation of History.clear
- Defined in src/history/AbstractHistory.ts:198

clearRedos

clearRedos(): void
Returns void
Implementation of History.clearRedos
- Defined in src/history/AbstractHistory.ts:206

enableSerialization

enableSerialization(id): void
Parameters
- id: number
Returns void
Implementation of History.enableSerialization
- Defined in src/history/AbstractHistory.ts:241

execute

execute(cmd, optionalName?): void
Parameters
- cmd: Command
- Optional optionalName: string
Returns void
Implementation of History.execute
- Defined in src/history/AbstractHistory.ts:45

fromJSON

fromJSON(json): void
Parameters
- json: HistoryJSON
Returns void
Implementation of History.fromJSON
- Defined in src/history/AbstractHistory.ts:161

goToState

goToState(id): void
Parameters
- id: number
Returns void
Implementation of History.goToState
- Defined in src/history/AbstractHistory.ts:211

redo

redo(): undefined | Command
Returns undefined | Command
Implementation of History.redo
- Defined in src/history/AbstractHistory.ts:111

test

test(): boolean
Returns boolean
Implementation of History.test
- Defined in src/history/AbstractHistory.ts:271

toJSON

toJSON(): HistoryJSON
Returns HistoryJSON
Implementation of History.toJSON
- Defined in src/history/AbstractHistory.ts:134

undo

undo(): undefined | Command
Returns undefined | Command
Implementation of History.undo
- Defined in src/history/AbstractHistory.ts:89

Generated using TypeDoc