com.swfm.mica.core
Class MiHelpInfo

java.lang.Object
  com.swfm.mica.core.MiHelpInfo

All Implemented Interfaces:

MiiHelpInfo

public class MiHelpInfo

extends java.lang.Object

implements MiiHelpInfo

A basic implementation of the MiiHelpInfo interface. This class is used to specify ToolHints, StatusBar help, etc. and allows the programmer to specify unique color and fonts for each help message.

Version:

%I% %G%

Author:

Michael L. Davis

See Also:

MiPart.setToolHintHelp(com.swfm.mica.core.MiiHelpInfo), MiPart.setBalloonHelp(com.swfm.mica.core.MiiHelpInfo), MiPart.setBalloonHelp(com.swfm.mica.core.MiiHelpInfo), MiPart.setDialogHelp(com.swfm.mica.core.MiiHelpInfo)

Field Summary

static MiHelpInfo	ignoreThis A special MiHelpInfo instance that indicates that the user, for example the status bar, is to just ignore this help message.
static MiHelpInfo	noneForThis

Constructor Summary

MiHelpInfo(java.lang.String msg)
Contructs a new MiHelpInfo.

MiHelpInfo(java.lang.String msg, MiAttributes atts)
Contructs a new MiHelpInfo.

Method Summary

MiAttributes	getAttributes() Gets the attributes of the message display.
java.lang.String	getMessage() Gets the helpful message to display.
boolean	isEnabled() Gets whether this help is enabled.
void	setAttributes(MiAttributes atts) Sets the attributes of the message display.
void	setEnabled(boolean flag) Sets whether this help is enabled.
void	setMessage(java.lang.String msg) Sets the helpful message to display.
java.lang.String	toString() Prints information about this class.

Methods inherited from class java.lang.Object

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

Field Detail

ignoreThis

public static final MiHelpInfo ignoreThis

A special MiHelpInfo instance that indicates that the user, for example the status bar, is to just ignore this help message. A null message will cause the status bar to be cleared to no message at all. This is often used for the backgrounds of dialogs and menus so that the status bar does not flash while the user is browsing these container widgets.

noneForThis

public static final MiHelpInfo noneForThis

Constructor Detail

MiHelpInfo

public MiHelpInfo(java.lang.String msg)

Contructs a new MiHelpInfo.

Parameters:

msg - the helpful text message

MiHelpInfo

public MiHelpInfo(java.lang.String msg,
                  MiAttributes atts)

Contructs a new MiHelpInfo.

Parameters:

msg - the helpful text message

atts - the attributes to use to display the message

Method Detail

setMessage

public void setMessage(java.lang.String msg)

Sets the helpful message to display.

Specified by:

setMessage in interface MiiHelpInfo

Parameters:

msg - the message

getMessage

public java.lang.String getMessage()

Gets the helpful message to display.

Specified by:

getMessage in interface MiiHelpInfo

Returns:

the message

setAttributes

public void setAttributes(MiAttributes atts)

Sets the attributes of the message display. This permits the message font, message color, help dialog background color and more to be controlled for each help message.

Specified by:

setAttributes in interface MiiHelpInfo

Parameters:

atts - the attributes

getAttributes

public MiAttributes getAttributes()

Gets the attributes of the message display.

Specified by:

getAttributes in interface MiiHelpInfo

Returns:

the attributes of the message

setEnabled

public void setEnabled(boolean flag)

Sets whether this help is enabled.

Specified by:

setEnabled in interface MiiHelpInfo

Parameters:

flag - true if this help message is enabled

isEnabled

public boolean isEnabled()

Gets whether this help is enabled.

Specified by:

isEnabled in interface MiiHelpInfo

Returns:

true if this help message is enabled

toString

public java.lang.String toString()

Prints information about this class.