org.safs.model.commands

Class VSFlexGridFunctions

java.lang.Object

org.safs.model.commands.VSFlexGridFunctions

public class VSFlexGridFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLICKCELL_KEYWORD "ClickCell"
static java.lang.String	SELECTCELL_KEYWORD "SelectCell"
static java.lang.String	VERIFYVALUESTOFILE_KEYWORD "VerifyValuesToFile"

Method Summary

Modifier and Type	Method and Description
static ComponentFunction	clickCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to perform a single Click on a table cell.
static ComponentFunction	clickCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to perform a single Click on a table cell.
static VSFlexGridFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	selectCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to perform a Select on a table cell.
static ComponentFunction	selectCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to perform a Select on a table cell.
static ComponentFunction	verifyValuesToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verify the string values of a grid block to a file benchmark.
static ComponentFunction	verifyValuesToFile(java.lang.String winname, java.lang.String compname, java.lang.String benchmarkFile, java.lang.String rowMin, java.lang.String rowMax, java.lang.String colMin, java.lang.String colMax) Verify the string values of a grid block to a file benchmark.

Methods inherited from class java.lang.Object

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

Field Detail

CLICKCELL_KEYWORD

public static final java.lang.String CLICKCELL_KEYWORD

"ClickCell"

See Also:

Constant Field Values

SELECTCELL_KEYWORD

public static final java.lang.String SELECTCELL_KEYWORD

"SelectCell"

See Also:

Constant Field Values

VERIFYVALUESTOFILE_KEYWORD

public static final java.lang.String VERIFYVALUESTOFILE_KEYWORD

"VerifyValuesToFile"

See Also:

Constant Field Values

Method Detail

getInstance

public static VSFlexGridFunctions getInstance()

public Singleton to access class static methods via instance

clickCell

public static ComponentFunction clickCell(java.lang.String winname,
                                          java.lang.String compname,
                                          java.lang.String row,
                                          java.lang.String col)

 
                 Attempts to perform a single Click on a table cell.
               
                 The cell to Click is provided in separate row and col 
                 parameters.  Missing parameters indicate index=1. The 
                 indexes are 1-based.  That is, the first row is row 1.
                 The first col is col 1. 
                 Logical Cells are those data cells viewable to the 
                 user.  They do not include hidden or fixed cells. 
                 Thus, the first top left cell for real grid data 
                 is considered cell 1,1.  
                 The grid will remain in edit mode if edit mode goes 
                 active. 
                  

Supporting Engines:

• Rational Robot

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

row - Optional:YES DefaultVal: The 1-based logical row to select.

col - Optional:YES DefaultVal: The 1-based logical col to select.

clickCell

public static ComponentFunction clickCell(java.lang.String winname,
                                          java.lang.String compname,
                                          java.lang.String[] parameters)

 
                 Attempts to perform a single Click on a table cell.
               
                 The cell to Click is provided in separate row and col 
                 parameters.  Missing parameters indicate index=1. The 
                 indexes are 1-based.  That is, the first row is row 1.
                 The first col is col 1. 
                 Logical Cells are those data cells viewable to the 
                 user.  They do not include hidden or fixed cells. 
                 Thus, the first top left cell for real grid data 
                 is considered cell 1,1.  
                 The grid will remain in edit mode if edit mode goes 
                 active. 
                  

Supporting Engines:

• Rational Robot

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

parameters - Optional:NO An array containing the following parameters:

row -- Optional:YES DefaultVal: The 1-based logical row to select.
col -- Optional:YES DefaultVal: The 1-based logical col to select.

selectCell

public static ComponentFunction selectCell(java.lang.String winname,
                                           java.lang.String compname,
                                           java.lang.String row,
                                           java.lang.String col)

 
                 Attempts to perform a Select on a table cell.
               
                 The cell to Select is provided in separate row and col 
                 parameters.  Missing parameters indicate index=1. The 
                 indexes are 1-based.  That is, the first row is row 1.
                 The first col is col 1. 
                 Logical Cells are those data cells viewable to the 
                 user.  They do not include hidden or fixed cells. 
                 Thus, the first top left cell for real grid data 
                 is considered cell 1,1.  
                 We will ESCAPE out of edit mode if edit mode goes 
                 active. 
                  

Supporting Engines:

• Rational Robot

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

row - Optional:YES DefaultVal: The 1-based logical row to select.

col - Optional:YES DefaultVal: The 1-based logical col to select.

selectCell

public static ComponentFunction selectCell(java.lang.String winname,
                                           java.lang.String compname,
                                           java.lang.String[] parameters)

 
                 Attempts to perform a Select on a table cell.
               
                 The cell to Select is provided in separate row and col 
                 parameters.  Missing parameters indicate index=1. The 
                 indexes are 1-based.  That is, the first row is row 1.
                 The first col is col 1. 
                 Logical Cells are those data cells viewable to the 
                 user.  They do not include hidden or fixed cells. 
                 Thus, the first top left cell for real grid data 
                 is considered cell 1,1.  
                 We will ESCAPE out of edit mode if edit mode goes 
                 active. 
                  

Supporting Engines:

• Rational Robot

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

parameters - Optional:NO An array containing the following parameters:

row -- Optional:YES DefaultVal: The 1-based logical row to select.
col -- Optional:YES DefaultVal: The 1-based logical col to select.

verifyValuesToFile

public static ComponentFunction verifyValuesToFile(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String benchmarkFile,
                                                   java.lang.String rowMin,
                                                   java.lang.String rowMax,
                                                   java.lang.String colMin,
                                                   java.lang.String colMax)

 
             Verify the string values of a grid block to a file benchmark.
              
             Grid rows and cols are considered 1-based.  You can specify a 
             subset of the grid by providing the optional values for 
             rowMin, rowMax, colMin, colMax.  The benchmark and the actual 
             will be stored as TAB delimited files.
             Typically, benchmarks are stored in the Datapool\Bench directory.  
                  

Supporting Engines:

• Rational Robot

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

benchmarkFile - Optional:NO The name of the file used as the comparison benchmark.

rowMin - Optional:YES DefaultVal:1 The first row to include in the capture and compare.

rowMax - Optional:YES The last row to include in the capture and compare.

colMin - Optional:YES DefaultVal:1 The first col to include in the capture and compare.

colMax - Optional:YES The last col to include in the capture and compare.

verifyValuesToFile

public static ComponentFunction verifyValuesToFile(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String[] parameters)

 
             Verify the string values of a grid block to a file benchmark.
              
             Grid rows and cols are considered 1-based.  You can specify a 
             subset of the grid by providing the optional values for 
             rowMin, rowMax, colMin, colMax.  The benchmark and the actual 
             will be stored as TAB delimited files.
             Typically, benchmarks are stored in the Datapool\Bench directory.  
                  

Supporting Engines:

• Rational Robot

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

parameters - Optional:NO An array containing the following parameters:

benchmarkFile -- Optional:NO The name of the file used as the comparison benchmark.
rowMin -- Optional:YES DefaultVal:1 The first row to include in the capture and compare.
rowMax -- Optional:YES The last row to include in the capture and compare.
colMin -- Optional:YES DefaultVal:1 The first col to include in the capture and compare.
colMax -- Optional:YES The last col to include in the capture and compare.