org.safs.model.commands

Class FPSpreadFunctions

java.lang.Object

org.safs.model.commands.FPSpreadFunctions

public class FPSpreadFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPTURERANGETOFILE_KEYWORD "CaptureRangeToFile"
static java.lang.String	CLICKCELL_KEYWORD "ClickCell"
static java.lang.String	CTRLCLICKCELL_KEYWORD "CtrlClickCell"
static java.lang.String	DOUBLECLICKCELL_KEYWORD "DoubleClickCell"
static java.lang.String	FINDROWNUMBER_KEYWORD "FindRowNumber"
static java.lang.String	RIGHTCLICKCELL_KEYWORD "RightClickCell"
static java.lang.String	SHIFTCLICKCELL_KEYWORD "ShiftClickCell"
static java.lang.String	VERIFYCELLTEXT_KEYWORD "VerifyCellText"

Method Summary

Modifier and Type	Method and Description
static ComponentFunction	captureRangeToFile(java.lang.String winname, java.lang.String compname, java.lang.String capturedFile) Capture the grid data to the specified file.
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 ComponentFunction	ctrlClickCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to perform a single Ctrl+Click on a table cell.
static ComponentFunction	ctrlClickCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to perform a single Ctrl+Click on a table cell.
static ComponentFunction	doubleClickCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to perform a double click on a table cell.
static ComponentFunction	doubleClickCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to perform a double click on a table cell.
static ComponentFunction	findRowNumber(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Search specified columns for the specified text.
static ComponentFunction	findRowNumber(java.lang.String winname, java.lang.String compname, java.lang.String rowVarName, java.lang.String startingRow, java.lang.String searchColumns, java.lang.String searchText, java.lang.String dELIMITER) Search specified columns for the specified text.
static FPSpreadFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	rightClickCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to perform a single right click on a table cell.
static ComponentFunction	rightClickCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to perform a single right click on a table cell.
static ComponentFunction	shiftClickCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to perform a single SHIFT+Click on a table cell.
static ComponentFunction	shiftClickCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to perform a single SHIFT+Click on a table cell.
static ComponentFunction	verifyCellText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verify a specific cell's text.
static ComponentFunction	verifyCellText(java.lang.String winname, java.lang.String compname, java.lang.String expectedCellText, java.lang.String row, java.lang.String col) Verify a specific cell's text.

Methods inherited from class java.lang.Object

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

Field Detail

CAPTURERANGETOFILE_KEYWORD

public static final java.lang.String CAPTURERANGETOFILE_KEYWORD

"CaptureRangeToFile"

See Also:

Constant Field Values

CLICKCELL_KEYWORD

public static final java.lang.String CLICKCELL_KEYWORD

"ClickCell"

See Also:

Constant Field Values

CTRLCLICKCELL_KEYWORD

public static final java.lang.String CTRLCLICKCELL_KEYWORD

"CtrlClickCell"

See Also:

Constant Field Values

DOUBLECLICKCELL_KEYWORD

public static final java.lang.String DOUBLECLICKCELL_KEYWORD

"DoubleClickCell"

See Also:

Constant Field Values

FINDROWNUMBER_KEYWORD

public static final java.lang.String FINDROWNUMBER_KEYWORD

"FindRowNumber"

See Also:

Constant Field Values

RIGHTCLICKCELL_KEYWORD

public static final java.lang.String RIGHTCLICKCELL_KEYWORD

"RightClickCell"

See Also:

Constant Field Values

SHIFTCLICKCELL_KEYWORD

public static final java.lang.String SHIFTCLICKCELL_KEYWORD

"ShiftClickCell"

See Also:

Constant Field Values

VERIFYCELLTEXT_KEYWORD

public static final java.lang.String VERIFYCELLTEXT_KEYWORD

"VerifyCellText"

See Also:

Constant Field Values

Method Detail

getInstance

public static FPSpreadFunctions getInstance()

public Singleton to access class static methods via instance

captureRangeToFile

public static ComponentFunction captureRangeToFile(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String capturedFile)

 
             Capture the grid data to the specified file.  For now,
             it can only be used to capture all of the grid data.
              
                  

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.

capturedFile - Optional:NO The name of the file used to save the captured data.

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. 
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 click.

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

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. 
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 click.
col -- Optional:YES DefaultVal: The 1-based logical col to click.

ctrlClickCell

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

 
                 Attempts to perform a single Ctrl+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. 
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 Ctrl+Click.

col - Optional:YES DefaultVal: The 1-based logical col to Ctrl+Click.

ctrlClickCell

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

 
                 Attempts to perform a single Ctrl+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. 
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 Ctrl+Click.
col -- Optional:YES DefaultVal: The 1-based logical col to Ctrl+Click.

doubleClickCell

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

 
                 Attempts to perform a double click on a table cell.
              
                 The cell to double 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.
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 double click.

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

doubleClickCell

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

 
                 Attempts to perform a double click on a table cell.
              
                 The cell to double 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.
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 double click.
col -- Optional:YES DefaultVal: The 1-based logical col to double click.

findRowNumber

public static ComponentFunction findRowNumber(java.lang.String winname,
                                              java.lang.String compname,
                                              java.lang.String rowVarName,
                                              java.lang.String startingRow,
                                              java.lang.String searchColumns,
                                              java.lang.String searchText,
                                              java.lang.String dELIMITER)

 
             Search specified columns for the specified text.  Assign the
             matching row number to the given variable.
              
             Multiple (column, search text) pairs can be used as parameters
             to find the matching row.

             The search column and the search text parameters should have
             the same number of parameters and are expected to work in
             parallel (the first search text is looked for in the first
             column listed).

             The column name and search text parameters, if more than one,
             use the delimiter specified to show the separation in the string.
                  

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.

rowVarName - Optional:NO The name of the variable to store the row number into.

startingRow - Optional:NO The row to use to begin the search. Defaults to row 1.

searchColumns - Optional:NO DefaultVal: The string of column names where you want to search.

searchText - Optional:YES DefaultVal: The string of search strings used to search in each specified column names.

dELIMITER - Optional:NO DefaultVal: Delimiter used by the search columns and search text to separate the different columns/text.

findRowNumber

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

 
             Search specified columns for the specified text.  Assign the
             matching row number to the given variable.
              
             Multiple (column, search text) pairs can be used as parameters
             to find the matching row.

             The search column and the search text parameters should have
             the same number of parameters and are expected to work in
             parallel (the first search text is looked for in the first
             column listed).

             The column name and search text parameters, if more than one,
             use the delimiter specified to show the separation in the string.
                  

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:

rowVarName -- Optional:NO The name of the variable to store the row number into.
startingRow -- Optional:NO The row to use to begin the search. Defaults to row 1.
searchColumns -- Optional:NO DefaultVal: The string of column names where you want to search.
searchText -- Optional:YES DefaultVal: The string of search strings used to search in each specified column names.
dELIMITER -- Optional:NO DefaultVal: Delimiter used by the search columns and search text to separate the different columns/text.

rightClickCell

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

 
                 Attempts to perform a single right 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. 
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 right click.

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

rightClickCell

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

 
                 Attempts to perform a single right 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. 
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 right click.
col -- Optional:YES DefaultVal: The 1-based logical col to right click.

shiftClickCell

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

 
                 Attempts to perform a single SHIFT+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. 
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 SHIFT+Click.

col - Optional:YES DefaultVal: The 1-based logical col to SHIFT+Click.

shiftClickCell

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

 
                 Attempts to perform a single SHIFT+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. 
                 The row headers, whether visible or not, are considered
                 column 0.  The column headers, whether visible or not,
                 are considered row 0.
                  

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 SHIFT+Click.
col -- Optional:YES DefaultVal: The 1-based logical col to SHIFT+Click.

verifyCellText

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

 
             Verify a specific cell's text.
              
                  

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.

expectedCellText - Optional:NO The expected text value of the specified cell.

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

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

verifyCellText

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

 
             Verify a specific cell's text.
              
                  

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:

expectedCellText -- Optional:NO The expected text value of the specified cell.
row -- Optional:YES DefaultVal: The 1-based logical row to verify.
col -- Optional:YES DefaultVal: The 1-based logical col to verify.