Packagecom.yworks.support
Interfacepublic interface ICompoundEdit

The interface used by IUndoSupport's and "UndoEngine's UndoEngine.beginCompoundEdit implementation.

UndoEngine and IUndoSupport implementations create instances of this class. You don't have to implement this class yourself. This class serves as a token for compound edits, only. Once this token has been obtained from the engine, it is essential for the functionality of the issuer of this instance that either end or cancel be called. If this instance gets disposed before either of the end or cancel method has been called, the end method will be called automatically.

See also

IUndoSupport
UndoEngine
IUndoUnit


Public Methods
 MethodDefined By
  
cancel():void
This method ends the compound editing process that has been initialized in UndoEngine.beginCompoundEdit.
ICompoundEdit
  
dispose():void
Frees all used resources and calls end.
ICompoundEdit
  
end():void
This method ends the compound editing process that has been initialized in UndoEngine.beginCompoundEdit.
ICompoundEdit
Method Detail
cancel()method
public function cancel():void

This method ends the compound editing process that has been initialized in UndoEngine.beginCompoundEdit.

Calling this method will automatically enqueue the corresponding IUndoUnits into the corresponding UndoEngine instance.

dispose()method 
public function dispose():void

Frees all used resources and calls end.

end()method 
public function end():void

This method ends the compound editing process that has been initialized in UndoEngine.beginCompoundEdit.

Calling this method will automatically enqueue the corresponding IUndoUnits into the corresponding UndoEngine instance. Alternatively client code can use the dispose method of this instance to end this instance.