org.fife.ui.app
Class GUIApplication.HelpAction

java.lang.Object
  extended by javax.swing.AbstractAction
      extended by org.fife.ui.app.StandardAction
          extended by org.fife.ui.app.GUIApplication.HelpAction
All Implemented Interfaces:
java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action
Enclosing interface:
GUIApplication

public static class GUIApplication.HelpAction
extends StandardAction

The action that displays the application's Help dialog. This action should be sufficient for most applications; it simply displays the modal Help dialog obtained from getHelpDialog.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.fife.ui.app.StandardAction
DEFAULT_ACCELERATOR
 
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
GUIApplication.HelpAction(GUIApplication app, java.util.ResourceBundle msg, java.lang.String nameKey)
          Creates a new HelpAction.
GUIApplication.HelpAction(GUIApplication app, java.lang.String nameKey)
          Creates a new HelpAction.
GUIApplication.HelpAction(GUIApplication app, java.lang.String nameKey, java.lang.String icon)
          Creates a new HelpAction.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Displays the Help dialog, if it is non-null.
 
Methods inherited from class org.fife.ui.app.StandardAction
getAccelerator, getApplication, getDefaultAccelerator, getIcon, getMnemonic, getName, getShortDescription, setAccelerator, setDefaultAccelerator, setIcon, setIcon, setIcon, setMnemonic, setName, setShortDescription
 
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
 

Constructor Detail

GUIApplication.HelpAction

public GUIApplication.HelpAction(GUIApplication app,
                                 java.lang.String nameKey)
Creates a new HelpAction.

Parameters:
app - The GUI application that owns this action.
nameKey - The key for the name of the action (and the possible root of keys for description, mnemonic, etc.).

GUIApplication.HelpAction

public GUIApplication.HelpAction(GUIApplication app,
                                 java.lang.String nameKey,
                                 java.lang.String icon)
Creates a new HelpAction.

Parameters:
app - The GUI application that owns this action.
nameKey - The key for the name of the action (and the possible root of keys for description, mnemonic, etc.).
icon - The name of the icon resource for this action.

GUIApplication.HelpAction

public GUIApplication.HelpAction(GUIApplication app,
                                 java.util.ResourceBundle msg,
                                 java.lang.String nameKey)
Creates a new HelpAction.

Parameters:
app - The GUI application that owns this action.
msg - The resource bundle to localize from.
nameKey - The key for the name of the action (and the possible root of keys for description, mnemonic, etc.).
Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Displays the Help dialog, if it is non-null.

Parameters:
e - The action event.