com.vividsolutions.jump.workbench.model

Class UndoableCommand

java.lang.Object

com.vividsolutions.jump.workbench.model.UndoableCommand

public abstract class UndoableCommand
extends java.lang.Object

An action that can be rolled back. Similar to an UndoableEdit, but assumes that the action is yet to be executed, whereas an UndoableEdit assumes that the action has already been executed (i.e. it has a #redo method but not a #do method).

See Also:

UndoableEdit

Field Summary

Fields

Modifier and Type	Field and Description
static UndoableCommand	DUMMY

Constructor Summary

Constructors

Constructor and Description
UndoableCommand(java.lang.String name) UndoableCommand with a name to be shown in the user interface.
UndoableCommand(java.lang.String name, Layer layer) UndoableCommand with a name and a layer parameter.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dispose() Releases resources and make the edit action unsignificant, so that it will be ignored in the undo chain.
abstract void	execute() If there is an exception that leaves this UndoableCommand execution partially complete and non-unexecutable, be sure to call #reportIrreversibleChange() on the UndoableEditReceiver (which can be obtained from the LayerManager).
Layer	getLayer()
java.lang.String	getName()
boolean	isCanceled()
void	setLayer(Layer layer)
javax.swing.undo.UndoableEdit	toUndoableEdit()
abstract void	unexecute()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DUMMY

public static final UndoableCommand DUMMY

Constructor Detail

UndoableCommand

public UndoableCommand(java.lang.String name)

UndoableCommand with a name to be shown in the user interface.

UndoableCommand

public UndoableCommand(java.lang.String name,
               Layer layer)

UndoableCommand with a name and a layer parameter. The layer parameter is used to neutralize the undoableEdit if the layer is removed from the LayerManager (neutralization uses significant attribute).

Method Detail

setLayer

public void setLayer(Layer layer)

getLayer

public Layer getLayer()

dispose

protected void dispose()

Releases resources and make the edit action unsignificant, so that it will be ignored in the undo chain. If a UndoableCommand subclasse has resources to be released, oveload this method and call super.dispose() set canceled to true.

isCanceled

public boolean isCanceled()

execute

public abstract void execute()

If there is an exception that leaves this UndoableCommand execution partially complete and non-unexecutable, be sure to call #reportIrreversibleChange() on the UndoableEditReceiver (which can be obtained from the LayerManager).

See Also:

UndoableEditReceiver.reportIrreversibleChange()

unexecute

public abstract void unexecute()

toUndoableEdit

public javax.swing.undo.UndoableEdit toUndoableEdit()

getName

public java.lang.String getName()