public final class HelpAction extends AbstractAction
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's left as is, since the JavaHelp GUI is often cut off at the bottom anyway, and centering would make this problem worse.
Modifier and Type | Class and Description |
---|---|
static class |
HelpAction.View
Enumeration for the style of presentation of the the Help system.
|
changeSupport, enabled
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 and Description |
---|
HelpAction(JFrame aFrame,
String aText,
int aMnemonicKeyEvent,
Icon aIcon,
HelpAction.View aView)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
actionPerformed(ActionEvent event) |
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled
public HelpAction(JFrame aFrame, String aText, int aMnemonicKeyEvent, Icon aIcon, HelpAction.View aView)
aFrame
- parent window to which the help window is attachedaText
- name of the menu item for this help actionaMnemonicKeyEvent
- mnemonic for aTextaIcon
- possibly-null graphic to be displayed alongside the text, or
in a toolbaraView
- determines which help window is to be displayed: Contents, Index,
or Searchpublic void actionPerformed(ActionEvent event)
Copyright Hirondelle Systems - License - Generated 2013Sep20.10.58