org.ka2ddo.yaac.gui.help

Class HelpAdapter

java.lang.Object

org.ka2ddo.yaac.gui.help.HelpAdapter

public class HelpAdapter
extends java.lang.Object

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):

1. 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

Fields

Modifier and Type	Field and Description
static java.lang.String	HELP_KEY JComponent client property name for an associated tag into a JavaHelp help map.

Method Summary

Modifier and Type	Method and Description
static void	registerWindowForHelpKeys(javax.swing.RootPaneContainer window) Set up infrastructure for handling Help-related window hot-keys on the specified window.
static void	setHelpTag(javax.swing.JComponent c, java.lang.String tag) Associate a JavaHelp tag with a GUI component so the F1 hot key will launch the appropriate help text.

Methods inherited from class java.lang.Object

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

Field Detail

HELP_KEY

public static final java.lang.String HELP_KEY

JComponent client property name for an associated tag into a JavaHelp help map.

See Also:

Constant Field Values

Method Detail

registerWindowForHelpKeys

public static void registerWindowForHelpKeys(javax.swing.RootPaneContainer window)

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

public static void setHelpTag(javax.swing.JComponent c,
                              java.lang.String tag)

Associate a JavaHelp tag with a GUI component so the F1 hot key will launch the appropriate help text.

Parameters:

c - JComponent to tag

tag - String name of help tag to associate