com.xmlmind.jhelp

Class JHelp

java.lang.Object

com.xmlmind.jhelp.JHelp

public final class JHelp
extends Object

An context-sensitive help system based on Web help.

Constructor Summary

Constructors

Constructor and Description
JHelp()

Method Summary

Modifier and Type	Method and Description
static IdMap	addIdMap(URL url) Adds the ID map of a help document to the (ordered) list of ID maps.
static boolean	configureHelpButton(AbstractButton button, String topicId) Configures specified button to display the help topic having specified ID.
static DefaultViewer	getDefaultViewer() Specifies how to invoke the system Web browser.
static URI	getHelpBaseURI() The base URI used to resolve the relative URIs of some help documents.
static String	getHelpTitle() The title of the embedded help browser.
static IdMap[]	getIdMaps() Returns the (ordered) llist of ID maps of help documents registered with this help system.
static boolean	hasHelpTopics() Returns true if some help topics are available; false otherwise.
static void	initialize(String helpTitle, URI helpBaseURI, DefaultViewer viewer) Initializes the help system.
static void	pickHelpTopic(Component component) Show the help topic associated to the component clicked upon.
static void	setHelpTopicId(Component component, String topicId) Associate specified help topic ID to specified component.
static boolean	showHelpTopic(String topicId, boolean useFallback, Component parentComponent) Show help topic having specified ID.
static boolean	showHelpTopic(String topicId, Component parentComponent) Equivalent to showHelpTopic(topicId, true, parentComponent).
static void	unsetHelpTopicId(Component component) Un-associate help topic ID, if any, from specified component.

Methods inherited from class java.lang.Object

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

Constructor Detail

JHelp

public JHelp()

Method Detail

initialize

public static void initialize(String helpTitle,
                              URI helpBaseURI,
                              DefaultViewer viewer)

Initializes the help system.

Parameters:

helpTitle - the title of the embedded help browser. May be null in which case the title of the first help document is used (or fixed string "Help" if no help documents have been registered with this help system).

helpBaseURI - the base URI used to resolve the relative URIs of some help documents. May be null if all help documents have absolute URIs.

viewer - specifies how to invoke the system Web browser. This system Web browser is used when the embedded help browser is not available (e.g. Java runtime older than version 1.8.0_40).

getHelpTitle

public static String getHelpTitle()

The title of the embedded help browser. May return null.

See Also:

initialize(java.lang.String, java.net.URI, com.xmlmind.jhelp.DefaultViewer)

getHelpBaseURI

public static URI getHelpBaseURI()

The base URI used to resolve the relative URIs of some help documents. May return null.

See Also:

initialize(java.lang.String, java.net.URI, com.xmlmind.jhelp.DefaultViewer)

getDefaultViewer

public static DefaultViewer getDefaultViewer()

Specifies how to invoke the system Web browser. May return default implementation DefaultViewerImpl.

See Also:

initialize(java.lang.String, java.net.URI, com.xmlmind.jhelp.DefaultViewer)

addIdMap

public static IdMap addIdMap(URL url)

Adds the ID map of a help document to the (ordered) list of ID maps.

This method basically registers a new help document with this help system.

See Also:

getIdMaps()

getIdMaps

public static IdMap[] getIdMaps()

Returns the (ordered) llist of ID maps of help documents registered with this help system.

See Also:

addIdMap(java.net.URL)

setHelpTopicId

public static void setHelpTopicId(Component component,
                                  String topicId)

Associate specified help topic ID to specified component.

Parameters:

component - component to be configured to display a help topic

topicId - ID of a help topic. A null or empty topicId may be used to specify the first topic of the first help document.

See Also:

configureHelpButton(javax.swing.AbstractButton, java.lang.String)

unsetHelpTopicId

public static void unsetHelpTopicId(Component component)

Un-associate help topic ID, if any, from specified component.

hasHelpTopics

public static boolean hasHelpTopics()

Returns true if some help topics are available; false otherwise.

This method may be used to disable a Help button at dialog box creation time.

configureHelpButton

public static boolean configureHelpButton(AbstractButton button,
                                          String topicId)

Configures specified button to display the help topic having specified ID.

Parameters:

button - button to be configured to display a help topic

topicId - ID of a help topic. A null or empty topicId may be used to specify the first topic of the first help document.

Returns:

true if specified button has been enabled as a help button; false otherwise.

See Also:

setHelpTopicId(java.awt.Component, java.lang.String)

showHelpTopic

public static boolean showHelpTopic(String topicId,
                                    Component parentComponent)

Equivalent to showHelpTopic(topicId, true, parentComponent).

showHelpTopic

public static boolean showHelpTopic(String topicId,
                                    boolean useFallback,
                                    Component parentComponent)

Show help topic having specified ID.

Parameters:

topicId - ID of a help topic. A null or empty topicId may be used to specify the first topic of the first help document.

useFallback - if true, use the first topic of the first help document as a fallback

parentComponent - parent of a possible user feedback dialog box

Returns:

true if topic having specified ID (or the fallback topic when useFallback is true) has been displayed; false otherwise

See Also:

pickHelpTopic(java.awt.Component)

pickHelpTopic

public static void pickHelpTopic(Component component)

Show the help topic associated to the component clicked upon.

Parameters:

component - used to specify the root ancestor of the component to be clicked upon

See Also:

showHelpTopic(String, Component)