meka.gui.experimenter.menu

Class AbstractExperimenterMenuItem

java.lang.Object

meka.gui.experimenter.menu.AbstractExperimenterMenuItem

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CombineStatisticsFiles

public abstract class AbstractExperimenterMenuItem
extends Object
implements Serializable

Ancestor for menu items to be displayed in the Experimenter 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
protected Experimenter	m_Owner the experimenter the menu item belongs to.

Constructor Summary

Constructors

Constructor and Description
AbstractExperimenterMenuItem()

Method Summary

Modifier and Type	Method and Description
AbstractAction	getAction() Returns the action.
ImageIcon	getIcon() Returns the icon for the menu item.
protected String	getIconName() Returns the name of the icon to use.
abstract String	getItem() Returns the name of the menu item.
abstract String	getMenu() Returns the name of the menu this menu item will get added to.
static Vector<String>	getMenuItems() Returns the classnames of all additional experiment menu items.
Experimenter	getOwner() Returns the owner.
protected abstract void	launch() Launches the menu item action.
void	setOwner(Experimenter value) Sets the owner.
void	update(Experimenter exp, AbstractAction action) Updates the action using the experimenter.

Methods inherited from class java.lang.Object

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

Field Detail

m_Owner

protected Experimenter m_Owner

the experimenter the menu item belongs to.

Constructor Detail

AbstractExperimenterMenuItem

public AbstractExperimenterMenuItem()

Method Detail

setOwner

public void setOwner(Experimenter value)

Sets the owner.

Parameters:

value - the owner

getOwner

public Experimenter getOwner()

Returns the owner.

Returns:

the owner

getMenu

public abstract String getMenu()

Returns the name of the menu this menu item will get added to.

Returns:

the menu name

getItem

public abstract String getItem()

Returns the name of the menu item.

Returns:

the menu item name

getIconName

protected String getIconName()

Returns the name of the icon to use.
Default implementation returns null.

Returns:

the file name (no path)

getIcon

public ImageIcon getIcon()

Returns the icon for the menu item.

Returns:

the icon

launch

protected abstract void launch()

Launches the menu item action.

getAction

public AbstractAction getAction()

Returns the action.

Returns:

the action

update

public void update(Experimenter exp,
                   AbstractAction action)

Updates the action using the experimenter.
Default implementation does nothing.

Parameters:

exp - the experimenter

action - the action to update

getMenuItems

public static Vector<String> getMenuItems()

Returns the classnames of all additional experiment menu items.

Returns:

the classnames