com.attachmate.sc.ssa
Interface IController

All Known Implementing Classes:

DefaultController, VTController

public interface IController

Custom Steps Only
This interface describes the interaction between IQAScreen and IDirectAccess objects. Classes based on this interface needs to intrepet sendkeys style keystrokes and converting them into actions on the screen.

Method Summary

Point	getCursorTrigger() Sets the cursor trigger.
IPerformanceTool	getPerformanceTool() Gets the current performance tool from the current controller.
long	getSettleTime() Gets the amount of time a read should wait for a settled read.
long	getTimeout() Gets the maximum amount of time a read should take.
void	performAction(java.lang.String commands) Convert the supplied array of '@' commands into actions.
void	setCursorTrigger(Point p) Sets the cursor trigger.
void	setFieldText(java.lang.String text) Write the supplied text to where the cursor is sitting.
void	setPerformanceTool(IPerformanceTool tool) Sets the performance tools on the current controller.
void	setSettleTime(long milliseconds) Sets the amount of time a read should wait for a settled read.
void	setTimeout(long milliseconds) Sets the amount of time to perform a read

Method Detail

setFieldText

public void setFieldText(java.lang.String text)
                  throws com.attachmate.nav.engine.CustomStepException

Write the supplied text to where the cursor is sitting. The text will be trimmed to fit the field length.

Parameters:

text - the String to write to the field

Throws:

ProtectedFieldException

com.attachmate.nav.engine.CustomStepException

performAction

public void performAction(java.lang.String commands)
                   throws java.io.IOException,
                          com.attachmate.nav.engine.NavException

Convert the supplied array of '@' commands into actions.

Parameters:

commands - a String containing a list of commands.

java.io.IOException

com.attachmate.nav.engine.NavException

setTimeout

public void setTimeout(long milliseconds)

Sets the amount of time to perform a read

Parameters:

milliseconds - the maximum number of milliseconds the read should take.

getTimeout

public long getTimeout()

Gets the maximum amount of time a read should take.

Returns:

the maximum amount of time in milliseconds.

setSettleTime

public void setSettleTime(long milliseconds)

Sets the amount of time a read should wait for a settled read. If the read returns with data before the time set, the timer is reset and another read is performed.

Parameters:

milliseconds - the amount of time to wait per read.

getSettleTime

public long getSettleTime()

Gets the amount of time a read should wait for a settled read. If the read returns with data before tthe time set, the timer is reset and another read is performed.

Returns:

the number of milliseconds to wait per read.

setCursorTrigger

public void setCursorTrigger(Point p)

Sets the cursor trigger. A settled read will exit when the host sets the cursor to this coordinate.

Parameters:

p - a Point containing the cursor coordinate to wait for. If it is set to (0,0), the read will rely on the timeout and settleTime for exiting the settled read.

getCursorTrigger

public Point getCursorTrigger()

Sets the cursor trigger. A settled read will exit when the host sets the cursor to this coordinate.

Returns:

a Point containing the cursor coordinate to wait for. If it is set to (0,0), the read will rely on the timeout and settleTime for exiting the settled read.

setPerformanceTool

public void setPerformanceTool(IPerformanceTool tool)

Sets the performance tools on the current controller.

Parameters:

tool - a reference to an object that has implemented IPerformanceTool.

getPerformanceTool

public IPerformanceTool getPerformanceTool()

Gets the current performance tool from the current controller.

Returns:

a reference to the object that has been assigned to this controller.