org.safs.selenium

Class CFComponent

java.lang.Object

org.safs.Processor

org.safs.ComponentFunction

org.safs.selenium.CFComponent

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Direct Known Subclasses:

CFCheckBox, CFComboBox, CFEditBox, CFHTMLDocument, CFHTMLTable, CFListBox

public class CFComponent
extends ComponentFunction

Component Functions for Selenium.

For some functionality we use the java.awt.Robot and our own InputKeysParser classes.

InputKeysParser requires the availability of a SAFSKeycodeMap.dat file which is normally located in the SAFS\lib directory. This file will be loaded through ClassLoader.getSystemResourceAsStream.

Since:

OCT 10, 2006
OCT 10, 2006 (PHSABO) Original Release
JAN 16, 2007 (Carl Nagle) Removed Java 1.5 dependency.
AUG 01, 2007 (Carl Nagle) Made search for SAFSKeycodeMap.dat use the whole System CLASSPATH.
FEB 01, 2010 (Carl Nagle) expanded casting of SeleniumGUIUtilities where needed.
JUN 21, 2011 (Lei Wang) Add two propeties winObject and compObject of type SGuiObject. Modify method process(), componentProcess() and maximize(): use the new focus and maximize method provided by SeleniumGUIUtilities.
JUN 28, 2011 (Lei Wang) Update 12 keywords.
JUL 04, 2011 (Lei Wang) Update keywords: maximize, minimize, restore, add keyword shiftclick.
MAR 05, 2014 (Lei Wang) Move some keywrod constants to ComponentFunction.

Author:

Philippe Sabourin

See Also:

Robot, InputKeysParser, CreateUnicodeMap, ClassLoader.getSystemResourceAsStream(java.lang.String)

Nested Class Summary

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

ComponentFunction.Window

Field Summary

Fields

Modifier and Type	Field and Description
protected SGuiObject	compObject
static InputKeysParser	keysparser
static java.awt.Robot	robot
protected com.thoughtworks.selenium.Selenium	selenium
protected STestRecordHelper	sHelper
protected SeleniumGUIUtilities	sUtils
protected SGuiObject	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	_maximize() Maximize the current window
protected void	_minimize() Minimize the current window
protected void	_restore() Perform the "restore" action on the current window.
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_getGuiImage() Processes a Component Function Test Record to capture a screen GUI image to a file.
protected void	action_verifyGuiImageToFile() Processes a Component Function Test Record to verify a screen GUI image to a file.
protected java.util.Collection<java.lang.String>	captureObjectData()
protected void	closeWindow() Close the current window
protected void	componentClick() Purpose: componentClick
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	getComponentBounds(java.lang.String s) Gets the size of the component
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.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 void	localProcess()
protected void	maximize() Maximize the current window.
protected void	minimize() Minimize the current window.
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	restore() Restore the current window.
protected void	scrollToAndClickComponent(SGuiObject o) Scrolls to a component then left clicks on it.
protected void	scrollToComponent(SGuiObject o) Scrolls to a component on the page
protected void	setPosition() perform SetPosition to move Main Window, resize it and set its status.
protected void	verifyProperty() Purpose: verifyProperty

Methods inherited from class org.safs.ComponentFunction

_close, action_ComputedStyle, action_GetSaveTextFromGUI, action_showOnPage, assignPropertyVariable, captureObjectDataToFile, capturePropertiesToFile, capturePropertyToFile, checkForCoord, checkForCoord, clearAppMapCache, clearCache, close, componentExecutedFailureMessage, componentFailureMessage, componentProcess, componentSuccessMessage, convertCoords, convertLine, convertNum, convertWindowPosition, ConvertWindowPosition, deduceImageRect, dragTo, executeScript, getAlternateParams, getHelpers, 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, normalizeFileEncoding, normalizePropertyCollection, performDrag, performScorll, selectMenuItem, sendEvent, setIterator, setPropertyValue, setRectVars, showComponentAsMuchPossible, updateFromTestRecordData, verifyClipboardToFile, verifyFileToFile, verifyMenuItem, verifyObjectDataToFile, verifyPropertiesToFile, 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

selenium

protected com.thoughtworks.selenium.Selenium selenium

sUtils

protected SeleniumGUIUtilities sUtils

sHelper

protected STestRecordHelper sHelper

winObject

protected SGuiObject winObject

compObject

protected SGuiObject compObject

robot

public static java.awt.Robot robot

keysparser

public static InputKeysParser keysparser

Constructor Detail

CFComponent

public CFComponent()

Method Detail

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

localProcess

protected void localProcess()

restore

protected void restore()
                throws SAFSException

Description copied from class: ComponentFunction

Restore the current window.

Overrides:

restore in class ComponentFunction

Throws:

SAFSException

maximize

protected void maximize()
                 throws SAFSException

Description copied from class: ComponentFunction

Maximize the current window.

Overrides:

maximize in class ComponentFunction

Throws:

SAFSException

minimize

protected void minimize()
                 throws SAFSException

Description copied from class: ComponentFunction

Minimize the current window.

Overrides:

minimize in class ComponentFunction

Throws:

SAFSException

action_getGuiImage

protected void action_getGuiImage()
                           throws SAFSException

Description copied from class: ComponentFunction

Processes a Component Function Test Record to capture a screen GUI image to a file. Currently, the available formats for the output file are JPG, BMP, TIF, GIF, PNG and PNM. Optionally, the user may utilize the SubArea parameter to only capture a portion of the Component. This routine expects to be called by subclasses only and the subclass must override the getComponentRectangle method to provide the necessary location of the desired Component. Subclasses must also have already set the fields for mapname, windowName, compName, and action. This is usually already done in the process() call from the subclasses. This routine utilizes Java Advanced Imaging (JAI) to output the screen image to the file. JAI must be installed at compile time and runtime.

Overrides:

action_getGuiImage in class ComponentFunction

Throws:

SAFSException

action_verifyGuiImageToFile

protected void action_verifyGuiImageToFile()
                                    throws SAFSException

Description copied from class: ComponentFunction

Processes a Component Function Test Record to verify a screen GUI image to a file. Currently, the available formats for the output file are BMP, JPG, TIFF, GIF, PNG, and PNM. Optionally, the user may utilize the SubArea parameter to only capture a portion of the Component. This routine expects to be called by subclasses only and the subclass must override the getComponentRectangle method to provide the necessary location of the desired Component. Subclasses must also have already set the fields for mapname, windowName, compName, and action. This is usually already done in the process() call from the subclasses. This routine utilizes Java Advanced Imaging (JAI) to output the screen image to the file. JAI must be installed at compile time and runtime.

Overrides:

action_verifyGuiImageToFile 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

_restore

protected void _restore()
                 throws SAFSException

Perform the "restore" action on the current window.

Overrides:

_restore in class ComponentFunction

Throws:

SAFSException

_maximize

protected void _maximize()
                  throws SAFSException

Maximize the current window

Overrides:

_maximize in class ComponentFunction

Throws:

SAFSException

_minimize

protected void _minimize()
                  throws SAFSException

Minimize the current window

Overrides:

_minimize in class ComponentFunction

Throws:

SAFSException

closeWindow

protected void closeWindow()
                    throws SAFSException

Close the current window

Overrides:

closeWindow in class ComponentFunction

Throws:

SAFSException

setPosition

protected void setPosition()
                    throws SAFSException

Description copied from class: ComponentFunction

perform SetPosition to move Main Window, resize it and set its status. Format: "Coords=0,0,640,480;Status=NORMAL". Status can be NORMAL, MINIMAZED and MAXMAZED Alteratively, semi-colon (;) can be used instead of comma (,) to separate numeric data. This would be required when placing the data directly in the test record and NOT in the App Map when using comma-delimited test tables.

Overrides:

setPosition in class ComponentFunction

Throws:

SAFSException

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

verifyProperty

protected void verifyProperty()
                       throws SAFSException

Purpose: verifyProperty

Overrides:

verifyProperty in class ComponentFunction

Throws:

SAFSException

componentClick

protected void componentClick()
                       throws SAFSException

Purpose: componentClick

Overrides:

componentClick in class ComponentFunction

Throws:

SAFSException

inputKeystrokes

protected void inputKeystrokes()
                        throws SAFSException

Purpose: inputKeys and inputCharacters

Overrides:

inputKeystrokes in class ComponentFunction

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

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

See Also:

ComponentFunction.deduceImageRect(String)

captureObjectData

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

Overrides:

captureObjectData in class ComponentFunction

Returns:

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

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

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

scrollToAndClickComponent

protected void scrollToAndClickComponent(SGuiObject o)

Scrolls to a component then left clicks on it.

Parameters:

o - component to be clicked

scrollToComponent

protected void scrollToComponent(SGuiObject o)

Scrolls to a component on the page

Parameters:

o - component to be scrolled to

getComponentBounds

protected java.awt.Rectangle getComponentBounds(java.lang.String s)

Gets the size of the component

Parameters:

s - component

Returns:

size of the component

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