ComponentFunction (SAFS API DOCUMENT)

java.lang.Object
- org.safs.Processor
- - org.safs.ComponentFunction

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Direct Known Subclasses:

AutoItComponent.CFComponent, CFComponent, CFComponent, CFComponent, CFComponent, CFComponentFunctions, CFDefaultComponent, CFEditBox, CFTIDComponent, CFWindow, TIDComponent.CFComponent, TIDComponent.RESTComponent
```
public abstract class ComponentFunction
extends Processor
```
Purpose: abstract ComponentFunction, enforces that the 'process' method be implemented
- COMPONENT FUNCTIONS (so far...):
  - CFButton
  - CFCheckBox
    - check
      
      Example: T,Frame,rememberPasswordCheckBox,check
    - uncheck
      
      Example: TF,Frame,rememberPasswordCheckBox,uncheck
  - CFComboBox
    - selectIndex
      
      1st param: index into the combobox of the item to select
      Example: T,Frame,nameComboComboBox,selectIndex,2
    - select/selectTextItem/selectUnverified/selectUnverifiedTextItem
      
      1st param: name of the item to select
      Example: T,Frame,nameComboComboBox,select,Karen Farrell
    - setTextValue (not sure if this one actually works, does guiObj.setProperty("text", val);)
      
      1st param: name of the item to select
      Example: T,Frame,nameComboComboBox,selectPartialMatch,Sammy The Fish
    - showlist/hidelist - shows or hides the list
      
      Example: T,Frame,nameComboComboBox,showlist
  - CFComponent (Available to nearly all components)
    - click/rightClick
      
      Example: T,Frame,radioButtonARadioButton,click
    - closeWindow/restore/minimize/maximize
      
      Example: T,Frame,radioButtonARadioButton,restore
    - verifyProperty - verify that a property exists and exactly matches specified value
      
      1st param: property name
      2nd param: property value to verify against
      Example: TW,PlaceOrder,totalPriceLabel,VerifyProperty,text,$19.99
    - verifyPropertyContains - verify that a property exists and contains specified value
      
      1st param: property name
      2nd param: property value to look for containment (substring of actual)
      Example: TW,PlaceOrder,totalPriceLabel,VerifyPropertyContains,text,19
    - verifyValue - verify that a value exactly matches specified value
      
      1st param: property name
      2nd param: property value to verify against
      Example: TW,PlaceOrder,totalPriceLabel,VerifyValue,$19.99,^variable
    - verifyValueContains - verify that a value contains specified value
      
      1st param: property name
      2nd param: property value to look for containment (substring of actual)
      Example: TW,PlaceOrder,totalPriceLabel,VerifyPropertyContains,^variable,$19
    - clearAppMapCache - clear the cache of testobjects, normally not needed.
      
      Example: T,PlaceOrder,PlaceOrder,clearAppMapCache
    - assignPropertyVariable - Assign the value of a cell to a variable
      
      1st param: property name
      2nd param: variablename
      Example: T,Frame,orderTableTable,assignPropertyVariable,text,var1
      Example: T,Frame,orderTableTable,assignPropertyVariable,text,var2
      Example: T,Frame,orderTableTable,assignPropertyVariable,text,var3
    - inputKeys - input keys to the frame for the component
      
      1st param: keys
      Example: T,PlaceOrder,_cardNumberFieldText,inputKeys,1234123412341234
      Example: T,PlaceOrder,_expireFieldText,inputKeys,09
      Example: T,PlaceOrder,_expireFieldText,inputKeys,/03
    - VerifyObjectDataToFile, grab value(s) in "text" property, verify against file
      
      1st param: file to verify against (in the bench directory)
      Example: T,PlaceOrder,PlaceOrder,VerifyObjectDataToFile,file.txt
    - VerifyTextFileToFile, verify one file to another
      
      1st param: file to verify against (in the bench directory)
      2nd param: file to verify against (in the bench directory)
      Example: T,PlaceOrder,PlaceOrder,VerifyObjectDataToFile,file.txt
  - CFLabel
  - CFList (similar to combobox)
    - activatetextitem
    - activatepartialmatch
    - activateunverifiedpartialmatch
    - activateunverifiedtextitem
    - select
    - selectTextItem
    - selectIndex
    - selectPartialMatch
    - verifymenupartialmatch - verify if a menu item exists (partial match)
    - verifymenuitem - verify if a menu item exists
    - verifypartialmatch - based on an index
    - verifyitem - based on an index
    - selectUnverifiedPartialMatch
    - selectUnverified
    - selectUnverifiedTextItem
    - setTextValue
  - CFMenuBar
    - selectMenuItem
    - selectMenuItemContains
  - CFPageTabList
    - click/clicktab
      
      1st param: the tab to click
      Example: T,Frame,tabbedPanePageTabList,clicktab,Details
    - selecttab/makeselection
      
      1st param: the tab to select
      Example: T,Frame,tabbedPanePageTabList,selecttab,Details
  - CFPopupMenu
    - selectPopupMenuItem
    - verifyPopupMenuItem
      
      1st param: verify a popup menu item exists
      Example: T,Frame,popup,verifyPopupMenuItem,"Item"
  - CFTable/CFJCTable (for Swing JTable, Sitraka JCTable respectively)
    - clickCellOfColWithRowValues/doubleclickCellOfColWithRowValues - click or doubleclick a cell specified by the params (CFTable only)
      
      1st param(opt): row;col coordinate within the cell, if omitted then the coords not used
      2nd param: Column name of the cell to click on
      3rd param: for a row, first column name of the row to click on
      4th param: for a row, first cell value of the row to click on for this column
      5th param(opt): for a row, second column name of the row to click on
      6th param(opt): for a row, second cell value of the row to click on for this column
      7th param(opt): for a row, third column name of the row to click on
      8th param(opt): for a row, third cell value of the row to click on for this column
      Example: T,Frame,orderTableTable,clickCellOfColWithRowValues,,TOTAL,ORDERDATE,3/11/98,EXPDATE,1298,QUANTITY,3
      Example: T,Frame,orderTableTable,clickCellOfColWithRowValues,43;12,TOTAL,ORDERDATE,3/11/98,EXPDATE,1298,QUANTITY,3
    - click/doubleclick/activatecell - click or doubleclick(activatecell) a cell specified by the params (from 1)
      
      1st param: row;col row and column of the cell to click
      Example: T,Frame,orderTableTable,click,1;2
    - selectRowWithRowValues - select a row specified by the params (CFTable only)
      
      1st param: for a row, first column name of the row to click on
      2nd param: for a row, first cell value of the row to click on for this column
      3rd param(opt): for a row, second column name of the row to click on
      4th param(opt): for a row, second cell value of the row to click on for this column
      5th param(opt): for a row, third column name of the row to click on
      6th param(opt): for a row, third cell value of the row to click on for this column
      Example: T,Frame,orderTableTable,selectRowWithRowValues,ORDERDATE,3/11/98,EXPDATE,1298,QUANTITY,3
    - selectcell/selectcelltext - select a cell specified by the params (from 1)
      
      1st param(opt): row;col row and column of the cell to select
      Example: T,Frame,orderTableTable,selectcell,3;4
    - selectfuzzycelltext - fuzzy select a cell specified by the params (from 1)
      
      1st param(opt): row;col row and column of the cell to select
      Example: T,Frame,orderTableTable,selectcell,3;4
    - verifycelltext/verifyfuzzycelltext - verify the text of a cell
      
      1st param: basevalue - value to compare against
      2nd param(opt): row;col row and column of the cell to verify text
      3rd param(opt): if included, the name of the column, in which case the col is ignored.
      Example: T,Frame,orderTableTable,verifyCellText,xyz
      Example: T,Frame,orderTableTable,verifyCellText,750 Central Expy,2;3
      Example: T,Frame,orderTableTable,verifyCellText,750 Central Expy,2,STREET
    - verifycelltextcontains/verifyfuzzycelltextcontains - verify the text of a cell contains substring
      
      1st param: basevalue - value to compare against (substring)
      2nd param(opt): row;col row and column of the cell to verify text
      3rd param(opt): if included, the name of the column, in which case the col is ignored.
      Example: T,Frame,orderTableTable,verifyCellTextContains,xy
      Example: T,Frame,orderTableTable,verifyCellTextContains,750 Central,2;3
      Example: T,Frame,orderTableTable,verifyCellTextContains,50 Cen,2,STREET
    - assignVariableCellText/assignVariableFuzzyCellText - Assign the value of a cell to a variable
      
      1st param: variablename
      2nd param(opt): row;col row and column of the cell get text from
      3rd param(opt): if included, the name of the column, in which case the col is ignored.
      Example: T,Frame,orderTableTable,assignVariableCellText,var1
      Example: T,Frame,orderTableTable,assignVariableCellText,var2,2;3
      Example: T,Frame,orderTableTable,assignVariableCellText,var3,2,STREET
    - captureRangeToFile/captureFuzzyRangeToFile - capture range to file
      
      1st param: variablename
      2nd param(opt): startRow
      3rd param(opt): startCol
      4rt param(opt): numRows
      5th param(opt): nujCols
      Example: T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt
      Example: T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt, 4, "Field5", 2, 5
  - CFText
    - setTextValue
      
      1st param: the text to set in the text value
      Example: T,Frame,_expireFieldText,SetTextValue,12/03
  - CFTree
    - click
      
      1st param: the node of the tree to click
      Example: T,Frame,tree2Tree,click,Composers->Bach->Brandenburg Concertos Nos. 1 & 3
    - doubleclick
      
      1st param: the node of the tree to doubleclick
      Example: T,Frame,tree2Tree,doubleclick,Composers->Bach
    - select/makeselection/selecttextnode/selectpartialtextnode
      
      1st param: the node of the tree to select
      Example: T,Frame,tree2Tree,select,Composers->Bach->Violin Concertos
    - expand/expandtextnode/expandpartialtextnode
      
      1st param: the node of the tree to expand
      Example: T,Frame,tree2Tree,expand,Composers->Schubert
    - collapse/collapsetextnode/collapsepartialtextnode
      
      1st param: the node of the tree to collapse
      Example: T,Frame,tree2Tree,collapse,Composers->Haydn

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ComponentFunction.Window` An inner class to encapsulate a window information for adjusting window size, position etc. It includes also some static methods to restore, maximize, minimize or close current focused window. These methods may only work on Windows system, it uses java Robot to trigger shortcut menu.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`action`
`static java.lang.String`	`ALTCLICK`
`static java.lang.String`	`ALTLEFTDRAG`
`protected java.lang.String`	`altText`
`static java.lang.String`	`ASSIGNPROPERTYVARIABLE`
`static java.lang.String`	`CAPTUREOBJECTDATATOFILE`
`static java.lang.String`	`CAPTUREPROPERTIESTOFILE`
`static java.lang.String`	`CAPTUREPROPERTYTOFILE`
`static java.lang.String`	`CLEARAPPMAPCACHE`
`static java.lang.String`	`CLICK`
`static java.lang.String`	`CLOSEWINDOW`
`protected java.lang.String`	`compName`
`static java.lang.String`	`COMPONENTCLICK`
`static java.lang.String`	`CTRLALTLEFTDRAG`
`static java.lang.String`	`CTRLCLICK`
`static java.lang.String`	`CTRLLEFTDRAG`
`static java.lang.String`	`CTRLRIGHTCLICK`
`static java.lang.String`	`CTRLSHIFTLEFTDRAG`
`static java.lang.String`	`DOUBLECLICK`
`static java.lang.String`	`GETGUIIMAGE`
`static java.lang.String`	`GETTEXTFROMGUI`
`static java.lang.String`	`GUIDOESEXIST`
`static java.lang.String`	`GUIDOESNOTEXIST`
`static java.lang.String`	`HOVERMOUSE`
`static java.lang.String`	`HSCROLLTO`
`static java.lang.String`	`INPUTCHARACTERS`
`static java.lang.String`	`INPUTKEYS`
`static java.lang.String`	`ISPROPERTYEXIST`
`protected java.util.Iterator<java.lang.String>`	`iterator`
`static java.lang.String`	`LEFTDRAG`
`static java.lang.String`	`LOCATESCREENIMAGE`
`protected java.lang.String`	`mapname`
`static java.lang.String`	`MAXIMIZE`
`static java.lang.String`	`MINIMIZE`
`static java.lang.String`	`MOUSECLICK`
`protected static java.lang.String`	`OBJECT_DATA`
`static java.lang.String`	`PARAM_FILTER` "FILTER"
`static java.lang.String`	`PARAM_UUID` "UUID"
`protected static java.lang.String`	`PROPERTY_DOT_itemText` ".itemText" property for list and combobox to grab all the items.
`protected static java.lang.String`	`PROPERTY_innerHTML` "innerHTML", property to grab html element's content.
`protected static java.lang.String`	`PROPERTY_innerText` "innerText" property to html element's content.
`protected static java.lang.String`	`PROPERTY_Items` "Items", property to grab all the items for DotNet Control.
`protected static java.lang.String`	`PROPERTY_text` "text" property to grab item's label.
`protected static java.lang.String`	`PROPERTY_textContent` "textContent" property to html element's content.
`static java.lang.String`	`RELATIVE_TO_PARENT` 'parent'
`static java.lang.String`	`RELATIVE_TO_SCREEN` 'screen'
`static java.lang.String`	`RESTORE`
`static java.lang.String`	`RIGHTCLICK`
`static java.lang.String`	`RIGHTDRAG`
`static java.lang.String`	`SAVETEXTFROMGUI`
`static java.lang.String`	`SELECTMENUITEM`
`static java.lang.String`	`SELECTMENUITEMCONTAINS`
`static java.lang.String`	`SENDEVENT`
`static java.lang.String`	`SETPOSITION`
`static java.lang.String`	`SETPROPERTYVALUE`
`static java.lang.String`	`SHIFTCLICK`
`static java.lang.String`	`SHIFTLEFTDRAG`
`protected static java.lang.String`	`TEST_DATA_SUFFIX` ".actual.txt", file suffix.
`protected DDGUIUtilities`	`utils`
`static java.lang.String`	`VERIFYARRAYPROPERTYTOFILE`
`static java.lang.String`	`VERIFYBINARYFILETOFILE`
`static java.lang.String`	`VERIFYCLIPBOARDTOFILE`
`static java.lang.String`	`VERIFYFILETOFILE`
`static java.lang.String`	`VERIFYGUIIMAGETOFILE`
`static java.lang.String`	`VERIFYMENUITEM`
`static java.lang.String`	`VERIFYMENUITEMCONTAINS`
`static java.lang.String`	`VERIFYOBJECTDATATOFILE`
`static java.lang.String`	`VERIFYPROPERTY`
`static java.lang.String`	`VERIFYPROPERTYCONTAINS`
`static java.lang.String`	`VERIFYPROPERTYTOFILE`
`static java.lang.String`	`VERIFYTEXTFILETOFILE`
`static java.lang.String`	`VERIFYVALUECONTAINS`
`static java.lang.String`	`VERIFYVALUEEQUALS`
`static java.lang.String`	`VERIFYVALUES`
`static java.lang.String`	`VERIFYVALUESIGNORECASE`
`static java.lang.String`	`VSCROLLTO`
`static java.lang.String`	`WAITFORGUI`
`protected java.lang.String`	`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

ComponentFunction()

Purpose: constructor

Constructors
Constructor and Description
`ComponentFunction()` Purpose: constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_close()` This implementation is NOT guarantee to work, if it works, it will happen on current focused window. Subclass should give its own implementation
`protected void`	`_maximize()` Subclass should give its own implementation, if it is difficult then call this instead, but this implementation is not guarantee to work
`protected void`	`_minimize()` Subclass should give its own implementation, if it is difficult then call this instead, but this implementation is not guarantee to work
`protected void`	`_restore()` Subclass should give its own implementation, if it is difficult then call this instead, but this implementation is not guarantee to work
`protected void`	`_setPosition(java.awt.Point position)` Subclass should give its own implementation
`protected void`	`_setSize(java.awt.Dimension size)` Subclass should give its own implementation
`protected void`	`action_ComputedStyle(boolean verification)`
`protected void`	`action_getGuiImage()` Processes a Component Function Test Record to capture a screen GUI image to a file.
`protected void`	`action_GetSaveTextFromGUI()` Use OCR to detect the text from captured screen, executing SaveTextFromGUI or SaveTextFromGUI.
`protected void`	`action_showOnPage()` Purpose: Show the component on the page as much as possible.
`protected void`	`action_verifyGuiImageToFile()` Processes a Component Function Test Record to verify a screen GUI image to a file.
`protected void`	`assignPropertyVariable()`
`protected java.util.Collection<java.lang.String>`	`captureObjectData()`
`protected void`	`captureObjectDataToFile()`
`protected void`	`capturePropertiesToFile()`
`protected void`	`capturePropertyToFile()`
`protected java.awt.Point`	`checkForCoord(java.util.Iterator<java.lang.String> iterator)` Purpose: check 'iterator' for coords, either a map reference, or x;y notation and convert it into Point.
`protected java.awt.Point`	`checkForCoord(java.lang.String coordinate)` Purpose: check for coords, either a map reference, or x;y notation and convert it into Point.
`protected void`	`clearAppMapCache()`
`protected void`	`clearCache()`
`protected void`	`close()` Close the current window.
`protected void`	`closeWindow()`
`protected void`	`componentClick()`
`protected void`	`componentExecutedFailureMessage(java.lang.String error)` "windowname compName action processed with a negative result." "Error at line number in file: [detail]" Purpose: log a simple failure message when a test record got processed with negative result.
`protected void`	`componentFailureMessage(java.lang.String detail)` "Unable to perform action on compName in file line N." "[Detail]" Purpose: log an "Unable to perform function" FAILED_MESSAGE with detail.
`protected void`	`componentProcess()` Process generic actions on a component.
`protected void`	`componentSuccessMessage(java.lang.String detail)` "windowName compName action successful." "[detail]" Purpose: Log a generic success message.
`java.awt.Point`	`convertCoords(java.lang.String coords)` Convert coordinates string of the formats: "x;y" "x,y" "x y" "Coords=x;y" "Coords=x,y" "Coords=x y" into a java.awt.Point object.
`java.awt.Polygon`	`convertLine(java.lang.String coords)` Convert 2-point Line coordinates string of the formats: "x1;y1;x2;y2" "x1,y1,x2,y2" "x1 y1 x2 y2" "Coords=x1;y1;x2;y2" "Coords=x1,y1,x2,y2" "Coords=x1 y1 x2 y2" into a java.awt.Polygon object.
`java.lang.Integer`	`convertNum(java.lang.String num)` Purpose: convertNum: convert into a number Assumptions: all exceptions are handled.
`ComponentFunction.Window`	`convertWindowPosition(java.lang.String windowPosition)` Convert window's position-size-status string of the formats: "x;y;width;height;status" "x,y,width,height,status" "x y width height status" "Coords=x;y;width;height;Status=status" "Coords=x,y,width,height,Status=status" "Coords=x y width height Status=status" into a org.safs.ComponentFunction.Window object.
`static ComponentFunction.Window`	`ConvertWindowPosition(java.lang.String windowPosition)` Convert window's position-size-status string of the formats: "x;y;width;height;status" "x,y,width,height,status" "x y width height status" "Coords=x;y;width;height;Status=status" "Coords=x,y,width,height,Status=status" "Coords=x y width height Status=status" into a org.safs.ComponentFunction.Window object.
`protected java.awt.Rectangle`	`deduceImageRect(java.lang.String subareaMapKey)`
`protected void`	`dragTo()`
`protected void`	`executeScript()`
`protected boolean`	`exist()` To test if the component exists or not. The sub class may test the component's visibility also.
`java.util.Collection<java.lang.String>`	`getAlternateParams()` Purpose: zero-based params with: windowname compname +N additional parameters
`protected java.awt.Rectangle`	`getComponentRectangle()` Do nothing method returns null.
`protected java.awt.Rectangle`	`getComponentRectangleOnScreen()` Get the absolute 'Rectangle bounds' of the Component, which means the rectangle is relative to the whole screen, NOT to a window/browser.
`protected void`	`getHelpers()` Simply calls getHelpersWorker.
`protected void`	`getHelpersWorker()` set instance variables from the current testRecordData: actionwindowNamecompNamemapnameutils Subclasses can override this for any additional setup beyond getHelpersWorker.
`protected java.lang.String`	`getPossibleMapItem(java.lang.String mapKey)`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getProperties()`
`protected java.lang.String`	`getProperty(java.lang.String propertyName)` Get component's property string value
`protected java.util.Collection<java.lang.String>`	`getPropertyCollection(java.util.List<java.lang.String> propertyList)` Get the value of property, and return them as a Collection. If the property-list contains only ONE property, the collection will contain only its value. If the property-list contains multiple properties, the collection will contain a set of string like "property:value". The assignment separator will actually be the current value of the testRecordData.separator.
`protected java.util.Collection<java.lang.String>`	`getPropertyCollection(java.lang.String property)` Get the value of a property, and return it as a Collection.
`protected java.lang.Object`	`getPropertyObject(java.lang.String propertyName)`
`protected java.awt.image.BufferedImage`	`getRectangleImage(java.awt.Rectangle imageRect)` Get BufferedImage within a rectangle. The rectangle may be absolute on screen, Or it may be relative to a browser or something. It depends on what is returned by `getComponentRectangle()`. This method assume the rectangle is absolute on screen, so get the image on screen within the rectangle. Sub class may override this method to get its own image.
`protected java.lang.String`	`getStringValue(java.lang.Object value)` Get the string value from the Object value. If the value is a collection, it will be converted to a string separated by 'New Line'.
`static boolean`	`getUUIDBoolean(java.lang.String parameter)` Check if the provided parameter is a UUID= flag. True if UUID=true\|1\|-1\|on\|yes.
`protected java.awt.Rectangle`	`getWindowRectangleOnScreen()` Get the absolute 'Rectangle bounds' of the Window, which means the rectangle is relative to the whole screen.
`protected void`	`guiDoesExist(boolean does)`
`protected void`	`hoverMouse()` Purpose: Response for HOVERMOUSE; called by componentProcess() to hover mouse.
`protected void`	`hoverScreenLocation()`
`protected void`	`inputKeystrokes()`
`protected void`	`isPropertyExist()`
`protected void`	`issueFileErrorFailure(java.lang.String filename)` Issue a file error and failure message Filename does not need to be localized.
`protected void`	`issueParameterCountFailure()` Issue parameter count error and failure message
`protected void`	`issueParameterCountFailure(java.lang.String detail)` Issue parameter count error and failure message
`protected void`	`issueParameterValueFailure(java.lang.String paramName)` Issue parameter value error and failure message
`protected void`	`issuePassedSuccess(java.lang.String comment)` "windowName compName action successful.
`protected void`	`issuePassedSuccessUsing(java.lang.String using)` "windowName compName action successful using [using]" Sets status to OK and issues a PASSED message.
`protected void`	`issueUnknownErrorFailure(java.lang.String cause)` Issue a generic error and failure message The cause parameter is expected to already be localized.
`boolean`	`isSupportedRecordType(java.lang.String recordType)` Supports standard TEST STEP record types (T, TW, TF)
`protected void`	`locateScreenImage()` Purpose: Response for HOVERMOUSE; called by componentProcess() to hover mouse.
`protected java.awt.Point`	`lookupAppMapCoordReference(java.lang.String referenceName)` lookupAppMapCoordReference: uses 'convertCoords' after the call to 'lookupAppMapReference'.
`protected java.awt.Polygon`	`lookupAppMapLineReference(java.lang.String referenceName)` lookupAppMapLineReference: uses 'convertLine' after the call to 'lookupAppMapReference'.
`protected java.lang.Integer`	`lookupAppMapNumReference(java.lang.String referenceName)` Purpose: lookupAppMapNumReference: uses 'convertNum' after the call to 'lookupAppMapReference'.
`protected java.lang.String`	`lookupAppMapReference(java.lang.String referenceName)` Looks up an item using the current appmapID=mapname, section=compName, item=referenceName.
`protected void`	`maximize()` Maximize the current window.
`protected void`	`minimize()` Minimize the current window.
`protected java.lang.String`	`normalizeFileEncoding(java.lang.String encoding)`
`static java.util.Collection<java.lang.String>`	`normalizePropertyCollection(java.util.Collection<java.lang.String> properties, java.lang.String encoding)` A Collection contains the value of a property.
`protected void`	`performDrag()`
`protected boolean`	`performHoverMouse(java.awt.Point point, int milliseconds)` Purpose: perform hovering mouse at 'point' for 'milliseconds' period on a Component. Subclass may need to give a specific implementation by tools (RJ, Selenium etc.) API.
`protected void`	`performScorll()`
`protected void`	`restore()` Restore the current window.
`protected void`	`selectMenuItem(boolean fuzzy)`
`protected void`	`sendEvent()`
`void`	`setIterator(java.util.Iterator<java.lang.String> iterator)`
`protected void`	`setPosition()` perform SetPosition to move Main Window, resize it and set its status.
`protected void`	`setPropertyValue()`
`protected boolean`	`setRectVars(java.awt.Rectangle rect, java.lang.String varname)` Set the varname.x, varname.y, varname.w, and varname.h variables to the values retrieved from the rectangle.
`protected boolean`	`showComponentAsMuchPossible(boolean verify)` If the component is not fully shown on the screen, try to make it visible on screen as much as possible.
`protected void`	`updateFromTestRecordData()` Updates our internal storage for action, windowName, compName, and mapname from the current TestRecordData.
`protected void`	`verifyClipboardToFile()`
`protected void`	`verifyFileToFile(boolean isTextFile)`
`protected void`	`verifyMenuItem(boolean fuzzy)`
`protected void`	`verifyObjectDataToFile()`
`protected void`	`verifyPropertiesToFile()` Purpose: verifyPropertiesToFile
`protected void`	`verifyProperty()` Purpose: verifyProperty
`protected void`	`verifyPropertyContains()`
`protected void`	`verifyPropertyToFile(boolean array)` Purpose: verifyArrayPropertyToFile/verifyPropertyToFile/verifyPropertiesToFile
`protected void`	`verifyValueContains()`
`protected void`	`verifyValues()`
`protected void`	`waitForGUI()` Waits for the object to be present on the screen, waits up to the timeout defined in the parameters or a default of 15 seconds.
`protected int`	`waitForObject(java.lang.String mapname, java.lang.String windowName, java.lang.String compName, int secii)`

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, process, 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
  - ALTCLICK
```
public static final java.lang.String ALTCLICK
```
    See Also:
    
    Constant Field Values
  - CLICK
```
public static final java.lang.String CLICK
```
    See Also:
    
    Constant Field Values
  - COMPONENTCLICK
```
public static final java.lang.String COMPONENTCLICK
```
    See Also:
    
    Constant Field Values
  - CTRLCLICK
```
public static final java.lang.String CTRLCLICK
```
    See Also:
    
    Constant Field Values
  - CTRLRIGHTCLICK
```
public static final java.lang.String CTRLRIGHTCLICK
```
    See Also:
    
    Constant Field Values
  - DOUBLECLICK
```
public static final java.lang.String DOUBLECLICK
```
    See Also:
    
    Constant Field Values
  - MOUSECLICK
```
public static final java.lang.String MOUSECLICK
```
    See Also:
    
    Constant Field Values
  - RIGHTCLICK
```
public static final java.lang.String RIGHTCLICK
```
    See Also:
    
    Constant Field Values
  - SHIFTCLICK
```
public static final java.lang.String SHIFTCLICK
```
    See Also:
    
    Constant Field Values
  - HSCROLLTO
```
public static final java.lang.String HSCROLLTO
```
    See Also:
    
    Constant Field Values
  - VSCROLLTO
```
public static final java.lang.String VSCROLLTO
```
    See Also:
    
    Constant Field Values
  - ALTLEFTDRAG
```
public static final java.lang.String ALTLEFTDRAG
```
    See Also:
    
    Constant Field Values
  - CTRLALTLEFTDRAG
```
public static final java.lang.String CTRLALTLEFTDRAG
```
    See Also:
    
    Constant Field Values
  - CTRLLEFTDRAG
```
public static final java.lang.String CTRLLEFTDRAG
```
    See Also:
    
    Constant Field Values
  - CTRLSHIFTLEFTDRAG
```
public static final java.lang.String CTRLSHIFTLEFTDRAG
```
    See Also:
    
    Constant Field Values
  - LEFTDRAG
```
public static final java.lang.String LEFTDRAG
```
    See Also:
    
    Constant Field Values
  - RIGHTDRAG
```
public static final java.lang.String RIGHTDRAG
```
    See Also:
    
    Constant Field Values
  - SHIFTLEFTDRAG
```
public static final java.lang.String SHIFTLEFTDRAG
```
    See Also:
    
    Constant Field Values
  - ASSIGNPROPERTYVARIABLE
```
public static final java.lang.String ASSIGNPROPERTYVARIABLE
```
    See Also:
    
    Constant Field Values
  - CAPTUREOBJECTDATATOFILE
```
public static final java.lang.String CAPTUREOBJECTDATATOFILE
```
    See Also:
    
    Constant Field Values
  - CAPTUREPROPERTIESTOFILE
```
public static final java.lang.String CAPTUREPROPERTIESTOFILE
```
    See Also:
    
    Constant Field Values
  - CAPTUREPROPERTYTOFILE
```
public static final java.lang.String CAPTUREPROPERTYTOFILE
```
    See Also:
    
    Constant Field Values
  - CLEARAPPMAPCACHE
```
public static final java.lang.String CLEARAPPMAPCACHE
```
    See Also:
    
    Constant Field Values
  - GUIDOESEXIST
```
public static final java.lang.String GUIDOESEXIST
```
    See Also:
    
    Constant Field Values
  - GUIDOESNOTEXIST
```
public static final java.lang.String GUIDOESNOTEXIST
```
    See Also:
    
    Constant Field Values
  - GETGUIIMAGE
```
public static final java.lang.String GETGUIIMAGE
```
    See Also:
    
    Constant Field Values
  - HOVERMOUSE
```
public static final java.lang.String HOVERMOUSE
```
    See Also:
    
    Constant Field Values
  - INPUTCHARACTERS
```
public static final java.lang.String INPUTCHARACTERS
```
    See Also:
    
    Constant Field Values
  - INPUTKEYS
```
public static final java.lang.String INPUTKEYS
```
    See Also:
    
    Constant Field Values
  - ISPROPERTYEXIST
```
public static final java.lang.String ISPROPERTYEXIST
```
    See Also:
    
    Constant Field Values
  - SENDEVENT
```
public static final java.lang.String SENDEVENT
```
    See Also:
    
    Constant Field Values
  - VERIFYARRAYPROPERTYTOFILE
```
public static final java.lang.String VERIFYARRAYPROPERTYTOFILE
```
    See Also:
    
    Constant Field Values
  - VERIFYBINARYFILETOFILE
```
public static final java.lang.String VERIFYBINARYFILETOFILE
```
    See Also:
    
    Constant Field Values
  - VERIFYCLIPBOARDTOFILE
```
public static final java.lang.String VERIFYCLIPBOARDTOFILE
```
    See Also:
    
    Constant Field Values
  - VERIFYFILETOFILE
```
public static final java.lang.String VERIFYFILETOFILE
```
    See Also:
    
    Constant Field Values
  - VERIFYGUIIMAGETOFILE
```
public static final java.lang.String VERIFYGUIIMAGETOFILE
```
    See Also:
    
    Constant Field Values
  - VERIFYOBJECTDATATOFILE
```
public static final java.lang.String VERIFYOBJECTDATATOFILE
```
    See Also:
    
    Constant Field Values
  - VERIFYPROPERTY
```
public static final java.lang.String VERIFYPROPERTY
```
    See Also:
    
    Constant Field Values
  - VERIFYPROPERTYTOFILE
```
public static final java.lang.String VERIFYPROPERTYTOFILE
```
    See Also:
    
    Constant Field Values
  - VERIFYPROPERTYCONTAINS
```
public static final java.lang.String VERIFYPROPERTYCONTAINS
```
    See Also:
    
    Constant Field Values
  - VERIFYTEXTFILETOFILE
```
public static final java.lang.String VERIFYTEXTFILETOFILE
```
    See Also:
    
    Constant Field Values
  - VERIFYVALUECONTAINS
```
public static final java.lang.String VERIFYVALUECONTAINS
```
    See Also:
    
    Constant Field Values
  - VERIFYVALUEEQUALS
```
public static final java.lang.String VERIFYVALUEEQUALS
```
    See Also:
    
    Constant Field Values
  - VERIFYVALUES
```
public static final java.lang.String VERIFYVALUES
```
    See Also:
    
    Constant Field Values
  - VERIFYVALUESIGNORECASE
```
public static final java.lang.String VERIFYVALUESIGNORECASE
```
    See Also:
    
    Constant Field Values
  - SETPROPERTYVALUE
```
public static final java.lang.String SETPROPERTYVALUE
```
    See Also:
    
    Constant Field Values
  - GETTEXTFROMGUI
```
public static final java.lang.String GETTEXTFROMGUI
```
    See Also:
    
    Constant Field Values
  - LOCATESCREENIMAGE
```
public static final java.lang.String LOCATESCREENIMAGE
```
    See Also:
    
    Constant Field Values
  - SAVETEXTFROMGUI
```
public static final java.lang.String SAVETEXTFROMGUI
```
    See Also:
    
    Constant Field Values
  - CLOSEWINDOW
```
public static final java.lang.String CLOSEWINDOW
```
    See Also:
    
    Constant Field Values
  - MAXIMIZE
```
public static final java.lang.String MAXIMIZE
```
    See Also:
    
    Constant Field Values
  - MINIMIZE
```
public static final java.lang.String MINIMIZE
```
    See Also:
    
    Constant Field Values
  - RESTORE
```
public static final java.lang.String RESTORE
```
    See Also:
    
    Constant Field Values
  - SELECTMENUITEM
```
public static final java.lang.String SELECTMENUITEM
```
    See Also:
    
    Constant Field Values
  - SELECTMENUITEMCONTAINS
```
public static final java.lang.String SELECTMENUITEMCONTAINS
```
    See Also:
    
    Constant Field Values
  - SETPOSITION
```
public static final java.lang.String SETPOSITION
```
    See Also:
    
    Constant Field Values
  - VERIFYMENUITEM
```
public static final java.lang.String VERIFYMENUITEM
```
    See Also:
    
    Constant Field Values
  - VERIFYMENUITEMCONTAINS
```
public static final java.lang.String VERIFYMENUITEMCONTAINS
```
    See Also:
    
    Constant Field Values
  - WAITFORGUI
```
public static final java.lang.String WAITFORGUI
```
    See Also:
    
    Constant Field Values
  - PARAM_UUID
```
public static final java.lang.String PARAM_UUID
```
    "UUID"
    
    See Also:
    
    Constant Field Values
  - PARAM_FILTER
```
public static final java.lang.String PARAM_FILTER
```
    "FILTER"
    
    See Also:
    
    Constant Field Values
  - PROPERTY_text
```
protected static final java.lang.String PROPERTY_text
```
    "text" property to grab item's label.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DOT_itemText
```
protected static final java.lang.String PROPERTY_DOT_itemText
```
    ".itemText" property for list and combobox to grab all the items.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_Items
```
protected static final java.lang.String PROPERTY_Items
```
    "Items", property to grab all the items for DotNet Control.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_innerText
```
protected static final java.lang.String PROPERTY_innerText
```
    "innerText" property to html element's content.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_textContent
```
protected static final java.lang.String PROPERTY_textContent
```
    "textContent" property to html element's content.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_innerHTML
```
protected static final java.lang.String PROPERTY_innerHTML
```
    "innerHTML", property to grab html element's content.
    
    See Also:
    
    Constant Field Values
  - TEST_DATA_SUFFIX
```
protected static final java.lang.String TEST_DATA_SUFFIX
```
    ".actual.txt", file suffix.
    
    See Also:
    
    Constant Field Values
  - OBJECT_DATA
```
protected static final java.lang.String OBJECT_DATA
```
    See Also:
    
    Constant Field Values
  - action
```
protected java.lang.String action
```
  - windowName
```
protected java.lang.String windowName
```
  - compName
```
protected java.lang.String compName
```
  - mapname
```
protected java.lang.String mapname
```
  - utils
```
protected DDGUIUtilities utils
```
  - iterator
```
protected java.util.Iterator<java.lang.String> iterator
```
  - altText
```
protected java.lang.String altText
```
  - RELATIVE_TO_SCREEN
```
public static final java.lang.String RELATIVE_TO_SCREEN
```
    'screen'
    
    See Also:
    
    Constant Field Values
  - RELATIVE_TO_PARENT
```
public static final java.lang.String RELATIVE_TO_PARENT
```
    'parent'
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ComponentFunction
```
public ComponentFunction()
```
    Purpose: constructor
- Method Detail
  - updateFromTestRecordData
```
protected void updateFromTestRecordData()
```
    Updates our internal storage for action, windowName, compName, and mapname from the current TestRecordData. Missing items in the TestRecordData will update our storage with null.
  - isSupportedRecordType
```
public boolean isSupportedRecordType(java.lang.String recordType)
```
    Supports standard TEST STEP record types (T, TW, TF)
    
    Specified by:
    
    isSupportedRecordType in class Processor
    
    Parameters:
    
    recordType - -- String text of record type to match (ignoring case).
    
    Returns:
    
    'true' if the provided recordType is one this Processor can execute. Note, that SAFS record types are normally not case-sensitive. So the comparison to match the provided recordType should ignore case.
  - getAlternateParams
```
public java.util.Collection<java.lang.String> getAlternateParams()
```
    Purpose: zero-based params with:
    1. windowname
    2. compname
    3. +N additional parameters
    Overrides:
    
    getAlternateParams in class Processor
    
    Returns:
    
    Collection
  - getHelpersWorker
```
protected void getHelpersWorker()
                         throws SAFSException
```
    set instance variables from the current testRecordData:
    - action
    - windowName
    - compName
    - mapname
    - utils
    Subclasses can override this for any additional setup beyond getHelpersWorker.
    Throws:
    
    SAFSException
  - getHelpers
```
protected void getHelpers()
                   throws SAFSException
```
    Simply calls getHelpersWorker. Subclasses can override this for any additional setup beyond getHelpersWorker.
    
    Throws:
    
    SAFSException
  - convertNum
```
public java.lang.Integer convertNum(java.lang.String num)
```
    Purpose: convertNum: convert into a number
    Assumptions: all exceptions are handled.
    
    Parameters:
    
    numStr, - String (indexed from 1, 1 will be subtracted from the number before returned)
    
    Returns:
    
    Integer if successful, null otherwise (if alpha chars instead of digits are encountered; or if number is less than one)
  - checkForCoord
```
protected java.awt.Point checkForCoord(java.util.Iterator<java.lang.String> iterator)
```
    Purpose: check 'iterator' for coords, either a map reference, or x;y notation and convert it into Point. The 'coords' could be provided in 2 formats:
    It could be number, such as "12, 15", "5, 10". Or it could be in percentage format, such as "30%, 45%", "0.25, 0.8". With this format, the method getComponentRectangle() should be provided in subclass, component's width and height are necessary to calculate the coordinate.
    
    Parameters:
    
    iterator - Iterator, whose next element is the coords parameter or map-reference
    
    Returns:
    
    java.awt.Point, null if iterator doesn't have another element
    
    See Also:
    
    checkForCoord(String), getComponentRectangle()
  - checkForCoord
```
protected java.awt.Point checkForCoord(java.lang.String coordinate)
```
    Purpose: check for coords, either a map reference, or x;y notation and convert it into Point. The 'coords' could be provided in 2 formats:
    It could be number, such as "12, 15", "5, 10". Or it could be in percentage format, such as "30%, 45%", "0.25, 0.8". With this format, the method getComponentRectangle() should be provided in subclass, component's width and height are necessary to calculate the coordinate.
    
    Parameters:
    
    coordinate - String, either an AppMap reference, or (x;y) notation
    
    Returns:
    
    java.awt.Point, null if coordinate is null or empty
    
    See Also:
    
    getComponentRectangle()
  - convertCoords
```
public java.awt.Point convertCoords(java.lang.String coords)
```
    Convert coordinates string of the formats:
    - "x;y"
    - "x,y"
    - "x y"
    - "Coords=x;y"
    - "Coords=x,y"
    - "Coords=x y"
    into a java.awt.Point object.
    Subclasses may override to convert alternative values, such as Row and Col values as is done in org.safs.rational.CFTable
    Parameters:
    
    coords, - String x;y or x,y or Coords=x;y or Coords=x,y
    
    Returns:
    
    Point if successful, null otherwise
  - convertLine
```
public java.awt.Polygon convertLine(java.lang.String coords)
```
    Convert 2-point Line coordinates string of the formats:
    - "x1;y1;x2;y2"
    - "x1,y1,x2,y2"
    - "x1 y1 x2 y2"
    - "Coords=x1;y1;x2;y2"
    - "Coords=x1,y1,x2,y2"
    - "Coords=x1 y1 x2 y2"
    into a java.awt.Polygon object.
    Parameters:
    
    coords, - String x1;y1;x2;y2 or x1,y1,x2,y2 or Coords=x1;y1;x2;y2 or Coords=x1,y1,x2,y2
    
    Returns:
    
    Polygon if successful, null otherwise
  - convertWindowPosition
```
public ComponentFunction.Window convertWindowPosition(java.lang.String windowPosition)
```
    Convert window's position-size-status string of the formats:
    - "x;y;width;height;status"
    - "x,y,width,height,status"
    - "x y width height status"
    - "Coords=x;y;width;height;Status=status"
    - "Coords=x,y,width,height,Status=status"
    - "Coords=x y width height Status=status"
    into a org.safs.ComponentFunction.Window object.
    Parameters:
    
    windowPosition - String, window's position-size-status string; or a map reference for window's status string.
    
    Returns:
    
    org.safs.ComponentFunction.Window if successful, null otherwise
  - lookupAppMapReference
```
protected java.lang.String lookupAppMapReference(java.lang.String referenceName)
```
    Looks up an item using the current appmapID=mapname, section=compName, item=referenceName. mapname and compName are expected to already be set from prior command processing.
    
    Parameters:
    
    referenceName -
    
    Returns:
    
    retrieved value or null
  - lookupAppMapCoordReference
```
protected java.awt.Point lookupAppMapCoordReference(java.lang.String referenceName)
```
    lookupAppMapCoordReference: uses 'convertCoords' after the call to 'lookupAppMapReference'.
    
    Parameters:
    
    referenceName, - String, the reference name passed on to method 'lookupAppMapReference' to lookup the coordinate string from an AppMap. Then that value is passed on to convertCoords.
    
    Returns:
    
    Point if successful, null otherwise (if alpha chars instead of digits are encountered; or if row or col less than one)
  - lookupAppMapLineReference
```
protected java.awt.Polygon lookupAppMapLineReference(java.lang.String referenceName)
```
    lookupAppMapLineReference: uses 'convertLine' after the call to 'lookupAppMapReference'.
    
    Parameters:
    
    referenceName, - String, the reference name passed on to method 'lookupAppMapReference' to lookup the Line string from an AppMap. Then that value is passed on to convertLine.
    
    Returns:
    
    Polygon if successful, null otherwise (if alpha chars instead of digits are encountered; or if less than 2 points are detected.)
  - lookupAppMapNumReference
```
protected java.lang.Integer lookupAppMapNumReference(java.lang.String referenceName)
```
    Purpose: lookupAppMapNumReference: uses 'convertNum' after the call to 'lookupAppMapReference'.
    
    Parameters:
    
    referenceName, - String, the reference name passed on to method 'lookupAppMapReference' to lookup the number string from an AppMap. Then that value is passed on to convertNum.
    
    Returns:
    
    Integer if successful, null otherwise (if alpha chars instead of digits are encountered; or if index is less than one)
  - ConvertWindowPosition
```
public static ComponentFunction.Window ConvertWindowPosition(java.lang.String windowPosition)
```
    Convert window's position-size-status string of the formats:
    - "x;y;width;height;status"
    - "x,y,width,height,status"
    - "x y width height status"
    - "Coords=x;y;width;height;Status=status"
    - "Coords=x,y,width,height,Status=status"
    - "Coords=x y width height Status=status"
    into a org.safs.ComponentFunction.Window object.
    Parameters:
    
    windowPosition - String, window's position-size-status string
    
    Returns:
    
    org.safs.ComponentFunction.Window if successful, null otherwise
  - restore
```
protected void restore()
                throws SAFSException
```
    Restore the current window.
    
    Throws:
    
    SAFSException
  - _restore
```
protected void _restore()
                 throws SAFSException
```
    Subclass should give its own implementation, if it is difficult then call this instead, but
    this implementation is not guarantee to work
    
    Throws:
    
    SAFSException
  - maximize
```
protected void maximize()
                 throws SAFSException
```
    Maximize the current window.
    
    Throws:
    
    SAFSException
  - _maximize
```
protected void _maximize()
                  throws SAFSException
```
    Subclass should give its own implementation, if it is difficult then call this instead, but
    this implementation is not guarantee to work
    
    Throws:
    
    SAFSException
  - minimize
```
protected void minimize()
                 throws SAFSException
```
    Minimize the current window.
    
    Throws:
    
    SAFSException
  - _minimize
```
protected void _minimize()
                  throws SAFSException
```
    Subclass should give its own implementation, if it is difficult then call this instead, but
    this implementation is not guarantee to work
    
    Throws:
    
    SAFSException
  - close
```
protected void close()
              throws SAFSException
```
    Close the current window.
    
    Throws:
    
    SAFSException
  - _close
```
protected void _close()
               throws SAFSException
```
    This implementation is NOT guarantee to work, if it works, it will happen on current focused window.
    Subclass should give its own implementation
    
    Throws:
    
    SAFSException
  - setPosition
```
protected void setPosition()
                    throws SAFSException
```
    perform SetPosition to move Main Window, resize it and set its status. Format: "Coords=0,0,640,480;Status=NORMAL". Status can be NORMAL, MINIMAZED and MAXMAZED Alteratively, semi-colon (;) can be used instead of comma (,) to separate numeric data. This would be required when placing the data directly in the test record and NOT in the App Map when using comma-delimited test tables.
    
    Throws:
    
    SAFSException
  - _setPosition
```
protected void _setPosition(java.awt.Point position)
                     throws SAFSException
```
    Subclass should give its own implementation
    
    Throws:
    
    SAFSException
  - _setSize
```
protected void _setSize(java.awt.Dimension size)
                 throws SAFSException
```
    Subclass should give its own implementation
    
    Throws:
    
    SAFSException
  - componentSuccessMessage
```
protected void componentSuccessMessage(java.lang.String detail)
```
    "windowName compName action successful." "[detail]"
    Purpose: Log a generic success message.
  - issuePassedSuccess
```
protected void issuePassedSuccess(java.lang.String comment)
```
    "windowName compName action successful. [comment]" Sets status to OK and issues a PASSED message. string comment is expected to already be localized. The comment can be empty, or null.
  - issuePassedSuccessUsing
```
protected void issuePassedSuccessUsing(java.lang.String using)
```
    "windowName compName action successful using [using]" Sets status to OK and issues a PASSED message. string comment is expected to already be localized, if necessary.
  - componentFailureMessage
```
protected void componentFailureMessage(java.lang.String detail)
```
    "Unable to perform action on compName in file line N." "[Detail]"
    Purpose: log an "Unable to perform function" FAILED_MESSAGE with detail. Expects testRecordData to already have filename, lineNumber, compName, and command.
  - componentExecutedFailureMessage
```
protected void componentExecutedFailureMessage(java.lang.String error)
```
    "windowname compName action processed with a negative result." "Error at line number in file: [detail]"
    Purpose: log a simple failure message when a test record got processed with negative result. When an action intends to make a judgment, a negative result is gotten if the logical result of the judgment is false; the test step will be logged as 'FAIL' although it got executed correctly. Called by some comparing actions. E.g. When doing verifyCaptureText, the result is negative if the body test captured doesn't match the bench mark file.
    
    Parameters:
    
    error - -- a error message
  - issueParameterCountFailure
```
protected void issueParameterCountFailure()
```
    Issue parameter count error and failure message
  - issueParameterCountFailure
```
protected void issueParameterCountFailure(java.lang.String detail)
```
    Issue parameter count error and failure message
    
    Parameters:
    
    detail - detail about specific missing params or command format
  - issueParameterValueFailure
```
protected void issueParameterValueFailure(java.lang.String paramName)
```
    Issue parameter value error and failure message
    
    Parameters:
    
    paramName - -- the Name of the action parameter in error.
  - issueFileErrorFailure
```
protected void issueFileErrorFailure(java.lang.String filename)
```
    Issue a file error and failure message Filename does not need to be localized.
  - issueUnknownErrorFailure
```
protected void issueUnknownErrorFailure(java.lang.String cause)
```
    Issue a generic error and failure message The cause parameter is expected to already be localized.
  - deduceImageRect
```
protected java.awt.Rectangle deduceImageRect(java.lang.String subareaMapKey)
                                      throws SAFSException
```
    Parameters:
    
    subareaMapKey, - String, the reference in Map file, represent the subarea; or the subarea itself. The subares is defined as (x, y, width, height) for example like (0, 0, %50, %90)
    
    Returns:
    
    Rectangle, The subarea rectangle deduced from the 'Component Rectangle' and 'subarea'
    
    Throws:
    
    SAFSException
    
    See Also:
    
    #lookupAppMapReference(String)}, #getComponentRectangle()}
  - getPossibleMapItem
```
protected java.lang.String getPossibleMapItem(java.lang.String mapKey)
```
  - action_getGuiImage
```
protected void action_getGuiImage()
                           throws SAFSException
```
    Processes a Component Function Test Record to capture a screen GUI image to a file. Currently, the available formats for the output file are JPG, BMP, TIF, GIF, PNG and PNM. Optionally, the user may utilize the SubArea parameter to only capture a portion of the Component. This routine expects to be called by subclasses only and the subclass must override the getComponentRectangle method to provide the necessary location of the desired Component. Subclasses must also have already set the fields for mapname, windowName, compName, and action. This is usually already done in the process() call from the subclasses. This routine utilizes Java Advanced Imaging (JAI) to output the screen image to the file. JAI must be installed at compile time and runtime.
    
    Throws:
    
    SAFSException
  - getUUIDBoolean
```
public static boolean getUUIDBoolean(java.lang.String parameter)
                              throws java.lang.Exception
```
    Check if the provided parameter is a UUID= flag.
    True if UUID=true|1|-1|on|yes. false otherwise. Unless an Exception is thrown.
    
    Parameters:
    
    parameter - to evaluate
    
    Returns:
    
    true/false value of the validated UUID flag, or throws the Exception.
    
    Throws:
    
    java.lang.Exception - if the parameter is bad or does NOT start with "UUID=" (case-insensitive).
    
    See Also:
    
    StringUtilities.convertBool(Object)
  - action_verifyGuiImageToFile
```
protected void action_verifyGuiImageToFile()
                                    throws SAFSException
```
    Processes a Component Function Test Record to verify a screen GUI image to a file. Currently, the available formats for the output file are BMP, JPG, TIFF, GIF, PNG, and PNM. Optionally, the user may utilize the SubArea parameter to only capture a portion of the Component. This routine expects to be called by subclasses only and the subclass must override the getComponentRectangle method to provide the necessary location of the desired Component. Subclasses must also have already set the fields for mapname, windowName, compName, and action. This is usually already done in the process() call from the subclasses. This routine utilizes Java Advanced Imaging (JAI) to output the screen image to the file. JAI must be installed at compile time and runtime.
    
    Throws:
    
    SAFSException
  - setRectVars
```
protected boolean setRectVars(java.awt.Rectangle rect,
                              java.lang.String varname)
```
    Set the varname.x, varname.y, varname.w, and varname.h variables to the values retrieved from the rectangle.
    
    Parameters:
    
    rect - Rectangle,
    
    varname - String,
    
    Returns:
  - setIterator
```
public void setIterator(java.util.Iterator<java.lang.String> iterator)
```
  - componentProcess
```
protected void componentProcess()
```
    Process generic actions on a component.
  - componentClick
```
protected void componentClick()
                       throws SAFSException
```
    Throws:
    
    SAFSException
  - executeScript
```
protected void executeScript()
                      throws SAFSException
```
    Throws:
    
    SAFSException
  - inputKeystrokes
```
protected void inputKeystrokes()
                        throws SAFSException
```
    Throws:
    
    SAFSException
  - action_ComputedStyle
```
protected void action_ComputedStyle(boolean verification)
                             throws SAFSException
```
    Throws:
    
    SAFSException
  - closeWindow
```
protected void closeWindow()
                    throws SAFSException
```
    Throws:
    
    SAFSException
  - verifyPropertyContains
```
protected void verifyPropertyContains()
                               throws SAFSException
```
    Throws:
    
    SAFSException
  - verifyValueContains
```
protected void verifyValueContains()
                            throws SAFSException
```
    Throws:
    
    SAFSException
  - verifyValues
```
protected void verifyValues()
                     throws SAFSException
```
    Throws:
    
    SAFSException
  - hoverScreenLocation
```
protected void hoverScreenLocation()
                            throws SAFSException
```
    Throws:
    
    SAFSException
  - isPropertyExist
```
protected void isPropertyExist()
                        throws SAFSException
```
    Throws:
    
    SAFSException
  - clearAppMapCache
```
protected void clearAppMapCache()
                         throws SAFSException
```
    Throws:
    
    SAFSException
  - normalizeFileEncoding
```
protected java.lang.String normalizeFileEncoding(java.lang.String encoding)
```
  - verifyObjectDataToFile
```
protected void verifyObjectDataToFile()
                               throws SAFSException
```
    Throws:
    
    SAFSException
  - captureObjectDataToFile
```
protected void captureObjectDataToFile()
                                throws SAFSException
```
    Throws:
    
    SAFSException
  - verifyFileToFile
```
protected void verifyFileToFile(boolean isTextFile)
                         throws SAFSException
```
    Parameters:
    
    isTextFile, - boolean, if true, then text files, else binary files
    
    Throws:
    
    SAFSException
  - guiDoesExist
```
protected void guiDoesExist(boolean does)
                     throws SAFSException
```
    Parameters:
    
    does - boolean, true if hope the GUI exist; false hope not exist.
    
    Throws:
    
    SAFSException
  - verifyPropertyToFile
```
protected void verifyPropertyToFile(boolean array)
                             throws SAFSException
```
    Purpose: verifyArrayPropertyToFile/verifyPropertyToFile/verifyPropertiesToFile
    
    Parameters:
    
    array - boolean, if true, then array property, else scalar
    
    Throws:
    
    SAFSException
  - verifyPropertiesToFile
```
protected void verifyPropertiesToFile()
                               throws SAFSException
```
    Purpose: verifyPropertiesToFile
    
    Parameters:
    
    array - boolean, if true, then array property, else scalar
    
    Throws:
    
    SAFSException
  - capturePropertyToFile
```
protected void capturePropertyToFile()
                              throws SAFSException
```
    Throws:
    
    SAFSException
  - capturePropertiesToFile
```
protected void capturePropertiesToFile()
                                throws SAFSException
```
    Throws:
    
    SAFSException
  - verifyClipboardToFile
```
protected void verifyClipboardToFile()
                              throws SAFSException
```
    Throws:
    
    SAFSException
  - hoverMouse
```
protected void hoverMouse()
                   throws SAFSException
```
    Purpose: Response for HOVERMOUSE; called by componentProcess() to hover mouse.
```
 Parameters:
 CoordinationMapKey String, The offset from 'Uper-Left corner' of component,
                            such as "20;40", or a mapKey defined under "ComponentName" or "ApplicationConstants" in map file.
 HoverTime int, milliseconds to hover
 support different format of test record:
  1. T, ClassicCD,      JavaTree,       HoverMouse
  2. T, ClassicCD,      JavaMenu,       HoverMouse,     myCoord
     --  In this case myCoord should be defined in the 'JavaMenu' section of the Application Map File like this:
     --  [JavaMenu]
     --  myCoord="10,10"
  3. T, ClassicCD,      JavaMenu,       HoverMouse,     "10;10"
  4. T, ClassicCD,      JavaTree,       HoverMouse,     "10;10", 4000
  5. T, ClassicCD,      JavaMenu,       HoverMouse,     , 3000
```
    Throws:
    
    SAFSException
  - setPropertyValue
```
protected void setPropertyValue()
                         throws SAFSException
```
    Throws:
    
    SAFSException
  - performScorll
```
protected void performScorll()
                      throws SAFSException
```
    Throws:
    
    SAFSException
  - selectMenuItem
```
protected void selectMenuItem(boolean fuzzy)
                       throws SAFSException
```
    Parameters:
    
    fuzzy, - false: select the menu item that exactly matches the given path
    
    Throws:
    
    SAFSException
  - verifyMenuItem
```
protected void verifyMenuItem(boolean fuzzy)
                       throws SAFSException
```
    Parameters:
    
    fuzzy, - to do exactly match if false, otherwise do fuzzy match
    
    Throws:
    
    SAFSException
  - performDrag
```
protected void performDrag()
                    throws SAFSException
```
    Throws:
    
    SAFSException
  - dragTo
```
protected void dragTo()
               throws SAFSException
```
    Throws:
    
    SAFSException
  - sendEvent
```
protected void sendEvent()
                  throws SAFSException
```
    Throws:
    
    SAFSException
  - action_GetSaveTextFromGUI
```
protected void action_GetSaveTextFromGUI()
                                  throws SAFSException
```
    Use OCR to detect the text from captured screen, executing SaveTextFromGUI or SaveTextFromGUI. T, Window, Component, SaveTextFromGUI, outputfile [,subArea] [,OCR option] [,LangId] [,scaleRatio] T, Window, Component,GetTextFromGUI, variable [,subArea][,OCR] [,LangId] [,scaleRatio]
    
    Throws:
    
    SAFSException
  - locateScreenImage
```
protected void locateScreenImage()
```
    Purpose: Response for HOVERMOUSE; called by componentProcess() to hover mouse.
```
 Parameters:
 VarName String, The root name of the collection of variables to receive the location and dimensions.
 WhomRelativeTo String, "screen" or "parent"
 T  WindowName  CompName  LocateScreenImage  VarName [WhomRelativeTo]
        [WhomRelativeTo]: relative to the screen or parentWindow
        default(not set): relative to the screen
                  screen: relative to the screen
                  parent: relative to the parent window

 locate the GUI if CompName in the GUI of WindowName and write the area to Varname

 variables set:
   varname=x y w h  (space delimited)
   varname.x=x
   varname.y=y
   varname.w=w
   varname.h=h
 
```
  - action_showOnPage
```
protected void action_showOnPage()
                          throws SAFSException
```
    Purpose: Show the component on the page as much as possible.
    
    Throws:
    
    SAFSException
  - clearCache
```
protected void clearCache()
                   throws SAFSException
```
    Throws:
    
    SAFSException
  - waitForGUI
```
protected void waitForGUI()
                   throws SAFSException
```
    Waits for the object to be present on the screen, waits up to the timeout defined in the parameters or a default of 15 seconds.
    
    Throws:
    
    SAFSException
  - verifyProperty
```
protected void verifyProperty()
                       throws SAFSException
```
    Purpose: verifyProperty
    
    Throws:
    
    SAFSException
  - assignPropertyVariable
```
protected void assignPropertyVariable()
                               throws SAFSException
```
    Throws:
    
    SAFSException
  - waitForObject
```
protected int waitForObject(java.lang.String mapname,
                            java.lang.String windowName,
                            java.lang.String compName,
                            int secii)
                     throws SAFSException
```
    Throws:
    
    SAFSException
  - normalizePropertyCollection
```
public static java.util.Collection<java.lang.String> normalizePropertyCollection(java.util.Collection<java.lang.String> properties,
                                                                                 java.lang.String encoding)
```
    A Collection contains the value of a property. If the value contains:
```
   StringUtils.CRLF,
   StringUtils.CARRIAGE_RETURN,
   StringUtils.NEW_LINE,
 
```
    by calling this method, this value will be broke into several values according to those line breaks.
    Each of these values will be stored as an item in the new collection. (The old collection contains
    these values as ONE item containing all the various linebreaks.)
    Parameters:
    
    properties - Collection, a collection of properties to normalize
    
    encoding - String, the encoding used to write and read a collection of properties
    
    Returns:
    
    Collection, a normalized collection of properties
    
    See Also:
    
    getPropertyCollection(List), getPropertyCollection(String), verifyPropertyToFile(boolean)
  - getPropertyCollection
```
protected java.util.Collection<java.lang.String> getPropertyCollection(java.lang.String property)
                                                                throws SAFSException
```
    Get the value of a property, and return it as a Collection.
    
    Parameters:
    
    property - String, the property name
    
    Returns:
    
    Collection, a set containing the property's value
    
    Throws:
    
    SAFSException
  - getPropertyCollection
```
protected java.util.Collection<java.lang.String> getPropertyCollection(java.util.List<java.lang.String> propertyList)
                                                                throws SAFSException
```
    Get the value of property, and return them as a Collection.
    If the property-list contains only ONE property, the collection will contain only its value.
    If the property-list contains multiple properties, the collection will contain a set of string like "property:value".
    The assignment separator will actually be the current value of the testRecordData.separator. If the property-list is null, then all the properties should be retrieved.
    
    Parameters:
    
    propertyList - List, a list of property names
    
    Returns:
    
    Collection, a set of values
    
    Throws:
    
    SAFSException
  - getStringValue
```
protected java.lang.String getStringValue(java.lang.Object value)
                                   throws SAFSException
```
    Get the string value from the Object value.
    If the value is a collection, it will be converted to a string separated by 'New Line'.
    
    Throws:
    
    SAFSException
  - getProperty
```
protected java.lang.String getProperty(java.lang.String propertyName)
                                throws SAFSException
```
    Get component's property string value
    
    Throws:
    
    SAFSException
  - getProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getProperties()
                                                                  throws SAFSException
```
    Returns:
    
    Map, a map of (property, value) for all properties of the component. It may be null or empty.
    
    Throws:
    
    SAFSException
  - getPropertyObject
```
protected java.lang.Object getPropertyObject(java.lang.String propertyName)
                                      throws SAFSException
```
    Returns:
    
    Object, component's property object value
    
    Throws:
    
    SAFSException
  - captureObjectData
```
protected java.util.Collection<java.lang.String> captureObjectData()
                                                            throws SAFSException
```
    Returns:
    
    Collection, component's content. It may be null or empty.
    
    Throws:
    
    SAFSException
  - getWindowRectangleOnScreen
```
protected java.awt.Rectangle getWindowRectangleOnScreen()
```
    Get the absolute 'Rectangle bounds' of the Window, which means the rectangle is relative to the
    whole screen.
    
    Returns:
    
    Rectangle, 'Rectangle bounds' of the Window
  - getComponentRectangleOnScreen
```
protected java.awt.Rectangle getComponentRectangleOnScreen()
```
    Get the absolute 'Rectangle bounds' of the Component, which means the rectangle is relative to the
    whole screen, NOT to a window/browser.
    
    Returns:
    
    Rectangle, 'Rectangle bounds' of the Component
  - showComponentAsMuchPossible
```
protected boolean showComponentAsMuchPossible(boolean verify)
                                       throws SAFSException
```
    If the component is not fully shown on the screen, try to make it visible on screen as much as possible.
    
    Parameters:
    
    verify - boolean, verify that the component is shown on page if verify is true.
    
    Returns:
    
    boolean, true if the component is shown on page; false otherwise.
    
    Throws:
    
    SAFSException - if some unexpected things happen.
  - getComponentRectangle
```
protected java.awt.Rectangle getComponentRectangle()
```
    Do nothing method returns null. Subclasses should override to provide the 'Rectangle bounds' of the Component currently represented in the current testRecordData. The 'Rectangle bounds' may be absolute on screen or relative to a window/browser, this is decided by subclass. If returned 'Rectangle bounds' is NOT absolute on screen, the the method getRectangleImage(Rectangle) SHOULD be overridden in subclass to provide appropriate implementation.
    Subclasses should assume the mapname, windowName, and compName currently stored for the instance hold the information needed to identify and locate the Component on the screen or in the system.
    This method is called by deduceImageRect(String) to get a subarea rectangle.
    
    Returns:
    
    Rectangle bounds of the Component or null.
    
    See Also:
    
    deduceImageRect(String)
  - getRectangleImage
```
protected java.awt.image.BufferedImage getRectangleImage(java.awt.Rectangle imageRect)
                                                  throws SAFSException
```
    Get BufferedImage within a rectangle.
    The rectangle may be absolute on screen, Or it may be relative to a browser or something.
    It depends on what is returned by getComponentRectangle().
    This method assume the rectangle is absolute on screen, so get the image on screen within the rectangle.
    Sub class may override this method to get its own image.
    
    Parameters:
    
    imageRect - Rectangle, within the rectangle to get image.
    
    Returns:
    
    BufferedImage
    
    Throws:
    
    SAFSException
    
    See Also:
    
    #getComponentRectangle()}, deduceImageRect(String)
  - exist
```
protected boolean exist()
                 throws SAFSException
```
    To test if the component exists or not.
    The sub class may test the component's visibility also.
    
    Returns:
    
    boolean, true if the component GUI exist; false otherwise.
    
    Throws:
    
    SAFSException
  - performHoverMouse
```
protected boolean performHoverMouse(java.awt.Point point,
                                    int milliseconds)
                             throws SAFSException
```
    Purpose: perform hovering mouse at 'point' for 'milliseconds' period on a Component.
    Subclass may need to give a specific implementation by tools (RJ, Selenium etc.) API.
    
    Parameters:
    
    point - Point, coordinate relative to the component to hover at. null if hover the center.
    
    milliseconds - int, time to hover, in milliseconds
    
    Returns:
    
    boolean, true if hover successful; false otherwise
    
    Throws:
    
    SAFSException

Class ComponentFunction

Nested Class Summary

Field Summary

Fields inherited from class org.safs.Processor

Constructor Summary

Method Summary

Methods inherited from class org.safs.Processor

Methods inherited from class java.lang.Object

Field Detail

ALTCLICK

CLICK

COMPONENTCLICK

CTRLCLICK

CTRLRIGHTCLICK

DOUBLECLICK

MOUSECLICK

RIGHTCLICK

SHIFTCLICK

HSCROLLTO

VSCROLLTO

ALTLEFTDRAG

CTRLALTLEFTDRAG

CTRLLEFTDRAG

CTRLSHIFTLEFTDRAG

LEFTDRAG

RIGHTDRAG

SHIFTLEFTDRAG

ASSIGNPROPERTYVARIABLE

CAPTUREOBJECTDATATOFILE

CAPTUREPROPERTIESTOFILE

CAPTUREPROPERTYTOFILE

CLEARAPPMAPCACHE

GUIDOESEXIST

GUIDOESNOTEXIST

GETGUIIMAGE

HOVERMOUSE

INPUTCHARACTERS

INPUTKEYS

ISPROPERTYEXIST

SENDEVENT

VERIFYARRAYPROPERTYTOFILE

VERIFYBINARYFILETOFILE

VERIFYCLIPBOARDTOFILE

VERIFYFILETOFILE

VERIFYGUIIMAGETOFILE

VERIFYOBJECTDATATOFILE

VERIFYPROPERTY

VERIFYPROPERTYTOFILE

VERIFYPROPERTYCONTAINS

VERIFYTEXTFILETOFILE

VERIFYVALUECONTAINS

VERIFYVALUEEQUALS

VERIFYVALUES

VERIFYVALUESIGNORECASE

SETPROPERTYVALUE

GETTEXTFROMGUI

LOCATESCREENIMAGE

SAVETEXTFROMGUI

CLOSEWINDOW

MAXIMIZE

MINIMIZE

RESTORE

SELECTMENUITEM

SELECTMENUITEMCONTAINS

SETPOSITION

VERIFYMENUITEM

VERIFYMENUITEMCONTAINS

WAITFORGUI

PARAM_UUID

PARAM_FILTER

PROPERTY_text

PROPERTY_DOT_itemText

PROPERTY_Items

PROPERTY_innerText

PROPERTY_textContent

PROPERTY_innerHTML

TEST_DATA_SUFFIX

OBJECT_DATA

action

windowName