org.safs.selenium.webdriver

Class CFComponent

java.lang.Object

org.safs.Processor

org.safs.ComponentFunction

org.safs.selenium.webdriver.CFComponent

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Direct Known Subclasses:

CFCheckBox, CFComboBox, CFEditBox, CFListView, CFMenuBar, CFScrollBar, CFTabControl, CFTree, SetPosition

public class CFComponent
extends ComponentFunction

Component Functions for Selenium WebDriver.

Nested Class Summary

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

ComponentFunction.Window

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openqa.selenium.WebElement	compObject
static int	DEFAULT_MAX_RETRY_ENTER 5, the default maximum time to retry enter text if verification fails.
static java.lang.String	INDENT_MARK
protected Component	libComponent
protected static java.util.Map<org.openqa.selenium.WebElement,Component>	libComponentCache A cache, which stores a pair(WebElement, Component)
protected boolean	ready Boolean value indicates if the web-element is "ready" for processing. The "ready" has different meanings for different component and different keywords.
static java.lang.String	SAFS_JAVASCRIPT_RESULT
protected org.openqa.selenium.support.ui.WebDriverWait	waiter The WebDriverWait used to wait 'ready' of a WebElement. It is assigned in waitReady(WebElement), which should be called in sub-class if overridden.
protected WDTestRecordHelper	wdHelper
protected WebDriverGUIUtilities	wdUtils
protected org.openqa.selenium.WebElement	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()

Method Summary

Modifier and Type	Method and Description
protected void	_close() Close the window.
protected void	_maximize() Maximize the window.
protected void	_minimize() Minimize the window.
void	_setFocus()
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) Purpose: verifyComputedStyle()
static void	captureHierarchicalData(java.util.Collection<java.lang.String> contents, HierarchicalElement[] nodes, java.lang.String indentMark, int level) Caputre the content of hierarchical structure like tree or menu.
protected java.util.Collection<java.lang.String>	captureObjectData() Sub class may override this method to get its own data.
void	clearCache() clear the cache 'libComponentCache'
static void	clearInternalCache() clear the cache 'libComponentCache'
protected void	componentClick() Purpose: componentClick
static java.util.List<java.lang.String>	convertElementArrayToList(Element[] elements) Get the text of each element object in an array, and add it to a list, then return the list.
protected void	doSetText(java.lang.String libName, boolean isCharacter, boolean needVerify) Set the text of Component box.
protected void	dragTo() perform dragTo from component1 to component2 with offset.
protected void	executeScript() Purpose: executeScript
protected boolean	exist() To test if the component exists or not. The sub class may test the component's visibility also.
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 java.util.Map<java.lang.String,java.lang.Object>	getProperties()
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 ComponentFunction.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.awt.Rectangle	getWindowRectangleOnScreen() Get the absolute 'Rectangle bounds' of the Window, which means the rectangle is relative to the whole screen.
protected void	inputKeystrokes() handles InputKeys and InputCharacters.
protected void	localProcess() Handle the cache for component-library. In this class CFComponent, component-library is not required for some keywords like Maximize, Minimize etc. So in the method process() of this class, when calling localProcess(), if any Exception is caught, just ignore it. But for subclass, component-library is required, so if this method is overrided, user needs to call super.localProcess() in a try-catch clause like following:
protected Component	newLibComponent(org.openqa.selenium.WebElement webelement) sub class MUST to override this method and provide its own library 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 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.
void	process() The primary method that all subclasses must implement.
protected void	refresh(boolean includingWinObject) Refresh the winObject/compObject if stable.
protected void	refresh(boolean includingWinObject, boolean checkStable) Refresh the winObject/compObject if stable or refresh is forced by setting parameter 'checkStale' to false.
static org.openqa.selenium.WebElement	refresh(org.openqa.selenium.WebElement webelement) Try to get a fresh WebElement. When the page change, the WebElement may be stale, or the information (like its location, size etc.) may be stale, so we need to get the fresh WebElement on the page to get latest information. Note: This method may consume some time for getting refreshed WebElement.
static org.openqa.selenium.WebElement	refresh(org.openqa.selenium.WebElement webelement, boolean checkStale) Try to get a fresh WebElement if it is stale. When the page change, the WebElement may be stale, or the information (like its location, size etc.) may be stale, so we need to get the fresh WebElement on the page to get latest information. Note: This method may consume some time for getting refreshed WebElement.
void	setMaxRetry(int maxRetry)
protected void	setText(java.lang.String libName, boolean isCharacter, java.lang.String text) Clear the content of Component box first, and then enter the text into it.
protected boolean	showComponentAsMuchPossible(boolean verify, boolean refresh) Show the component in the browser's viewport as much as possible.
protected org.openqa.selenium.WebElement	waitReady(org.openqa.selenium.WebElement element) Wait for the component to be "ready": "ready" has different meanings for different components and different types.

Methods inherited from class org.safs.ComponentFunction

_restore, action_getGuiImage, action_GetSaveTextFromGUI, action_showOnPage, action_verifyGuiImageToFile, assignPropertyVariable, captureObjectDataToFile, capturePropertiesToFile, capturePropertyToFile, checkForCoord, checkForCoord, clearAppMapCache, close, closeWindow, componentExecutedFailureMessage, componentFailureMessage, componentProcess, componentSuccessMessage, convertCoords, convertLine, convertNum, convertWindowPosition, ConvertWindowPosition, deduceImageRect, getAlternateParams, getHelpers, getHelpersWorker, getPossibleMapItem, getProperty, getPropertyCollection, getPropertyCollection, getStringValue, getUUIDBoolean, guiDoesExist, hoverMouse, hoverScreenLocation, isClickAction, isPropertyExist, issueFileErrorFailure, issueParameterCountFailure, issueParameterCountFailure, issueParameterValueFailure, issuePassedSuccess, issuePassedSuccessUsing, issueUnknownErrorFailure, isSupportedRecordType, locateScreenImage, lookupAppMapCoordReference, lookupAppMapLineReference, lookupAppMapNumReference, lookupAppMapReference, maximize, minimize, normalizeFileEncoding, normalizePropertyCollection, performScorll, restore, selectMenuItem, sendEvent, setIterator, setPosition, setPropertyValue, setRectVars, 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

SAFS_JAVASCRIPT_RESULT

public static final java.lang.String SAFS_JAVASCRIPT_RESULT

See Also:

Constant Field Values

INDENT_MARK

public static final java.lang.String INDENT_MARK

See Also:

Constant Field Values

wdUtils

protected WebDriverGUIUtilities wdUtils

wdHelper

protected WDTestRecordHelper wdHelper

winObject

protected org.openqa.selenium.WebElement winObject

compObject

protected org.openqa.selenium.WebElement compObject

libComponent

protected Component libComponent

libComponentCache

protected static java.util.Map<org.openqa.selenium.WebElement,Component> libComponentCache

A cache, which stores a pair(WebElement, Component)

DEFAULT_MAX_RETRY_ENTER

public static int DEFAULT_MAX_RETRY_ENTER

5, the default maximum time to retry enter text if verification fails.

ready

protected boolean ready

Boolean value indicates if the web-element is "ready" for processing.
The "ready" has different meanings for different component and different keywords.

waiter

protected org.openqa.selenium.support.ui.WebDriverWait waiter

The WebDriverWait used to wait 'ready' of a WebElement.
It is assigned in waitReady(WebElement), which should be called in sub-class if overridden.

Constructor Detail

CFComponent

public CFComponent()

Method Detail

setMaxRetry

public void setMaxRetry(int maxRetry)

Parameters:

maxRetry - int, the max times to retry 'enter the text' into Component box if the verification fails.

process

public void process()

Description copied from class: Processor

The primary method that all subclasses must implement. The implementation here simply checks for any chainedProcessor,
invokes chainedProcessor.setParams(this.getParams()),
invokes chainedProcessor.process(),
invokes setRecordProcessed(chainedProcessor.isRecordProcessed()).

Thus, any subclassing Processor should attempt to process it's own commands and then invoke super.process() to try any chained Processor(s).

Otherwise, by default executes setRecordProcessed(false) if no chainedProcessor is present.

Overrides:

process in class Processor

waitReady

protected org.openqa.selenium.WebElement waitReady(org.openqa.selenium.WebElement element)

Wait for the component to be "ready": "ready" has different meanings for different components and different types.

Parameters:

element - WebElement the web-element to be checked

Returns:

WebElement, the "ready" WebElement

localProcess

protected void localProcess()
                     throws SeleniumPlusException

Handle the cache for component-library.
In this class CFComponent, component-library is not required for some keywords like Maximize, Minimize etc.
So in the method process() of this class, when calling localProcess(),
if any Exception is caught, just ignore it.
But for subclass, component-library is required, so if this method is overrided, user needs to
call super.localProcess() in a try-catch clause like following:

 
 try{
   super.localProcess();
   subLibrary = (SubComponentLibrary) libComponent;

 }catch(SeleniumPlusException se){
   testRecordData.setStatusCode(StatusCodes.GENERAL_SCRIPT_FAILURE);
 }
 
 

Throws:

SeleniumPlusException

newLibComponent

protected Component newLibComponent(org.openqa.selenium.WebElement webelement)
                             throws SeleniumPlusException

sub class MUST to override this method and provide its own library Component.

Throws:

SeleniumPlusException

clearInternalCache

public static void clearInternalCache()

clear the cache 'libComponentCache'

_setFocus

public void _setFocus()
               throws SAFSException

Throws:

SAFSException

clearCache

public void clearCache()

clear the cache 'libComponentCache'

Overrides:

clearCache in class ComponentFunction

inputKeystrokes

protected void inputKeystrokes()
                        throws SAFSException

handles InputKeys and InputCharacters.

Overrides:

inputKeystrokes in class ComponentFunction

Throws:

SAFSException

_setPosition

protected void _setPosition(java.awt.Point position)
                     throws SAFSException

Subclass should give its own implementation

Overrides:

_setPosition in class ComponentFunction

Throws:

SAFSException

_setSize

protected void _setSize(java.awt.Dimension size)
                 throws SAFSException

Subclass should give its own implementation

Overrides:

_setSize in class ComponentFunction

Throws:

SAFSException

_maximize

protected void _maximize()
                  throws SeleniumPlusException

Maximize the window.

Overrides:

_maximize in class ComponentFunction

Throws:

SeleniumPlusException

_close

protected void _close()
               throws SeleniumPlusException

Close the window.

Overrides:

_close in class ComponentFunction

Throws:

SeleniumPlusException

_minimize

protected void _minimize()
                  throws SeleniumPlusException

Minimize the window.

Overrides:

_minimize in class ComponentFunction

Throws:

SeleniumPlusException

componentClick

protected void componentClick()
                       throws SAFSException

Purpose: componentClick

Overrides:

componentClick in class ComponentFunction

Throws:

SAFSException

executeScript

protected void executeScript()
                      throws SAFSException

Purpose: executeScript

Overrides:

executeScript in class ComponentFunction

Throws:

SAFSException

action_ComputedStyle

protected void action_ComputedStyle(boolean verification)
                             throws SAFSException

Purpose: verifyComputedStyle()

Overrides:

action_ComputedStyle in class ComponentFunction

Throws:

SAFSException

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."

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."

captureObjectData

protected java.util.Collection<java.lang.String> captureObjectData()
                                                            throws SAFSException

Sub class may override this method to get its own data.

Overrides:

captureObjectData in class ComponentFunction

Returns:

Collection<String>, component's content. It may be null or empty.

Throws:

SAFSException - "Not supported yet."

convertElementArrayToList

public static java.util.List<java.lang.String> convertElementArrayToList(Element[] elements)

Get the text of each element object in an array, and add it to a list, then return the list.

Parameters:

elements - Element[], an array of element object

Returns:

List, a list of element's text

captureHierarchicalData

public static void captureHierarchicalData(java.util.Collection<java.lang.String> contents,
                                           HierarchicalElement[] nodes,
                                           java.lang.String indentMark,
                                           int level)
                                    throws SeleniumPlusException

Caputre the content of hierarchical structure like tree or menu.

Parameters:

contents - Collection, out, provide a empty Collection and will be filled with content. MUST NOT be null.

nodes - HierarchicalElement[], an array of hierarchical structure's nodes

indentMark - String, The character(s) to indent the child nodes from the parent branch.

level - int, the level of the node in the whole hierarchical structure. 0 at root level.

Throws:

SeleniumPlusException

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, the absolute rectangle on screen for the window

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, the absolute rectangle on screen for the component

showComponentAsMuchPossible

protected boolean showComponentAsMuchPossible(boolean verify,
                                              boolean refresh)
                                       throws SeleniumPlusException

Show the component in the browser's viewport as much as possible.

Overrides:

showComponentAsMuchPossible in class ComponentFunction

Parameters:

verify - boolean, verify that the component is shown on page if verify is true.

refresh - boolean, the component may need to be refreshed after scrolling into view.

Returns:

boolean, true if the component is shown on page; false otherwise.

Throws:

SeleniumPlusException

refresh

protected void refresh(boolean includingWinObject)

Refresh the winObject/compObject if stable. Do nothing if not stable.

Parameters:

includingWinObject - boolean, if true this method will also refresh window object. if false, only refresh component object.

refresh

protected void refresh(boolean includingWinObject,
                       boolean checkStable)

Refresh the winObject/compObject if stable or refresh is forced by setting parameter 'checkStale' to false.

Parameters:

includingWinObject - boolean, if true this method will also refresh window object. if false, only refresh component object.

checkStale - boolean, whether to check if the webelement is stable before refresh. true, check stable; false, force refresh directly without check.

refresh

public static org.openqa.selenium.WebElement refresh(org.openqa.selenium.WebElement webelement)

Try to get a fresh WebElement.
When the page change, the WebElement may be stale, or the information (like its location, size etc.) may be stale, so we need to get the fresh WebElement on the page to get latest information.
Note: This method may consume some time for getting refreshed WebElement.

Parameters:

webelement - WebElement, to be refreshed.

Returns:

WebElement, the new refreshed WebElement; or the original WebElement if there is something wrong.

See Also:

refresh(WebElement, boolean)

refresh

public static org.openqa.selenium.WebElement refresh(org.openqa.selenium.WebElement webelement,
                                                     boolean checkStale)

Try to get a fresh WebElement if it is stale.
When the page change, the WebElement may be stale, or the information (like its location, size etc.) may be stale, so we need to get the fresh WebElement on the page to get latest information.
Note: This method may consume some time for getting refreshed WebElement.

Parameters:

webelement - WebElement, to be refreshed.

checkStale - boolean, whether to check if the webelement is stable before refresh. true, check stable; false, force refresh directly without check.

Returns:

WebElement, the new refreshed WebElement;
or the original WebElement if it is not stale or if there is something wrong.

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, the rectangle relative to the browser. If this return 'absolute rectangle on screen', we SHOULD remove override method getRectangleImage(Rectangle).
But we need to be careful, Robot will be used to get image, we have to implement RMI to get image if the
browser is running on a remote machine.

See Also:

ComponentFunction.deduceImageRect(String)

getRectangleImage

protected java.awt.image.BufferedImage getRectangleImage(java.awt.Rectangle imageRect)
                                                  throws SAFSException

Description copied from class: ComponentFunction

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 ComponentFunction.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.

Overrides:

getRectangleImage in class ComponentFunction

Parameters:

imageRect - Rectangle, within the rectangle to get image.

Returns:

BufferedImage

Throws:

SAFSException

See Also:

ComponentFunction.getComponentRectangle(), 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

performHoverMouse

protected boolean performHoverMouse(java.awt.Point point,
                                    int milliseconds)
                             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.

milliseconds - int, time to hover, in milliseconds

Returns:

boolean, true if hover successful; false otherwise

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

dragTo

protected void dragTo()
               throws SAFSException

perform dragTo from component1 to component2 with offset.

Overrides:

dragTo in class ComponentFunction

Throws:

SAFSException

doSetText

protected void doSetText(java.lang.String libName,
                         boolean isCharacter,
                         boolean needVerify)

Set the text of Component box.

Parameters:

libName - String, the concrete Component name of class, which calls 'doSetText()' method, like 'EditBox', 'ComboBox'.

isCharacter - boolean, if true, the text'll be treated as plain text, without special key dealing;
if false, the text'll be treated as special keys.

needVerify - boolean, if true, verify if the text has been correctly entered.(But if the text contains special keys, i.e. isCharacter is false, there's no verification.) if false, no verification.

setText

protected void setText(java.lang.String libName,
                       boolean isCharacter,
                       java.lang.String text)
                throws SeleniumPlusException

Clear the content of Component box first, and then enter the text into it.

Parameters:

libName - String, the concrete Component name of class, which calls 'setText()' method, like 'EditBox', 'ComboBox'.

isCharacter - boolean, if true, the text'll be treated as plain text, without special key dealing;
if false, the text'll be treated as special keys.

text - String, the content to be entered into Component box.

Throws:

SeleniumPlusException