com.rational.test.ft.services
Class PlaybackMonitor

java.lang.Object
  com.rational.test.ft.services.PlaybackMonitorAdapter
      com.rational.test.ft.services.PlaybackMonitor

All Implemented Interfaces:

IPlaybackMonitor, IPlaybackMonitorDisplay

public class PlaybackMonitor
extends PlaybackMonitorAdapter

The adapter which receives playback monitor requests. The methods in this class are empty.

Nested Class Summary

class

PlaybackMonitor.FixedHeightTextField

Field Summary

Fields inherited from class com.rational.test.ft.services.PlaybackMonitorAdapter

FINDING, WAITING

Fields inherited from interface com.rational.test.ft.services.IPlaybackMonitor

LAST_STATE, LINE_NUM_UNKNOWN, RUNNING, START_APP, TYPING

Constructor Summary

PlaybackMonitor()
Create a playback monitor

Method Summary

void	close() Method called to take the playback monitor down and release all its resources
protected void	finalize()
java.awt.Frame	getFrame() Return the playback monitor's frame
static void	main(java.lang.String[] args)
void	pause() Set the monitor UI to the paused state
void	resetDescription() Reset to the base Running state
void	resume() Set the monitor UI to the resumed state
void	setAlwaysOnTop(boolean b) Display playback monitor in front of any other window or not, depending on the argument.
void	setDescription(int state, java.lang.String additionalText) Set the description of the currently executing statement
void	setFinding(boolean b) Set whether currently trying to find an object
void	setScriptLine(int lineNum) Set the line in the script currently executing
void	setScriptName(java.lang.String scriptName) Set the name of the script being played back
void	setVisible(boolean b) Show or hide the playback monitor depending on the argument.
void	setWaiting(boolean b) Set whether the playback engine is waiting (e.g.
void	stop() Put the monitor UI in the "stopping" state.
void	toFront() Method called to bring the playback monitor to the front of the stacking order (AKA z-order).

Methods inherited from class com.rational.test.ft.services.PlaybackMonitorAdapter

getDescription, getDisplayLocked, isAlwaysOnTop, isVisible, setDisplayLocked

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaybackMonitor

public PlaybackMonitor()

Create a playback monitor

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

close

public void close()

Method called to take the playback monitor down and release all its resources

Overrides:

close in class PlaybackMonitorAdapter

setScriptName

public void setScriptName(java.lang.String scriptName)

Set the name of the script being played back

Specified by:

setScriptName in interface IPlaybackMonitor

Overrides:

setScriptName in class PlaybackMonitorAdapter

Parameters:

scriptName - The script name

setScriptLine

public void setScriptLine(int lineNum)

Set the line in the script currently executing

Specified by:

setScriptLine in interface IPlaybackMonitor

Overrides:

setScriptLine in class PlaybackMonitorAdapter

Parameters:

lineNum - The currently executing line number or (@link #LINE_NUM_UNKNOWN) if unknown

setDescription

public void setDescription(int state,
                           java.lang.String additionalText)

Set the description of the currently executing statement

Specified by:

setDescription in interface IPlaybackMonitor

Overrides:

setDescription in class PlaybackMonitorAdapter

Parameters:

state - The state (this selects a stock message) (@link #RUNNING, @link #TYPING, @link #START_APP)

additionalText - Additional text appended to the stock message.

resetDescription

public void resetDescription()

Reset to the base Running state

Specified by:

resetDescription in interface IPlaybackMonitor

Overrides:

resetDescription in class PlaybackMonitorAdapter

setFinding

public void setFinding(boolean b)

Set whether currently trying to find an object

Specified by:

setFinding in interface IPlaybackMonitor

Overrides:

setFinding in class PlaybackMonitorAdapter

Parameters:

b - true - searching, false - not

setWaiting

public void setWaiting(boolean b)

Set whether the playback engine is waiting (e.g. waiting before retrying an action)

Specified by:

setWaiting in interface IPlaybackMonitor

Overrides:

setWaiting in class PlaybackMonitorAdapter

Parameters:

b - true - waiting, false - not

setVisible

public void setVisible(boolean b)

Show or hide the playback monitor depending on the argument.

Specified by:

setVisible in interface IPlaybackMonitor

Specified by:

setVisible in interface IPlaybackMonitorDisplay

Overrides:

setVisible in class PlaybackMonitorAdapter

Parameters:

b - true - show the playback monitor, otherwise, hide

setAlwaysOnTop

public void setAlwaysOnTop(boolean b)

Display playback monitor in front of any other window or not, depending on the argument.

Specified by:

setAlwaysOnTop in interface IPlaybackMonitorDisplay

Overrides:

setAlwaysOnTop in class PlaybackMonitorAdapter

Parameters:

b - true - show always on top, otherwise, may be behind another window

toFront

public void toFront()

Method called to bring the playback monitor to the front of the stacking order (AKA z-order).

Specified by:

toFront in interface IPlaybackMonitorDisplay

Overrides:

toFront in class PlaybackMonitorAdapter

getFrame

public java.awt.Frame getFrame()

Return the playback monitor's frame

Specified by:

getFrame in interface IPlaybackMonitorDisplay

Overrides:

getFrame in class PlaybackMonitorAdapter

Returns:

the playback monitor's frame

pause

public void pause()

Set the monitor UI to the paused state

Specified by:

pause in interface IPlaybackMonitor

Overrides:

pause in class PlaybackMonitorAdapter

resume

public void resume()

Set the monitor UI to the resumed state

Specified by:

resume in interface IPlaybackMonitor

Overrides:

resume in class PlaybackMonitorAdapter

stop

public void stop()

Put the monitor UI in the "stopping" state.

Specified by:

stop in interface IPlaybackMonitor

Overrides:

stop in class PlaybackMonitorAdapter

main

public static void main(java.lang.String[] args)