org.peace_tools.generic
Class HelpHandler

java.lang.Object
  org.peace_tools.generic.HelpHandler

public class HelpHandler
extends java.lang.Object

A simple class to handle display of help URLs. This class was introduced to centralize the generic process of displaying help information to the user. This class contains static methods that can be directly used to display help from peace-tools.org via the default browser.

Field Summary

private static java.lang.String

HELP_ERROR This message is displayed when the default system browser could not be launched to display help.

Constructor Summary

private

HelpHandler() Private constructor to ensure this class is never instantiated.

Method Summary

static void

showHelp(java.awt.Component parent, java.lang.String url) Displays a given URL.

Methods inherited from class java.lang.Object

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

Field Detail

HELP_ERROR

private static final java.lang.String HELP_ERROR

This message is displayed when the default system browser could not be launched to display help.

See Also:

Constant Field Values

Constructor Detail

HelpHandler

private HelpHandler()

Private constructor to ensure this class is never instantiated. All the methods in this class are static and are designed to be used directly. In other words, this class is not meant to be instantiated. Consequently, the constructor is private.

Method Detail

showHelp

public static void showHelp(java.awt.Component parent,
                            java.lang.String url)

Displays a given URL. This method is used when the user chooses to view one of the selected help topics. This method is actually invoked from various classes to display help. The help is actually redirected to the PEACE web site. Having users visit a web site permits help content to be developed independently and updated consistently.

Parameters:

parent - The parent component that must be used to display any error dialogs.

url - The complete web site URL that must be displayed in the default system browser.