org.safs.cukes.ai.selenium

Class AIComponent

java.lang.Object

org.safs.SAFSPlus

org.safs.selenium.webdriver.SeleniumPlus

org.safs.cukes.ai.selenium.AISearchBase

org.safs.cukes.ai.selenium.AIComponent

Direct Known Subclasses:

AIButtonActions, AICheckBoxActions, AIComboBoxActions, AIComponentActions, AIEditBoxActions, AIListViewActions, AIMiscActions, AITextActions

public class AIComponent
extends AISearchBase

Used to hold checkbox test step definitions for gherkin feature files. CheckBoxes are generally found by matching the Criteria.

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.selenium.webdriver.SeleniumPlus

SeleniumPlus.Assert, SeleniumPlus.CheckBox, SeleniumPlus.ComboBox, SeleniumPlus.Component, SeleniumPlus.Counters, SeleniumPlus.EditBox, SeleniumPlus.Files, SeleniumPlus.ListView, SeleniumPlus.Logging, SeleniumPlus.Menu, SeleniumPlus.Misc, SeleniumPlus.Rest, SeleniumPlus.ScrollBar, SeleniumPlus.Strings, SeleniumPlus.TabControl, SeleniumPlus.Tree, SeleniumPlus.WDTimeOut, SeleniumPlus.Window

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

SAFSPlus.DriverCommand

Field Summary

Fields

Modifier and Type	Field and Description
protected Component	libComponent The library component
static int	MAX_TRY_DEFAULT
protected int	maxRetry The maximum time to retry 'enter the text' into Component box if the verification fails.
static java.lang.String	TYPE "Component"

Fields inherited from class org.safs.cukes.ai.selenium.AISearchBase

_abort_on_assert_failure, _abort_on_find_failure, _case_does_not_matter, _log_details, _substring_matches_allowed, _using_cached_component, cachedLibComponents, DEFAULT_SEPLUS_AI_DEFINITIONS, frames, frameTree, GLUE_OPT, searchContext

Fields inherited from class org.safs.selenium.webdriver.SeleniumPlus

PRODUCT_DESCRIPTION, PRODUCT_NAME, PRODUCT_VERSION, Runner, TEMP_SELENIUM_PLUS_RS_VAR

Fields inherited from class org.safs.SAFSPlus

_autorun, _autorunClassProvided, _injectDataAwareness, _isInjected, _isSPC, _junit, allowExit, ARG_AUTORUN, ARG_AUTORUN_CLASS, ARG_JUNIT, ARG_SAFSVAR, DefaultRunner, exitCode, normalizeTextForInput, prevResults, RELATIVE_TO_PARENT, RELATIVE_TO_SCREEN, springApplicationContext

Constructor Summary

Constructors

Constructor and Description
AIComponent()

Method Summary

Modifier and Type	Method and Description
protected java.awt.Point	checkForCoord(java.lang.String coordinate)
protected boolean	clearHighlight() Clear the highlight after the execution if user has turned on the highlight ability.
protected boolean	doSetText(java.lang.String libName, java.lang.String text, boolean isCharacter, boolean needVerify)
protected Criteria	generateCriteria(java.lang.String recognitionString)
protected Criteria	generateCriteria(java.lang.String recognitionString, java.lang.String customerType)
protected java.awt.Rectangle	getComponentRectangle()
protected java.lang.String	getType()
protected boolean	highlight() Highlight the WebElement if user has turned on the highlight ability.
protected boolean	ignoreCache(java.lang.String action)
protected void	initComponent(org.openqa.selenium.WebElement we)
protected void	localProcess(java.lang.String action, java.util.List<java.lang.String> parameters) Handle the specific keywords against a specific component.
protected void	process(java.lang.String action, Criteria criteria, int nthMatched, java.util.List<java.lang.String> parameters) Handle the SAFS Keywords against the a component matching the provided textlabel.
protected void	process(java.lang.String action, java.lang.String criteria, int nthMatched, java.util.List<java.lang.String> parameters) Handle the SAFS Keywords against the a component matching the provided textlabel.
protected void	process(java.lang.String action, java.lang.String criteria, int nthMatched, java.util.List<java.lang.String> parameters, java.lang.String customerType) Handle the SAFS Keywords against the a component matching the provided textlabel.
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.

Methods inherited from class org.safs.cukes.ai.selenium.AISearchBase

addNonRepeatedElements, convertElementArrayToList, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, findElementInParent, findElements, findElementsInParent, findSelectableItemFromText, getCachedLibComponent, getFirstIFrame, getXpathType, initializeFrames, logElementIdInfo, logElementProperties, logListElementsInfo, logMapKeyValues, main, matched, resetFrames, runCukesTest, runCukesTest, runCukesTest, runTest, saveCachedLibComponent

Methods inherited from class org.safs.selenium.webdriver.SeleniumPlus

AbortTest, AltLeftDrag, Click, ClickUnverified, CtrlAltLeftDrag, CtrlClick, CtrlLeftDrag, CtrlRightClick, CtrlShiftLeftDrag, deduceFilterAreas, DoubleClick, executeAsyncScript, ExecuteScript, executeScript, GetGUIImage, GetGUIImage, getObject, getObject, GetVariableValue, Highlight, HoverScreenLocation, LeftDrag, Pause, PrintTestCaseSummary, PrintTestSuiteSummary, RightClick, RightDrag, SetVariableValue, ShiftClick, ShiftLeftDrag, StartTestCase, StartTestSuite, StartWebBrowser, StopTestCase, StopWebBrowser, SwitchWebBrowser, TypeChars, TypeEncryption, TypeKeys, VerifyBinaryFileToFile, VerifyFileToFile, VerifyGUIImageToFile, VerifyTextFileToFile, VerifyValueContains, VerifyValueContainsIgnoreCase, VerifyValueDoesNotContain, VerifyValues, VerifyValuesIgnoreCase, VerifyValuesNotEqual, WaitForGUI, WebDriver

Methods inherited from class org.safs.SAFSPlus

_getMappedValue, _getVariable, _processArgs, _resolveDDVariables, _setVariable, action, actionGUILess, autorun, back, combineParams, command, debug, error, forward, getAllowExit, getExitCode, getRunner, iDriver, normalizeTextForInput, quote, quotePath, replaceSeparator, setAllowExit, setExitCode, setLeveledTest, setNormalizeTextForInput, setRunner, testStatusCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final java.lang.String TYPE

"Component"

See Also:

Constant Field Values

libComponent

protected Component libComponent

The library component

MAX_TRY_DEFAULT

public static int MAX_TRY_DEFAULT

maxRetry

protected int maxRetry

The maximum time to retry 'enter the text' into Component box if the verification fails.

Constructor Detail

AIComponent

public AIComponent()

Method Detail

initComponent

protected void initComponent(org.openqa.selenium.WebElement we)
                      throws SeleniumPlusException

Throws:

SeleniumPlusException

highlight

protected boolean highlight()

Highlight the WebElement if user has turned on the highlight ability. Should be called in the initComponent(WebElement) after the libComponent has been initialized.

Returns:

boolean true if the WebElement has been highlighted.

clearHighlight

protected boolean clearHighlight()

Clear the highlight after the execution if user has turned on the highlight ability.

Returns:

boolean if the highlighted rectangle has been cleared successfully.

doSetText

protected boolean doSetText(java.lang.String libName,
                            java.lang.String text,
                            boolean isCharacter,
                            boolean needVerify)
                     throws SeleniumPlusException

Parameters:

libName - String, the name of the library, like "EditBox", "CheckBox" etc.

text - String, the characters or keys to input

isCharacter - boolean, if the text should be input as characters or as keys

needVerify - boolean, if need to verify the text has been input correctly

Returns:

boolean

Throws:

SeleniumPlusException

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

getType

protected java.lang.String getType()

Returns:

String, represent this component's type.

process

protected void process(java.lang.String action,
                       java.lang.String criteria,
                       int nthMatched,
                       java.util.List<java.lang.String> parameters,
                       java.lang.String customerType)
                throws SAFSException

Handle the SAFS Keywords against the a component matching the provided textlabel.

Parameters:

action - String, the action to perform

criteria - String, the search-conditions helping to find the component
it can be the 'text label' associated with (or near) the component
it can be the xpath (start with prefix XPATH=) to identify the component
it can be the css-selector (start with prefix CSS=) to find the component
It can be map-item (plain-text, SAFS-recognition-string) defined in a map file.

nthMatched - int, 1-based index, the Nth matched component if there are multiple components matching the search criteria.

parameters - List, the parameters required by the action

customerType - String, the customer-defined type for matching component.

Throws:

SAFSException - if target object cannot be found, or the keyword is not supported, or any exception has been met.

process

protected void process(java.lang.String action,
                       java.lang.String criteria,
                       int nthMatched,
                       java.util.List<java.lang.String> parameters)
                throws SAFSException

Handle the SAFS Keywords against the a component matching the provided textlabel.

Parameters:

action - String, the action to perform

criteria - String, the search-conditions helping to find the component
it can be the 'text label' associated with (or near) the component
it can be the xpath (start with prefix XPATH=) to identify the component
it can be the css-selector (start with prefix CSS=) to find the component
It can be map-item (plain-text, SAFS-recognition-string) defined in a map file.

nthMatched - int, 1-based index, the Nth matched component if there are multiple components matching the search criteria.

parameters - List, the parameters required by the action

Throws:

SAFSException - if target object cannot be found, or the keyword is not supported, or any exception has been met.

process

protected void process(java.lang.String action,
                       Criteria criteria,
                       int nthMatched,
                       java.util.List<java.lang.String> parameters)
                throws SAFSException

Handle the SAFS Keywords against the a component matching the provided textlabel.

Parameters:

action - String, the action to perform

criteria - Criteria, the search-conditions helping to find the component

nthMatched - int, 1-based index, the Nth matched component if there are multiple components matching the search criteria.

parameters - List, the parameters required by the action

Throws:

SAFSException - if target object cannot be found, or the keyword is not supported, or any exception has been met.

ignoreCache

protected boolean ignoreCache(java.lang.String action)

localProcess

protected void localProcess(java.lang.String action,
                            java.util.List<java.lang.String> parameters)
                     throws SAFSException

Handle the specific keywords against a specific component.

Parameters:

action - String, the action to perform

parameters - List, the action's parameters

Throws:

SAFSException - if target object cannot be found, or the action is not supported, or any exception has been met.

checkForCoord

protected java.awt.Point checkForCoord(java.lang.String coordinate)

getComponentRectangle

protected java.awt.Rectangle getComponentRectangle()

generateCriteria

protected Criteria generateCriteria(java.lang.String recognitionString)

Parameters:

recognitionString - String, it can be

1. text-label
2. a recognition-string containing both window's info and component's info separated by TypeRegistryConfiguration.SEPARATOR_WIN_COMP.

Returns:

Criteria, it is used to find matched WebElement

generateCriteria

protected Criteria generateCriteria(java.lang.String recognitionString,
                                    java.lang.String customerType)

Parameters:

recognitionString - String, it can be

1. text-label
2. a recognition-string containing both window's info and component's info separated by TypeRegistryConfiguration.SEPARATOR_WIN_COMP.

customerType - String, the customer-defined type for matching component.

Returns:

Criteria, it is used to find matched WebElement