org.safs.ios

Class CFComponent

java.lang.Object

org.safs.Processor

org.safs.ComponentFunction

org.safs.ios.CFComponent

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

public class CFComponent
extends ComponentFunction

Nested Class Summary

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

ComponentFunction.Window

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	CASE_INSENSITIVE
(package private) static java.lang.String	CASEINSENSITIVE
static java.lang.String	COMMAND_ASSIGNPROPERTYVARIABLE "ASSIGNPROPERTYVARIABLE"
static java.lang.String	COMMAND_CAPTUREPROPERTIESTOFILE "CAPTUREPROPERTIESTOFILE"
static java.lang.String	COMMAND_CAPTUREPROPERTYTOFILE "CAPTUREPROPERTYTOFILE"
static java.lang.String	COMMAND_CLICK "CLICK"
static java.lang.String	COMMAND_DOUBLECLICK "DOUBLECLICK"
static java.lang.String	COMMAND_DOUBLETAP "DOUBLETAP"
static java.lang.String	COMMAND_FLICK "FLICK"
static java.lang.String	COMMAND_FLICKDOWN "FLICKDOWN"
static java.lang.String	COMMAND_FLICKLEFT "FLICKLEFT"
static java.lang.String	COMMAND_FLICKRIGHT "FLICKRIGHT"
static java.lang.String	COMMAND_FLICKUP "FLICKUP"
static java.lang.String	COMMAND_GETGUIIMAGE "GETGUIIMAGE"
static java.lang.String	COMMAND_GUIDOESEXIST "GUIDOESEXIST"
static java.lang.String	COMMAND_GUIDOESNOTEXIST "GUIDOESNOTEXIST"
static java.lang.String	COMMAND_INPUTCHARACTERS "INPUTCHARACTERS"
static java.lang.String	COMMAND_LOCATESCREENIMAGE "LOCATESCREENIMAGE"
static java.lang.String	COMMAND_PRESS "PRESS"
static java.lang.String	COMMAND_TAP "TAP"
static java.lang.String	COMMAND_TWOFINGERTAP "TWOFINGERTAP"
static java.lang.String	COMMAND_VERIFYGUIIMAGETOFILE "VERIFYGUIIMAGETOFILE"
static java.lang.String	COMMAND_VERIFYPROPERTIESTOFILE "VERIFYPROPERTIESTOFILE"
static java.lang.String	COMMAND_VERIFYPROPERTY "VERIFYPROPERTY"
static java.lang.String	COMMAND_VERIFYPROPERTYCONTAINS "VERIFYPROPERTYCONTAINS"
static java.lang.String	COMMAND_VERIFYPROPERTYTOFILE "VERIFYPROPERTYTOFILE"
protected java.lang.String	compGUIID
protected CFEditBox	editBoxFunctions
static java.lang.String	JSCRIPTS_CLICK_SCRIPT "click.js" implementation for supported Click commands in JSCRIPTS_GENERICOBECT_SUBDIR.
static java.lang.String	JSCRIPTS_FLICK_SCRIPT "flick.js" implementation for supported Flick commands in JSCRIPTS_GENERICOBECT_SUBDIR.
static java.lang.String	JSCRIPTS_GENERICOBJECT_SUBDIR "GenericObject/" Subdir off of Utilities.ROOT_JSCRIPTS_DIR containing GenericObject and GenericMaster keyword implementation scripts.
static java.lang.String	JSCRIPTS_GUIEXISTS_SCRIPT "guiexists.js" implementation for supported GuiDoes/DoesNotExist commands in JSCRIPTS_GENERICOBECT_SUBDIR.
static java.lang.String	JSCRIPTS_GUIIMAGE_SCRIPT "guiimage.js" implementation for supported GetGuiImage and related commands in JSCRIPTS_GENERICOBECT_SUBDIR.
static java.lang.String	JSCRIPTS_GUIPROPERTY_SCRIPT "guiproperty.js" implementation for supported GetProperty and related commands in JSCRIPTS_GENERICOBECT_SUBDIR.
static java.lang.String	JSCRIPTS_KEYBOARD_SCRIPT "keyboard.js" implementation for supported keyboard commands in JSCRIPTS_GENERICOBECT_SUBDIR.
static java.lang.String	JSCRIPTS_PRESS_SCRIPT "press.js" implementation for supported Press commands in JSCRIPTS_GENERICOBECT_SUBDIR.
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 CFWindow	windowFunctions
protected java.lang.String	windowGUIID

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	doCharacters() process the InputCharacters command.
protected void	doClick() process the Click, DoubleClick, Tap, DoubleTap, and TwoFingerTap commands...
protected void	doFlick() process the Flick command...
protected void	doGetGuiImage() Capture a component GUI image to a file.
protected void	doGuiExists(boolean seekexists) process the GuiDoesExist, GuiDoesNotExist commands.
protected void	doPress() process the Press command.
protected void	doSimpleFlick() process the FlickUp, FlickDown, FlickLeft, FlickRight commands...
protected void	doVerifyGuiImage() Verify a component GUI image to a benchmark file.
boolean	getKeepEncodingConsistent()
void	process() TestRecordData should already have most fields including the object recognition strings.
protected static IStatus	processIOSScript(java.lang.String jsSubdir, java.lang.String jscript, java.lang.String jsAppend, TestRecordHelper testRecordData)
void	setKeepEncodingConsistent()

Methods inherited from class org.safs.ComponentFunction

_close, _maximize, _minimize, _restore, _setPosition, _setSize, action_ComputedStyle, action_getGuiImage, action_GetSaveTextFromGUI, action_showOnPage, action_verifyGuiImageToFile, assignPropertyVariable, captureObjectData, captureObjectDataToFile, capturePropertiesToFile, capturePropertyToFile, checkForCoord, checkForCoord, clearAppMapCache, clearCache, close, closeWindow, componentClick, componentExecutedFailureMessage, componentFailureMessage, componentProcess, componentSuccessMessage, convertCoords, convertLine, convertNum, convertWindowPosition, ConvertWindowPosition, deduceImageRect, dragTo, executeScript, exist, getAlternateParams, getComponentRectangle, getComponentRectangleOnScreen, 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, performHoverMouse, 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

JSCRIPTS_GENERICOBJECT_SUBDIR

public static final java.lang.String JSCRIPTS_GENERICOBJECT_SUBDIR

"GenericObject/" Subdir off of Utilities.ROOT_JSCRIPTS_DIR containing GenericObject and GenericMaster keyword implementation scripts.

See Also:

Constant Field Values

JSCRIPTS_CLICK_SCRIPT

public static final java.lang.String JSCRIPTS_CLICK_SCRIPT

"click.js" implementation for supported Click commands in JSCRIPTS_GENERICOBECT_SUBDIR.

See Also:

Constant Field Values

JSCRIPTS_PRESS_SCRIPT

public static final java.lang.String JSCRIPTS_PRESS_SCRIPT

"press.js" implementation for supported Press commands in JSCRIPTS_GENERICOBECT_SUBDIR.

See Also:

Constant Field Values

JSCRIPTS_GUIEXISTS_SCRIPT

public static final java.lang.String JSCRIPTS_GUIEXISTS_SCRIPT

"guiexists.js" implementation for supported GuiDoes/DoesNotExist commands in JSCRIPTS_GENERICOBECT_SUBDIR.

See Also:

Constant Field Values

JSCRIPTS_GUIIMAGE_SCRIPT

public static final java.lang.String JSCRIPTS_GUIIMAGE_SCRIPT

"guiimage.js" implementation for supported GetGuiImage and related commands in JSCRIPTS_GENERICOBECT_SUBDIR.

See Also:

Constant Field Values

JSCRIPTS_GUIPROPERTY_SCRIPT

public static final java.lang.String JSCRIPTS_GUIPROPERTY_SCRIPT

"guiproperty.js" implementation for supported GetProperty and related commands in JSCRIPTS_GENERICOBECT_SUBDIR.

See Also:

Constant Field Values

JSCRIPTS_FLICK_SCRIPT

public static final java.lang.String JSCRIPTS_FLICK_SCRIPT

"flick.js" implementation for supported Flick commands in JSCRIPTS_GENERICOBECT_SUBDIR.

See Also:

Constant Field Values

JSCRIPTS_KEYBOARD_SCRIPT

public static final java.lang.String JSCRIPTS_KEYBOARD_SCRIPT

"keyboard.js" implementation for supported keyboard commands in JSCRIPTS_GENERICOBECT_SUBDIR.

See Also:

Constant Field Values

CASE_INSENSITIVE

static final java.lang.String CASE_INSENSITIVE

See Also:

Constant Field Values

CASEINSENSITIVE

static final java.lang.String CASEINSENSITIVE

See Also:

Constant Field Values

COMMAND_ASSIGNPROPERTYVARIABLE

public static final java.lang.String COMMAND_ASSIGNPROPERTYVARIABLE

"ASSIGNPROPERTYVARIABLE"

See Also:

Constant Field Values

COMMAND_CAPTUREPROPERTYTOFILE

public static final java.lang.String COMMAND_CAPTUREPROPERTYTOFILE

"CAPTUREPROPERTYTOFILE"

See Also:

Constant Field Values

COMMAND_CAPTUREPROPERTIESTOFILE

public static final java.lang.String COMMAND_CAPTUREPROPERTIESTOFILE

"CAPTUREPROPERTIESTOFILE"

See Also:

Constant Field Values

COMMAND_CLICK

public static final java.lang.String COMMAND_CLICK

"CLICK"

See Also:

Constant Field Values

COMMAND_DOUBLECLICK

public static final java.lang.String COMMAND_DOUBLECLICK

"DOUBLECLICK"

See Also:

Constant Field Values

COMMAND_DOUBLETAP

public static final java.lang.String COMMAND_DOUBLETAP

"DOUBLETAP"

See Also:

Constant Field Values

COMMAND_FLICK

public static final java.lang.String COMMAND_FLICK

"FLICK"

See Also:

Constant Field Values

COMMAND_FLICKUP

public static final java.lang.String COMMAND_FLICKUP

"FLICKUP"

See Also:

Constant Field Values

COMMAND_FLICKDOWN

public static final java.lang.String COMMAND_FLICKDOWN

"FLICKDOWN"

See Also:

Constant Field Values

COMMAND_FLICKLEFT

public static final java.lang.String COMMAND_FLICKLEFT

"FLICKLEFT"

See Also:

Constant Field Values

COMMAND_FLICKRIGHT

public static final java.lang.String COMMAND_FLICKRIGHT

"FLICKRIGHT"

See Also:

Constant Field Values

COMMAND_GUIDOESEXIST

public static final java.lang.String COMMAND_GUIDOESEXIST

"GUIDOESEXIST"

See Also:

Constant Field Values

COMMAND_GUIDOESNOTEXIST

public static final java.lang.String COMMAND_GUIDOESNOTEXIST

"GUIDOESNOTEXIST"

See Also:

Constant Field Values

COMMAND_GETGUIIMAGE

public static final java.lang.String COMMAND_GETGUIIMAGE

"GETGUIIMAGE"

See Also:

Constant Field Values

COMMAND_INPUTCHARACTERS

public static final java.lang.String COMMAND_INPUTCHARACTERS

"INPUTCHARACTERS"

See Also:

Constant Field Values

COMMAND_LOCATESCREENIMAGE

public static final java.lang.String COMMAND_LOCATESCREENIMAGE

"LOCATESCREENIMAGE"

See Also:

Constant Field Values

COMMAND_PRESS

public static final java.lang.String COMMAND_PRESS

"PRESS"

See Also:

Constant Field Values

COMMAND_TAP

public static final java.lang.String COMMAND_TAP

"TAP"

See Also:

Constant Field Values

COMMAND_TWOFINGERTAP

public static final java.lang.String COMMAND_TWOFINGERTAP

"TWOFINGERTAP"

See Also:

Constant Field Values

COMMAND_VERIFYGUIIMAGETOFILE

public static final java.lang.String COMMAND_VERIFYGUIIMAGETOFILE

"VERIFYGUIIMAGETOFILE"

See Also:

Constant Field Values

COMMAND_VERIFYPROPERTY

public static final java.lang.String COMMAND_VERIFYPROPERTY

"VERIFYPROPERTY"

See Also:

Constant Field Values

COMMAND_VERIFYPROPERTYTOFILE

public static final java.lang.String COMMAND_VERIFYPROPERTYTOFILE

"VERIFYPROPERTYTOFILE"

See Also:

Constant Field Values

COMMAND_VERIFYPROPERTIESTOFILE

public static final java.lang.String COMMAND_VERIFYPROPERTIESTOFILE

"VERIFYPROPERTIESTOFILE"

See Also:

Constant Field Values

COMMAND_VERIFYPROPERTYCONTAINS

public static final java.lang.String COMMAND_VERIFYPROPERTYCONTAINS

"VERIFYPROPERTYCONTAINS"

See Also:

Constant Field Values

windowGUIID

protected java.lang.String windowGUIID

compGUIID

protected java.lang.String compGUIID

windowFunctions

protected CFWindow windowFunctions

editBoxFunctions

protected CFEditBox editBoxFunctions

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

Method Detail

setKeepEncodingConsistent

public void setKeepEncodingConsistent()

getKeepEncodingConsistent

public boolean getKeepEncodingConsistent()

process

public void process()

TestRecordData should already have most fields including the object recognition strings.

Overrides:

process in class Processor

processIOSScript

protected static IStatus processIOSScript(java.lang.String jsSubdir,
                                          java.lang.String jscript,
                                          java.lang.String jsAppend,
                                          TestRecordHelper testRecordData)
                                   throws InstrumentsScriptExecutionException

Parameters:

jsSubdir - -- Subdirectory off of to locate desired jscript. If jsSubdir is not null and equals than the routine will assume the specified jscript parameter is NOT relative and contains the full absolute path to the script.

jscript - -- filename (or fullpath) to be used with jsSubdir for hook.js.

trdAppend - -- any additional javascript variables or code to add to trd.js.

Returns:

IStatus object generated from Utilities.waitScriptComplete(String)
This routine should be assumed to have already localized whatever comment or detail was sent back from Instruments.

Throws:

InstrumentsScriptExecutionException

doGetGuiImage

protected void doGetGuiImage()
                      throws SAFSObjectRecognitionException,
                             InstrumentsScriptExecutionException,
                             SAFSObjectNotFoundException

Capture a component GUI image to a file. Currently, IOS 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. Appends an offsets variable into trd.js with:

 var imagename="imagename";
 

Parameters:

b -

Throws:

SAFSObjectRecognitionException

InstrumentsScriptExecutionException

SAFSObjectNotFoundException

doVerifyGuiImage

protected void doVerifyGuiImage()
                         throws SAFSObjectRecognitionException,
                                InstrumentsScriptExecutionException,
                                SAFSObjectNotFoundException

Verify a component GUI image to a benchmark file. Currently, IOS 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. Appends an offsets variable into trd.js with:

 var imagename="imagename";
 

Parameters:

b -

Throws:

SAFSObjectRecognitionException

InstrumentsScriptExecutionException

SAFSObjectNotFoundException

doGuiExists

protected void doGuiExists(boolean seekexists)
                    throws SAFSObjectRecognitionException,
                           InstrumentsScriptExecutionException,
                           SAFSObjectNotFoundException

process the GuiDoesExist, GuiDoesNotExist commands.

Parameters:

seekexists - true for GuiDoesExist, false for GuiDoesNotExist.

Throws:

SAFSObjectRecognitionException

InstrumentsScriptExecutionException

SAFSObjectNotFoundException

doClick

protected void doClick()
                throws SAFSObjectRecognitionException,
                       InstrumentsScriptExecutionException,
                       SAFSObjectNotFoundException

process the Click, DoubleClick, Tap, DoubleTap, and TwoFingerTap commands... Appends an offsets variable into trd.js with:

 var offsets={x:value, y:value};
 

If no offsets are specified than the default percent relative offsets of x:50, y:50 will be sent.

Throws:

SAFSObjectRecognitionException

InstrumentsScriptExecutionException

SAFSObjectNotFoundException

doPress

protected void doPress()
                throws SAFSObjectRecognitionException,
                       InstrumentsScriptExecutionException,
                       SAFSObjectNotFoundException

process the Press command. Appends a duration variable into trd.js with:

 var seconds=N (in seconds);
 

If no duration is specified than the default value of 0 will be sent.

Throws:

SAFSObjectRecognitionException

InstrumentsScriptExecutionException

SAFSObjectNotFoundException

doCharacters

protected void doCharacters()
                     throws SAFSObjectRecognitionException,
                            InstrumentsScriptExecutionException,
                            SAFSObjectNotFoundException

process the InputCharacters command. Appends a duration variable into trd.js with:

 var characters="string";
 

If no duration is specified than the default value of 0 will be sent.

Throws:

SAFSObjectRecognitionException

InstrumentsScriptExecutionException

SAFSObjectNotFoundException

doFlick

protected void doFlick()
                throws SAFSObjectRecognitionException,
                       InstrumentsScriptExecutionException,
                       SAFSObjectNotFoundException

process the Flick command... Appends the following variables into trd.js:

 var offsets={x1:value, y1:value, x2:value, y2:value};
 var seconds=N;  (in seconds, default: 1 )
 var touches=N; (default: 1)
 var counter=N; (default: 1)
 

If no offsets are specified than the default percent relative offsets of x:50, y:50 will be sent.

Throws:

SAFSObjectRecognitionException

InstrumentsScriptExecutionException

SAFSObjectNotFoundException

doSimpleFlick

protected void doSimpleFlick()
                      throws SAFSObjectRecognitionException,
                             InstrumentsScriptExecutionException,
                             SAFSObjectNotFoundException

process the FlickUp, FlickDown, FlickLeft, FlickRight commands... Appends the following variables into trd.js:

 var offsets={x1:value, y1:value, x2:value, y2:value};
 var seconds=N;  (in seconds, default: 0)
 var touches=N; (default: 1)
 var counter=N; (default: 1)
 

If no offsets are specified than the default percent relative offsets of x:50, y:50 will be sent.

Throws:

SAFSObjectRecognitionException

InstrumentsScriptExecutionException

SAFSObjectNotFoundException