meka.gui.guichooser

Class AbstractMenuItemDefinition

java.lang.Object

meka.gui.guichooser.AbstractMenuItemDefinition

All Implemented Interfaces:

Serializable, Comparable<AbstractMenuItemDefinition>

Direct Known Subclasses:

DataViewerDefinition, ExperimenterDefinition, ExplorerDefinition, HomepageDefinition, ModelViewerDefinition, PrecisionRecallCurve, ROC, SystemInfo

public abstract class AbstractMenuItemDefinition
extends Object
implements Serializable, Comparable<AbstractMenuItemDefinition>

Defines menu items for the GUIChooser's menu.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MENU_HELP "Help", the last menu.
static String	MENU_PROGRAM "Program", the first menu.
static String	MENU_TOOLS "Tools" menu.
static String	MENU_VISUALIZATION "Visualization" menu.

Constructor Summary

Constructors

Constructor and Description
AbstractMenuItemDefinition()

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbstractMenuItemDefinition o) Comparison on the group and name.
boolean	equals(Object o) Checks equality using the name of the plugin.
JButton	getButton() Returns the shortcut button.
static List<String>	getDefinitions() Returns all the available menu items.
abstract String	getGroup() The name of the menu this item belongs to.
ImageIcon	getIcon() Returns the icon to use.
String	getIconName() The name of the menu icon.
JMenuItem	getMenuItem() Returns the menu item to insert
abstract String	getName() The name of the menu item.
boolean	isShortcutButton() Returns whether this menu item should also be listed as a shortcut button.
protected abstract void	launch() Called by the menu items action listener.

Methods inherited from class java.lang.Object

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

Field Detail

MENU_PROGRAM

public static final String MENU_PROGRAM

"Program", the first menu.

See Also:

Constant Field Values

MENU_VISUALIZATION

public static final String MENU_VISUALIZATION

"Visualization" menu.

See Also:

Constant Field Values

MENU_TOOLS

public static final String MENU_TOOLS

"Tools" menu.

See Also:

Constant Field Values

MENU_HELP

public static final String MENU_HELP

"Help", the last menu.

See Also:

Constant Field Values

Constructor Detail

AbstractMenuItemDefinition

public AbstractMenuItemDefinition()

Method Detail

getGroup

public abstract String getGroup()

The name of the menu this item belongs to.

Returns:

the menu text

getName

public abstract String getName()

The name of the menu item.

Returns:

the menu item text

getIconName

public String getIconName()

The name of the menu icon.

Returns:

the file name, null if none

getIcon

public ImageIcon getIcon()

Returns the icon to use.

Returns:

the icon

launch

protected abstract void launch()

Called by the menu items action listener.

getMenuItem

public JMenuItem getMenuItem()

Returns the menu item to insert

Returns:

the menu item

isShortcutButton

public boolean isShortcutButton()

Returns whether this menu item should also be listed as a shortcut button.

Returns:

true if to use as button as well

getButton

public JButton getButton()

Returns the shortcut button.

Returns:

the button

compareTo

public int compareTo(AbstractMenuItemDefinition o)

Comparison on the group and name.

Specified by:

compareTo in interface Comparable<AbstractMenuItemDefinition>

Parameters:

o - the other plugin

Returns:

less than 0, equal to 0, greater than 0 if the name is less, equal or greater

See Also:

getGroup(), getName()

equals

public boolean equals(Object o)

Checks equality using the name of the plugin.

Overrides:

equals in class Object

Parameters:

o - the other object

Returns:

true if other object is a plugin with the same name

See Also:

getGroup(), getName()

getDefinitions

public static List<String> getDefinitions()

Returns all the available menu items.

Returns:

the classnames of the menu items