com.swfm.mica.sys
Class MiHelpManager

java.lang.Object
  com.swfm.mica.sys.MiHelpManager

public class MiHelpManager

extends java.lang.Object

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

static int	BALLOON_HELP_TYPE
static int	DIALOG_HELP_TYPE
static int	METHODOLOGY_SCROLLING_TO_MESSAGE_USING_OBJECT_HELPTEXT_AS_KEY_IN_FILE
static int	METHODOLOGY_SCROLLING_TO_MESSAGE_USING_OBJECT_NAME_AS_KEY_IN_FILE
static int	METHODOLOGY_SHOWING_HELPTEXT_ASSIGNED_TO_OBJECT
static int	METHODOLOGY_SHOWING_ONE_MESSAGE_USING_OBJECT_HELPTEXT_AS_KEY_IN_FILE
static int	METHODOLOGY_SHOWING_ONE_MESSAGE_USING_OBJECT_NAME_AS_KEY_IN_FILE
static int	METHODOLOGY_USING_HELPTEXT_AS_FILENAME
static int	NO_HELP_AVAILABLE_ID
static int	SHOW_HELP_NOT_FOUND_MESSAGES_DEBUG_MODE
static int	SHOW_NAME_OF_OBJECT_WITHOUT_HELP_DEBUG_MODE
static int	STATUS_HELP_TYPE
static int	TOOLTIP_HELP_TYPE

Constructor Summary

MiHelpManager()

Method Summary

void	displayAboutDialog()
void	displayHelpOnApplication()
MiPart	getAboutDialog()
boolean	getBalloonHelpEnabled()
java.lang.String	getBalloonHelpForObject(MiPart obj, MiPoint point)
int	getBalloonHelpMethodology()
boolean	getDialogHelpEnabled()
java.lang.String	getDialogHelpForObject(MiPart obj, MiPoint point)
int	getDialogHelpMethodology()
MiPart	getHelpOnApplicationDialog()
boolean	getStatusHelpEnabled()
java.lang.String	getStatusHelpForObject(MiPart obj, MiPoint point)
int	getStatusHelpMethodology()
java.lang.String	getToolHintForObject(MiPart obj, MiPoint point)
boolean	getToolHintHelpEnabled()
int	getToolHintMethodology()
void	setAboutDialog(MiPart aboutDialog)
void	setBallonHelpFilename(java.lang.String name)
void	setBalloonHelpEnabled(boolean flag)
void	setBalloonHelpFile(MiiHelpFile file)
void	setBalloonHelpMethodology(int methodology)
void	setDialogHelpEnabled(boolean flag)
void	setDialogHelpFile(MiiHelpFile file)
void	setDialogHelpFilename(java.lang.String name)
void	setDialogHelpMethodology(int methodology)
void	setHelpOnApplicationDialog(MiPart dialog)
void	setNoBalloonHelpAvailableMessage(java.lang.String msg)
void	setNoDialogHelpAvailableMessage(java.lang.String msg)
void	setNoStatusHelpAvailableMessage(java.lang.String msg)
void	setNoToolHintHelpAvailableMessage(java.lang.String msg)
void	setStatusHelpEnabled(boolean flag)
void	setStatusHelpFile(MiiHelpFile file)
void	setStatusHelpFilename(java.lang.String name)
void	setStatusHelpMethodology(int methodology)
void	setToolHintHelpEnabled(boolean flag)
void	setToolHintHelpFile(MiiHelpFile file)
void	setToolHintHelpFilename(java.lang.String name)
void	setToolHintMethodology(int methodology)

Methods inherited from class java.lang.Object

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

Field Detail

NO_HELP_AVAILABLE_ID

public static final int NO_HELP_AVAILABLE_ID

See Also:

Constant Field Values

TOOLTIP_HELP_TYPE

public static final int TOOLTIP_HELP_TYPE

See Also:

Constant Field Values

BALLOON_HELP_TYPE

public static final int BALLOON_HELP_TYPE

See Also:

Constant Field Values

STATUS_HELP_TYPE

public static final int STATUS_HELP_TYPE

See Also:

Constant Field Values

DIALOG_HELP_TYPE

public static final int DIALOG_HELP_TYPE

See Also:

Constant Field Values

SHOW_HELP_NOT_FOUND_MESSAGES_DEBUG_MODE

public static final int SHOW_HELP_NOT_FOUND_MESSAGES_DEBUG_MODE

See Also:

Constant Field Values

SHOW_NAME_OF_OBJECT_WITHOUT_HELP_DEBUG_MODE

public static final int SHOW_NAME_OF_OBJECT_WITHOUT_HELP_DEBUG_MODE

See Also:

Constant Field Values

METHODOLOGY_SHOWING_HELPTEXT_ASSIGNED_TO_OBJECT

public static final int METHODOLOGY_SHOWING_HELPTEXT_ASSIGNED_TO_OBJECT

See Also:

Constant Field Values

METHODOLOGY_SHOWING_ONE_MESSAGE_USING_OBJECT_NAME_AS_KEY_IN_FILE

public static final int METHODOLOGY_SHOWING_ONE_MESSAGE_USING_OBJECT_NAME_AS_KEY_IN_FILE

See Also:

Constant Field Values

METHODOLOGY_SCROLLING_TO_MESSAGE_USING_OBJECT_NAME_AS_KEY_IN_FILE

public static final int METHODOLOGY_SCROLLING_TO_MESSAGE_USING_OBJECT_NAME_AS_KEY_IN_FILE

See Also:

Constant Field Values

METHODOLOGY_SHOWING_ONE_MESSAGE_USING_OBJECT_HELPTEXT_AS_KEY_IN_FILE

public static final int METHODOLOGY_SHOWING_ONE_MESSAGE_USING_OBJECT_HELPTEXT_AS_KEY_IN_FILE

See Also:

Constant Field Values

METHODOLOGY_SCROLLING_TO_MESSAGE_USING_OBJECT_HELPTEXT_AS_KEY_IN_FILE

public static final int METHODOLOGY_SCROLLING_TO_MESSAGE_USING_OBJECT_HELPTEXT_AS_KEY_IN_FILE

See Also:

Constant Field Values

METHODOLOGY_USING_HELPTEXT_AS_FILENAME

public static final int METHODOLOGY_USING_HELPTEXT_AS_FILENAME

See Also:

Constant Field Values

Constructor Detail

MiHelpManager

public MiHelpManager()

Method Detail

setBalloonHelpEnabled

public void setBalloonHelpEnabled(boolean flag)

getBalloonHelpEnabled

public boolean getBalloonHelpEnabled()

setToolHintHelpEnabled

public void setToolHintHelpEnabled(boolean flag)

getToolHintHelpEnabled

public boolean getToolHintHelpEnabled()

setStatusHelpEnabled

public void setStatusHelpEnabled(boolean flag)

getStatusHelpEnabled

public boolean getStatusHelpEnabled()

setDialogHelpEnabled

public void setDialogHelpEnabled(boolean flag)

getDialogHelpEnabled

public boolean getDialogHelpEnabled()

setToolHintMethodology

public void setToolHintMethodology(int methodology)

getToolHintMethodology

public int getToolHintMethodology()

setStatusHelpMethodology

public void setStatusHelpMethodology(int methodology)

getStatusHelpMethodology

public int getStatusHelpMethodology()

setBalloonHelpMethodology

public void setBalloonHelpMethodology(int methodology)

getBalloonHelpMethodology

public int getBalloonHelpMethodology()

setDialogHelpMethodology

public void setDialogHelpMethodology(int methodology)

getDialogHelpMethodology

public int getDialogHelpMethodology()

setToolHintHelpFilename

public void setToolHintHelpFilename(java.lang.String name)

setBallonHelpFilename

public void setBallonHelpFilename(java.lang.String name)

setStatusHelpFilename

public void setStatusHelpFilename(java.lang.String name)

setDialogHelpFilename

public void setDialogHelpFilename(java.lang.String name)

setToolHintHelpFile

public void setToolHintHelpFile(MiiHelpFile file)

setBalloonHelpFile

public void setBalloonHelpFile(MiiHelpFile file)

setStatusHelpFile

public void setStatusHelpFile(MiiHelpFile file)

setDialogHelpFile

public void setDialogHelpFile(MiiHelpFile file)

setNoToolHintHelpAvailableMessage

public void setNoToolHintHelpAvailableMessage(java.lang.String msg)

setNoBalloonHelpAvailableMessage

public void setNoBalloonHelpAvailableMessage(java.lang.String msg)

setNoStatusHelpAvailableMessage

public void setNoStatusHelpAvailableMessage(java.lang.String msg)

setNoDialogHelpAvailableMessage

public void setNoDialogHelpAvailableMessage(java.lang.String msg)

getToolHintForObject

public java.lang.String getToolHintForObject(MiPart obj,
                                             MiPoint point)

getStatusHelpForObject

public java.lang.String getStatusHelpForObject(MiPart obj,
                                               MiPoint point)

getBalloonHelpForObject

public java.lang.String getBalloonHelpForObject(MiPart obj,
                                                MiPoint point)

getDialogHelpForObject

public java.lang.String getDialogHelpForObject(MiPart obj,
                                               MiPoint point)

setHelpOnApplicationDialog

public void setHelpOnApplicationDialog(MiPart dialog)

getHelpOnApplicationDialog

public MiPart getHelpOnApplicationDialog()

displayHelpOnApplication

public void displayHelpOnApplication()

setAboutDialog

public void setAboutDialog(MiPart aboutDialog)

getAboutDialog

public MiPart getAboutDialog()

displayAboutDialog

public void displayAboutDialog()