com.wrq.vhi.script.api.command
Class WaitForUpdate

java.lang.Object
  com.wrq.vhi.script.api.command.Command
      com.wrq.vhi.script.api.command.WaitForUpdate

public class WaitForUpdate
extends Command

A class that represents a VHI WaitForUpdate command.

See Also:

CommandList, HostSession.executeCommandList(com.wrq.vhi.script.api.command.CommandList), HostSession.waitForUpdate(int, int, int, int, int, boolean, int)

Constructor Summary

WaitForUpdate(int topRow, int leftColumn, int bottomRow, int rightColumn, int regionType, boolean relativeToCursor, int timeout)
Constructs a new WaitForUpdate command.

Method Summary

int	getBottomRow() Gets the bottom row of the region.
int	getLeftColumn() Gets the left column of the region.
java.lang.String	getName() Gets the command name.
int	getRegionType() Gets the region type.
int	getRightColumn() Gets the right column of the region.
int	getTimeout() Gets the timeout.
int	getTopRow() Gets the top row of the region.
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

WaitForUpdate

public WaitForUpdate(int topRow,
                     int leftColumn,
                     int bottomRow,
                     int rightColumn,
                     int regionType,
                     boolean relativeToCursor,
                     int timeout)

Constructs a new WaitForUpdate command.

Parameters:

topRow - the top row of the region to watch

leftColumn - the left column of the region to watch

bottomRow - the bottom row of the region to watch

rightColumn - the right column of the region to watch

regionType - the type of region to use: HostSession.LINEAR_REGION or HostSession.RECTANGULAR_REGION.

relativeToCursor - true if the region is relative to the cursor position

timeout - the maximum time to wait in seconds

Method Detail

getTopRow

public int getTopRow()

Gets the top row of the region.

Returns:

the top row of the region to watch

getLeftColumn

public int getLeftColumn()

Gets the left column of the region.

Returns:

the left column of the region to watch

getBottomRow

public int getBottomRow()

Gets the bottom row of the region.

Returns:

the bottom row of the region to watch

getRightColumn

public int getRightColumn()

Gets the right column of the region.

Returns:

the right column of the region to watch

getRegionType

public int getRegionType()

Gets the region type.

Returns:

the type of region to use: HostSession.LINEAR_REGION or HostSession.RECTANGULAR_REGION.

isRelativeToCursor

public boolean isRelativeToCursor()

Gets the relative to cursor flag.

Returns:

true if the region is relative to the cursor position

getTimeout

public int getTimeout()

Gets the timeout.

Returns:

the maximum time to wait in seconds

getName

public java.lang.String getName()

Gets the command name.

Specified by:

getName in class Command

Returns:

the command name