com.swfm.mica.commands
Class MiIconifyPartsCommand

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

All Implemented Interfaces:

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

public class MiIconifyPartsCommand

extends MiCommandHandler

implements MiiTransaction, MiiCommandNames, MiiDisplayNames, MiiActionTypes

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

Constructor Summary

MiIconifyPartsCommand()

MiIconifyPartsCommand(MiEditor editor, MiParts groups, MiParts icons, boolean toIconify)

MiIconifyPartsCommand(MiPart icon)

Method Summary

static MiPart	deIconify(MiEditor editor, MiPart icon)
java.lang.String	getCommand() Gets the command perfromed by this transaction.
MiEditor	getEditor()
java.lang.String	getName() Gets the name of this transaction.
static MiPart	getPrototypeIcon()
MiParts	getSources() Gets the parts used by this transaction.
MiParts	getTargets() Gets the targets of this transaction.
static MiInternalWindow	getWindowFromIcon(MiPart icon)
static void	iconify(MiEditor editor, MiPart container, MiPart icon)
static boolean	isIconification(MiPart icon)
boolean	isRepeatable() Gets whether this transaction is repeatable.
boolean	isUndoable() Gets whether this transaction is undoable.
MiPart	makeIconicRepresentation(MiPart container)
void	processCommand(MiEditor editor, MiParts groups, MiParts icons, boolean toIconify)
void	processCommand(java.lang.String cmd) Processes the given command.
void	redo() Redoes this transaction.
void	repeat() Repeats this transaction.
static void	setPrototypeIcon(MiPart icon)
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

MiIconifyPartsCommand

public MiIconifyPartsCommand()

MiIconifyPartsCommand

public MiIconifyPartsCommand(MiPart icon)

MiIconifyPartsCommand

public MiIconifyPartsCommand(MiEditor editor,
                             MiParts groups,
                             MiParts icons,
                             boolean toIconify)

Method Detail

getEditor

public MiEditor getEditor()

setPrototypeIcon

public static void setPrototypeIcon(MiPart icon)

getPrototypeIcon

public static MiPart getPrototypeIcon()

makeIconicRepresentation

public MiPart makeIconicRepresentation(MiPart container)

processCommand

public void processCommand(java.lang.String cmd)

Description copied from interface: MiiCommandHandler

Processes the given command.

Specified by:

processCommand in interface MiiCommandHandler

processCommand

public void processCommand(MiEditor editor,
                           MiParts groups,
                           MiParts icons,
                           boolean toIconify)

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

iconify

public static void iconify(MiEditor editor,
                           MiPart container,
                           MiPart icon)

deIconify

public static MiPart deIconify(MiEditor editor,
                               MiPart icon)

isIconification

public static boolean isIconification(MiPart icon)

getWindowFromIcon

public static MiInternalWindow getWindowFromIcon(MiPart icon)