Package adams.gui.flow.tree.menu

Class Help

java.lang.Object

javax.swing.AbstractAction

adams.gui.action.AbstractBaseAction

adams.gui.action.AbstractActionWithDialog<D>

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

adams.gui.action.AbstractPropertiesMenuItemAction<StateContainer,GenericObjectEditorDialog>

adams.gui.flow.tree.menu.AbstractTreePopupMenuItemAction

adams.gui.flow.tree.menu.Help

All Implemented Interfaces:

CleanUpHandler, BaseAction, PropertiesAction<StateContainer>, TreePopupAction, ActionListener, Serializable, Cloneable, EventListener, Action

public class Help
extends AbstractTreePopupMenuItemAction

For showing the help dialog for an actor.

Version:

$Revision$

Author:

fracpete

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.gui.action.AbstractPropertiesAction

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

Method Summary

Modifier and Type	Method	Description
protected void	doActionPerformed(ActionEvent e)	The action to execute.
protected void	doUpdate()	Updates the action using the current state information.
protected String	getTitle()	Returns the caption of this action.
protected void	help(TreePath path)	Displays the help for the selected actor.

Methods inherited from class adams.gui.flow.tree.menu.AbstractTreePopupMenuItemAction

addUndoPoint, getParentDialog, getParentFrame, getProperties, keyStrokeApplies

Methods inherited from class adams.gui.action.AbstractPropertiesMenuItemAction

getMenuItem

Methods inherited from class adams.gui.action.AbstractPropertiesAction

canUseIcon, initialize, update

Methods inherited from class adams.gui.action.AbstractActionWithDialog

cleanUp, createDialog, getDialog

Methods inherited from class adams.gui.action.AbstractBaseAction

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

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from interface adams.gui.action.BaseAction

cleanUp, getAccelerator, getIcon, getMnemonic, getName, getToolTipText, hasAccelerator, hasMnemonic, hasToolTipText, isAsynchronous, isSelected, setAccelerator, setAsynchronous, setIcon, setIcon, setMnemonic, setName, setSelected, setToolTipText

Methods inherited from interface adams.gui.action.PropertiesAction

getMenuItem, update

Constructor Detail

Help

public Help()

Method Detail

getTitle

protected String getTitle()

Returns the caption of this action.

Specified by:

getTitle in class AbstractPropertiesAction<StateContainer,GenericObjectEditorDialog>

Returns:

the caption, null if not applicable

doUpdate

protected void doUpdate()

Updates the action using the current state information.

Specified by:

doUpdate in class AbstractPropertiesAction<StateContainer,GenericObjectEditorDialog>

help

protected void help(TreePath path)

Displays the help for the selected actor.

Parameters:

path - the path to the actor

doActionPerformed

protected void doActionPerformed(ActionEvent e)

The action to execute.

Specified by:

doActionPerformed in class AbstractBaseAction

Parameters:

e - the event