hirondelle.stocks.help
Class HelpAction

Object
  AbstractAction
      HelpAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public final class HelpAction
extends AbstractAction

Display the help system for the application.

Display one of table of contents, index, or search tab, according to argument passed to the constructor. This implementation uses Sun's JavaHelp tool.

This action activates the Help key (often F1) for this application. When the help key is pressed, the help system's table of contents is displayed.

This action is unusual in that it corresponds to more than one menu item (Contents, Index, and Search).

Note: the displayed JavaHelp screen is not centered; it is left as is, since the JavaHelp GUI is often cut off at the bottom anyway, and centering would make this problem worse.

See Also:

Serialized Form

Nested Class Summary

static class

HelpAction.View Enumeration for the style of presentation of the the Help system.

Field Summary

Fields inherited from class AbstractAction

changeSupport, enabled

Fields inherited from interface Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

HelpAction(JFrame aFrame, String aText, int aMnemonicKeyEvent, Icon aIcon, HelpAction.View aView)
Constructor.

Method Summary

void	actionPerformed(ActionEvent event)

Methods inherited from class AbstractAction

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

Methods inherited from class Object

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

Constructor Detail

HelpAction

public HelpAction(JFrame aFrame,
                  String aText,
                  int aMnemonicKeyEvent,
                  Icon aIcon,
                  HelpAction.View aView)

Constructor.

Parameters:

aFrame - parent window to which the help window is attached

aText - name of the menu item for this help action

aMnemonicKeyEvent - mnemonic for aText

aIcon - possibly-null graphic to be displayed alongside the text, or in a toolbar

aView - determines which help window is to be displayed: Contents, Index, or Search

Method Detail

actionPerformed

public void actionPerformed(ActionEvent event)