de.must.util

Class Help

java.lang.Object

de.must.util.Help

public class Help
extends java.lang.Object

Link from help context to help content via browser presentation. All components implementing the ContextHelp interface support method setHelpContext, which may be used to assign a position in the manual.

Constructor Summary

Constructors

Constructor and Description
Help()

Method Summary

Modifier and Type	Method and Description
static boolean	show() Shows the default page of the application.
static void	showContextHelp(java.awt.Container field) Shows the context help of a Container.
static boolean	showTopic(java.lang.String topic) Shows the help page as specified by topic.
static boolean	showTopic(java.lang.String topic, java.lang.String target) Shows the help page as specified by topic and target.

Methods inherited from class java.lang.Object

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

Constructor Detail

Help

public Help()

Method Detail

show

public static boolean show()

Shows the default page of the application.

Returns:

true of the specified page was reachable

showTopic

public static boolean showTopic(java.lang.String topic)

Shows the help page as specified by topic. Actually, the topic is the name of a html page.

Parameters:

topic - the topic of the help to show

Returns:

true of the specified page was reachable

showTopic

public static boolean showTopic(java.lang.String topic,
                                java.lang.String target)

Shows the help page as specified by topic and target. Actually, the topic is the name of a HTML page, and the target is the target inside this page.

Parameters:

topic - the topic of the help to show

target - the target of the help to show

Returns:

true of the specified page was reachable

showContextHelp

public static void showContextHelp(java.awt.Container field)

Shows the context help of a Container. If help is demanded via F1, the most special help is shown. Sample: If the field is help context defined, this context is used. If not, the context of the Frame is used . . .

Parameters:

field - the field, from where the help is requested.