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

java.lang.Object
  extended by com.wrq.vhi.script.api.command.Command
      extended by com.wrq.vhi.script.api.command.MoveCursor

public class MoveCursor
extends Command

A class that represents a VHI MoveCursor command.

See Also:
CommandList, HostSession.executeCommandList(com.wrq.vhi.script.api.command.CommandList), HostSession.moveCursor(int, int)

Constructor Summary
MoveCursor(int row, int column)
          Constructs a new MoveCursor command.
 
Method Summary
 int getColumn()
          Gets the cursor column.
 java.lang.String getName()
          Gets the command name.
 int getRow()
          Gets the cursor row.
 
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

MoveCursor

public MoveCursor(int row,
                  int column)
Constructs a new MoveCursor command.

Parameters:
row - one-based vertical position of the cursor (HostSession.CURRENT_ROW means the current cursor row).
column - one-based horizontal position of the cursor (HostSession.CURRENT_COLUMN means the current cursor column).
Method Detail

getRow

public int getRow()
Gets the cursor row.

Returns:
one-based vertical position of the cursor (HostSession.CURRENT_ROW means the current cursor row).

getColumn

public int getColumn()
Gets the cursor column.

Returns:
one-based horizontal position of the cursor (HostSession.CURRENT_COLUMN means the current cursor column).

getName

public java.lang.String getName()
Gets the command name.

Specified by:
getName in class Command
Returns:
the command name