meka.gui.explorer

Class AbstractResultHistoryPlugin

java.lang.Object

meka.gui.explorer.AbstractResultHistoryPlugin

All Implemented Interfaces:

Serializable, Comparable<AbstractResultHistoryPlugin>, ResultHistoryList.ResultHistoryPopupMenuCustomizer

Direct Known Subclasses:

AbstractClassifyResultHistoryPlugin

public abstract class AbstractResultHistoryPlugin
extends Object
implements ResultHistoryList.ResultHistoryPopupMenuCustomizer, Serializable, Comparable<AbstractResultHistoryPlugin>

Ancestor for plugins that work .

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 AbstractExplorerTab	m_Owner the tab this plugin belongs to (for accessing the session).

Constructor Summary

Constructors

Constructor and Description
AbstractResultHistoryPlugin()

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbstractResultHistoryPlugin o) Comparison on the group and name.
void	customizePopupMenu(ResultHistoryList history, int index, JPopupMenu menu) Allows to customize the popup menu for the result history.
boolean	equals(Object o) Checks equality using the name of the plugin.
abstract ActionListener	getActionListener(ResultHistoryList history, int index) Returns the action lister to use in the menu.
abstract String	getGroup() Returns the group of the plugin.
abstract String	getName() Returns the name of the plugin.
AbstractExplorerTab	getOwner() Returns the tab the plugin belongs to.
Object	getSessionValue(String key) Returns a session value, if present.
abstract boolean	handles(ResultHistoryList history, int index) Checks whether the current item can be handled.
boolean	hasSessionValue(String key) Checks whether a session value is present.
static void	populateMenu(AbstractExplorerTab tab, List<String> classnames, ResultHistoryList history, int index, JPopupMenu menu) Allows to customize the popup menu for the result history.
void	setOwner(AbstractExplorerTab value)
void	setSessionValue(String key, Object value) Sets a session value.

Methods inherited from class java.lang.Object

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

Field Detail

m_Owner

protected AbstractExplorerTab m_Owner

the tab this plugin belongs to (for accessing the session).

Constructor Detail

AbstractResultHistoryPlugin

public AbstractResultHistoryPlugin()

Method Detail

setOwner

public void setOwner(AbstractExplorerTab value)

getOwner

public AbstractExplorerTab getOwner()

Returns the tab the plugin belongs to.

Returns:

the owner

hasSessionValue

public boolean hasSessionValue(String key)

Checks whether a session value is present.

Parameters:

key - the key to look for

Returns:

true if present

getSessionValue

public Object getSessionValue(String key)

Returns a session value, if present.

Parameters:

key - the key to look for

Returns:

the value, null if not present

setSessionValue

public void setSessionValue(String key,
                            Object value)

Sets a session value.

Parameters:

key - the key to look for

value - the value to set

compareTo

public int compareTo(AbstractResultHistoryPlugin o)

Comparison on the group and name.

Specified by:

compareTo in interface Comparable<AbstractResultHistoryPlugin>

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()

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

handles

public abstract boolean handles(ResultHistoryList history,
                                int index)

Checks whether the current item can be handled. Disables/enables the menu item.

Parameters:

history - the current history

index - the selected history item

Returns:

true if can be handled

getActionListener

public abstract ActionListener getActionListener(ResultHistoryList history,
                                                 int index)

Returns the action lister to use in the menu.

Parameters:

history - the current history

index - the selected history item

Returns:

the listener

customizePopupMenu

public void customizePopupMenu(ResultHistoryList history,
                               int index,
                               JPopupMenu menu)

Allows to customize the popup menu for the result history.

Specified by:

customizePopupMenu in interface ResultHistoryList.ResultHistoryPopupMenuCustomizer

Parameters:

history - the list this popup menu is for

index - the index of the select item from the history

menu - the menu to customize

populateMenu

public static void populateMenu(AbstractExplorerTab tab,
                                List<String> classnames,
                                ResultHistoryList history,
                                int index,
                                JPopupMenu menu)

Allows to customize the popup menu for the result history.

Parameters:

tab - the tab the result history belongs to

classnames - the plugins (classnames) to add

history - the list this popup menu is for

index - the index of the select item from the history

menu - the menu to customize