org.carewebframework.shell

Class CareWebUtil

java.lang.Object

org.carewebframework.shell.CareWebUtil

public class CareWebUtil
extends Object

Static utility methods.

Method Summary

Modifier and Type	Method and Description
static void	about() Displays the About dialog.
static void	associateCSH(org.fujion.component.BaseUIComponent component, HelpContext context) Associates help context with a component.
static void	associateCSH(org.fujion.component.BaseUIComponent component, String module, String topic, String label) Associates help context with a component.
static CareWebShell	getShell() Returns the active instance of the CareWeb shell.
protected static void	setShell(CareWebShell shell) Sets the active instance of the CareWeb shell.
static void	showHelpTOC() Shows table of contents in help viewer.
static void	showHelpTopic(String module, String topic, String label) Shows help topic in help viewer.
static void	showMessage(String message) Sends an informational message for display by desktop.
static void	showMessage(String message, String caption) Sends an informational message for display by desktop.

Methods inherited from class java.lang.Object

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

Method Detail

getShell

public static CareWebShell getShell()

Returns the active instance of the CareWeb shell.

Returns:

The shell instance.

setShell

protected static void setShell(CareWebShell shell)

Sets the active instance of the CareWeb shell. An exception is raised if an active instance has already been set.

Parameters:

shell - Shell to become the active instance.

about

public static void about()

Displays the About dialog.

showMessage

public static void showMessage(String message,
                               String caption)

Sends an informational message for display by desktop.

Parameters:

message - Text of the message.

caption - Optional caption text.

showMessage

public static void showMessage(String message)

Sends an informational message for display by desktop.

Parameters:

message - Text of the message.

showHelpTOC

public static void showHelpTOC()

Shows table of contents in help viewer.

showHelpTopic

public static void showHelpTopic(String module,
                                 String topic,
                                 String label)

Shows help topic in help viewer.

Parameters:

module - The id of the help module.

topic - The id of the desired topic.

label - The label to display for the topic.

associateCSH

public static void associateCSH(org.fujion.component.BaseUIComponent component,
                                String module,
                                String topic,
                                String label)

Associates help context with a component.

Parameters:

component - The component.

module - The help module identifier.

topic - The topic id.

label - The topic label.

associateCSH

public static void associateCSH(org.fujion.component.BaseUIComponent component,
                                HelpContext context)

Associates help context with a component.

Parameters:

component - The component.

context - The help context.