org.safs.tools.engines

Class TIDComponent.CFComponent

java.lang.Object

org.safs.Processor

org.safs.ComponentFunction

org.safs.tools.engines.TIDComponent.CFComponent

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Enclosing class:

TIDComponent

class TIDComponent.CFComponent
extends ComponentFunction

Local CFComponent

Author:

Carl Nagle

Nested Class Summary

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

ComponentFunction.Window

Field Summary

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
CFComponent()

Method Summary

Modifier and Type	Method and Description
protected void	clickHoverScreenLocation() T WindowName CompName ClickScreenLocation T WindowName CompName HoverScreenLocation Coords CAN be in the App Map under windowName:compName and\or AppMapSubkey
protected void	clickScreenImage(java.lang.String winrec) T WindowName CompName ClickScreenImage image(s) are in App Map under windowName:compName
protected void	clickScreenPoint() ClickScreenPoint x,y
protected java.awt.Rectangle	getComponentRectangle() Capture a screen GUI image to a file.
protected java.lang.String	getRecImagePath(java.lang.String imagex, java.lang.String[] modifiers, java.lang.String winrec) Retrieve specific Image= path from the recognition modifiers.
protected java.lang.String	getRecImagePath(java.lang.String imagex, java.lang.String[] modifiers, java.lang.String winrec, boolean logit) Retrieve specific Image= path from the recognition modifiers.
protected void	getSaveTextFromGUI() Run two keywords: GetTextFromGUI and SaveTextFromGUI
protected void	guiDoesExist() T WindowName CompName GUIDoesExist T WindowName CompName GUIDoesNotExist image(s) are in App Map under windowName:compName
protected void	hoverScreenImage(java.lang.String winrec) T WindowName CompName HoverMouse image(s) are in App Map under windowName:compName
protected void	inputEncryptions() Decrypt the "encrypted text" and then send keyboard input to the current input focus target.
protected void	inputKeys() Send keyboard input to the current input focus target.
protected void	locateScreenImage() T WindowName CompName LocateScreenImage VarName image(s) are in App Map under windowName:compName param1 varname variables set: varname=x y w h (space delimited) varname.x=x varname.y=y varname.w=w varname.h=h
protected void	mouseDrag(java.lang.String winrec) T WindowName CompName LeftDrag AppMapSubKey T WindowName CompName RightDrag AppMapSubKey T WindowName CompName LeftDrag "x1,y1,x2,y2" T WindowName CompName RightDrag "Coords=x1;y1;x2;y2" image(s) are in App Map under windowName:compName AppMapSubKey would be in App Map under CompName section: [CompName] AppMapSubKey="Coords=x1,y1,x2,y2" or AppMapSubKey="x1;y1;x2;y2" Supports both comma (,) and semi-colon (;) coordinate delimiters.
void	process() Process the record present in the provided testRecordData.
protected void	snapshotScreen()
protected void	verifyFileToFile(boolean text) Purpose: verifyFileToFile
protected void	verifyValues() VerifyValues, VerifyValueEquals, VerifyValuesNotEqual, VerifyValuesIgnoreCase, VerifyValueContains, VerifyValueContainsIgnoreCase, VerifyValueDoesNotContain

Methods inherited from class org.safs.ComponentFunction

_close, _maximize, _minimize, _restore, _setPosition, _setSize, action_ComputedStyle, action_getGuiImage, action_GetSaveTextFromGUI, action_showOnPage, action_verifyGuiImageToFile, assignPropertyVariable, captureObjectData, captureObjectDataToFile, capturePropertiesToFile, capturePropertyToFile, checkForCoord, checkForCoord, clearAppMapCache, clearCache, close, closeWindow, componentClick, componentExecutedFailureMessage, componentFailureMessage, componentProcess, componentSuccessMessage, convertCoords, convertLine, convertNum, convertWindowPosition, ConvertWindowPosition, deduceImageRect, dragTo, executeScript, exist, getAlternateParams, getComponentRectangleOnScreen, getHelpers, getHelpersWorker, getPossibleMapItem, getProperties, getProperty, getPropertyCollection, getPropertyCollection, getPropertyObject, getRectangleImage, getStringValue, getUUIDBoolean, getWindowRectangleOnScreen, guiDoesExist, hoverMouse, hoverScreenLocation, inputKeystrokes, isClickAction, isPropertyExist, issueFileErrorFailure, issueParameterCountFailure, issueParameterCountFailure, issueParameterValueFailure, issuePassedSuccess, issuePassedSuccessUsing, issueUnknownErrorFailure, isSupportedRecordType, lookupAppMapCoordReference, lookupAppMapLineReference, lookupAppMapNumReference, lookupAppMapReference, maximize, minimize, normalizeFileEncoding, normalizePropertyCollection, performDrag, performHoverMouse, performScorll, restore, selectMenuItem, sendEvent, setIterator, setPosition, setPropertyValue, setRectVars, showComponentAsMuchPossible, updateFromTestRecordData, verifyClipboardToFile, verifyMenuItem, verifyObjectDataToFile, verifyPropertiesToFile, verifyProperty, verifyPropertyContains, verifyPropertyToFile, verifyValueContains, 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

Constructor Detail

CFComponent

CFComponent()

Method Detail

snapshotScreen

protected void snapshotScreen()

process

public void process()

Process the record present in the provided testRecordData.

Overrides:

process in class Processor

getRecImagePath

protected java.lang.String getRecImagePath(java.lang.String imagex,
                                           java.lang.String[] modifiers,
                                           java.lang.String winrec)

Retrieve specific Image= path from the recognition modifiers. Issues Action Failure and FAILED status if path is not in winrec.

Parameters:

imagex - Should be MOD_IMAGE, MOD_IMAGEW, or MOD_IMAGEH

modifiers - the array of recognition modifiers

winrec - the recognition string originating the modifiers

Returns:

String or null if not found.

getRecImagePath

protected java.lang.String getRecImagePath(java.lang.String imagex,
                                           java.lang.String[] modifiers,
                                           java.lang.String winrec,
                                           boolean logit)

Retrieve specific Image= path from the recognition modifiers. Issues Action Failure and FAILED status if path is not in winrec.

Parameters:

imagex - Should be MOD_IMAGE, MOD_IMAGEW, or MOD_IMAGEH

modifiers - the array of recognition modifiers

winrec - the recognition string originating the modifiers

logit - -- send false if you don't want logging and status to occur Ex: when seeking ImageW and ImageH info which is optional

Returns:

locateScreenImage

protected void locateScreenImage()

T WindowName CompName LocateScreenImage VarName image(s) are in App Map under windowName:compName param1 varname variables set: varname=x y w h (space delimited) varname.x=x varname.y=y varname.w=w varname.h=h

Overrides:

locateScreenImage in class ComponentFunction

getComponentRectangle

protected java.awt.Rectangle getComponentRectangle()

Capture a screen GUI image to a file. Currently, the available formats for the output file are BMP and JPG. Optionally, the user may utilize the SubArea parameter to only capture a portion of the Component. This routine utilizes Java Advanced Imaging (JAI) to output the screen image to the file. JAI must be installed at compile time and runtime.

Overrides:

getComponentRectangle in class ComponentFunction

Returns:

Rectangle bounds of the Component or null.

See Also:

ComponentFunction.deduceImageRect(String)

guiDoesExist

protected void guiDoesExist()

T WindowName CompName GUIDoesExist T WindowName CompName GUIDoesNotExist image(s) are in App Map under windowName:compName

clickScreenImage

protected void clickScreenImage(java.lang.String winrec)

T WindowName CompName ClickScreenImage image(s) are in App Map under windowName:compName

clickHoverScreenLocation

protected void clickHoverScreenLocation()

T WindowName CompName ClickScreenLocation T WindowName CompName HoverScreenLocation Coords CAN be in the App Map under windowName:compName and\or AppMapSubkey

hoverScreenImage

protected void hoverScreenImage(java.lang.String winrec)

T WindowName CompName HoverMouse image(s) are in App Map under windowName:compName

mouseDrag

protected void mouseDrag(java.lang.String winrec)

T WindowName CompName LeftDrag AppMapSubKey T WindowName CompName RightDrag AppMapSubKey T WindowName CompName LeftDrag "x1,y1,x2,y2" T WindowName CompName RightDrag "Coords=x1;y1;x2;y2" image(s) are in App Map under windowName:compName AppMapSubKey would be in App Map under CompName section: [CompName] AppMapSubKey="Coords=x1,y1,x2,y2" or AppMapSubKey="x1;y1;x2;y2" Supports both comma (,) and semi-colon (;) coordinate delimiters. The default Hotspot for Right/LeftDrag is TopLeft, not Center.

clickScreenPoint

protected void clickScreenPoint()

ClickScreenPoint x,y

inputKeys

protected void inputKeys()

Send keyboard input to the current input focus target. The command does not attempt to change keyboard focus from where it already is.

inputEncryptions

protected void inputEncryptions()

Decrypt the "encrypted text" and then send keyboard input to the current input focus target. The command does not attempt to change keyboard focus from where it already is.
note: Be careful, decrypted-text MUST NOT appear in any logs during implementation.

verifyValues

protected void verifyValues()
                     throws SAFSException

VerifyValues, VerifyValueEquals, VerifyValuesNotEqual, VerifyValuesIgnoreCase, VerifyValueContains, VerifyValueContainsIgnoreCase, VerifyValueDoesNotContain

Overrides:

verifyValues in class ComponentFunction

Throws:

SAFSException

verifyFileToFile

protected void verifyFileToFile(boolean text)
                         throws SAFSException

Purpose: verifyFileToFile

Overrides:

verifyFileToFile in class ComponentFunction

Parameters:

text, - boolean, if true, then text files, else binary files

Throws:

SAFSException

getSaveTextFromGUI

protected void getSaveTextFromGUI()
                           throws SAFSException

Run two keywords: GetTextFromGUI and SaveTextFromGUI

Throws:

SAFSException, - thrown when keywords fail to execute

SAFSException