IBM Rational Functional Tester
Version 8.2.1
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.services
Class MonitorUIPreferences

java.lang.Object
  extended by WindowUIPreferences
      extended by com.rational.test.ft.services.MonitorUIPreferences

public class MonitorUIPreferences
extends WindowUIPreferences


Constructor Summary
MonitorUIPreferences(HashtableEx preferences)
          Create a MonitorUIPreferences object
 
Method Summary
 java.awt.Color getErrorMessageColor()
          Return the error level message text color.
 java.awt.Color getErrorMessageColorDefault()
          Return the error level message text color default.
 int getHistorySize()
          Return the number of messages displayed before the oldest message is removed when a new message is added
 boolean getIncludeTimeStampDefault()
          Return the timestamp is included in the message output to the monitor default
 java.awt.Color getInfoMessageColor()
          Return the info level message text color.
 java.awt.Color getInfoMessageColorDefault()
          Return the info level message text color default.
 java.lang.String getLastSavePath()
          Return the last path (directory) a file was saved to
 int getMessageLevelFilter()
          Return the message level filter.
 int getMessageLevelFilterDefault()
          Return the message level filter default.
 java.awt.Rectangle getRectangle()
          Return the window rectangle
 boolean getShowHelpOnStartupDefault()
          Return whether help is displayed by default monitor default
static MonitorUIPreferences getUIPreferences()
          Return the monitor's UI preferences.
 java.awt.Color getWarningMessageColor()
          Return the warning level message text color.
 java.awt.Color getWarningMessageColorDefault()
          Return the warning level message text color default.
 boolean isIncludeTimeStamp()
          Return whether a timestamp is included in the message output to the monitor
 boolean isShowHelpOnStartup()
          Return whether a timestamp is included in the message output to the monitor
 void setErrorMessageColor(java.awt.Color color)
          Set the error level message text color.
 void setHistorySize(int length)
          Set the number of messages displayed before the oldest message is removed when a new message is added
 void setIncludeTimeStamp(boolean timeStamp)
          Set whether a timestamp is included in the message output to the monitor
 void setInfoMessageColor(java.awt.Color color)
          Set the info level message text color.
 void setLastSavePath(java.lang.String path)
          Set the last path (directory) a file was saved to
 void setMessageLevelFilter(int msgLevelFilter)
          Set the message level filter.
 void setShowHelpOnStartup(boolean showHelp)
          Set whether a timestamp is included in the message output to the monitor
 void setWarningMessageColor(java.awt.Color color)
          Set the warning level message text color.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MonitorUIPreferences

public MonitorUIPreferences(HashtableEx preferences)
Create a MonitorUIPreferences object

Method Detail

getUIPreferences

public static MonitorUIPreferences getUIPreferences()
Return the monitor's UI preferences. This is the method to call to create MonitorUIPreferences


getRectangle

public java.awt.Rectangle getRectangle()
Return the window rectangle


setIncludeTimeStamp

public void setIncludeTimeStamp(boolean timeStamp)
Set whether a timestamp is included in the message output to the monitor

Parameters:
timeStamp - Yes or no

isIncludeTimeStamp

public boolean isIncludeTimeStamp()
Return whether a timestamp is included in the message output to the monitor

Returns:
true - include timestamp, false - no timestamp

getIncludeTimeStampDefault

public boolean getIncludeTimeStampDefault()
Return the timestamp is included in the message output to the monitor default

Returns:
true - include timestamp, false - no timestamp(default)

setShowHelpOnStartup

public void setShowHelpOnStartup(boolean showHelp)
Set whether a timestamp is included in the message output to the monitor

Parameters:
timeStamp - Yes or no

isShowHelpOnStartup

public boolean isShowHelpOnStartup()
Return whether a timestamp is included in the message output to the monitor

Returns:
true - include timestamp, false - no timestamp

getShowHelpOnStartupDefault

public boolean getShowHelpOnStartupDefault()
Return whether help is displayed by default monitor default

Returns:
true - show help(default), false - don't show help

setMessageLevelFilter

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

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.

Returns:
Message severity level

getMessageLevelFilterDefault

public int getMessageLevelFilterDefault()
Return the message level filter default.

Returns:
Message severity level default

setErrorMessageColor

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

Parameters:
color - The new text color

getErrorMessageColor

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

Returns:
The text color

getErrorMessageColorDefault

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

Parameters:
color - The text color default

setWarningMessageColor

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

Parameters:
color - The new text color

getWarningMessageColor

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

Returns:
The text color

getWarningMessageColorDefault

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

Returns:
The text color default

setInfoMessageColor

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

Parameters:
color - The new text color

getInfoMessageColor

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

Returns:
The text color

getInfoMessageColorDefault

public java.awt.Color getInfoMessageColorDefault()
Return the info level message text color default.

Returns:
The text color default

setHistorySize

public void setHistorySize(int length)
Set the number of messages displayed before the oldest message is removed when a new message is added

Parameters:
length - Maximum number of messages to keep

getHistorySize

public int getHistorySize()
Return the number of messages displayed before the oldest message is removed when a new message is added

Returns:
Maximum number of messages to keep

setLastSavePath

public void setLastSavePath(java.lang.String path)
Set the last path (directory) a file was saved to

Parameters:
path - The last path a file was saved to

getLastSavePath

public java.lang.String getLastSavePath()
Return the last path (directory) a file was saved to

Returns:
The last path a file was saved to

toString

public java.lang.String toString()