dsto.dfc.swing.commands
Class BasicAboutCommand

java.lang.Object
  dsto.dfc.swing.commands.AbstractCommand
      dsto.dfc.swing.commands.BasicAboutCommand

All Implemented Interfaces:

Command, Iconic, Copyable, ActionListener, Cloneable, EventListener

public class BasicAboutCommand
extends AbstractCommand

Show an about box. Subclasses should override createAboutDialog() to create the about box.

Version:

$Revision$

Field Summary

protected Component

client

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

displayName, icon

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

NULL_ICON

Constructor Summary

BasicAboutCommand(Component client)

Method Summary

protected Dialog	createAboutDialog() Override this to create the about box dialog.
void	execute() Execute 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.
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.

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

actionPerformed, canReplace, clone, getAccelerator, getDefaultDisplayName, getDisplayName, getIcon, getLargeIcon, getLogString, isEnabled, setDisplayName, setIcon

Methods inherited from class java.lang.Object

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

Field Detail

client

protected Component client

Constructor Detail

BasicAboutCommand

public BasicAboutCommand(Component client)

Method Detail

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

execute

public void execute()

Description copied from interface: Command

Execute the command.

Specified by:

execute in interface Command

Specified by:

execute in class AbstractCommand

createAboutDialog

protected Dialog createAboutDialog()

Override this to create the about box dialog.

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.

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

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