com.rational.test.ft.services

Class PlaybackMonitorAdapter

java.lang.Object

com.rational.test.ft.services.PlaybackMonitorAdapter

All Implemented Interfaces:

IPlaybackMonitor, IPlaybackMonitorDisplay

Direct Known Subclasses:

PlaybackMonitor

public class PlaybackMonitorAdapter
extends java.lang.Object
implements IPlaybackMonitor, IPlaybackMonitorDisplay

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	FINDING Searching the system for a particular object
static int	WAITING Waiting

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

LAST_STATE, LINE_NUM_UNKNOWN, RUNNING, START_APP, TYPING

Constructor Summary

Constructors

Constructor and Description
PlaybackMonitorAdapter()

Method Summary

Modifier and Type	Method and Description
void	close() Method called to take the playback monitor down and release all its resources
java.lang.String	getDescription() Get the description of the currently executing statement.
boolean	getDisplayLocked() Get the lock state of the monitor's display fields.
java.awt.Frame	getFrame() Return the playback monitor's frame
boolean	isAlwaysOnTop() Returns whether the playback monitor is always displayed on top of other windows.
boolean	isVisible() Returns whether the playback monitor is visible.
void	pause() Put the monitor in the "paused" state.
void	resetDescription() Reset to the base Running state
void	resume() Resume the monitor from the paused 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	setDisplayLocked(boolean lockedState) Lock (or unlock) the display fields so the contents can not be changed.
void	setFinding(boolean state) Set whether currently trying to find an object
void	setScriptLine(int line) 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 state) 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 java.lang.Object

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

Field Detail

WAITING

public static final int WAITING

Waiting

See Also:

Constant Field Values

FINDING

public static final int FINDING

Searching the system for a particular object

See Also:

Constant Field Values

Constructor Detail

PlaybackMonitorAdapter

public PlaybackMonitorAdapter()

Method Detail

setScriptName

public void setScriptName(java.lang.String scriptName)

Set the name of the script being played back

Specified by:

setScriptName in interface IPlaybackMonitor

Parameters:

scriptName - The script name

setScriptLine

public void setScriptLine(int line)

Set the line in the script currently executing

Specified by:

setScriptLine in interface IPlaybackMonitor

Parameters:

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

getDescription

public java.lang.String getDescription()

Get the description of the currently executing statement. If we already have a description, some lower-level code may skip setting a description.

Specified by:

getDescription in interface IPlaybackMonitor

setDescription

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

Set the description of the currently executing statement

Specified by:

setDescription in interface IPlaybackMonitor

Parameters:

state - The state (this selects a stock message) (@link #RUNNING, @link #WAITING, @link #FINDING,

additionalText - Additional text appended to the stock message.

resetDescription

public void resetDescription()

Reset to the base Running state

Specified by:

resetDescription in interface IPlaybackMonitor

setFinding

public void setFinding(boolean state)

Set whether currently trying to find an object

Specified by:

setFinding in interface IPlaybackMonitor

Parameters:

state - true - searching, false - not

setWaiting

public void setWaiting(boolean state)

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

Specified by:

setWaiting in interface IPlaybackMonitor

Parameters:

state - 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

Parameters:

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

isVisible

public boolean isVisible()

Returns whether the playback monitor is visible.

Specified by:

isVisible in interface IPlaybackMonitorDisplay

Returns:

true if the playback monitor is visible, false otherwise

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

Parameters:

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

isAlwaysOnTop

public boolean isAlwaysOnTop()

Returns whether the playback monitor is always displayed on top of other windows.

Specified by:

isAlwaysOnTop in interface IPlaybackMonitorDisplay

Returns:

true if the playback monitor is displayed on top, false otherwise

close

public void close()

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

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

getFrame

public java.awt.Frame getFrame()

Return the playback monitor's frame

Specified by:

getFrame in interface IPlaybackMonitorDisplay

Returns:

the playback monitor's frame

setDisplayLocked

public void setDisplayLocked(boolean lockedState)

Lock (or unlock) the display fields so the contents can not be changed. Useful for calling public api methods internally that update the description field (when you don't want it updated).

Specified by:

setDisplayLocked in interface IPlaybackMonitor

Parameters:

lockState - true to lock the display

getDisplayLocked

public boolean getDisplayLocked()

Get the lock state of the monitor's display fields.

Specified by:

getDisplayLocked in interface IPlaybackMonitor

pause

public void pause()

Put the monitor in the "paused" state.

Specified by:

pause in interface IPlaybackMonitor

resume

public void resume()

Resume the monitor from the paused state.

Specified by:

resume in interface IPlaybackMonitor

stop

public void stop()

Put the monitor UI in the "stopping" state.

Specified by:

stop in interface IPlaybackMonitor