com.novell.application.console.shell.help
Class HelpServer

java.lang.Object
  |
  +--com.novell.application.console.shell.help.HelpServer

public final class HelpServer

extends java.lang.Object

Manages ConsoleOne's universal help system.

The HelpServer class manages the help system by 1) generating a master help set of all the *.hs files in the help directory 2) Managing on Help Broker to display the help content in a uniform manner

Constructor Summary

HelpServer()
Construct a new HelpServer with a new frame and the ConsoleOne base path

HelpServer(java.awt.Frame hostFrame, java.lang.String basePath)
Construct a new HelpServer with the hostFrame and basePath parameters.

Method Summary

boolean	helpExists(java.lang.String helpSetName, java.lang.String helpID) Checks to see if a JavaHelp help Set and ID exists
void	launchHelp(java.lang.String helpSetName, java.lang.String helpID, java.awt.Window window) Launches the ConsoleOne help from a modal dialog and displays the content corresponding to the Help ID tag
void	launchHelp(java.lang.String helpSetName, java.awt.Window window) Launches the ConsoleOne help from a modal dialog and displays the content at the top of the helpset
int	launchMsgBox(java.lang.String title, java.lang.String message, int type, java.lang.String helpSetName) Displays a common message box with a help button.
int	launchMsgBox(java.lang.String title, java.lang.String message, int type, java.lang.String helpSetName, java.lang.String helpID) Displays a common message box with a help button.
void	setActiveWindow(java.awt.Window window) Sets the active parent window for the current help broker

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpServer

public HelpServer(java.awt.Frame hostFrame,
                  java.lang.String basePath)

Construct a new HelpServer with the hostFrame and basePath parameters.

Parameters:

hostFrame - The host frame.

basePath - The base path for the help files.

HelpServer

public HelpServer()

Construct a new HelpServer with a new frame and the ConsoleOne base path

Method Detail

launchMsgBox

public int launchMsgBox(java.lang.String title,
                        java.lang.String message,
                        int type,
                        java.lang.String helpSetName,
                        java.lang.String helpID)

Displays a common message box with a help button. If the help button is pushed the content corresponding to helpId tag will be displayed

Parameters:

title - The title of the message box caption.

message - The message to go in the body of the message box.

type - The type of message box (see NMsgBox types).

helpSetName - The helpSet name

helpID - The help ID tag for the content to be displayed

Returns:

The value of the button that was pressed (see NMsgBox return values).

See Also:

NMsgBox

launchMsgBox

public int launchMsgBox(java.lang.String title,
                        java.lang.String message,
                        int type,
                        java.lang.String helpSetName)

Displays a common message box with a help button. If the help button is pushed the content corresponding to the top of the helpset will be displayed

Parameters:

title - The title of the message box caption.

message - The message to go in the body of the message box.

type - The type of message box (see NMsgBox types).

helpSetName - The helpSet name

Returns:

The value of the button that was pressed (see NMsgBox return values).

See Also:

NMsgBox

setActiveWindow

public void setActiveWindow(java.awt.Window window)

Sets the active parent window for the current help broker

Parameters:

window: - parent window object

helpExists

public boolean helpExists(java.lang.String helpSetName,
                          java.lang.String helpID)

Checks to see if a JavaHelp help Set and ID exists

Parameters:

helpSetName: - A JavaHelp help set name

helpID: - A HelpSet ID tag

Returns:

True or false depending on whether or not the Help Set and ID exist

launchHelp

public void launchHelp(java.lang.String helpSetName,
                       java.awt.Window window)

Launches the ConsoleOne help from a modal dialog and displays the content at the top of the helpset

Parameters:

helpSetName: - A JavaHelp help set file name

window: - parent window object

launchHelp

public void launchHelp(java.lang.String helpSetName,
                       java.lang.String helpID,
                       java.awt.Window window)

Launches the ConsoleOne help from a modal dialog and displays the content corresponding to the Help ID tag

Parameters:

helpSetName: - A JavaHelp help set file name

helpID: - A Help ID tag

window: - parent window object