CFComponent (SAFS API DOCUMENT)

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

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Direct Known Subclasses:

CFButton, CFCheckBox, CFComboBox, CFDatabase, CFFlexColor, CFFlexDate, CFFlexNumericStepper, CFFlexSlider, CFHtmlDocument, CFHtmlImage, CFHtmlLink, CFLabel, CFList, CFMenuBar, CFPageTabList, CFScrollBar, CFTable, CFText, CFToolBar, CFTree, CFWPFLabel, CFWPFSlider
```
public class CFComponent
extends ComponentFunction
```
CFComponent, process a generic component to handle Generic Master Keywords and Generic Object Keywords

Nested Class Summary
- Nested classes/interfaces inherited from class org.safs.ComponentFunction
  ComponentFunction.Window

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`keepEncodingConsistent` Keywords like CaptureXXXXX, will write file with different encoding before. To keep them consistent, we let them to use the same default encoding But this will affect the old test, this option is used to tell if we use consistent encoding for these keywords Default, we should let it as true to use consistent encoding. See defect S0751446.
`protected TestObject`	`obj1`
`protected Script`	`script`
`protected TestObject`	`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

CFComponent()

Purpose: constructor, calls super

Constructors
Constructor and Description
`CFComponent()` Purpose: constructor, calls super

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_maximize()` Purpose: maximize
`protected void`	`_minimize()` Purpose: minimize
`protected void`	`_restore()` Purpose: restore
`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 java.util.List`	`captureObjectData(TestObject table)` Captures the object data into a List.
`protected void`	`captureObjectDataToFile()` A generic implementation for CaptureObjectDataToFile.
`protected void`	`capturePropertiesToFile()` Purpose: capturePropertiesToFile
`protected void`	`capturePropertyToFile()` Purpose: capturePropertyToFile Note: for now, the value of the parameter is meaningless because the value of the property inferrs if it is an array or not.
`protected void`	`clearAppMapCache()` Purpose: clearAppMapCache
`protected void`	`closeWindow()` Purpose: closeWindow
`protected void`	`componentClick()` Checks for optional coords parameter and then routes to performClick.
`protected java.lang.String`	`convertObjectValueToString(java.lang.Object value)` Given an object of any type attempt to convert or extract its intended or visible text value.
`protected boolean`	`exist()` To test if the component exists or not. The sub class may test the component's visibility also.
`protected Tree`	`extractTreeItemsSub(java.lang.Object nitem)` Extract a 'Tree' hierarchy from a TestObject.
`protected TestObject[]`	`findMenuBars(TestObject guiObj)` Note: Only java-swing and .NET are supported.
`protected java.lang.String`	`formatObjectData(java.util.List list)` Format the List data into a single String.
`protected TopLevelTestObject`	`getAppletsBrowser(GuiTestObject guiObj)` getParentBrowser Given a component assumed to be inside an Applet, we will attempt to locate the TopLevelTestObject in the "Html" domain that has the containing Java Plug-in object overlapping the same screen location.
`protected java.awt.Rectangle`	`getComponentRectangle()` Return the component's screen bounds.
`protected java.awt.Rectangle`	`getComponentRectangleOnScreen()` Return the component's screen bounds.
`protected void`	`getHelpers()` Simply calls getHelpersWorker.
`boolean`	`getKeepEncodingConsistent()`
`protected java.lang.Object`	`getObjectProperty(TestObject o, java.lang.String prop)` get the RFT value of a property or an indexed property as in rowLabel(0)
`protected java.lang.Object`	`getObjectPropertyFromProperties(TestObject o, java.lang.String prop)` Attempt to extract a property value from the Hashtable provided from getProperties().
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getProperties()`
`protected java.lang.Object`	`getPropertyObject(java.lang.String propertyName)`
`protected java.lang.Object`	`getUserObject(java.lang.Object obj, java.lang.Integer level)` Purpose: getUserObject, should be overridden by children.
`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`	`inputKeystrokes()` Purpose: inputkeys and inputcharacters
`protected static boolean`	`isDotnetDomain(TestObject tobj)`
`protected static boolean`	`isFlexDomain(TestObject tobj)`
`protected static boolean`	`isHtmlDomain(TestObject tobj)`
`protected static boolean`	`isJavaDomain(TestObject tobj)`
`protected static boolean`	`isSwtDomain(TestObject tobj)`
`protected boolean`	`isSWTWidget(TestObject theobj)` Determine if the TestObject is an Eclipse SWT component.
`protected static boolean`	`isWinDomain(TestObject tobj)`
`protected void`	`listAllProperties(TestObject obj)` Purpose: list all TestObject properties, using listProperties and listNonValueProperties
`protected void`	`listAllProperties(TestObject obj, java.lang.String str)` Purpose: list all TestObject properties, using listProperties and listNonValueProperties
`protected void`	`listMethods(TestObject obj)` Purpose: list TestObject methods
`protected void`	`listNonValueProperties(TestObject obj)` Purpose: list 'non-value' TestObject properties
`protected void`	`listProperties(TestObject obj)` Purpose: list 'regular' TestObject properties
`protected void`	`localProcess()` no implementation, just here so that our children know the 'protected' interface
`protected java.lang.String`	`matchedPathOfMenuItem(GuiTestObject guiObj, java.lang.String path, boolean fuzzy, java.lang.String status)` Note: guiObj is a GuiSubitemTestObject in Java or DotNet domains; a FlexMenuBarTestObject in Flex domain.
`protected void`	`mouseClick(GuiTestObject gto, java.awt.Point clickPoint)` Attempt to click an object by mouse event.
`protected java.lang.Object`	`parseWhereInfo(java.lang.String whereinfo)` Parse a string to determine 'where' something should happen on a given component.
`protected void`	`performClick(java.lang.Object point)` Perform a standard Click, RightClick, or DoubleClick on the component.
`protected void`	`performDrag()` perform LeftDrag or RightDrag on component moving from (x1,y1) to (x2,y2).
`protected boolean`	`performHoverMouse(java.awt.Point point, int miliseconds)` 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()` Purpose: Drag a compenent horizontally or vertically Note: If TestObject 'obj1' represent a GuiSubitemTestObject, then use the RFT API setState method; This method will consider the position as a relative value.
`void`	`process()` Purpose: do the processing.
`protected void`	`selectMenuItem(boolean fuzzy)` perform SelectMenuItem and SelectMenuItemContains
`protected void`	`sendEvent()` send an event to the object--assuming it supports receiving events.
`protected void`	`sendFlexEvent()` called from sendEvent for Flex Domain sendEvent handling.
`void`	`setKeepEncodingConsistent()`
`protected void`	`setPropertyValue()` Purpose: setPropertyValue Note: Log the original value the the property; Set the new value to this property.
`protected Tree`	`tobj(TestObject nitem)` Purpose: extract a 'Tree' hierarchy from a TestObject using recursion; The item is for JTree node.
`protected void`	`verifyClipboardToFile()` Purpose: verifyClipboardToFile
`protected void`	`verifyFileToFile(boolean text)` Purpose: verifyFileToFile
`protected void`	`verifyMenuItem(boolean fuzzy)` perform actions for keywords verifyMenuItem and verifyMenuItemContains
`protected void`	`verifyObjectDataToFile()` Purpose: verifyObjectDataToFile
`protected void`	`verifyPropertyContains()` Purpose: verifyPropertyContains
`protected void`	`verifyPropertyToFile(boolean array)` Purpose: verifyArrayPropertyToFile/verifyPropertyToFile
`protected void`	`verifyValueContains()` Purpose: verifyValueContains
`protected void`	`verifyValues()` Purpose: verifyValues, verifyValuesIgnoreCase, verifyValueEquals

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, convertCoords, 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
  - script
```
protected Script script
```
  - winObject
```
protected TestObject winObject
```
  - obj1
```
protected TestObject obj1
```
  - keepEncodingConsistent
```
protected boolean keepEncodingConsistent
```
    Keywords like CaptureXXXXX, will write file with different encoding before.
    To keep them consistent, we let them to use the same default encoding
    But this will affect the old test, this option is used to tell if we use consistent
    encoding for these keywords
    Default, we should let it as true to use consistent encoding.
    See defect S0751446.
- Constructor Detail
  - CFComponent
```
public CFComponent()
```
    Purpose: constructor, calls super
- Method Detail
  - setKeepEncodingConsistent
```
public void setKeepEncodingConsistent()
```
  - getKeepEncodingConsistent
```
public boolean getKeepEncodingConsistent()
```
  - getHelpers
```
protected void getHelpers()
                   throws SAFSException
```
    Description copied from class: ComponentFunction
    
    Simply calls getHelpersWorker. Subclasses can override this for any additional setup beyond getHelpersWorker.
    
    Overrides:
    
    getHelpers in class ComponentFunction
    
    Throws:
    
    SAFSException
  - process
```
public void process()
```
    Purpose: do the processing. Children of us can us this method to call their own 'localProcess' method
    Assumptions:
    sequence:
    testRecordData.setStatusCode(StatusCodes.SCRIPT_NOT_EXECUTED);
    localProcess();
    if (testRecordData.getStatusCode() === StatusCodes.SCRIPT_NOT_EXECUTED) {
    componentProcess(); // CFComponent will do the work
    }
    
    Overrides:
    
    process in class Processor
  - localProcess
```
protected void localProcess()
```
    no implementation, just here so that our children know the 'protected' interface
  - parseWhereInfo
```
protected java.lang.Object parseWhereInfo(java.lang.String whereinfo)
```
    Parse a string to determine 'where' something should happen on a given component. This is generally x,y coordinates, but subclasses can override this to provide other options. This is most often called by the CLICK commands.
    Supported formats of whereinfo:
    - Coords=x,y
    - x,y (same as Coords=x,y)
    - Coords=x;y
    - x;y (same as Coords=x;y)
    Parameters:
    
    whereinfo - String usually retrieved from the test table.
    
    Returns:
    
    java.awt.Point or null. Subclasses may return other object types as they deem appropriate.
  - sendFlexEvent
```
protected void sendFlexEvent()
```
    called from sendEvent for Flex Domain sendEvent handling.
  - sendEvent
```
protected void sendEvent()
                  throws SAFSException
```
    send an event to the object--assuming it supports receiving events. Initially, this is being implemented to support the Flex "performAction" functionality, but this can readily be expanded to other component types and technologies.
    In general, the command as initially implemented for Flex expects there to be an event name followed by 0 or more parameters. These parameters will be different and defined by the event or technology.
    
    Overrides:
    
    sendEvent in class ComponentFunction
    
    Throws:
    
    SAFSException
  - selectMenuItem
```
protected void selectMenuItem(boolean fuzzy)
                       throws SAFSException
```
    perform SelectMenuItem and SelectMenuItemContains
    
    Overrides:
    
    selectMenuItem in class ComponentFunction
    
    Parameters:
    
    fuzzy, - false: select the menu item that exactly matches the gaven path
    
    Throws:
    
    SAFSException
  - verifyMenuItem
```
protected void verifyMenuItem(boolean fuzzy)
                       throws SAFSException
```
    perform actions for keywords verifyMenuItem and verifyMenuItemContains
    
    Overrides:
    
    verifyMenuItem in class ComponentFunction
    
    Parameters:
    
    fuzzy, - to do exactly match if false, otherwise do fuzzy match
    
    Throws:
    
    SAFSException
  - performDrag
```
protected void performDrag()
                    throws SAFSException
```
    perform LeftDrag or RightDrag on component moving from (x1,y1) to (x2,y2). Format: "T,SwingApp,component,LeftDrag,"Coords=x1;y1;x2;y2"
    
    Overrides:
    
    performDrag in class ComponentFunction
    
    Throws:
    
    SAFSException
  - matchedPathOfMenuItem
```
protected java.lang.String matchedPathOfMenuItem(GuiTestObject guiObj,
                                                 java.lang.String path,
                                                 boolean fuzzy,
                                                 java.lang.String status)
                                          throws SAFSException
```
    Note: guiObj is a GuiSubitemTestObject in Java or DotNet domains; a FlexMenuBarTestObject in Flex domain.
    
    Throws:
    
    SAFSException
  - findMenuBars
```
protected TestObject[] findMenuBars(TestObject guiObj)
```
    Note: Only java-swing and .NET are supported.
    
    Parameters:
    
    guiObj - A test object represents an application window from which we try to get menu bars.
    
    Returns:
    
    An array of MenuBars found from parameter guiObj
  - componentClick
```
protected void componentClick()
```
    Checks for optional coords parameter and then routes to performClick. Some subclasses may add additional functionality for the optional argument string. For example, CFTable supports "Row=n;Col=n". Subclasses may override componentClick or other methods to detect such extensions and route accordingly.
    
    Overrides:
    
    componentClick in class ComponentFunction
  - performClick
```
protected void performClick(java.lang.Object point)
```
    Perform a standard Click, RightClick, or DoubleClick on the component. Subclasses may override this param
    
    Parameters:
    
    point - java.awt.Point x,y coords relative to the component or null.
  - closeWindow
```
protected void closeWindow()
```
    Purpose: closeWindow
    
    Overrides:
    
    closeWindow in class ComponentFunction
  - _restore
```
protected void _restore()
                 throws SAFSException
```
    Purpose: restore
    
    Overrides:
    
    _restore in class ComponentFunction
    
    Throws:
    
    SAFSException
  - _setPosition
```
protected void _setPosition(java.awt.Point position)
                     throws SAFSException
```
    Description copied from class: ComponentFunction
    
    Subclass should give its own implementation
    
    Overrides:
    
    _setPosition in class ComponentFunction
    
    Throws:
    
    SAFSException
  - _setSize
```
protected void _setSize(java.awt.Dimension size)
                 throws SAFSException
```
    Description copied from class: ComponentFunction
    
    Subclass should give its own implementation
    
    Overrides:
    
    _setSize in class ComponentFunction
    
    Throws:
    
    SAFSException
  - _minimize
```
protected void _minimize()
                  throws SAFSException
```
    Purpose: minimize
    
    Overrides:
    
    _minimize in class ComponentFunction
    
    Throws:
    
    SAFSException
  - _maximize
```
protected void _maximize()
                  throws SAFSException
```
    Purpose: maximize
    
    Overrides:
    
    _maximize in class ComponentFunction
    
    Throws:
    
    SAFSException
  - mouseClick
```
protected void mouseClick(GuiTestObject gto,
                          java.awt.Point clickPoint)
```
    Attempt to click an object by mouse event. MouseClick uses low level RFT's API (emitLowLevelEvent).
    
    Parameters:
    
    gto - - GuiTestObject
    
    clickPoint - - Point as location, default center
  - getObjectPropertyFromProperties
```
protected java.lang.Object getObjectPropertyFromProperties(TestObject o,
                                                           java.lang.String prop)
```
    Attempt to extract a property value from the Hashtable provided from getProperties(). This is sometimes useful if getProperty does NOT return a specific property's value but getProperties does!
    
    Parameters:
    
    o - - TestObject to get property from
    
    prop - - property to seek
    
    Returns:
    
    null or Object value
  - getObjectProperty
```
protected java.lang.Object getObjectProperty(TestObject o,
                                             java.lang.String prop)
                                      throws PropertyNotFoundException
```
    get the RFT value of a property or an indexed property as in rowLabel(0)
    
    Parameters:
    
    o - - TestObject to get property from
    
    prop - - property to seek, can be an indexed property like rowLabel(0)
    
    Returns:
    
    null or Object value or PropertyNotFoundException
    
    Throws:
    
    PropertyNotFoundException
  - verifyPropertyContains
```
protected void verifyPropertyContains()
                               throws SAFSException
```
    Purpose: verifyPropertyContains
    
    Overrides:
    
    verifyPropertyContains in class ComponentFunction
    
    Throws:
    
    SAFSException
  - verifyValueContains
```
protected void verifyValueContains()
                            throws SAFSException
```
    Purpose: verifyValueContains
    
    Overrides:
    
    verifyValueContains in class ComponentFunction
    
    Throws:
    
    SAFSException
  - verifyValues
```
protected void verifyValues()
                     throws SAFSException
```
    Purpose: verifyValues, verifyValuesIgnoreCase, verifyValueEquals
    
    Overrides:
    
    verifyValues in class ComponentFunction
    
    Throws:
    
    SAFSException
  - getProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getProperties()
                                                                  throws SAFSException
```
    Overrides:
    
    getProperties in class ComponentFunction
    
    Returns:
    
    Map<String, Object>, a map of (property, value) for all properties of the component. It may be null or empty.
    
    Throws:
    
    SAFSException - "Not supported yet."
  - getPropertyObject
```
protected java.lang.Object getPropertyObject(java.lang.String propertyName)
                                      throws SAFSException
```
    Overrides:
    
    getPropertyObject in class ComponentFunction
    
    Returns:
    
    Object, component's property object value
    
    Throws:
    
    SAFSException - "Not supported yet."
  - clearAppMapCache
```
protected void clearAppMapCache()
```
    Purpose: clearAppMapCache
    
    Overrides:
    
    clearAppMapCache in class ComponentFunction
  - inputKeystrokes
```
protected void inputKeystrokes()
                        throws SAFSException
```
    Purpose: inputkeys and inputcharacters
    
    Overrides:
    
    inputKeystrokes in class ComponentFunction
    
    Throws:
    
    SAFSException
  - verifyObjectDataToFile
```
protected void verifyObjectDataToFile()
                               throws SAFSException
```
    Purpose: verifyObjectDataToFile
    
    Overrides:
    
    verifyObjectDataToFile in class ComponentFunction
    
    Throws:
    
    SAFSException
  - convertObjectValueToString
```
protected java.lang.String convertObjectValueToString(java.lang.Object value)
                                               throws SAFSException
```
    Given an object of any type attempt to convert or extract its intended or visible text value. This function is intended to be overridden as necessary by subclasses and\or custom classes to extend the number of supported objects that can have their visible text extracted. This implementation handles:
    
    String = value.toString() TestObject = RGuiObjectRecognition.getText(value) Handling something other than these must be done in subclasses.
    
    Parameters:
    
    value - String or TestObject to get the text from
    
    Returns:
    
    String or null -- may be object.toString() which might not be desired.
    
    Throws:
    
    SAFSException
    
    See Also:
    
    RGuiObjectRecognition.getText(TestObject)
  - captureObjectData
```
protected java.util.List captureObjectData(TestObject table)
                                    throws java.lang.IllegalArgumentException,
                                           SAFSException
```
    Captures the object data into a List. This is generally for the CaptureObjectDataToFile and VerifyObjectDataToFile commands. Subclasses may provide this as a single List, or a List of Lists for 2D arrays. This implementation assumes the List is a single Object item. We extract the "text" or "itemText" property from the TestObject.
    
    Parameters:
    
    table - TestObject to snapshot data from.
    
    Returns:
    
    List containing a single Object item. Null if an invalid table reference is provided or some other error occurs.
    
    Throws:
    
    SAFSException
    
    java.lang.IllegalArgumentException - if table is not an acceptable TestObject.
  - formatObjectData
```
protected java.lang.String formatObjectData(java.util.List list)
                                     throws java.lang.IllegalArgumentException
```
    Format the List data into a single String. This String may include whatever formatting like Tabs, line separators, etc. are needed for the command being executed. This is generally for the CaptureObjectDataToFile and VerifyObjectDataToFile commands. Subclasses may need to override this method as appropriate for these commands.
    In this implementation the List is expected to be a single Object provided by captureObjectData. This Object has typically been a Rational NameSet of Strings, a Java Collection of Strings, or a simple Object on which we use toString().
    Each final item(s) in the List will be output using the toString().trim() method.
    It is expected the data is ready for writing to a file or other similar use without further modification.
    
    Parameters:
    
    list - List returned from captureObjectData
    
    Returns:
    
    String formatted for writing to file or screen.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the List or the Object extracted from the List are null.
    
    See Also:
    
    captureObjectData(TestObject)
  - performHoverMouse
```
protected boolean performHoverMouse(java.awt.Point point,
                                    int miliseconds)
                             throws SAFSException
```
    Description copied from class: ComponentFunction
    
    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.
    
    Overrides:
    
    performHoverMouse in class ComponentFunction
    
    Parameters:
    
    point - Point, coordinate relative to the component to hover at. null if hover the center.
    
    miliseconds - int, time to hover, in milliseconds
    
    Returns:
    
    boolean, true if hover successful; false otherwise
    
    Throws:
    
    SAFSException
  - captureObjectDataToFile
```
protected void captureObjectDataToFile()
                                throws SAFSException
```
    A generic implementation for CaptureObjectDataToFile. Provides the primary implementation for validating the filename and writing the data to the specified file. Calls the functions captureObjectData then formatObjectData allowing subclasses like CFTable to override the data capturing and formatting functionality. The String retrieved from formatObjectData is written to the specified file unmodified.
    
    Overrides:
    
    captureObjectDataToFile in class ComponentFunction
    
    Throws:
    
    SAFSException
    
    See Also:
    
    captureObjectData(TestObject), formatObjectData(java.util.List)
  - capturePropertiesToFile
```
protected void capturePropertiesToFile()
                                throws SAFSException
```
    Purpose: capturePropertiesToFile
    
    Overrides:
    
    capturePropertiesToFile 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
  - getWindowRectangleOnScreen
```
protected java.awt.Rectangle getWindowRectangleOnScreen()
```
    Description copied from class: ComponentFunction
    
    Get the absolute 'Rectangle bounds' of the Window, which means the rectangle is relative to the
    whole screen.
    
    Overrides:
    
    getWindowRectangleOnScreen in class ComponentFunction
    
    Returns:
    
    Rectangle, 'Rectangle bounds' of the Window
  - getComponentRectangleOnScreen
```
protected java.awt.Rectangle getComponentRectangleOnScreen()
```
    Return the component's screen bounds.
    
    Overrides:
    
    getComponentRectangleOnScreen in class ComponentFunction
    
    Returns:
    
    Rectangle, 'Rectangle bounds' of the Component
  - getComponentRectangle
```
protected java.awt.Rectangle getComponentRectangle()
```
    Return the component's screen bounds.
    
    Overrides:
    
    getComponentRectangle in class ComponentFunction
    
    Returns:
    
    Rectangle bounds of the Component or null.
    
    See Also:
    
    ComponentFunction.deduceImageRect(String)
  - exist
```
protected boolean exist()
                 throws SAFSException
```
    Description copied from class: ComponentFunction
    
    To test if the component exists or not.
    The sub class may test the component's visibility also.
    
    Overrides:
    
    exist in class ComponentFunction
    
    Returns:
    
    boolean, true if the component GUI exist; false otherwise.
    
    Throws:
    
    SAFSException
  - verifyPropertyToFile
```
protected void verifyPropertyToFile(boolean array)
                             throws SAFSException
```
    Purpose: verifyArrayPropertyToFile/verifyPropertyToFile
    
    Overrides:
    
    verifyPropertyToFile in class ComponentFunction
    
    Parameters:
    
    array, - boolean, if true, then array property, else scalar
    Note: for now, the value of the parameter is meaningless because the value of the property inferrs if it is an array or not.
    
    Throws:
    
    SAFSException
  - capturePropertyToFile
```
protected void capturePropertyToFile()
                              throws SAFSException
```
    Purpose: capturePropertyToFile
    Note: for now, the value of the parameter is meaningless because the value of the property inferrs if it is an array or not.
    
    Overrides:
    
    capturePropertyToFile in class ComponentFunction
    
    Throws:
    
    SAFSException
  - verifyClipboardToFile
```
protected void verifyClipboardToFile()
                              throws SAFSException
```
    Purpose: verifyClipboardToFile
    
    Overrides:
    
    verifyClipboardToFile in class ComponentFunction
    
    Throws:
    
    SAFSException
  - setPropertyValue
```
protected void setPropertyValue()
```
    Purpose: setPropertyValue Note: Log the original value the the property; Set the new value to this property. Note that this directly modifies the object in the software under test; therefore, it should be done with extreme care. Avoid using setProperty whenever possible because it allows you to modify the software under test in ways that a typical user cannot.
    
    Overrides:
    
    setPropertyValue in class ComponentFunction
  - performScorll
```
protected void performScorll()
                      throws SAFSException
```
    Purpose: Drag a compenent horizontally or vertically Note: If TestObject 'obj1' represent a GuiSubitemTestObject, then use the RFT API setState method; This method will consider the position as a relative value. Else the object will be draged by mouse to simulate the scroll action; And the position will be considered as a absolute value.
    
    Overrides:
    
    performScorll in class ComponentFunction
    
    Throws:
    
    SAFSException
  - listAllProperties
```
protected void listAllProperties(TestObject obj)
```
    Purpose: list all TestObject properties, using listProperties and listNonValueProperties
    
    Parameters:
    
    obj, - TestObject
  - listAllProperties
```
protected void listAllProperties(TestObject obj,
                                 java.lang.String str)
```
    Purpose: list all TestObject properties, using listProperties and listNonValueProperties
    
    Parameters:
    
    obj, - TestObject
    
    str, - String, used in the header of the list
  - listProperties
```
protected void listProperties(TestObject obj)
```
    Purpose: list 'regular' TestObject properties
    
    Parameters:
    
    obj, - TestObject
  - listNonValueProperties
```
protected void listNonValueProperties(TestObject obj)
```
    Purpose: list 'non-value' TestObject properties
    
    Parameters:
    
    obj, - TestObject
  - listMethods
```
protected void listMethods(TestObject obj)
```
    Purpose: list TestObject methods
    
    Parameters:
    
    obj, - TestObject
  - extractTreeItemsSub
```
protected Tree extractTreeItemsSub(java.lang.Object nitem)
                            throws SAFSException
```
    Extract a 'Tree' hierarchy from a TestObject. The method currently only supports swing JTrees.
    Assumptions:
    this is the mechanism used (gleaned through lots of trial and error):
    
    Parameters:
    
    nitem, - TestObject, the next item
    
    Returns:
    
    org.safs.Tree
    
    Throws:
    
    SAFSException
  - tobj
```
protected Tree tobj(TestObject nitem)
             throws java.lang.Exception
```
    Purpose: extract a 'Tree' hierarchy from a TestObject using recursion; The item is for JTree node.
    Assumptions:
    this is the mechanism used (gleaned through lots of trial and error):
    
    Parameters:
    
    obj, - Object (actually of type GuiSubitemTestObject)
    
    Returns:
    
    org.safs.Tree
    
    Throws:
    
    java.lang.Exception
  - getUserObject
```
protected java.lang.Object getUserObject(java.lang.Object obj,
                                         java.lang.Integer level)
```
    Purpose: getUserObject, should be overridden by children. Check if obj instanceof TestObject, if not, return obj; This version hard codes the equivalent of 'obj.toString()' if it is a test object.
    
    Parameters:
    
    obj, - Object obj
    
    level, - Integer
    
    Returns:
    
    either obj, or fi a testobject, the output of 'obj.toString()'
  - isSWTWidget
```
protected boolean isSWTWidget(TestObject theobj)
```
    Determine if the TestObject is an Eclipse SWT component.
    
    Parameters:
    
    theobj, - TestObject reference to GUI component
    
    Returns:
    
    true if the component classname begins with 'org.eclipse.swt.'
  - getAppletsBrowser
```
protected TopLevelTestObject getAppletsBrowser(GuiTestObject guiObj)
```
    getParentBrowser Given a component assumed to be inside an Applet, we will attempt to locate the TopLevelTestObject in the "Html" domain that has the containing Java Plug-in object overlapping the same screen location. Example of use is inputKeys to an applet component. Applets and the HTMLAppletProxy do not have inputKeys and there is no easy way to get hold of the parent Browser object for an applet. We must simply get the Point on screen of our Component and then attempt to find a TopLevelTestObject (BrowserTestObject?) whose child at that same Point is a Java Plug-In ActiveX control. It is possible that there will be multiple browsers running Applets on screen at the same time. We will match the first one whose applet screen coordinates overlap our component screen coordinates. This will almost always give us the right browser window, but it may be possible for 2 browsers with applets to reside one on top of the other and it may be possible that we will find the wrong one first. There isn't much we can do about that given the API and object properties currently available. If we do see this error in the future we may have to do additional checks like checking process ids, applet rectangle coordinates, and the like, but even these can still result in false matches because 2 browsers could be showing the same applet, the same size, and in 2 browsers that have the same process id.
    
    Parameters:
    
    GuiTestObject - component assumed to be inside a browser applet.
    
    Returns:
    
    TopLevelTestObject of the matching Browser or null.
  - isJavaDomain
```
protected static boolean isJavaDomain(TestObject tobj)
```
  - isDotnetDomain
```
protected static boolean isDotnetDomain(TestObject tobj)
```
  - isHtmlDomain
```
protected static boolean isHtmlDomain(TestObject tobj)
```
  - isWinDomain
```
protected static boolean isWinDomain(TestObject tobj)
```
  - isSwtDomain
```
protected static boolean isSwtDomain(TestObject tobj)
```
  - isFlexDomain
```
protected static boolean isFlexDomain(TestObject tobj)
```

Class CFComponent

Nested Class Summary

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

Field Summary

Fields inherited from class org.safs.ComponentFunction

Fields inherited from class org.safs.Processor

Constructor Summary

Method Summary

Methods inherited from class org.safs.ComponentFunction

Methods inherited from class org.safs.Processor

Methods inherited from class java.lang.Object

Field Detail

script

winObject

obj1

keepEncodingConsistent

Constructor Detail

CFComponent

Method Detail

setKeepEncodingConsistent

getKeepEncodingConsistent

getHelpers

process

localProcess

parseWhereInfo

sendFlexEvent

sendEvent

selectMenuItem

verifyMenuItem

performDrag

matchedPathOfMenuItem

findMenuBars

componentClick

performClick

closeWindow

_restore

_setPosition

_setSize

_minimize

_maximize

mouseClick

getObjectPropertyFromProperties

getObjectProperty

verifyPropertyContains

verifyValueContains

verifyValues

getProperties

getPropertyObject

clearAppMapCache

inputKeystrokes

verifyObjectDataToFile

convertObjectValueToString

captureObjectData

formatObjectData

performHoverMouse

captureObjectDataToFile

capturePropertiesToFile

verifyFileToFile

getWindowRectangleOnScreen

getComponentRectangleOnScreen

getComponentRectangle

exist

verifyPropertyToFile

capturePropertyToFile

verifyClipboardToFile

setPropertyValue

performScorll

listAllProperties

listAllProperties

listProperties

listNonValueProperties

listMethods

extractTreeItemsSub

tobj

getUserObject

isSWTWidget

getAppletsBrowser

isJavaDomain

isDotnetDomain

isHtmlDomain