org.safs.model.components

Class FPSpread

java.lang.Object

org.safs.model.Component

org.safs.model.components.UIComponent

org.safs.model.components.GenericMaster

org.safs.model.components.GenericObject

org.safs.model.components.FPSpread

public class FPSpread
extends GenericObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FPSpread(java.lang.String compname)
	FPSpread(java.lang.String winname, java.lang.String compname) Constructor Create an instance of pseudo-component representing a specific component in a specific window.
	FPSpread(Window window, java.lang.String compname) Constructor Create an instance of pseudo-component representing a specific component in a specific window.

Method Summary

Modifier and Type	Method and Description
void	captureRangeToFile(StepTestTable table, java.lang.String capturedFile) Capture the grid data to the specified file.
ComponentFunction	captureRangeToFile(java.lang.String capturedFile) Capture the grid data to the specified file.
void	clickCell(StepTestTable table, java.lang.String[] parameters) Attempts to perform a single click on a table cell.
void	clickCell(StepTestTable table, java.lang.String row, java.lang.String col) Attempts to perform a single click on a table cell.
ComponentFunction	clickCell(java.lang.String[] parameters) Attempts to perform a single click on a table cell.
ComponentFunction	clickCell(java.lang.String row, java.lang.String col) Attempts to perform a single click on a table cell.
void	ctrlClickCell(StepTestTable table, java.lang.String[] parameters) Attempts to perform a single Ctrl+Click on a table cell.
void	ctrlClickCell(StepTestTable table, java.lang.String row, java.lang.String col) Attempts to perform a single Ctrl+Click on a table cell.
ComponentFunction	ctrlClickCell(java.lang.String[] parameters) Attempts to perform a single Ctrl+Click on a table cell.
ComponentFunction	ctrlClickCell(java.lang.String row, java.lang.String col) Attempts to perform a single Ctrl+Click on a table cell.
void	doubleClickCell(StepTestTable table, java.lang.String[] parameters) Attempts to perform a double click on a table cell.
void	doubleClickCell(StepTestTable table, java.lang.String row, java.lang.String col) Attempts to perform a double click on a table cell.
ComponentFunction	doubleClickCell(java.lang.String[] parameters) Attempts to perform a double click on a table cell.
ComponentFunction	doubleClickCell(java.lang.String row, java.lang.String col) Attempts to perform a double click on a table cell.
void	findRowNumber(StepTestTable table, java.lang.String[] parameters) Search specified columns for the specified text.
void	findRowNumber(StepTestTable table, 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.
ComponentFunction	findRowNumber(java.lang.String[] parameters) Search specified columns for the specified text.
ComponentFunction	findRowNumber(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.
void	rightClickCell(StepTestTable table, java.lang.String[] parameters) Attempts to perform a single right click on a table cell.
void	rightClickCell(StepTestTable table, java.lang.String row, java.lang.String col) Attempts to perform a single right click on a table cell.
ComponentFunction	rightClickCell(java.lang.String[] parameters) Attempts to perform a single right click on a table cell.
ComponentFunction	rightClickCell(java.lang.String row, java.lang.String col) Attempts to perform a single right click on a table cell.
void	shiftClickCell(StepTestTable table, java.lang.String[] parameters) Attempts to perform a single SHIFT+Click on a table cell.
void	shiftClickCell(StepTestTable table, java.lang.String row, java.lang.String col) Attempts to perform a single SHIFT+Click on a table cell.
ComponentFunction	shiftClickCell(java.lang.String[] parameters) Attempts to perform a single SHIFT+Click on a table cell.
ComponentFunction	shiftClickCell(java.lang.String row, java.lang.String col) Attempts to perform a single SHIFT+Click on a table cell.
void	verifyCellText(StepTestTable table, java.lang.String[] parameters) Verify a specific cell's text.
void	verifyCellText(StepTestTable table, java.lang.String expectedCellText, java.lang.String row, java.lang.String col) Verify a specific cell's text.
ComponentFunction	verifyCellText(java.lang.String[] parameters) Verify a specific cell's text.
ComponentFunction	verifyCellText(java.lang.String expectedCellText, java.lang.String row, java.lang.String col) Verify a specific cell's text.

Methods inherited from class org.safs.model.components.GenericObject

altClick, altClick, altClick, altClick, altLeftDrag, altLeftDrag, click, click, click, click, clickScreenImage, clickScreenImage, clickScreenLocation, clickScreenLocation, clickScreenPoint, clickScreenPoint, compareStoredData, compareStoredData, compareStoredData, compareStoredData, compareStoredProperties, compareStoredProperties, compareStoredProperties, compareStoredProperties, ctrlAltLeftDrag, ctrlAltLeftDrag, ctrlClick, ctrlClick, ctrlClick, ctrlClick, ctrlClickScreenImage, ctrlClickScreenImage, ctrlLeftDrag, ctrlLeftDrag, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClickScreenImage, ctrlRightClickScreenImage, ctrlShiftLeftDrag, ctrlShiftLeftDrag, doubleClick, doubleClick, doubleClick, doubleClick, doubleClickScreenImage, doubleClickScreenImage, doubleClickScreenLocation, doubleClickScreenLocation, doubleClickScreenPoint, doubleClickScreenPoint, doubleTap, doubleTap, dragTo, dragTo, dragTo, dragTo, flick, flick, flick, flick, flickDown, flickDown, flickLeft, flickLeft, flickRight, flickRight, flickUp, flickUp, hScrollTo, hScrollTo, javaMenuSelect, javaMenuSelect, leftDrag, leftDrag, mouseClick, mouseClick, multiClick, multiClick, multiClick, multiClick, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, press, press, rightClick, rightClick, rightClick, rightClick, rightClickScreenImage, rightClickScreenImage, rightClickScreenLocation, rightClickScreenLocation, rightClickScreenPoint, rightClickScreenPoint, rightDrag, rightDrag, shiftClick, shiftClick, shiftClick, shiftClick, shiftClickScreenImage, shiftClickScreenImage, shiftLeftDrag, shiftLeftDrag, tap, tap, twoFingerTap, twoFingerTap, verifyImage, verifyImage, vScrollTo, vScrollTo

Methods inherited from class org.safs.model.components.GenericMaster

assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, clearAppMapCache, clearAppMapCache, clearCache, clearCache, executeScript, executeScript, executeScript, executeScript, getComputedStyle, getComputedStyle, getGUIImage, getGUIImage, getGUIImage, getGUIImage, getTextFromGUI, getTextFromGUI, getTextFromGUI, getTextFromGUI, gUIDoesExist, gUIDoesExist, gUIDoesNotExist, gUIDoesNotExist, hoverMouse, hoverMouse, hoverMouse, hoverMouse, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, inputCharacters, inputCharacters, inputKeys, inputKeys, isPropertyExist, isPropertyExist, isPropertyExist, isPropertyExist, locateScreenImage, locateScreenImage, locateScreenImage, locateScreenImage, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, sendEvent, sendEvent, sendEvent, sendEvent, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, showOnPage, showOnPage, typeChars, typeChars, typeEncryption, typeEncryption, typeEncryption, typeEncryption, typeKeys, typeKeys, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardVP, verifyClipboardVP, verifyComputedStyle, verifyComputedStyle, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyProperty, verifyProperty, verifyProperty, verifyProperty, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyTabOrder, verifyTabOrder, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValues, verifyValues, verifyValues, verifyValues, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual

Methods inherited from class org.safs.model.components.UIComponent

getWindow, setWindow

Methods inherited from class org.safs.model.Component

getName, getParent, getParentName, quote

Methods inherited from class java.lang.Object

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

Constructor Detail

FPSpread

public FPSpread(Window window,
                java.lang.String compname)

Constructor Create an instance of pseudo-component representing a specific component in a specific window.

Parameters:

window - Optional:NO Specifies which Window this component is 'in'.

compname - Optional:NO Specifies the AppMap name of the component in the Window.

FPSpread

public FPSpread(java.lang.String winname,
                java.lang.String compname)

Constructor Create an instance of pseudo-component representing a specific component in a specific window. This convenience routine will create the requisite Window component.

Parameters:

winname - Optional:NO Specifies the AppMap name of the window.

compname - Optional:NO Specifies the AppMap name of the component in the Window.

FPSpread

protected FPSpread(java.lang.String compname)

Method Detail

captureRangeToFile

public ComponentFunction captureRangeToFile(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:

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

captureRangeToFile

public void captureRangeToFile(StepTestTable table,
                               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:

table - Optional:NO The table to add the record to.

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

clickCell

public ComponentFunction clickCell(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:

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

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

clickCell

public void clickCell(StepTestTable table,
                      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:

table - Optional:NO The table to add the record to.

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

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

clickCell

public ComponentFunction clickCell(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:

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.

clickCell

public void clickCell(StepTestTable table,
                      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:

table - Optional:NO The table to add the record to.

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 ComponentFunction ctrlClickCell(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:

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 void ctrlClickCell(StepTestTable table,
                          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:

table - Optional:NO The table to add the record to.

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 ComponentFunction ctrlClickCell(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:

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.

ctrlClickCell

public void ctrlClickCell(StepTestTable table,
                          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:

table - Optional:NO The table to add the record to.

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 ComponentFunction doubleClickCell(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:

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 void doubleClickCell(StepTestTable table,
                            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:

table - Optional:NO The table to add the record to.

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 ComponentFunction doubleClickCell(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:

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.

doubleClickCell

public void doubleClickCell(StepTestTable table,
                            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:

table - Optional:NO The table to add the record to.

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 ComponentFunction findRowNumber(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:

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 void findRowNumber(StepTestTable table,
                          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:

table - Optional:NO The table to add the record to.

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 ComponentFunction findRowNumber(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:

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.

findRowNumber

public void findRowNumber(StepTestTable table,
                          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:

table - Optional:NO The table to add the record to.

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 ComponentFunction rightClickCell(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:

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 void rightClickCell(StepTestTable table,
                           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:

table - Optional:NO The table to add the record to.

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 ComponentFunction rightClickCell(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:

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.

rightClickCell

public void rightClickCell(StepTestTable table,
                           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:

table - Optional:NO The table to add the record to.

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 ComponentFunction shiftClickCell(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:

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 void shiftClickCell(StepTestTable table,
                           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:

table - Optional:NO The table to add the record to.

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 ComponentFunction shiftClickCell(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:

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.

shiftClickCell

public void shiftClickCell(StepTestTable table,
                           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:

table - Optional:NO The table to add the record to.

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 ComponentFunction verifyCellText(java.lang.String expectedCellText,
                                        java.lang.String row,
                                        java.lang.String col)

 
             Verify a specific cell's text.
              
                  

Supporting Engines:

• Rational Robot

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.

verifyCellText

public void verifyCellText(StepTestTable table,
                           java.lang.String expectedCellText,
                           java.lang.String row,
                           java.lang.String col)

 
             Verify a specific cell's text.
              
                  

Supporting Engines:

• Rational Robot

Parameters:

table - Optional:NO The table to add the record to.

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 ComponentFunction verifyCellText(java.lang.String[] parameters)

 
             Verify a specific cell's text.
              
                  

Supporting Engines:

• Rational Robot

Parameters:

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.

verifyCellText

public void verifyCellText(StepTestTable table,
                           java.lang.String[] parameters)

 
             Verify a specific cell's text.
              
                  

Supporting Engines:

• Rational Robot

Parameters:

table - Optional:NO The table to add the record to.

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.