meka.gui.explorer

Class AbstractTabMenuItem<T extends AbstractExplorerTab>

java.lang.Object

meka.gui.explorer.AbstractTabMenuItem<T>

All Implemented Interfaces:

Comparable<AbstractTabMenuItem<T>>

Direct Known Subclasses:

AbstractClassifyTabMenuItem

public abstract class AbstractTabMenuItem<T extends AbstractExplorerTab>
extends Object
implements Comparable<AbstractTabMenuItem<T>>

Ancestor to classes that can be added to a tab's custom menu.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Constructor Summary

Constructors

Constructor and Description
AbstractTabMenuItem()

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbstractTabMenuItem<T> o) Compares this item to another, using group and name.
abstract ActionListener	getActionListener(T owner) Returns the action lister to use in the menu.
abstract String	getGroup() Returns the group of the plugin.
abstract String	getIcon() Returns the name of the icon to use.
abstract String	getName() Returns the name of the plugin.
Object	getSessionValue(T owner, String key) Returns a session value, if present.
boolean	hasSessionValue(T owner, String key) Checks whether a session value is present.
void	setSessionValue(T owner, String key, Object value) Sets a session value.
abstract void	update(T owner, JMenuItem menuitem) Updates the menu item using the current state of the tab.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTabMenuItem

public AbstractTabMenuItem()

Method Detail

hasSessionValue

public boolean hasSessionValue(T owner,
                               String key)

Checks whether a session value is present.

Parameters:

owner - the tab this menu item belongs to

key - the key to look for

Returns:

true if present

getSessionValue

public Object getSessionValue(T owner,
                              String key)

Returns a session value, if present.

Parameters:

owner - the tab this menu item belongs to

key - the key to look for

Returns:

the value, null if not present

setSessionValue

public void setSessionValue(T owner,
                            String key,
                            Object value)

Sets a session value.

Parameters:

owner - the tab this menu item belongs to

key - the key to look for

value - the value to set

getGroup

public abstract String getGroup()

Returns the group of the plugin. Used for the grouping the menu items.

Returns:

the group

getName

public abstract String getName()

Returns the name of the plugin. Used for the menu item text.

Returns:

the name

getIcon

public abstract String getIcon()

Returns the name of the icon to use.

Returns:

the name of the icon, null if none to use

getActionListener

public abstract ActionListener getActionListener(T owner)

Returns the action lister to use in the menu.

Returns:

the listener

update

public abstract void update(T owner,
                            JMenuItem menuitem)

Updates the menu item using the current state of the tab.

Parameters:

owner - the tab that the menu item belongs to

menuitem - the menu item to update (was generated by this class)

compareTo

public int compareTo(AbstractTabMenuItem<T> o)

Compares this item to another, using group and name.

Specified by:

compareTo in interface Comparable<AbstractTabMenuItem<T extends AbstractExplorerTab>>

Parameters:

o - the other item

Returns:

less than 0, equal to 0, greater than 0 if the this item group/name is smaller, equal to or greater than the specified one