com.yworks.yfiles.graph

Interface ICompoundEdit

All Superinterfaces:

AutoCloseable, IDisposable

public interface ICompoundEdit
extends IDisposable

This interface is a means to bracket several IUndoUnits, that is a collection of units that are treated as one (e.g. they are always undone or redone as a single unit).

ICompoundEdits have two states: active and disposed. Whenever an ICompoundEdit is retrieved from the UndoEngine or the graph instance, it automatically is active. While an edit is in the active state, it gathers IUndoUnits until the commit() or cancel() methods are called. Calling the commit() method commits all gathered IUndoUnits to the UndoEngine, while canceling will dispose them. Calling either method will put the edit in the disposed state. In this state, the edit does not gather units anymore and is not reusable.

Additionally, this interface extends the IDisposable interface. This enables the usage in using statements that will automatically commit() the edit.

ICompoundEdits can also be nested, in this case the changes of the inner edit are not committed directly to the UndoEngine but to the outer edit. Only when the outer edit is committed, the units are committed to the UndoEngine.

See Also:

UndoEngine, IUndoUnit

Method Summary

Modifier and Type	Method and Description
void	cancel() This method cancels the compound editing process.
void	commit() This method commits the compound editing process.

Methods inherited from interface com.yworks.yfiles.utils.IDisposable

close, dispose

Method Detail

cancel

void cancel()

This method cancels the compound editing process.

The recorded IUndoUnits are disposed and the edit is not usable anymore.

commit

void commit()

This method commits the compound editing process.

The IUndoUnits are enqueued into the corresponding UndoEngine instance and the edit is not usable anymore. Alternatively client code can use the IDisposable.dispose() method of this instance to end this instance. This can be done conveniently using a using statement.