org.xnap.gui.util
Class HelpManager

java.lang.Object
  org.xnap.gui.util.HelpManager

public class HelpManager
extends java.lang.Object

A helper class providing the main helpset and helpbroker and some convenience functions for registering help keys in components.

Field Summary

static java.lang.String

XNAP_MANUAL

Method Summary

static void	add(javax.help.HelpSet hs) Adds helpset to the main helpset hierarchy.
static void	enableContextHelpKey(javax.swing.JComponent jc) Enables the context help key for a JComponent.
static void	enableHelpKeys(javax.swing.JComponent comp, java.lang.String id, javax.help.HelpSet hs) Convenience method enabling the help keys and the context help key for a JComponent.
static XNapHelpBroker	getMainHelpBroker() Returns the main helpbroker.
static javax.help.HelpSet	getMainHelpSet() Returns the main helpset.
static java.awt.event.ActionListener	getTracker()
static javax.help.HelpSet	loadHelpSet(java.lang.String helpset) Helper method to load helpsets.
static void	remove(javax.help.HelpSet hs) Removes helpset from the main helpset hierarchy.

Methods inherited from class java.lang.Object

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

Field Detail

XNAP_MANUAL

public static final java.lang.String XNAP_MANUAL

See Also:

Constant Field Values

Method Detail

getMainHelpSet

public static javax.help.HelpSet getMainHelpSet()

Returns the main helpset. If helpset isn't loaded yet, it will be loaded on demand.

Returns:

returns null if helpset couldn't be loaded.

getMainHelpBroker

public static XNapHelpBroker getMainHelpBroker()

Returns the main helpbroker.

add

public static void add(javax.help.HelpSet hs)

Adds helpset to the main helpset hierarchy.

remove

public static void remove(javax.help.HelpSet hs)

Removes helpset from the main helpset hierarchy.

loadHelpSet

public static javax.help.HelpSet loadHelpSet(java.lang.String helpset)

Helper method to load helpsets.

Parameters:

helpset - name of the helpset file without the ending, e.g. "xnap-manual" from "xnap-manual.hs".

enableHelpKeys

public static void enableHelpKeys(javax.swing.JComponent comp,
                                  java.lang.String id,
                                  javax.help.HelpSet hs)

Convenience method enabling the help keys and the context help key for a JComponent.

enableContextHelpKey

public static void enableContextHelpKey(javax.swing.JComponent jc)

Enables the context help key for a JComponent.

getTracker

public static java.awt.event.ActionListener getTracker()