com.swfm.mica.commands
Class MiLayoutPartsCommand

java.lang.Object
  com.swfm.mica.commands.MiCommandHandler
      com.swfm.mica.commands.MiLayoutPartsCommand

All Implemented Interfaces:

MiiActionTypes, MiiCommandHandler, MiiCommandNames, MiiDisplayNames, MiiMessages, MiiTargetableCommandHandler, MiiTransaction, MiiTypes

public class MiLayoutPartsCommand

extends MiCommandHandler

implements MiiTransaction, MiiCommandNames, MiiDisplayNames, MiiTypes, MiiActionTypes

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

Constructor Summary

MiLayoutPartsCommand()

MiLayoutPartsCommand(MiEditor editor, java.lang.String formatCommand, MiParts formattedParts)

Method Summary

MiPart	format(MiParts parts, java.lang.String command)
java.lang.String	getCommand() Gets the command perfromed by this transaction.
MiEditor	getEditor()
java.lang.String	getName() Gets the name of this transaction.
static MiColumnLayout	getPrototypeColumnLayout()
static MiGridLayout	getPrototypeGridLayout()
static MiRowLayout	getPrototypeRowLayout()
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	processCommand(MiEditor editor, java.lang.String formatCommand, MiParts formattedParts)
void	processCommand(java.lang.String command) Processes the given command.
void	redo() Redoes this transaction.
void	repeat() Repeats this transaction.
static void	setPrototypeColumnLayout(MiColumnLayout layout)
static void	setPrototypeGridLayout(MiGridLayout layout)
static void	setPrototypeRowLayout(MiRowLayout layout)
void	undo() Undoes this transaction.

Methods inherited from class com.swfm.mica.commands.MiCommandHandler

getTargetOfCommand, setTargetOfCommand

Methods inherited from class java.lang.Object

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

Constructor Detail

MiLayoutPartsCommand

public MiLayoutPartsCommand()

MiLayoutPartsCommand

public MiLayoutPartsCommand(MiEditor editor,
                            java.lang.String formatCommand,
                            MiParts formattedParts)

Method Detail

setPrototypeRowLayout

public static void setPrototypeRowLayout(MiRowLayout layout)

getPrototypeRowLayout

public static MiRowLayout getPrototypeRowLayout()

setPrototypeColumnLayout

public static void setPrototypeColumnLayout(MiColumnLayout layout)

getPrototypeColumnLayout

public static MiColumnLayout getPrototypeColumnLayout()

setPrototypeGridLayout

public static void setPrototypeGridLayout(MiGridLayout layout)

getPrototypeGridLayout

public static MiGridLayout getPrototypeGridLayout()

getEditor

public MiEditor getEditor()

processCommand

public void processCommand(java.lang.String command)

Description copied from interface: MiiCommandHandler

Processes the given command.

Specified by:

processCommand in interface MiiCommandHandler

processCommand

public void processCommand(MiEditor editor,
                           java.lang.String formatCommand,
                           MiParts formattedParts)

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.

Specified by:

getName in interface MiiTransaction

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.

Specified by:

getCommand in interface MiiTransaction

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.

Specified by:

redo in interface MiiTransaction

undo

public void undo()

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

Specified by:

undo in interface MiiTransaction

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.

Specified by:

repeat in interface MiiTransaction

isUndoable

public boolean isUndoable()

Gets whether this transaction is undoable.

Specified by:

isUndoable in interface MiiTransaction

isRepeatable

public boolean isRepeatable()

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

Specified by:

isRepeatable in interface MiiTransaction

getTargets

public MiParts getTargets()

Gets the targets of this transaction.

Specified by:

getTargets in interface MiiTransaction

getSources

public MiParts getSources()

Gets the parts used by this transaction.

Specified by:

getSources in interface MiiTransaction

format

public MiPart format(MiParts parts,
                     java.lang.String command)