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

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

public class WaitForCursorAtLocation
extends Command

A class that represents a VHI WaitForCursorAtLocation command.

See Also:

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

Constructor Summary

WaitForCursorAtLocation(int row, int column, int timeout)
Constructs a new WaitForCursorAtLocation command.

Method Summary

int	getColumn() Gets the column.
java.lang.String	getName() Gets the command name.
int	getRow() Gets the row.
int	getTimeout() Gets the timeout.

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

WaitForCursorAtLocation

public WaitForCursorAtLocation(int row,
                               int column,
                               int timeout)

Constructs a new WaitForCursorAtLocation command.

Parameters:

row - the one-based screen row (HostSession.ANY_ROW matches any row)

column - the one-based screen column (HostSession.ANY_COLUMN matches any column)

timeout - the maximum time to wait in seconds

Method Detail

getRow

public int getRow()

Gets the row.

Returns:

the one-based screen row (HostSession.ANY_ROW matches any row)

getColumn

public int getColumn()

Gets the column.

Returns:

the one-based screen column (HostSession.ANY_COLUMN matches any column)

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