Package org.ka2ddo.yaac.gui.help
Class HelpAdapter
java.lang.Object
org.ka2ddo.yaac.gui.help.HelpAdapter
This class provides generalized support for hot-key "help" on functions within YAAC.
Help can be invoked (in addition to the normal ways through the Help menu):
- by pressing the F1 or HELP keys on your keyboard when the focus is on a component tagged with a JavaHelp tag in the collected help maps (or an ancestor container of the focused component has such a tag).
- Author:
- Andrew Pavlin, KA2DDO
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
Set up infrastructure for handling Help-related window hot-keys on the specified window.static void
setHelpTag
(JComponent c, String tag) Associate a JavaHelp tag with a GUI component so the F1 hot key will launch the appropriate help text.
-
Field Details
-
HELP_KEY
JComponent client property name for an associated tag into a JavaHelp help map.- See Also:
-
-
Method Details
-
registerWindowForHelpKeys
Set up infrastructure for handling Help-related window hot-keys on the specified window.- Parameters:
window
- RootPaneContainer on which to enable hot-key help
-
setHelpTag
Associate a JavaHelp tag with a GUI component so the F1 hot key will launch the appropriate help text.- Parameters:
c
- JComponent to tagtag
- String name of help tag to associate
-