org.safs.rational

Class CFHtmlTable

java.lang.Object

org.safs.Processor

org.safs.ComponentFunction

org.safs.rational.CFComponent

org.safs.rational.CFTable

org.safs.rational.CFHtmlTable

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

public class CFHtmlTable
extends CFTable

Process html table components (like Html.TABLE). See the file ObjectTypesMap.dat for cross reference as to which map to us.
Lifetime: instantiated by TestStepProcessor

Since:

Dec 16, 2003
Dec 16, 2003 (DBauman) Original Release
Nov 23, 2004 (Carl Nagle) Correcting Click implementation for HTMLTables
Nov 03, 2005 (Carl Nagle) Removing Generic Click as supported by CFComponent. Removing ClickCell as supported by CFTable. Added convertCoords to accept Coords=x1,y1,x2,y2 variants of generic Click commands.
Apr 08, 2008 (Lei Wang and JunwuMa) Added localprocess() for better using hopefully(in the future). Added 'VerifyCellValue' in localprocess(). Added getColumnNames,getColumns,getCellText. Overrided getColumnName,getNumRows, getNumColumns and getColi for supporting HTML table. Modified some code in CFHtmlTable.commandCaptureRangeToFile making it useful for 'CaptureFuzzyRangeToFile' and 'CaptureRangeToFile' in HTML table. Below are new keywords supported by HTML table. CaptureFuzzyRangeToFile CaptureRangeToFile SelectCell SelectCellContainsTextFind SelectCellText SelectCellTextFind SelectFuzzyCellText SelectFuzzyCellTextFind VerifyCellTextFind VerifyColumnLabel VerifyFuzzyCellText VerifyFuzzyCellTextContains VerifyFuzzyCellTextFind VerifyCellValue JSAFSBefore this modification, supported keywords are: ActivateCell AssignVariableCellText ClickCell DoubleClickCell RightClickCell SelectCellTextSpecial VerifyCellEditable VerifyCellText VerifyCellTextContains
Oct 27, 2008 (Lei Wang) Add method captureObjectData() and getITestDataTable(), these methods are almost the same as those in CFDotNetTable, maybe we should consider to move them to CFTable in future. See defect S0542755.
MAR 10, 2009 (Lei Wang) Remove method command commandCaptureRangeToFile(), keyword CaptureRangeToFile will call the same method in superclass CFTable. Modify method getITestDataTable(): try type 'visiblegrid' and 'visiblecontents' to get ITestDataTable.
AUG 28, 2013 (Lei Wang) Modify method getITestDataTable(): try 'visiblegrid', 'visiblecontents', 'contents' and 'grid' one by one.

Author:

Doug Bauman

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.rational.CFTable

CFTable.TableCell

Nested classes/interfaces inherited from class org.safs.ComponentFunction

ComponentFunction.Window

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERIFYCELLVALUE

Fields inherited from class org.safs.rational.CFTable

ACTIVATECELL, ACTIVATECOLUMNLABEL, ACTIVATEROWLABEL, ASSIGNCELLCONTAINSTEXTROW, ASSIGNCELLTEXTROW, ASSIGNVARIABLECELLTEXT, ASSIGNVARIABLEFUZZYCELLTEXT, CAPTUREFUZZYRANGETOFILE, CAPTURERANGETOFILE, CLICKCELL, CLICKCELLOFCOLWITHROWVALUES, CLICKCOLUMNLABEL, CLICKROWLABEL, customCellObjects, DOUBLECLICKCELL, DOUBLECLICKCELLOFCOLWITHROWVALUES, DOUBLECLICKCOLUMNLABEL, DOUBLECLICKROWLABEL, GETCELLCOORDINATES, GETTABLEROWCOLUMNCOUNT, RFTGENERALVALUEPACKAGENAME, RIGHTCLICKCELL, RIGHTCLICKCOLUMNLABEL, SELECTCELL, SELECTCELLCONTAINSTEXTFIND, SELECTCELLTEXT, SELECTCELLTEXTFIND, SELECTCELLTEXTSPECIAL, SELECTFUZZYCELLTEXT, SELECTFUZZYCELLTEXTFIND, SELECTROWWITHROWVALUES, VERIFYCELLEDITABLE, VERIFYCELLTEXT, VERIFYCELLTEXTCONTAINS, VERIFYCELLTEXTFIND, VERIFYCOLUMNLABEL, VERIFYFUZZYCELLTEXT, VERIFYFUZZYCELLTEXTCONTAINS, VERIFYFUZZYCELLTEXTFIND, VERIFYROWLABEL

Fields inherited from class org.safs.rational.CFComponent

keepEncodingConsistent, obj1, script, winObject

Fields inherited from class org.safs.ComponentFunction

action, ALTCLICK, ALTLEFTDRAG, altText, ASSIGNPROPERTYVARIABLE, CAPTUREOBJECTDATATOFILE, CAPTUREPROPERTIESTOFILE, CAPTUREPROPERTYTOFILE, CLEARAPPMAPCACHE, CLICK, CLOSEWINDOW, compName, COMPONENTCLICK, CTRLALTLEFTDRAG, CTRLCLICK, CTRLLEFTDRAG, CTRLRIGHTCLICK, CTRLSHIFTLEFTDRAG, DOUBLECLICK, GETGUIIMAGE, GETTEXTFROMGUI, GUIDOESEXIST, GUIDOESNOTEXIST, HOVERMOUSE, HSCROLLTO, INPUTCHARACTERS, INPUTKEYS, ISPROPERTYEXIST, iterator, LEFTDRAG, LOCATESCREENIMAGE, mapname, MAXIMIZE, MINIMIZE, MOUSECLICK, OBJECT_DATA, PARAM_FILTER, PARAM_UUID, PROPERTY_DOT_itemText, PROPERTY_innerHTML, PROPERTY_innerText, PROPERTY_Items, PROPERTY_text, PROPERTY_textContent, RELATIVE_TO_PARENT, RELATIVE_TO_SCREEN, RESTORE, RIGHTCLICK, RIGHTDRAG, SAVETEXTFROMGUI, SELECTMENUITEM, SELECTMENUITEMCONTAINS, SENDEVENT, SETPOSITION, SETPROPERTYVALUE, SHIFTCLICK, SHIFTLEFTDRAG, TEST_DATA_SUFFIX, utils, VERIFYARRAYPROPERTYTOFILE, VERIFYBINARYFILETOFILE, VERIFYCLIPBOARDTOFILE, VERIFYFILETOFILE, VERIFYGUIIMAGETOFILE, VERIFYMENUITEM, VERIFYMENUITEMCONTAINS, VERIFYOBJECTDATATOFILE, VERIFYPROPERTY, VERIFYPROPERTYCONTAINS, VERIFYPROPERTYTOFILE, VERIFYTEXTFILETOFILE, VERIFYVALUECONTAINS, VERIFYVALUEEQUALS, VERIFYVALUES, VERIFYVALUESIGNORECASE, VSCROLLTO, WAITFORGUI, windowName

Fields inherited from class org.safs.Processor

breakpointsOn, CASE_INSENSITIVE_FLAG, CASEINSENSITIVE_FLAG, clearProxiesAlways, commandLineBreakpoint, customStr, customText, DEBUG_MESSAGE, debugStr, debugText, DEFAULT_CUSTOM_PROCESSOR_PACKAGE, DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE, DEFAULT_PROCESSOR_PACKAGE, FAILED_MESSAGE, FAILED_OK_MESSAGE, failedStr, failedText, FAILURE_DETAIL, GENERIC_MESSAGE, genericStr, genericText, LINE_FAILURE_4, log, myBreakpointsOn, otherStr, otherText, PARAM_SIZE_1, PARAM_SIZE_2, PARAM_SIZE_3, PARAM_SIZE_4, params, PASSED_MESSAGE, passedStr, passedText, PRE_TXT_SUCCESS_4, PRE_TXT_SUCCESS_5, processorConfigSet, processorMap, recordProcessed, RECTYPE_DRIVER_COMMAND, RECTYPE_DRIVER_COMMAND_F, RECTYPE_DRIVER_COMMAND_W, RECTYPE_TEST_STEP, RECTYPE_TEST_STEP_F, RECTYPE_TEST_STEP_W, RFSMCache, RFSMOnly, RFT_FIND_SEARCH_MODE_ALGORITHM, RFT_FIND_SEARCH_MODE_CACHE, SAFS_CLEARPROXIESALWAYS_ITEM, SAFS_COMMANDLINEBREAKPOINT_ITEM, SAFS_COMMANDLINEBREAKPOINT_VARIABLE, SAFS_PARAMS_FILE, SAFS_RESBUN_NAME, SAFS_SECSWAITFORCOMPONENT_ITEM, SAFS_SECSWAITFORCOMPONENT_VARIABLE, SAFS_SECSWAITFORWINDOW_ITEM, SAFS_SECSWAITFORWINDOW_VARIABLE, SAFS_TESTDOMAINS_ITEM, SAFS_TESTDOMAINS_VARIABLE, secsWaitForComponent, secsWaitForWindow, SENT_MSG_3, testDomains, testRecordData, testrecordStackable, TXT_FAILURE_1, TXT_FAILURE_2, TXT_FAILURE_3, TXT_FAILURE_4, TXT_FAILURE_5, TXT_SUCCESS_1, TXT_SUCCESS_2, TXT_SUCCESS_2a, TXT_SUCCESS_3, TXT_SUCCESS_3a, TXT_SUCCESS_4, TXT_SUCCESS_5, unexpectedAlertBehaviour, WARNING_MESSAGE, WARNING_OK_MESSAGE, warningStr, warningText

Constructor Summary

Constructors

Constructor and Description
CFHtmlTable() Purpose: constructor, calls super

Method Summary

Modifier and Type	Method and Description
protected void	actionVerifyColumnLabel(GuiTestObject guiObj, java.lang.String val, int col) Purpose: overrides CFTable.actionVerifyColumnLabel, only for HTML Table.
protected java.util.List<java.util.List<java.lang.String>>	captureObjectData(TestObject table) overrides CFTable.captureObjectData to capture the object data into a List of rows.
protected void	commandVerifyCellValue() preform VerifyCellValue.
java.awt.Point	convertCoords(java.lang.String coords) Overrides the version in superclass CFTable to allow for alternative of "Coords=x1,y1,x2,y2".
protected java.lang.String	getCellText(TestObject guiObj, int row, int col) Note: get the text value of the cell at (row,col) in HTML table
protected int	getColi(boolean fuzzy, java.lang.String column, GuiTestObject guiObj) Purpose: overrides CFTable.getColi.
protected java.lang.String	getColumnName(TestObject jctable, int col) Overrides CFTable.getColumnName for using by HTML Table only.
protected TestObject[]	getColumns(TestObject jctable) Note: The first line of html.table will be found, that is the first "<tr>...</tr>" contained in "<table></table>".
protected int	getNumColumns(TestObject jctable) Purpose: get number of columns in HTML table; override CFTable.GetNumColumns(TestObject jctable),
protected int	getNumRows(TestObject jctable) Purpose: get number of rows in HTML table; override CFTable.getNumRows(TestObject).
java.lang.String	getTextProperty()
protected void	localProcess() Note: For furture use if we want to separate the "manipulation of HtmlTable" from "CFTable" Now the super class CFTable handle also the html table.
protected TestObject[]	processChildren(TestObject obj1, java.lang.String matchType)

Methods inherited from class org.safs.rational.CFTable

actionAssign, actionCaptureRangeToFile, actionClick, actionClick, actionClickColumnLabel, actionClickRowLabel, actionGetCellCoordinates, actionGetTableRowColumnCount, actionLocalSelectCellTextSpecial, actionSelectCellTextSpecial, actionVerify, actionVerifyCellEditable, actionVerifyRowLabel, commandAssignCellTextRow, commandAssignVariableCellText, commandCaptureRangeToFile, commandClick, commandClickCellOfColWithRowValues, commandClickColumnLabel, commandClickFind, commandClickRowLabel, commandGetCellCoordinates, commandGetTableRowColumnCount, commandSelectCellTextSpecial, commandSelectRowWithRowValues, commandVerifyCellEditable, commandVerifyCellText, commandVerifyCellTextFind, commandVerifyColumnLabel, commandVerifyRowLabel, doActionClick, formatObjectData, getCell, getCell, getCellText, getJCTable, getLocalRect, getObjectData, getRealTable, getRowi, getTableCellSubItemText, isCustomCellObject, performClick, processCustomCellObject, selectCellText

Methods inherited from class org.safs.rational.CFComponent

_maximize, _minimize, _restore, _setPosition, _setSize, captureObjectDataToFile, capturePropertiesToFile, capturePropertyToFile, clearAppMapCache, closeWindow, componentClick, convertObjectValueToString, exist, extractTreeItemsSub, findMenuBars, getAppletsBrowser, getComponentRectangle, getComponentRectangleOnScreen, getHelpers, getKeepEncodingConsistent, getObjectProperty, getObjectPropertyFromProperties, getProperties, getPropertyObject, getUserObject, getWindowRectangleOnScreen, inputKeystrokes, isDotnetDomain, isFlexDomain, isHtmlDomain, isJavaDomain, isSwtDomain, isSWTWidget, isWinDomain, listAllProperties, listAllProperties, listMethods, listNonValueProperties, listProperties, matchedPathOfMenuItem, mouseClick, parseWhereInfo, performDrag, performHoverMouse, performScorll, process, selectMenuItem, sendEvent, sendFlexEvent, setKeepEncodingConsistent, setPropertyValue, tobj, verifyClipboardToFile, verifyFileToFile, verifyMenuItem, verifyObjectDataToFile, verifyPropertyContains, verifyPropertyToFile, verifyValueContains, verifyValues

Methods inherited from class org.safs.ComponentFunction

_close, action_ComputedStyle, action_getGuiImage, action_GetSaveTextFromGUI, action_showOnPage, action_verifyGuiImageToFile, assignPropertyVariable, captureObjectData, checkForCoord, checkForCoord, clearCache, close, componentExecutedFailureMessage, componentFailureMessage, componentProcess, componentSuccessMessage, convertLine, convertNum, convertWindowPosition, ConvertWindowPosition, deduceImageRect, dragTo, executeScript, getAlternateParams, getHelpersWorker, getPossibleMapItem, getProperty, getPropertyCollection, getPropertyCollection, getRectangleImage, getStringValue, getUUIDBoolean, guiDoesExist, hoverMouse, hoverScreenLocation, isClickAction, isPropertyExist, issueFileErrorFailure, issueParameterCountFailure, issueParameterCountFailure, issueParameterValueFailure, issuePassedSuccess, issuePassedSuccessUsing, issueUnknownErrorFailure, isSupportedRecordType, locateScreenImage, lookupAppMapCoordReference, lookupAppMapLineReference, lookupAppMapNumReference, lookupAppMapReference, maximize, minimize, normalizeFileEncoding, normalizePropertyCollection, restore, setIterator, setPosition, setRectVars, showComponentAsMuchPossible, updateFromTestRecordData, verifyPropertiesToFile, verifyProperty, waitForGUI, waitForObject

Methods inherited from class org.safs.Processor

activateBreakpoint, checkBreakpoints, checkMyBreakpoints, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, delay, distributeConfigInformation, getAbsolutFileName, getAppMapItem, getChainedProcessor, getClassInstance, getClearProxiesAlways, getCustomProcClassNames, getCustomProcInstancePath, getLogUtilities, getParams, getProcClassNames, getProcInstance, getProcInstancePath, getRequiredField, getSecsWaitForComponent, getSecsWaitForWindow, getStandardErrorMessage, getTestRecordData, getUnexpectedAlertBehaviour, getVariable, hasChainedProcessor, initProcessorAndProcess, instanceProcessorAndProcess, isBreakpointsOn, isComponentFunctionRecord, isDriverCommandRecord, isEngineCommandRecord, isMyBreakpointsOn, isRecordProcessed, isRFSMCache, isRFSMOnly, issueActionFailure, issueActionOnXFailure, issueErrorPerformingAction, issueErrorPerformingActionOnX, issueErrorPerformingActionUsing, issueInputRecordFailure, issueInputRecordFailure, issuePassedSuccess, logFailureMessage, normalizeTestFileName, paramsFailedMsg, paramsFailedMsg, popTestRecord, processCustomProcessor, processSubclassProcessor, pushTestRecord, setAtEndOfProcess, setBreakpointsOn, setChainedProcessor, setClearProxiesAlways, setCommandLineBreakpoint, setCustomProcInstancePath, setLogUtilities, setMyBreakpointsOn, setParams, setProcInstance, setProcInstancePath, setRecordProcessed, setRFSMCache, setRFSMOnly, setSecsWaitForComponent, setSecsWaitForWindow, setTestDomains, setTestRecordData, setUnexpectedAlertBehaviour, setVariable, standardFailureMessage, substituteVariable, validateParamSize, validProcessorClassName

Methods inherited from class java.lang.Object

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

Field Detail

VERIFYCELLVALUE

public static final java.lang.String VERIFYCELLVALUE

See Also:

Constant Field Values

Constructor Detail

CFHtmlTable

public CFHtmlTable()

Purpose: constructor, calls super

Method Detail

getTextProperty

public java.lang.String getTextProperty()

Overrides:

getTextProperty in class CFTable

convertCoords

public java.awt.Point convertCoords(java.lang.String coords)

Overrides the version in superclass CFTable to allow for alternative of "Coords=x1,y1,x2,y2". Supports both comma or semi-colon separators. Calculates the point that is the center of the specified region.

The calling routine will have to determine whether the returned Point is an x,y coordinate or a row,col cell -- probably by checking for "Row" or "Col" text in the provided string just as we do internally.

Overrides:

convertCoords in class CFTable

Parameters:

coords, - String x;y or x,y or Coords=x;y or Coords=x,y or Row=y,Col=x or Col=x;Row=y or Coords=x1,y1,x2,y2 or Coords=x1;y1;x2;y2

Returns:

Point (center of region) if successfull, null otherwise

processChildren

protected TestObject[] processChildren(TestObject obj1,
                                       java.lang.String matchType)

localProcess

protected void localProcess()

Note:
For furture use if we want to separate the "manipulation of HtmlTable" from "CFTable" Now the super class CFTable handle also the html table.

Overrides:

localProcess in class CFTable

captureObjectData

protected java.util.List<java.util.List<java.lang.String>> captureObjectData(TestObject table)
                                                                      throws java.lang.IllegalArgumentException,
                                                                             SAFSException

overrides CFTable.captureObjectData to capture the object data into a List of rows. Each row is a List of column values. The first row is a List of Column names, if any. If no column names exists then this first row will be a List of empty strings.

Overrides:

captureObjectData in class CFTable

Parameters:

table - GuiTestObject to snapshot data from. DataGrid and DataGridView are acceptable.

Returns:

List of rows of column value Lists. Null if an invalid table reference is provided or some other error occurs.

Throws:

SAFSException

java.lang.IllegalArgumentException - if table is not an acceptable GuiTestObject.

See Also:

CFTable.captureObjectData(TestObject), CFTable.formatObjectData(java.util.List)

commandVerifyCellValue

protected void commandVerifyCellValue()
                               throws SAFSException

preform VerifyCellValue.

Throws:

SAFSException

actionVerifyColumnLabel

protected void actionVerifyColumnLabel(GuiTestObject guiObj,
                                       java.lang.String val,
                                       int col)
                                throws SAFSException

Purpose: overrides CFTable.actionVerifyColumnLabel, only for HTML Table. assume that column labels is in the first line of the html table.

Overrides:

actionVerifyColumnLabel in class CFTable

Parameters:

guiObj, - GuiTestObject

val, - String

col, - int

Throws:

SAFSException

getColi

protected int getColi(boolean fuzzy,
                      java.lang.String column,
                      GuiTestObject guiObj)
               throws SAFSException

Purpose: overrides CFTable.getColi. get the column number based on fuzzy match

Overrides:

getColi in class CFTable

Parameters:

fuzzy, - boolean

column, - String

guiObj, - GuiSubitemTestObject

Returns:

Integer

Throws:

SAFSException

getNumRows

protected int getNumRows(TestObject jctable)
                  throws SAFSException

Purpose: get number of rows in HTML table; override CFTable.getNumRows(TestObject).

Overrides:

getNumRows in class CFTable

Parameters:

jctable -

Returns:

int, the number of rows

Throws:

SAFSException

getNumColumns

protected int getNumColumns(TestObject jctable)
                     throws SAFSException

Purpose: get number of columns in HTML table; override CFTable.GetNumColumns(TestObject jctable),

Overrides:

getNumColumns in class CFTable

Parameters:

jctable -

Returns:

int, the number of columns

Throws:

SAFSException

getColumns

protected TestObject[] getColumns(TestObject jctable)
                           throws SAFSException

Note:
The first line of html.table will be found, that is the first "<tr>...</tr>" contained in "<table></table>". The "<td>...</td>s" contained in that "<tr>...</tr>" will be returned as an array.

Parameters:

jctable - Which is the Html.TABLE object

Returns:

An array of "<td>...</td>s"

Throws:

SAFSException

getColumnName

protected java.lang.String getColumnName(TestObject jctable,
                                         int col)

Overrides CFTable.getColumnName for using by HTML Table only. Retrieve the column name for the provided zero-based column number.

Overrides:

getColumnName in class CFTable

Parameters:

guiObj - Expected to be a Html Table with a getColumnName(i) method that returns a String.

col - the column to get the name of.

Returns:

String column name or null if not available or an error occurs.

getCellText

protected java.lang.String getCellText(TestObject guiObj,
                                       int row,
                                       int col)

Note:
get the text value of the cell at (row,col) in HTML table

Overrides:

getCellText in class CFTable

Parameters:

guiObj -

row -

col -

Returns:

String, the text of the cell at row,col