Package adams.gui.action

Class AbstractPropertiesAction<T,D extends Dialog>

java.lang.Object

javax.swing.AbstractAction

adams.gui.action.AbstractBaseAction

adams.gui.action.AbstractActionWithDialog<D>

adams.gui.action.AbstractPropertiesAction<T,D>

Type Parameters:

T - the type of state

D - the type of dialog

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractPropertiesCheckBoxMenuItemAction, AbstractPropertiesMenuItemAction, AbstractPropertiesSubMenuAction

public abstract class AbstractPropertiesAction<T,D extends Dialog>
extends AbstractActionWithDialog<D>

Ancestor for actions that use a Properties file as basis for shortcuts, icons and mnemonics.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected T	m_State	the state.

Fields inherited from class adams.gui.action.AbstractActionWithDialog

m_Dialog

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canUseIcon()	Returns whether the icon (if available) can be used.
protected abstract void	doUpdate()	Performs the actual update of the state of the action.
abstract JMenuItem	getMenuItem()	Creates a new menuitem.
protected abstract Properties	getProperties()	Returns the underlying properties.
protected abstract String	getTitle()	Returns the caption of this action.
protected void	initialize()	Initializes the action.
void	update(T state)	Updates the state of the action.

Methods inherited from class adams.gui.action.AbstractActionWithDialog

cleanUp, createDialog, getDialog

Methods inherited from class adams.gui.action.AbstractBaseAction

actionPerformed, doActionPerformed, getAccelerator, getIcon, getMnemonic, getName, getToolTipText, hasAccelerator, hasIcon, hasMnemonic, hasToolTipText, 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

Field Detail

m_State

protected T m_State

the state.

Constructor Detail

AbstractPropertiesAction

public AbstractPropertiesAction()

Method Detail

initialize

protected void initialize()

Initializes the action.

Overrides:

initialize in class AbstractActionWithDialog<D extends Dialog>

canUseIcon

protected boolean canUseIcon()

Returns whether the icon (if available) can be used.

Returns:

true if it can be used

getProperties

protected abstract Properties getProperties()

Returns the underlying properties.

Returns:

the properties

getTitle

protected abstract String getTitle()

Returns the caption of this action.

Returns:

the caption, null if not applicable

getMenuItem

public abstract JMenuItem getMenuItem()

Creates a new menuitem.

doUpdate

protected abstract void doUpdate()

Performs the actual update of the state of the action.

update

public void update(T state)

Updates the state of the action.

Parameters:

state - the current state