IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.services
Class MessageOptionsWizard

java.lang.Object
  extended by com.rational.test.ft.ui.wizarddialog.Wizard
      extended by com.rational.test.ft.services.MessageOptionsWizard
All Implemented Interfaces:
IMessageOptions, com.rational.test.ft.ui.wizarddialog.IWizard

public class MessageOptionsWizard
extends com.rational.test.ft.ui.wizarddialog.Wizard
implements IMessageOptions

The wizard that controls the message filter level, message color, and whether to include a time stamp with each message.


Constructor Summary
MessageOptionsWizard(MonitorUIPreferences preferences)
           
 
Method Summary
 void addPages()
          The Wizard implementation of this IWizard method does nothing.
 javax.swing.ImageIcon getDefaultPageImage()
          Returns the default page image for this wizard.
 java.awt.Color getErrorMessageColor()
          Return the error level message text color.
 java.awt.Color getInfoMessageColor()
          Return the information level message text color.
 int getMessageLevelFilter()
          Return the message level filter.
 java.awt.Color getWarningMessageColor()
          Return the warning level message text color.
 java.lang.String getWindowTitle()
          Returns the window title string for this wizard.
 boolean isIncludeTimeStamp()
          Return whether to include a time stamp with the message display
 boolean isShowHelpOnStartup()
          Return whether to show help on startup
 boolean performFinish()
          Performs any actions appropriate in response to the user having pressed the Finish button, or refuse if finishing now is not permitted.
 void setErrorMessageColor(java.awt.Color color)
          Set the error level message text color.
 void setIncludeTimeStamp(boolean state)
          Set whether to include a time stamp with the message display
 void setInfoMessageColor(java.awt.Color color)
          Set the information level message text color.
 void setMessageLevelFilter(int level)
          Set the message level filter.
 void setShowHelpOnStartup(boolean state)
          Set whether to show help on startup
 void setWarningMessageColor(java.awt.Color color)
          Set the warning level message text color.
 
Methods inherited from class com.rational.test.ft.ui.wizarddialog.Wizard
addPage, canFinish, createPageControls, dispose, getContainer, getNeedsProgressMonitor, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, isHelpAvailable, needsCancelButtonOnly, needsPreviousAndNextButtons, needsProgressMonitor, needsTitleBar, performCancel, setContainer, setDefaultPageImage, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setNeedsTitleBar, setTitle, setWindowTitle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessageOptionsWizard

public MessageOptionsWizard(MonitorUIPreferences preferences)
Method Detail

addPages

public void addPages()
Description copied from class: com.rational.test.ft.ui.wizarddialog.Wizard
The Wizard implementation of this IWizard method does nothing. Subclasses should extend if extra pages need to be added before the wizard opens. New pages should be added by calling addPage.

Specified by:
addPages in interface com.rational.test.ft.ui.wizarddialog.IWizard
Overrides:
addPages in class com.rational.test.ft.ui.wizarddialog.Wizard

getDefaultPageImage

public javax.swing.ImageIcon getDefaultPageImage()
Returns the default page image for this wizard.

This image can be used for pages which do not supply their own image.

Specified by:
getDefaultPageImage in interface com.rational.test.ft.ui.wizarddialog.IWizard
Overrides:
getDefaultPageImage in class com.rational.test.ft.ui.wizarddialog.Wizard
Returns:
the default page image

getWindowTitle

public java.lang.String getWindowTitle()
Returns the window title string for this wizard.

Specified by:
getWindowTitle in interface com.rational.test.ft.ui.wizarddialog.IWizard
Overrides:
getWindowTitle in class com.rational.test.ft.ui.wizarddialog.Wizard
Returns:
the window title string, or null for no title

performFinish

public boolean performFinish()
Performs any actions appropriate in response to the user having pressed the Finish button, or refuse if finishing now is not permitted.

Specified by:
performFinish in interface com.rational.test.ft.ui.wizarddialog.IWizard
Specified by:
performFinish in class com.rational.test.ft.ui.wizarddialog.Wizard
Returns:
true to indicate the finish request was duly processed, and false to indicate that the finish request was refused

setIncludeTimeStamp

public void setIncludeTimeStamp(boolean state)
Set whether to include a time stamp with the message display

Specified by:
setIncludeTimeStamp in interface IMessageOptions
Parameters:
b - true - include timestamp, otherwise no

setShowHelpOnStartup

public void setShowHelpOnStartup(boolean state)
Set whether to show help on startup

Specified by:
setShowHelpOnStartup in interface IMessageOptions
Parameters:
state - true - show help otherwise not

isIncludeTimeStamp

public boolean isIncludeTimeStamp()
Return whether to include a time stamp with the message display

Specified by:
isIncludeTimeStamp in interface IMessageOptions
Returns:
true - timestamp included, false - no

isShowHelpOnStartup

public boolean isShowHelpOnStartup()
Return whether to show help on startup

Specified by:
isShowHelpOnStartup in interface IMessageOptions
Returns:
true - show help, false - no

setMessageLevelFilter

public void setMessageLevelFilter(int level)
Set the message level filter. Messages at or more severe will be output to the monitor.

Specified by:
setMessageLevelFilter in interface IMessageOptions
Parameters:
level - Message severity level
See Also:
IMonitor.ERROR_MSG, IMonitor.WARNING_MSG, IMonitor.INFO_MSG

getMessageLevelFilter

public int getMessageLevelFilter()
Return the message level filter. Messages at or more severe will be output to the monitor.

Specified by:
getMessageLevelFilter in interface IMessageOptions
Returns:
Message severity level

setErrorMessageColor

public void setErrorMessageColor(java.awt.Color color)
Set the error level message text color.

Specified by:
setErrorMessageColor in interface IMessageOptions
Parameters:
color - The new text color

getErrorMessageColor

public java.awt.Color getErrorMessageColor()
Return the error level message text color.

Specified by:
getErrorMessageColor in interface IMessageOptions
Returns:
The text color

setWarningMessageColor

public void setWarningMessageColor(java.awt.Color color)
Set the warning level message text color.

Specified by:
setWarningMessageColor in interface IMessageOptions
Parameters:
color - The new text color

getWarningMessageColor

public java.awt.Color getWarningMessageColor()
Return the warning level message text color.

Specified by:
getWarningMessageColor in interface IMessageOptions
Returns:
The text color

setInfoMessageColor

public void setInfoMessageColor(java.awt.Color color)
Set the information level message text color.

Specified by:
setInfoMessageColor in interface IMessageOptions
Parameters:
color - The new text color

getInfoMessageColor

public java.awt.Color getInfoMessageColor()
Return the information level message text color.

Specified by:
getInfoMessageColor in interface IMessageOptions
Returns:
The text color