org.safs.tools.engines

Class AutoItComponent.CFComponent

java.lang.Object

org.safs.Processor

org.safs.ComponentFunction

org.safs.tools.engines.AutoItComponent.CFComponent

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Enclosing class:

AutoItComponent

class AutoItComponent.CFComponent
extends ComponentFunction

Local CFComponent

Author:

Carl Nagle

Nested Class Summary

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

ComponentFunction.Window

Field Summary

Fields

Modifier and Type	Field and Description
protected int	DEFAULT_TIMEOUT_WAIT_WIN_FOCUSED '1', the default timeout in seconds to wait the window become focused.
protected AutoItRs	rs AutoItRs, the object representing the component

Fields inherited from class org.safs.ComponentFunction

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

Fields inherited from class org.safs.Processor

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

Constructor Summary

Constructors

Constructor and Description
CFComponent()

Method Summary

Modifier and Type	Method and Description
protected void	_close() Override the execution method '_close()' of keyword 'WindowFunctions.CLOSEWINDOW_KEYWORD'
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 boolean	activate(AutoItRs rs) Try to set focus to the window and component.
protected void	click(AutoItRs ars) Deprecated.
protected void	click(AutoItRs autoArgs, java.awt.Point offset) Click with position offset.
protected void	click(AutoItRs autoArgs, java.lang.String mouseButton, int nClicks, java.awt.Point offset, java.lang.String specialKey) Workhorse of AutoIt click routine.
protected void	componentClick() Override componentClick() to deal with groups of CLICK keywords.
protected void	ctrlClick(AutoItRs autoArgs, java.awt.Point offset) Ctrl click with position offset.
protected void	doubleClick(AutoItRs autoArgs, java.awt.Point offset) Double click with position offset.
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 boolean	performHoverMouse(java.awt.Point offset, int milliSeconds) Override the execution method 'performHoverMouse()' of keyword 'ComponentFunction.HOVERMOUSE'
void	process() Process the record present in the provided testRecordData.
protected void	rightClick(AutoItRs autoArgs, java.awt.Point offset) Right click with position offset.
protected void	setFocus(AutoItRs ars) setfoucs
protected void	setText(AutoItRs ars) Send keyboard input to the current input focus target.
protected void	shiftClick(AutoItRs autoArgs, java.awt.Point offset) Shift click with position offset.

Methods inherited from class org.safs.ComponentFunction

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

DEFAULT_TIMEOUT_WAIT_WIN_FOCUSED

protected int DEFAULT_TIMEOUT_WAIT_WIN_FOCUSED

'1', the default timeout in seconds to wait the window become focused.

rs

protected AutoItRs rs

AutoItRs, the object representing the component

Constructor Detail

CFComponent

CFComponent()

Method Detail

process

public void process()

Process the record present in the provided testRecordData. Tao Xie Note: Add '@Override' annotation.

Overrides:

process in class Processor

activate

protected boolean activate(AutoItRs rs)

Try to set focus to the window and component.

Parameters:

rs - AutoItRs, the object representing the component

Returns:

boolean, true if the window and component are focused.

setFocus

protected void setFocus(AutoItRs ars)

setfoucs

componentClick

protected void componentClick()
                       throws SAFSException

Override componentClick() to deal with groups of CLICK keywords.

Overrides:

componentClick in class ComponentFunction

Throws:

SAFSException

click

protected void click(AutoItRs autoArgs,
                     java.awt.Point offset)

Click with position offset.

Parameters:

autoArgs - AutoItRs, AutoIt engine's recognition string.

offset - Point, the offset position to click within the target component. Also can be null.

doubleClick

protected void doubleClick(AutoItRs autoArgs,
                           java.awt.Point offset)

Double click with position offset.

Parameters:

autoArgs - AutoItRs, AutoIt engine's recognition string.

offset - Point, the offset position to click within the target component. Also can be null.

rightClick

protected void rightClick(AutoItRs autoArgs,
                          java.awt.Point offset)

Right click with position offset.

Parameters:

autoArgs - AutoItRs, AutoIt engine's recognition string.

offset - Point, the offset position to click within the target component. Also can be null.

ctrlClick

protected void ctrlClick(AutoItRs autoArgs,
                         java.awt.Point offset)

Ctrl click with position offset.

Parameters:

autoArgs - AutoItRs, AutoIt engine's recognition string.

offset - Point, the offset position to click within the target component. Also can be null.

shiftClick

protected void shiftClick(AutoItRs autoArgs,
                          java.awt.Point offset)

Shift click with position offset.

Parameters:

autoArgs - AutoItRs, AutoIt engine's recognition string.

offset - Point, the offset position to click within the target component. Also can be null.

click

protected void click(AutoItRs autoArgs,
                     java.lang.String mouseButton,
                     int nClicks,
                     java.awt.Point offset,
                     java.lang.String specialKey)

Workhorse of AutoIt click routine. It allows us to use specified 'mouse button' to click target component at assigned position with a number of times. Note: at current stage, we don't support the parameter 'text' in AutoIt's API controlClick: https://www.autoitscript.com/autoit3/docs/functions/ControlClick.htm . We just treat parameter 'text' as empty string.

Parameters:

autoArgs - AutoItRs, AutoIt engine's recognition string.

mouseButton - String, the button to click, "left", "right", or "middle". Default is the left button, which means if mouseButton is null or empty, it'll use the "left" as its value.

nClicks - int, number of times to click the mouse.

offset - Point, the offset position to click within the target component. Also can be null.

specialKey - String, keyboard key that be hold when click action happening.

click

@Deprecated
protected void click(AutoItRs ars)

Deprecated.

SEP 23, 2016 Tao Xie, It's better to use the same click() workhorse for consistency. Depreciate this original implementation.

setText

protected void setText(AutoItRs ars)

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

_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

_close

protected void _close()
               throws SAFSException

Override the execution method '_close()' of keyword 'WindowFunctions.CLOSEWINDOW_KEYWORD'

Overrides:

_close in class ComponentFunction

Throws:

SAFSException

getComponentRectangle

protected java.awt.Rectangle getComponentRectangle()

Description copied from class: ComponentFunction

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 ComponentFunction.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 ComponentFunction.deduceImageRect(String) to get a subarea rectangle.

Overrides:

getComponentRectangle in class ComponentFunction

Returns:

Rectangle bounds of the Component or null.

See Also:

ComponentFunction.deduceImageRect(String)

getComponentRectangleOnScreen

protected java.awt.Rectangle getComponentRectangleOnScreen()

Description copied from class: ComponentFunction

Get the absolute 'Rectangle bounds' of the Component, which means the rectangle is relative to the
whole screen, NOT to a window/browser.

Overrides:

getComponentRectangleOnScreen in class ComponentFunction

Returns:

Rectangle, 'Rectangle bounds' of the Component

performHoverMouse

protected boolean performHoverMouse(java.awt.Point offset,
                                    int milliSeconds)
                             throws SAFSException

Override the execution method 'performHoverMouse()' of keyword 'ComponentFunction.HOVERMOUSE'

Overrides:

performHoverMouse in class ComponentFunction

Parameters:

offset - 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