org.fife.ui.app
Class GUIApplication.HelpAction

java.lang.Object
  javax.swing.AbstractAction
      org.fife.ui.app.StandardAction
          org.fife.ui.app.GUIApplication.HelpAction

All Implemented Interfaces:

javax.swing.Action, java.awt.event.ActionListener, java.lang.Cloneable, java.util.EventListener, java.io.Serializable

Enclosing class:

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 javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, 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 text)
Creates a new HelpAction.

GUIApplication.HelpAction(GUIApplication app, java.lang.String text, javax.swing.Icon icon, java.lang.String desc, int mnemonic, javax.swing.KeyStroke accelerator)
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, getIcon, getMnemonic, getName, getShortDescription, setAccelerator, 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.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.).

GUIApplication.HelpAction

public GUIApplication.HelpAction(GUIApplication app,
                                 java.lang.String text)

Creates a new HelpAction.

Parameters:

app - The GUI application that owns this action.

text - The text associated with the action.

GUIApplication.HelpAction

public GUIApplication.HelpAction(GUIApplication app,
                                 java.lang.String text,
                                 javax.swing.Icon icon,
                                 java.lang.String desc,
                                 int mnemonic,
                                 javax.swing.KeyStroke accelerator)

Creates a new HelpAction.

Parameters:

app - The GUI application that owns this action.

text - The text associated with the action.

icon - The icon associated with the action.

desc - The description of the action.

mnemonic - The mnemonic for the action.

accelerator - The accelerator key for the action.

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.