com.wrq.vhi.script.api.command

Class WaitForDisplayString

java.lang.Object

com.wrq.vhi.script.api.command.Command

com.wrq.vhi.script.api.command.WaitForDisplayString

public class WaitForDisplayString
extends Command

A class that represents a VHI WaitForDisplayString command.

See Also:

CommandList, HostSession.executeCommandList(com.wrq.vhi.script.api.command.CommandList), HostSession.waitForDisplayString(java.lang.String, int, int, boolean, int)

Constructor Summary

Constructors

Constructor and Description
WaitForDisplayString(java.lang.String text, int timeout, int row, int column, boolean relativeToCursor) Constructs a new WaitForDisplayString command

Method Summary

Methods

Modifier and Type	Method and Description
int	getColumn() Gets the column.
java.lang.String	getName() Gets the command name.
int	getRow() Gets the row.
java.lang.String	getText() Gets the text to wait to appear.
int	getTimeout() Gets the wait timeout.
boolean	isRelativeToCursor() Gets the relative to cursor flag.

Methods inherited from class com.wrq.vhi.script.api.command.Command

isValidEchoType

Methods inherited from class java.lang.Object

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

Constructor Detail

WaitForDisplayString

public WaitForDisplayString(java.lang.String text,
                    int timeout,
                    int row,
                    int column,
                    boolean relativeToCursor)

Constructs a new WaitForDisplayString command

Parameters:

text - the text to wait to appear

timeout - the timeout in seconds

row - if relativeToCursor is true, the offset to the cursor row; otherwise, the one-based screen row (ANY_ROW matches any row)

column - if relativeToCursor is true, the offset to the cursor column; otherwise, the one-based screen column (ANY_COLUMN matches any column)

relativeToCursor - true if the row and column should be interpreted as offsets from the cursor position

Method Detail

getText

public java.lang.String getText()

Gets the text to wait to appear.

Returns:

the text to wait to appear

getTimeout

public int getTimeout()

Gets the wait timeout.

Returns:

the timeout in seconds

getRow

public int getRow()

Gets the row.

Returns:

if isRelativeToCursor() is true, gets the offset to the cursor row; otherwise, the one-based screen row (HostSession.ANY_ROW matches any row)

getColumn

public int getColumn()

Gets the column.

Returns:

if isRelativeToCursor() is true, gets the offset to the cursor column; otherwise, the one-based screen column (HostSession.ANY_COLUMN matches any column)

isRelativeToCursor

public boolean isRelativeToCursor()

Gets the relative to cursor flag.

Returns:

true if the row and column should be interpreted as offsets from the cursor position

getName

public java.lang.String getName()

Gets the command name.

Specified by:

getName in class Command

Returns:

the command name