mxUndoableEdit

Implements a composite undoable edit.

Summary

mxUndoableEdit	Implements a composite undoable edit.
Events
mxEvent.EXECUTED	Fires between START_EDIT and END_EDIT after an atomic change was executed.
mxEvent.START_EDIT	Fires before a set of changes will be executed in undo or redo.
mxEvent.END_EDIT	Fires after a set of changeswas executed in undo or redo.
Functions
mxUndoableEdit	Constructs a new undoable edit for the given source.
Variables
source	Specifies the source of the edit.
changes	Array that contains the changes that make up this edit.
significant	Specifies if the undoable change is significant.
undone	Specifies if this edit has been undone.
redone	Specifies if this edit has been redone.
Functions
isEmpty	Returns true if the this edit contains no changes.
isSignificant	Returns significant.
add	Adds the specified change to this edit.
notify	Hook to notify any listeners of the changes after an undo or redo has been carried out.
die	Hook to free resources after the edit has been removed from the command history.
undo	Undoes all changes in this edit.
redo	Redoes all changes in this edit.

Events

mxEvent.EXECUTED

Fires between START_EDIT and END_EDIT after an atomic change was executed. The <code>change</code> property contains the change that was executed.

mxEvent.START_EDIT

Fires before a set of changes will be executed in undo or redo. This event contains no properties.

mxEvent.END_EDIT

Fires after a set of changeswas executed in undo or redo. This event contains no properties.

Functions

mxUndoableEdit

function mxUndoableEdit( source,
significant )

Constructs a new undoable edit for the given source.

Variables

source

mxUndoableEdit.prototype.source

Specifies the source of the edit.

changes

mxUndoableEdit.prototype.changes

Array that contains the changes that make up this edit. The changes are expected to either have an undo and redo function, or an execute function. Default is an empty array.

significant

mxUndoableEdit.prototype.significant

Specifies if the undoable change is significant. Default is true.

undone

mxUndoableEdit.prototype.undone

Specifies if this edit has been undone. Default is false.

redone

mxUndoableEdit.prototype.redone

Specifies if this edit has been redone. Default is false.

Functions

isEmpty

mxUndoableEdit.prototype.isEmpty = function()

Returns true if the this edit contains no changes.

isSignificant

mxUndoableEdit.prototype.isSignificant = function()

Returns significant.

add

mxUndoableEdit.prototype.add = function( change )

Adds the specified change to this edit. The change is an object that is expected to either have an undo and redo, or an execute function.

notify

mxUndoableEdit.prototype.notify = function()

Hook to notify any listeners of the changes after an undo or redo has been carried out. This implementation is empty.

die

mxUndoableEdit.prototype.die = function()

Hook to free resources after the edit has been removed from the command history. This implementation is empty.

undo

mxUndoableEdit.prototype.undo = function()

Undoes all changes in this edit.

redo

mxUndoableEdit.prototype.redo = function()

Redoes all changes in this edit.