org.safs.model.commands

Class DotNetTableFunctions

java.lang.Object

org.safs.model.commands.DotNetTableFunctions

public class DotNetTableFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVATECELL_KEYWORD "ActivateCell"
static java.lang.String	ACTIVATECOLUMNLABEL_KEYWORD "ActivateColumnLabel"
static java.lang.String	ASSIGNCELLCONTAINSTEXTROW_KEYWORD "AssignCellContainsTextRow"
static java.lang.String	ASSIGNCELLTEXTROW_KEYWORD "AssignCellTextRow"
static java.lang.String	ASSIGNVARIABLECELLTEXT_KEYWORD "AssignVariableCellText"
static java.lang.String	ASSIGNVARIABLEFUZZYCELLTEXT_KEYWORD "AssignVariableFuzzyCellText"
static java.lang.String	CAPTUREFUZZYRANGETOFILE_KEYWORD "CaptureFuzzyRangeToFile"
static java.lang.String	CAPTURERANGETOFILE_KEYWORD "CaptureRangeToFile"
static java.lang.String	CLICKCELL_KEYWORD "ClickCell"
static java.lang.String	CLICKCOLUMNLABEL_KEYWORD "ClickColumnLabel"
static java.lang.String	DOUBLECLICKCELL_KEYWORD "DoubleClickCell"
static java.lang.String	DOUBLECLICKCOLUMNLABEL_KEYWORD "DoubleClickColumnLabel"
static java.lang.String	RIGHTCLICKCELL_KEYWORD "RightClickCell"
static java.lang.String	SELECTCELL_KEYWORD "SelectCell"
static java.lang.String	SELECTCELLCONTAINSTEXTFIND_KEYWORD "SelectCellContainsTextFind"
static java.lang.String	SELECTCELLTEXT_KEYWORD "SelectCellText"
static java.lang.String	SELECTCELLTEXTFIND_KEYWORD "SelectCellTextFind"
static java.lang.String	SELECTCELLTEXTSPECIAL_KEYWORD "SelectCellTextSpecial"
static java.lang.String	SELECTFUZZYCELLTEXT_KEYWORD "SelectFuzzyCellText"
static java.lang.String	SELECTFUZZYCELLTEXTFIND_KEYWORD "SelectFuzzyCellTextFind"
static java.lang.String	VERIFYCELLEDITABLE_KEYWORD "VerifyCellEditable"
static java.lang.String	VERIFYCELLTEXT_KEYWORD "VerifyCellText"
static java.lang.String	VERIFYCELLTEXTCONTAINS_KEYWORD "VerifyCellTextContains"
static java.lang.String	VERIFYCELLTEXTFIND_KEYWORD "VerifyCellTextFind"
static java.lang.String	VERIFYCOLUMNLABEL_KEYWORD "VerifyColumnLabel"
static java.lang.String	VERIFYFUZZYCELLTEXT_KEYWORD "VerifyFuzzyCellText"
static java.lang.String	VERIFYFUZZYCELLTEXTCONTAINS_KEYWORD "VerifyFuzzyCellTextContains"
static java.lang.String	VERIFYFUZZYCELLTEXTFIND_KEYWORD "VerifyFuzzyCellTextFind"

Method Summary

Modifier and Type	Method and Description
static ComponentFunction	activateCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to perform a double click on a DotNetTable cell.
static ComponentFunction	activateCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to perform a double click on a DotNetTable cell.
static ComponentFunction	activateColumnLabel(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Double clicks on the label of the specified column.
static ComponentFunction	activateColumnLabel(java.lang.String winname, java.lang.String compname, java.lang.String colNumber, java.lang.String yOffset) Double clicks on the label of the specified column.
static ComponentFunction	assignCellContainsTextRow(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Assigns a user-defined variable a row # based on partial matching cell values.
static ComponentFunction	assignCellContainsTextRow(java.lang.String winname, java.lang.String compname, java.lang.String var, java.lang.String col, java.lang.String colN, java.lang.String valueN) Assigns a user-defined variable a row # based on partial matching cell values.
static ComponentFunction	assignCellTextRow(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Assigns a user-defined variable a row # based on matching cell values.
static ComponentFunction	assignCellTextRow(java.lang.String winname, java.lang.String compname, java.lang.String var, java.lang.String col, java.lang.String colN, java.lang.String valueN) Assigns a user-defined variable a row # based on matching cell values.
static ComponentFunction	assignVariableCellText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to extract a particular cell value and assign it to the provided variable name.
static ComponentFunction	assignVariableCellText(java.lang.String winname, java.lang.String compname, java.lang.String variableName, java.lang.String row, java.lang.String col) Attempts to extract a particular cell value and assign it to the provided variable name.
static ComponentFunction	assignVariableFuzzyCellText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to extract a particular cell value and assign it to the provided variable name.
static ComponentFunction	assignVariableFuzzyCellText(java.lang.String winname, java.lang.String compname, java.lang.String variableName, java.lang.String row, java.lang.String col) Attempts to extract a particular cell value and assign it to the provided variable name.
static ComponentFunction	captureFuzzyRangeToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Saves a range of values to the specified file.
static ComponentFunction	captureFuzzyRangeToFile(java.lang.String winname, java.lang.String compname, java.lang.String fileName, java.lang.String row, java.lang.String col, java.lang.String rows, java.lang.String columns, java.lang.String fileEncoding, java.lang.String filterMode, java.lang.String filterOptions) Saves a range of values to the specified file.
static ComponentFunction	captureRangeToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Saves a range of values to the specified file.
static ComponentFunction	captureRangeToFile(java.lang.String winname, java.lang.String compname, java.lang.String fileName, java.lang.String row, java.lang.String col, java.lang.String rows, java.lang.String columns, java.lang.String fileEncoding, java.lang.String filterMode, java.lang.String filterOptions) Saves a range of values to the specified file.
static ComponentFunction	clickCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to perform a Click on a cell in a DotNetTable.
static ComponentFunction	clickCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to perform a Click on a cell in a DotNetTable.
static ComponentFunction	clickColumnLabel(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Clicks on the label of the specified column.
static ComponentFunction	clickColumnLabel(java.lang.String winname, java.lang.String compname, java.lang.String colNumber, java.lang.String yOffset) Clicks on the label of the specified column.
static ComponentFunction	doubleClickCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to perform a double click on a cell in a DotNetTable.
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 cell in a DotNetTable.
static ComponentFunction	doubleClickColumnLabel(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Double clicks on the label of the specified column.
static ComponentFunction	doubleClickColumnLabel(java.lang.String winname, java.lang.String compname, java.lang.String colNumber, java.lang.String yOffset) Double clicks on the label of the specified column.
static DotNetTableFunctions	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 right click on a cell in a DotNetTable.
static ComponentFunction	rightClickCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to perform a right click on a cell in a DotNetTable.
static ComponentFunction	selectCell(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Same as ClickCell.
static ComponentFunction	selectCell(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Same as ClickCell.
static ComponentFunction	selectCellContainsTextFind(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to select a particular cell by finding the row based on cell values.
static ComponentFunction	selectCellContainsTextFind(java.lang.String winname, java.lang.String compname, java.lang.String var, java.lang.String col, java.lang.String colN, java.lang.String valueN) Attempts to select a particular cell by finding the row based on cell values.
static ComponentFunction	selectCellText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to select a particular cell.
static ComponentFunction	selectCellText(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to select a particular cell.
static ComponentFunction	selectCellTextFind(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to select a particular cell by finding the row based on cell values.
static ComponentFunction	selectCellTextFind(java.lang.String winname, java.lang.String compname, java.lang.String var, java.lang.String col, java.lang.String colN, java.lang.String valueN) Attempts to select a particular cell by finding the row based on cell values.
static ComponentFunction	selectCellTextSpecial(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Holds down either Ctrl or Shift while making a cell selection with emulating either a Left or Right mouse click.
static ComponentFunction	selectCellTextSpecial(java.lang.String winname, java.lang.String compname, java.lang.String specialKey, java.lang.String mouseClick, java.lang.String row, java.lang.String col) Holds down either Ctrl or Shift while making a cell selection with emulating either a Left or Right mouse click.
static ComponentFunction	selectFuzzyCellText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to select a particular cell.
static ComponentFunction	selectFuzzyCellText(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col) Attempts to select a particular cell.
static ComponentFunction	selectFuzzyCellTextFind(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to select a particular cell by finding the row based on fuzzy cell values.
static ComponentFunction	selectFuzzyCellTextFind(java.lang.String winname, java.lang.String compname, java.lang.String var, java.lang.String col, java.lang.String colN, java.lang.String valueN) Attempts to select a particular cell by finding the row based on fuzzy cell values.
static ComponentFunction	verifyCellEditable(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verifies whether the specified cell is editable.
static ComponentFunction	verifyCellEditable(java.lang.String winname, java.lang.String compname, java.lang.String row, java.lang.String col, java.lang.String expectedValue) Verifies whether the specified cell is editable.
static ComponentFunction	verifyCellText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to verify a particular cell value.
static ComponentFunction	verifyCellText(java.lang.String winname, java.lang.String compname, java.lang.String benchValue, java.lang.String row, java.lang.String col) Attempts to verify a particular cell value.
static ComponentFunction	verifyCellTextContains(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to verify a particular cell value.
static ComponentFunction	verifyCellTextContains(java.lang.String winname, java.lang.String compname, java.lang.String benchValue, java.lang.String row, java.lang.String col) Attempts to verify a particular cell value.
static ComponentFunction	verifyCellTextFind(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to verify a particular cell by finding the row based on cell values.
static ComponentFunction	verifyCellTextFind(java.lang.String winname, java.lang.String compname, java.lang.String benchValue, java.lang.String var, java.lang.String col, java.lang.String colN, java.lang.String valueN) Attempts to verify a particular cell by finding the row based on cell values.
static ComponentFunction	verifyColumnLabel(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to verify a particular column's label when given a column number.
static ComponentFunction	verifyColumnLabel(java.lang.String winname, java.lang.String compname, java.lang.String colLabel, java.lang.String colNumber) Attempts to verify a particular column's label when given a column number.
static ComponentFunction	verifyFuzzyCellText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to verify a particular cell value.
static ComponentFunction	verifyFuzzyCellText(java.lang.String winname, java.lang.String compname, java.lang.String benchValue, java.lang.String row, java.lang.String col) Attempts to verify a particular cell value.
static ComponentFunction	verifyFuzzyCellTextContains(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to verify a particular cell value.
static ComponentFunction	verifyFuzzyCellTextContains(java.lang.String winname, java.lang.String compname, java.lang.String benchValue, java.lang.String row, java.lang.String col) Attempts to verify a particular cell value.
static ComponentFunction	verifyFuzzyCellTextFind(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to verify a particular cell by finding the row based on fuzzy cell values.
static ComponentFunction	verifyFuzzyCellTextFind(java.lang.String winname, java.lang.String compname, java.lang.String benchValue, java.lang.String var, java.lang.String col, java.lang.String colN, java.lang.String valueN) Attempts to verify a particular cell by finding the row based on fuzzy cell values.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVATECELL_KEYWORD

public static final java.lang.String ACTIVATECELL_KEYWORD

"ActivateCell"

See Also:

Constant Field Values

ACTIVATECOLUMNLABEL_KEYWORD

public static final java.lang.String ACTIVATECOLUMNLABEL_KEYWORD

"ActivateColumnLabel"

See Also:

Constant Field Values

ASSIGNCELLCONTAINSTEXTROW_KEYWORD

public static final java.lang.String ASSIGNCELLCONTAINSTEXTROW_KEYWORD

"AssignCellContainsTextRow"

See Also:

Constant Field Values

ASSIGNCELLTEXTROW_KEYWORD

public static final java.lang.String ASSIGNCELLTEXTROW_KEYWORD

"AssignCellTextRow"

See Also:

Constant Field Values

ASSIGNVARIABLECELLTEXT_KEYWORD

public static final java.lang.String ASSIGNVARIABLECELLTEXT_KEYWORD

"AssignVariableCellText"

See Also:

Constant Field Values

ASSIGNVARIABLEFUZZYCELLTEXT_KEYWORD

public static final java.lang.String ASSIGNVARIABLEFUZZYCELLTEXT_KEYWORD

"AssignVariableFuzzyCellText"

See Also:

Constant Field Values

CAPTUREFUZZYRANGETOFILE_KEYWORD

public static final java.lang.String CAPTUREFUZZYRANGETOFILE_KEYWORD

"CaptureFuzzyRangeToFile"

See Also:

Constant Field Values

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

CLICKCOLUMNLABEL_KEYWORD

public static final java.lang.String CLICKCOLUMNLABEL_KEYWORD

"ClickColumnLabel"

See Also:

Constant Field Values

DOUBLECLICKCELL_KEYWORD

public static final java.lang.String DOUBLECLICKCELL_KEYWORD

"DoubleClickCell"

See Also:

Constant Field Values

DOUBLECLICKCOLUMNLABEL_KEYWORD

public static final java.lang.String DOUBLECLICKCOLUMNLABEL_KEYWORD

"DoubleClickColumnLabel"

See Also:

Constant Field Values

RIGHTCLICKCELL_KEYWORD

public static final java.lang.String RIGHTCLICKCELL_KEYWORD

"RightClickCell"

See Also:

Constant Field Values

SELECTCELL_KEYWORD

public static final java.lang.String SELECTCELL_KEYWORD

"SelectCell"

See Also:

Constant Field Values

SELECTCELLCONTAINSTEXTFIND_KEYWORD

public static final java.lang.String SELECTCELLCONTAINSTEXTFIND_KEYWORD

"SelectCellContainsTextFind"

See Also:

Constant Field Values

SELECTCELLTEXT_KEYWORD

public static final java.lang.String SELECTCELLTEXT_KEYWORD

"SelectCellText"

See Also:

Constant Field Values

SELECTCELLTEXTFIND_KEYWORD

public static final java.lang.String SELECTCELLTEXTFIND_KEYWORD

"SelectCellTextFind"

See Also:

Constant Field Values

SELECTCELLTEXTSPECIAL_KEYWORD

public static final java.lang.String SELECTCELLTEXTSPECIAL_KEYWORD

"SelectCellTextSpecial"

See Also:

Constant Field Values

SELECTFUZZYCELLTEXT_KEYWORD

public static final java.lang.String SELECTFUZZYCELLTEXT_KEYWORD

"SelectFuzzyCellText"

See Also:

Constant Field Values

SELECTFUZZYCELLTEXTFIND_KEYWORD

public static final java.lang.String SELECTFUZZYCELLTEXTFIND_KEYWORD

"SelectFuzzyCellTextFind"

See Also:

Constant Field Values

VERIFYCELLEDITABLE_KEYWORD

public static final java.lang.String VERIFYCELLEDITABLE_KEYWORD

"VerifyCellEditable"

See Also:

Constant Field Values

VERIFYCELLTEXT_KEYWORD

public static final java.lang.String VERIFYCELLTEXT_KEYWORD

"VerifyCellText"

See Also:

Constant Field Values

VERIFYCELLTEXTCONTAINS_KEYWORD

public static final java.lang.String VERIFYCELLTEXTCONTAINS_KEYWORD

"VerifyCellTextContains"

See Also:

Constant Field Values

VERIFYCELLTEXTFIND_KEYWORD

public static final java.lang.String VERIFYCELLTEXTFIND_KEYWORD

"VerifyCellTextFind"

See Also:

Constant Field Values

VERIFYCOLUMNLABEL_KEYWORD

public static final java.lang.String VERIFYCOLUMNLABEL_KEYWORD

"VerifyColumnLabel"

See Also:

Constant Field Values

VERIFYFUZZYCELLTEXT_KEYWORD

public static final java.lang.String VERIFYFUZZYCELLTEXT_KEYWORD

"VerifyFuzzyCellText"

See Also:

Constant Field Values

VERIFYFUZZYCELLTEXTCONTAINS_KEYWORD

public static final java.lang.String VERIFYFUZZYCELLTEXTCONTAINS_KEYWORD

"VerifyFuzzyCellTextContains"

See Also:

Constant Field Values

VERIFYFUZZYCELLTEXTFIND_KEYWORD

public static final java.lang.String VERIFYFUZZYCELLTEXTFIND_KEYWORD

"VerifyFuzzyCellTextFind"

See Also:

Constant Field Values

Method Detail

getInstance

public static DotNetTableFunctions getInstance()

public Singleton to access class static methods via instance

activateCell

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

 
                Attempts to perform a double click on a DotNetTable cell.
               
                Clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.

col - Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

activateCell

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

 
                Attempts to perform a double click on a DotNetTable cell.
               
                Clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.
col -- Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

activateColumnLabel

public static ComponentFunction activateColumnLabel(java.lang.String winname,
                                                    java.lang.String compname,
                                                    java.lang.String colNumber,
                                                    java.lang.String yOffset)

 
                Double clicks on the label of the specified column.
               
                Performs a double click on the specified column number.
                A Y offset will be able to be set in the future.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

colNumber - Optional:NO The 1-based column label number to double click.

yOffset - Optional:YES (FUTURE) Number of pixels to adjust where the actual double click occurs.

activateColumnLabel

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

 
                Double clicks on the label of the specified column.
               
                Performs a double click on the specified column number.
                A Y offset will be able to be set in the future.
                  

Supporting Engines:

• Rational RobotJ

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:

colNumber -- Optional:NO The 1-based column label number to double click.
yOffset -- Optional:YES (FUTURE) Number of pixels to adjust where the actual double click occurs.

assignCellContainsTextRow

public static ComponentFunction assignCellContainsTextRow(java.lang.String winname,
                                                          java.lang.String compname,
                                                          java.lang.String var,
                                                          java.lang.String col,
                                                          java.lang.String colN,
                                                          java.lang.String valueN)

 
                  Assigns a user-defined variable a row # based on partial matching cell values.
              
                  The cell value from the specified column in the found row is also assigned to 
                  a variable derived from the user-defined variable name.
                  
                  The cell value comparisons are not case-senstive, and provided values can be substrings 
                  of the actual cell value in the table.
                  
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

var - Optional:NO The variable which gets assigned the row found.

col - Optional:NO The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".

colN - Optional:NO A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

valueN - Optional:NO A Value to search for in the 'COLN' column.

assignCellContainsTextRow

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

 
                  Assigns a user-defined variable a row # based on partial matching cell values.
              
                  The cell value from the specified column in the found row is also assigned to 
                  a variable derived from the user-defined variable name.
                  
                  The cell value comparisons are not case-senstive, and provided values can be substrings 
                  of the actual cell value in the table.
                  
                  

Supporting Engines:

• Rational RobotJ

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:

var -- Optional:NO The variable which gets assigned the row found.
col -- Optional:NO The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".
colN -- Optional:NO A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
valueN -- Optional:NO A Value to search for in the 'COLN' column.

assignCellTextRow

public static ComponentFunction assignCellTextRow(java.lang.String winname,
                                                  java.lang.String compname,
                                                  java.lang.String var,
                                                  java.lang.String col,
                                                  java.lang.String colN,
                                                  java.lang.String valueN)

 
                  Assigns a user-defined variable a row # based on matching cell values.
              
                  The cell value from the specified column in the found row is also assigned to 
                  a variable derived from the user-defined variable name.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

var - Optional:NO The variable which gets assigned the row found.

col - Optional:NO The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".

colN - Optional:NO A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

valueN - Optional:NO A Value to search for in the 'COLN' column

assignCellTextRow

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

 
                  Assigns a user-defined variable a row # based on matching cell values.
              
                  The cell value from the specified column in the found row is also assigned to 
                  a variable derived from the user-defined variable name.
                  

Supporting Engines:

• Rational RobotJ

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:

var -- Optional:NO The variable which gets assigned the row found.
col -- Optional:NO The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".
colN -- Optional:NO A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
valueN -- Optional:NO A Value to search for in the 'COLN' column

assignVariableCellText

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

 
                Attempts to extract a particular cell value and assign 
                it to the provided variable name.
              
               Note, if you supply the name of the variable and include the leading
               caret (^) symbol then the variable must be enclosed in quotes.
               Otherwise, that variable will be used like any other variable and the
               substituted value of that variable will be interpretted as the name
               of the variable you wish to use.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

variableName - Optional:NO The name of the variable to receive the property value.

row - Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

assignVariableCellText

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

 
                Attempts to extract a particular cell value and assign 
                it to the provided variable name.
              
               Note, if you supply the name of the variable and include the leading
               caret (^) symbol then the variable must be enclosed in quotes.
               Otherwise, that variable will be used like any other variable and the
               substituted value of that variable will be interpretted as the name
               of the variable you wish to use.
                  

Supporting Engines:

• Rational RobotJ

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:

variableName -- Optional:NO The name of the variable to receive the property value.
row -- Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

assignVariableFuzzyCellText

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

 
                Attempts to extract a particular cell value and assign 
                it to the provided variable name.
              
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

variableName - Optional:NO The name of the variable to receive the property value.

row - Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

assignVariableFuzzyCellText

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

 
                Attempts to extract a particular cell value and assign 
                it to the provided variable name.
              
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

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:

variableName -- Optional:NO The name of the variable to receive the property value.
row -- Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

captureFuzzyRangeToFile

public static ComponentFunction captureFuzzyRangeToFile(java.lang.String winname,
                                                        java.lang.String compname,
                                                        java.lang.String fileName,
                                                        java.lang.String row,
                                                        java.lang.String col,
                                                        java.lang.String rows,
                                                        java.lang.String columns,
                                                        java.lang.String fileEncoding,
                                                        java.lang.String filterMode,
                                                        java.lang.String filterOptions)

 
                Saves a range of values to the specified file.
              
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

fileName - Optional:NO The name of the file to receive the data.

row - Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

rows - Optional:YES DefaultVal: The number of rows to capture.

columns - Optional:YES DefaultVal: The number of columns to capture.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

filterMode - Optional:YES DefaultVal: (FUTURE) A file filter to use when processing the text values.

filterOptions - Optional:YES DefaultVal: (FUTURE) Filter options to use with the file filter.

captureFuzzyRangeToFile

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

 
                Saves a range of values to the specified file.
              
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

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:

fileName -- Optional:NO The name of the file to receive the data.
row -- Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.
rows -- Optional:YES DefaultVal: The number of rows to capture.
columns -- Optional:YES DefaultVal: The number of columns to capture.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.
filterMode -- Optional:YES DefaultVal: (FUTURE) A file filter to use when processing the text values.
filterOptions -- Optional:YES DefaultVal: (FUTURE) Filter options to use with the file filter.

captureRangeToFile

public static ComponentFunction captureRangeToFile(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String fileName,
                                                   java.lang.String row,
                                                   java.lang.String col,
                                                   java.lang.String rows,
                                                   java.lang.String columns,
                                                   java.lang.String fileEncoding,
                                                   java.lang.String filterMode,
                                                   java.lang.String filterOptions)

 
                Saves a range of values to the specified file.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

fileName - Optional:NO The name of the file to receive the data.

row - Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

rows - Optional:YES DefaultVal: The number of rows to capture.

columns - Optional:YES DefaultVal: The number of columns to capture.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

filterMode - Optional:YES DefaultVal: (FUTURE) A file filter to use when processing the text values.

filterOptions - Optional:YES DefaultVal: (FUTURE) Filter options to use with the file filter.

captureRangeToFile

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

 
                Saves a range of values to the specified file.
                  

Supporting Engines:

• Rational RobotJ

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:

fileName -- Optional:NO The name of the file to receive the data.
row -- Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.
rows -- Optional:YES DefaultVal: The number of rows to capture.
columns -- Optional:YES DefaultVal: The number of columns to capture.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.
filterMode -- Optional:YES DefaultVal: (FUTURE) A file filter to use when processing the text values.
filterOptions -- Optional:YES DefaultVal: (FUTURE) Filter options to use with the file filter.

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 Click on a cell in a DotNetTable.
               
                Clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.

col - Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

clickCell

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

 
                Attempts to perform a Click on a cell in a DotNetTable.
               
                Clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.
col -- Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

clickColumnLabel

public static ComponentFunction clickColumnLabel(java.lang.String winname,
                                                 java.lang.String compname,
                                                 java.lang.String colNumber,
                                                 java.lang.String yOffset)

 
                Clicks on the label of the specified column.
               
                Performs a single click on the specified column number.
                A Y offset will be able to be set in the future.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

colNumber - Optional:NO The 1-based column label number to click.

yOffset - Optional:YES (FUTURE) Number of pixels to adjust where the actual click occurs.

clickColumnLabel

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

 
                Clicks on the label of the specified column.
               
                Performs a single click on the specified column number.
                A Y offset will be able to be set in the future.
                  

Supporting Engines:

• Rational RobotJ

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:

colNumber -- Optional:NO The 1-based column label number to click.
yOffset -- Optional:YES (FUTURE) Number of pixels to adjust where the actual click occurs.

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 cell in a DotNetTable.
               
                Clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.

col - Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

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 cell in a DotNetTable.
               
                Clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.
col -- Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

doubleClickColumnLabel

public static ComponentFunction doubleClickColumnLabel(java.lang.String winname,
                                                       java.lang.String compname,
                                                       java.lang.String colNumber,
                                                       java.lang.String yOffset)

 
                Double clicks on the label of the specified column.
               
                Performs a double click on the specified column number.
                A Y offset will be able to be set in the future.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

colNumber - Optional:NO The 1-based column label number to double click.

yOffset - Optional:YES (FUTURE) Number of pixels to adjust where the actual double click occurs.

doubleClickColumnLabel

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

 
                Double clicks on the label of the specified column.
               
                Performs a double click on the specified column number.
                A Y offset will be able to be set in the future.
                  

Supporting Engines:

• Rational RobotJ

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:

colNumber -- Optional:NO The 1-based column label number to double click.
yOffset -- Optional:YES (FUTURE) Number of pixels to adjust where the actual double click occurs.

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 right click on a cell in a DotNetTable.
               
                Right clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.

col - Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

rightClickCell

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

 
                Attempts to perform a right click on a cell in a DotNetTable.
               
                Right clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.
col -- Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

selectCell

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

 
                Same as ClickCell.
               
                Clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.

col - Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

selectCell

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

 
                Same as ClickCell.
               
                Clicks on a particular row/column of the table. 
                The default location is Row=1, Col=1 unless either parameter 
                is specified otherwise.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row in the row/col specification.
col -- Optional:YES DefaultVal:1 The 1-based cell column in the row/col specification.

selectCellContainsTextFind

public static ComponentFunction selectCellContainsTextFind(java.lang.String winname,
                                                           java.lang.String compname,
                                                           java.lang.String var,
                                                           java.lang.String col,
                                                           java.lang.String colN,
                                                           java.lang.String valueN)

 
                  Attempts to select a particular cell by finding the row based on cell values.
              
                  This is the same as SelectFuzzyCellTextFind.
                  The row # for the cell is also assigned to a user-defined variable.
                  The parameter values are not case-sensitive, and can be substrings of the actual 
                  table values.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

var - Optional:NO The variable which gets assigned the row found.

col - Optional:NO The 1-based cell column # or header value, identifying the column for the select.

colN - Optional:NO A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

valueN - Optional:NO A Value to search for in the 'COLN' column

selectCellContainsTextFind

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

 
                  Attempts to select a particular cell by finding the row based on cell values.
              
                  This is the same as SelectFuzzyCellTextFind.
                  The row # for the cell is also assigned to a user-defined variable.
                  The parameter values are not case-sensitive, and can be substrings of the actual 
                  table values.
                  

Supporting Engines:

• Rational RobotJ

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:

var -- Optional:NO The variable which gets assigned the row found.
col -- Optional:NO The 1-based cell column # or header value, identifying the column for the select.
colN -- Optional:NO A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
valueN -- Optional:NO A Value to search for in the 'COLN' column

selectCellText

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

 
                Attempts to select a particular cell.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

selectCellText

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

 
                Attempts to select a particular cell.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

selectCellTextFind

public static ComponentFunction selectCellTextFind(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String var,
                                                   java.lang.String col,
                                                   java.lang.String colN,
                                                   java.lang.String valueN)

 
                  Attempts to select a particular cell by finding the row based on cell values.
              
                  The row # for the cell is also assigned to a user-defined variable.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

var - Optional:NO The variable which gets assigned the row found.

col - Optional:NO The 1-based cell column # or header value, identifying the column for the select.

colN - Optional:NO A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

valueN - Optional:NO A Value to search for in the 'COLN' column

selectCellTextFind

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

 
                  Attempts to select a particular cell by finding the row based on cell values.
              
                  The row # for the cell is also assigned to a user-defined variable.
                  

Supporting Engines:

• Rational RobotJ

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:

var -- Optional:NO The variable which gets assigned the row found.
col -- Optional:NO The 1-based cell column # or header value, identifying the column for the select.
colN -- Optional:NO A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
valueN -- Optional:NO A Value to search for in the 'COLN' column

selectCellTextSpecial

public static ComponentFunction selectCellTextSpecial(java.lang.String winname,
                                                      java.lang.String compname,
                                                      java.lang.String specialKey,
                                                      java.lang.String mouseClick,
                                                      java.lang.String row,
                                                      java.lang.String col)

 
                Holds down either Ctrl or Shift while making a cell selection
                with emulating either a Left or Right mouse click.
              
                Special cell selection which can be used to select multiple rows.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

specialKey - Optional:NO The special key command used in the row selection. For now, ownly Control and Shift are supported.

mouseClick - Optional:NO The type of mouse click needed. For now, ownly Left and Right are supported.

row - Optional:NO The 1-based cell row in the row/col specification.

col - Optional:NO The 1-based cell column in the row/col specification.

selectCellTextSpecial

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

 
                Holds down either Ctrl or Shift while making a cell selection
                with emulating either a Left or Right mouse click.
              
                Special cell selection which can be used to select multiple rows.
                  

Supporting Engines:

• Rational RobotJ

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:

specialKey -- Optional:NO The special key command used in the row selection. For now, ownly Control and Shift are supported.
mouseClick -- Optional:NO The type of mouse click needed. For now, ownly Left and Right are supported.
row -- Optional:NO The 1-based cell row in the row/col specification.
col -- Optional:NO The 1-based cell column in the row/col specification.

selectFuzzyCellText

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

 
                Attempts to select a particular cell.
               
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

selectFuzzyCellText

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

 
                Attempts to select a particular cell.
               
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

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:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

selectFuzzyCellTextFind

public static ComponentFunction selectFuzzyCellTextFind(java.lang.String winname,
                                                        java.lang.String compname,
                                                        java.lang.String var,
                                                        java.lang.String col,
                                                        java.lang.String colN,
                                                        java.lang.String valueN)

 
                Attempts to select a particular cell by finding the row based on fuzzy cell values.
               
                This is the same as SelectCellContainsTextFind.
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified column/cell text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

var - Optional:NO The variable which gets assigned the row found.

col - Optional:NO The 1-based cell column # in the row/col specification or fuzzy column header text.

colN - Optional:NO A 1-based cell column # in the row/col specification or fuzzy column header text.

valueN - Optional:NO A Value to search for in a cell under the 'ColN' column

selectFuzzyCellTextFind

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

 
                Attempts to select a particular cell by finding the row based on fuzzy cell values.
               
                This is the same as SelectCellContainsTextFind.
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified column/cell text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

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:

var -- Optional:NO The variable which gets assigned the row found.
col -- Optional:NO The 1-based cell column # in the row/col specification or fuzzy column header text.
colN -- Optional:NO A 1-based cell column # in the row/col specification or fuzzy column header text.
valueN -- Optional:NO A Value to search for in a cell under the 'ColN' column

verifyCellEditable

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

 
                Verifies whether the specified cell is editable.
               
                Invokes the "editCellAt" method on a specific cell.
                The method returns a boolean which is used for the verification.
                  

Supporting Engines:

• Rational RobotJ

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:NO The 1-based cell row in the row/col specification.

col - Optional:NO The 1-based cell column in the row/col specification.

expectedValue - Optional:NO The case-insensitive value we expect for the editable value.

verifyCellEditable

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

 
                Verifies whether the specified cell is editable.
               
                Invokes the "editCellAt" method on a specific cell.
                The method returns a boolean which is used for the verification.
                  

Supporting Engines:

• Rational RobotJ

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:NO The 1-based cell row in the row/col specification.
col -- Optional:NO The 1-based cell column in the row/col specification.
expectedValue -- Optional:NO The case-insensitive value we expect for the editable value.

verifyCellText

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

 
                Attempts to verify a particular cell value.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

benchValue - Optional:NO The case-sensitive expected value for the specified cell.

row - Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

verifyCellText

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

 
                Attempts to verify a particular cell value.
                  

Supporting Engines:

• Rational RobotJ

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:

benchValue -- Optional:NO The case-sensitive expected value for the specified cell.
row -- Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

verifyCellTextContains

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

 
                Attempts to verify a particular cell value.
               
                The value comparison is NOT case-sensitive and can be a substring.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

benchValue - Optional:NO The expected value for the specified cell.

row - Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

verifyCellTextContains

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

 
                Attempts to verify a particular cell value.
               
                The value comparison is NOT case-sensitive and can be a substring.
                  

Supporting Engines:

• Rational RobotJ

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:

benchValue -- Optional:NO The expected value for the specified cell.
row -- Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

verifyCellTextFind

public static ComponentFunction verifyCellTextFind(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String benchValue,
                                                   java.lang.String var,
                                                   java.lang.String col,
                                                   java.lang.String colN,
                                                   java.lang.String valueN)

 
                Attempts to verify a particular cell by finding the row based on cell values.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

benchValue - Optional:NO The case-sensitive expected value for the specified cell.

var - Optional:NO The variable which gets assigned the row found.

col - Optional:NO The 1-based cell column # in the row/col specification or column header text.

colN - Optional:NO A 1-based cell column # in the row/col specification or column header text.

valueN - Optional:NO A Value to search for in a cell under the 'ColN' column

verifyCellTextFind

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

 
                Attempts to verify a particular cell by finding the row based on cell values.
                  

Supporting Engines:

• Rational RobotJ

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:

benchValue -- Optional:NO The case-sensitive expected value for the specified cell.
var -- Optional:NO The variable which gets assigned the row found.
col -- Optional:NO The 1-based cell column # in the row/col specification or column header text.
colN -- Optional:NO A 1-based cell column # in the row/col specification or column header text.
valueN -- Optional:NO A Value to search for in a cell under the 'ColN' column

verifyColumnLabel

public static ComponentFunction verifyColumnLabel(java.lang.String winname,
                                                  java.lang.String compname,
                                                  java.lang.String colLabel,
                                                  java.lang.String colNumber)

 
                Attempts to verify a particular column's label when given a column number.
               
                Verifies a column label when given the column number.  It currently
                does NOT work with columns with multi-line names.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

colLabel - Optional:NO The case-insensitive expected value for the specified column label.

colNumber - Optional:NO The 1-based column number of the label that needs verified.

verifyColumnLabel

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

 
                Attempts to verify a particular column's label when given a column number.
               
                Verifies a column label when given the column number.  It currently
                does NOT work with columns with multi-line names.
                  

Supporting Engines:

• Rational RobotJ

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:

colLabel -- Optional:NO The case-insensitive expected value for the specified column label.
colNumber -- Optional:NO The 1-based column number of the label that needs verified.

verifyFuzzyCellText

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

 
                Attempts to verify a particular cell value.
               
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                The Benchmark must be exact, however.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

benchValue - Optional:NO The case-sensitive expected value for the specified cell.

row - Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

verifyFuzzyCellText

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

 
                Attempts to verify a particular cell value.
               
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                The Benchmark must be exact, however.
                  

Supporting Engines:

• Rational RobotJ

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:

benchValue -- Optional:NO The case-sensitive expected value for the specified cell.
row -- Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

verifyFuzzyCellTextContains

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

 
                Attempts to verify a particular cell value.
               
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                The Benchmark comparison is NOT case-sensitive and can be a substring.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

benchValue - Optional:NO The expected value for the specified cell.

row - Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.

col - Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

verifyFuzzyCellTextContains

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

 
                Attempts to verify a particular cell value.
               
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                The Benchmark comparison is NOT case-sensitive and can be a substring.
                  

Supporting Engines:

• Rational RobotJ

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:

benchValue -- Optional:NO The expected value for the specified cell.
row -- Optional:YES DefaultVal:1 The 1-based cell row # in the row/col specification or a unique row value in column 1.
col -- Optional:YES DefaultVal:1 The 1-based cell column # in the row/col specification or column header text.

verifyFuzzyCellTextFind

public static ComponentFunction verifyFuzzyCellTextFind(java.lang.String winname,
                                                        java.lang.String compname,
                                                        java.lang.String benchValue,
                                                        java.lang.String var,
                                                        java.lang.String col,
                                                        java.lang.String colN,
                                                        java.lang.String valueN)

 
                Attempts to verify a particular cell by finding the row based on fuzzy cell values.
               
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified column/cell text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

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

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

benchValue - Optional:NO The case-sensitive expected value for the specified cell.

var - Optional:NO The variable which gets assigned the row found.

col - Optional:NO The 1-based cell column # in the row/col specification or fuzzy column header text.

colN - Optional:NO A 1-based cell column # in the row/col specification or fuzzy column header text.

valueN - Optional:NO A Value to search for in a cell under the 'ColN' column

verifyFuzzyCellTextFind

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

 
                Attempts to verify a particular cell by finding the row based on fuzzy cell values.
               
                "Fuzzy" matches come into play when using header field text 
                or column1 row text to specify row and column identities.  The 
                specified column/cell text does NOT have to be an exact match--it is NOT 
                case-sensitive and can be just a substring of the desired value 
                in the table.
                  

Supporting Engines:

• Rational RobotJ

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:

benchValue -- Optional:NO The case-sensitive expected value for the specified cell.
var -- Optional:NO The variable which gets assigned the row found.
col -- Optional:NO The 1-based cell column # in the row/col specification or fuzzy column header text.
colN -- Optional:NO A 1-based cell column # in the row/col specification or fuzzy column header text.
valueN -- Optional:NO A Value to search for in a cell under the 'ColN' column