dsto.dfc.swing.commands
Class AbstractMoveCommand

java.lang.Object
  dsto.dfc.swing.commands.AbstractCommand
      dsto.dfc.swing.commands.AbstractMutableCommand
          dsto.dfc.swing.commands.AbstractSelectionBasedCommand
              dsto.dfc.swing.commands.AbstractMoveCommand

All Implemented Interfaces:

Command, SelectionListener, Iconic, Copyable, Disposable, PropertyEventSource, ActionListener, Cloneable, EventListener

Direct Known Subclasses:

CmdMoveEntry, CmdMoveRow

public abstract class AbstractMoveCommand
extends AbstractSelectionBasedCommand

Base class for commands that move items up/down within their host. Subclasses that support auto enable/disable should override updateEnabled() and remember to call it from their constructor.

Version:

$Revision$

Field Summary

protected boolean	direction
static boolean	MOVE_DOWN
static Icon	MOVE_DOWN_ICON
static boolean	MOVE_UP
static Icon	MOVE_UP_ICON

Fields inherited from class dsto.dfc.swing.commands.AbstractSelectionBasedCommand

source

Fields inherited from class dsto.dfc.swing.commands.AbstractMutableCommand

listeners

Fields inherited from class dsto.dfc.swing.commands.AbstractCommand

displayName, icon

Fields inherited from interface dsto.dfc.swing.icons.Iconic

NULL_ICON

Constructor Summary

AbstractMoveCommand(SelectionEventSource client, boolean direction)
Create a new instance.

Method Summary

abstract void	execute() Execute the command.
KeyStroke	getAccelerator() Get a keyboard accelerator for the command.
String	getDescription() A short description of the command, suitable for a tooltip or use in a status panel.
String	getGroupInView(String viewName) Get the preferred group that this command should appear in for a given view.
Icon	getIcon() The small (16x16) icon for the object.
char	getMnemonic() Get a character shortcut for the command (eg for use on a menu).
String	getName() The formal identifying name for this command (eg edit.Copy, file.Open).
boolean	isInteractive() True if this command will interact with the user when execute() is called.
void	selectionChanged(SelectionEvent e) SelectionListener interface implementation: does nothing.
protected void	updateEnabled() Override this to update the enabled property appopriately.

Methods inherited from class dsto.dfc.swing.commands.AbstractSelectionBasedCommand

dispose

Methods inherited from class dsto.dfc.swing.commands.AbstractMutableCommand

addPropertyChangeListener, clone, isEnabled, removePropertyChangeListener, setEnabled, setIcon

Methods inherited from class dsto.dfc.swing.commands.AbstractCommand

actionPerformed, canReplace, getDefaultDisplayName, getDisplayName, getLargeIcon, getLogString, setDisplayName

Methods inherited from class java.lang.Object

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

Field Detail

MOVE_UP_ICON

public static final Icon MOVE_UP_ICON

MOVE_DOWN_ICON

public static final Icon MOVE_DOWN_ICON

MOVE_UP

public static final boolean MOVE_UP

See Also:

Constant Field Values

MOVE_DOWN

public static final boolean MOVE_DOWN

See Also:

Constant Field Values

direction

protected boolean direction

Constructor Detail

AbstractMoveCommand

public AbstractMoveCommand(SelectionEventSource client,
                           boolean direction)

Create a new instance.

Parameters:

client - The client of the command.

direction - The direction to move the entries (MOVE_UP or MOVE_DOWN).

Method Detail

execute

public abstract void execute()

Description copied from interface: Command

Execute the command.

Specified by:

execute in interface Command

Specified by:

execute in class AbstractCommand

getName

public String getName()

Description copied from interface: Command

The formal identifying name for this command (eg edit.Copy, file.Open). This must not change during the lifetime of a command instance.

Specified by:

getName in interface Command

Specified by:

getName in interface Iconic

Specified by:

getName in class AbstractCommand

getIcon

public Icon getIcon()

Description copied from interface: Iconic

The small (16x16) icon for the object. May be null if no small icon is available.

Specified by:

getIcon in interface Iconic

Overrides:

getIcon in class AbstractCommand

getDescription

public String getDescription()

Description copied from interface: Command

A short description of the command, suitable for a tooltip or use in a status panel.

Specified by:

getDescription in interface Command

Specified by:

getDescription in class AbstractCommand

isInteractive

public boolean isInteractive()

Description copied from interface: Command

True if this command will interact with the user when execute() is called.

Specified by:

isInteractive in interface Command

Specified by:

isInteractive in class AbstractCommand

getGroupInView

public String getGroupInView(String viewName)

Description copied from interface: Command

Get the preferred group that this command should appear in for a given view. This may be overridden by a setting in the CommandRegistry.

If the command changes its group in any view it should generate a groupInView property change event with the old value set to the old group and the new value set to the new group.

Specified by:

getGroupInView in interface Command

Specified by:

getGroupInView in class AbstractCommand

Parameters:

viewName - The name of the view.

Returns:

The group in the view, or null if this command does not appear in the given view.

getMnemonic

public char getMnemonic()

Description copied from interface: Command

Get a character shortcut for the command (eg for use on a menu). May return 0 for no mnemonic.

Specified by:

getMnemonic in interface Command

Specified by:

getMnemonic in class AbstractCommand

getAccelerator

public KeyStroke getAccelerator()

Description copied from interface: Command

Get a keyboard accelerator for the command. May return null for no accelerator.

Specified by:

getAccelerator in interface Command

Overrides:

getAccelerator in class AbstractCommand

selectionChanged

public void selectionChanged(SelectionEvent e)

Description copied from class: AbstractSelectionBasedCommand

SelectionListener interface implementation: does nothing.

Specified by:

selectionChanged in interface SelectionListener

Overrides:

selectionChanged in class AbstractSelectionBasedCommand

updateEnabled

protected void updateEnabled()

Override this to update the enabled property appopriately.