com.swfm.mica.sys
Interface MiiTransaction

All Known Implementing Classes:

MiDeletePartsCommand, MiExchangePartsTransaction, MiFlipPartsCommand, MiGraphPartsCommand, MiGroupPartsCommand, MiIconifyPartsCommand, MiLayoutPartsCommand, MiModelPropertyChangeCommand, MiModifyAttributesOfPartsCommand, MiModifyConnectionCommand, MiModifyTextCommand, MiNestedTransaction, MiPanAndZoomCommand, MiPositionPartsCommand, MiReorderPartsCommand, MiReplacePartsCommand, MiRotatePartsCommand, MiScalePartsCommand, MiSelectPartsCommand, MiSetVisibilityOfPartsCommand, MiTableAddItemCommand, MiTransactionCommandAdapter, MiTranslatePartsCommand, MiTranslatePointOfPartsCommand

public interface MiiTransaction

Version:

%I% %G%

Author:

Michael L. Davis

Method Summary

java.lang.String	getCommand() Gets the command perfromed by this transaction.
java.lang.String	getName() Gets the name of this transaction.
MiParts	getSources() Gets the parts used by this transaction.
MiParts	getTargets() Gets the targets of this transaction.
boolean	isRepeatable() Gets whether this transaction is repeatable.
boolean	isUndoable() Gets whether this transaction is undoable.
void	redo() Redoes this transaction.
void	repeat() Repeats this transaction.
void	undo() Undoes this transaction.

Method Detail

getName

public java.lang.String getName()

Gets the name of this transaction. This name is often displayed, for example, in the menubar's edit pulldown menu.

Returns:

the name of this transaction.

getCommand

public java.lang.String getCommand()

Gets the command perfromed by this transaction. This name is often found in the MiiCommandNames file.

Returns:

the command of this transaction.

redo

public void redo()

Redoes this transaction. This is only valid after an undo. This redoes the changes encapsulated by this transaction that were undone by the undo() method.

undo

public void undo()

Undoes this transaction. This undoes any changes that were made by the changes encapsulated by this transaction.

repeat

public void repeat()

Repeats this transaction. This re-applies the changes encapsulated by this transaction. For example, a translation of a shape can be repeated in order to move it further.

isUndoable

public boolean isUndoable()

Gets whether this transaction is undoable.

isRepeatable

public boolean isRepeatable()

Gets whether this transaction is repeatable. If repeatable then calling this transaction's repeat() method is permitted.

getTargets

public MiParts getTargets()

Gets the targets of this transaction.

getSources

public MiParts getSources()

Gets the parts used by this transaction.