A group of IUndoUnits that are undone/redone as a single unit.
Remarks
Clients can use this class to build an IUndoUnit that groups together multiple IUndoUnits. The IUndoUnits added to this unit are undone/redone in the order in which they were added. This implementation will try to merge or replace units that are added.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.CompositeUndoUnit
Constructors
Properties
Gets or sets the current redo name.
Implements
Gets or sets the current undo name.
Implements
Methods
Determines whether a call to redo can be made.
Determines whether a call to undo can be made.
Disposes this unit and all of its contents.
Tries to remove a given unit from this compound unit.
Remarks
This method will throw an exception if this unit has been undone or an undo or redo is in progress or this unit has already been disposed. This method will not automatically Dispose removed units.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- unit - IUndoUnit
- The unit to remove.
Returns
- ↪boolean
trueiff the unit has been removed from this instance.
Implements the IUndoUnit interface.
Remarks
This implementation will always yield
false.Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- unit - IUndoUnit
- The unit to incorporate that happened after this unit.
Returns
- ↪boolean
- Whether the state change of
unithas been incorporated into this unit andunitcan be disposed of.
See Also
Implements
Implements the IUndoUnit interface.
Remarks
This implementation will always yield
false.Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- unit - IUndoUnit
- The unit to incorporate that happened before this unit.
Returns
- ↪boolean
- Whether the state change of
thisunit has been incorporated into the givenunitandthiscan be disposed of.