Package adams.gui.visualization.report.reportfactory

Class AbstractTableActionWithDataContainerPanel

java.lang.Object

javax.swing.AbstractAction

adams.gui.action.AbstractBaseAction

adams.gui.visualization.report.reportfactory.AbstractTableAction

adams.gui.visualization.report.reportfactory.AbstractTableActionWithDataContainerPanel

All Implemented Interfaces:

CleanUpHandler, BaseAction, ActionListener, Serializable, Cloneable, EventListener, Action

public abstract class AbstractTableActionWithDataContainerPanel
extends AbstractTableAction

Ancestor for actions that require a DataContainerPanel to be present.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

DataContainerPanel, Serialized Form

Field Summary

Fields inherited from class adams.gui.visualization.report.reportfactory.AbstractTableAction

KEY_FIELDS, KEY_ROWS, KEY_TABLE, KEY_VALUES, SEPARATOR

Fields inherited from class adams.gui.action.AbstractBaseAction

ASYNCHRONOUS

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor	Description
AbstractTableActionWithDataContainerPanel()	Defines an AbstractTableActionWithDataContainerPanel object with a default description string and default icon.
AbstractTableActionWithDataContainerPanel(String name)	Defines an AbstractTableActionWithDataContainerPanel object with the specified description string and a default icon.
AbstractTableActionWithDataContainerPanel(String name, String icon)	Defines an AbstractTableActionWithDataContainerPanel object with the specified description string and a the specified icon.
AbstractTableActionWithDataContainerPanel(String name, Icon icon)	Defines an AbstractTableActionWithDataContainerPanel object with the specified description string and a the specified icon.

Method Summary

Modifier and Type	Method	Description
protected DataContainerPanel	getDataContainerPanel()	Returns the underlying DataContainerPanel.
protected abstract String	getSuffix()	Returns the suffix of the required field.
boolean	isApplicable(ReportFactory.Table table, int row, AbstractField field, String value)	Checks whether the action is applicable and should be added to the popup menu.

Methods inherited from class adams.gui.visualization.report.reportfactory.AbstractTableAction

createName, createPopup, getFields, getFileChooser, getReport, getReportProvider, getRow, getTable, getValues, notifyReportChangeListeners, parseBoolean, parseDouble, setFields, setReport, setRows, setTable, setValues

Methods inherited from class adams.gui.action.AbstractBaseAction

actionPerformed, cleanUp, doActionPerformed, getAccelerator, getIcon, getMnemonic, getName, getToolTipText, hasAccelerator, hasIcon, hasMnemonic, hasToolTipText, initialize, isAsynchronous, isSelected, postActionPerformed, preActionPerformed, setAccelerator, setAsynchronous, setIcon, setIcon, setMnemonic, setName, setSelected, setToolTipText

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.Action

accept, addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Constructor Detail

AbstractTableActionWithDataContainerPanel

public AbstractTableActionWithDataContainerPanel()

Defines an AbstractTableActionWithDataContainerPanel object with a default description string and default icon.

AbstractTableActionWithDataContainerPanel

public AbstractTableActionWithDataContainerPanel(String name)

Defines an AbstractTableActionWithDataContainerPanel object with the specified description string and a default icon.

Parameters:

name - the description

AbstractTableActionWithDataContainerPanel

public AbstractTableActionWithDataContainerPanel(String name,
                                                 Icon icon)

Defines an AbstractTableActionWithDataContainerPanel object with the specified description string and a the specified icon.

Parameters:

name - the description

icon - the icon

AbstractTableActionWithDataContainerPanel

public AbstractTableActionWithDataContainerPanel(String name,
                                                 String icon)

Defines an AbstractTableActionWithDataContainerPanel object with the specified description string and a the specified icon.

Parameters:

name - the description

icon - the icon file (without path)

Method Detail

getSuffix

protected abstract String getSuffix()

Returns the suffix of the required field.

Returns:

the required suffix, null if no restrictions

getDataContainerPanel

protected DataContainerPanel getDataContainerPanel()

Returns the underlying DataContainerPanel.

Returns:

the panel, null if not available

isApplicable

public boolean isApplicable(ReportFactory.Table table,
                            int row,
                            AbstractField field,
                            String value)

Checks whether the action is applicable and should be added to the popup menu.

Specified by:

isApplicable in class AbstractTableAction

Parameters:

table - the table the popup menu is for

row - the currently selected row

field - the field in the specified row

value - the current value

Returns:

true if the action is applicable, i.e., should be included in the popup menu