org.safs.cukes.ai.selenium

Class AIEditBoxActions

java.lang.Object

org.safs.SAFSPlus

org.safs.selenium.webdriver.SeleniumPlus

org.safs.cukes.ai.selenium.AISearchBase

org.safs.cukes.ai.selenium.AIComponent

org.safs.cukes.ai.selenium.AIEditBoxActions

public class AIEditBoxActions
extends AIComponent

Used to hold TEXTAREA and TEXT INPUT test step definitions for gherkin feature files. EditBoxes are generally found by matching their @placeholder, @aria-placeholder, or displayed text values; or by matching the Criteria.

Future support needs to include identifying the textfield by its @aria-labelledby or @for (or equivalent) attributes and finding the text label associated with the text field that contains the matching label text.

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 static java.lang.String	_editbox_elements_xpath
protected static java.util.List<java.lang.String>	_editbox_map
protected EditBox	editbox
static java.lang.String	TYPE "EditBox"

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

libComponent, MAX_TRY_DEFAULT, maxRetry

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

Method Summary

Modifier and Type	Method and Description
protected java.util.List<org.openqa.selenium.WebElement>	findElements(Criteria criteria) Find the WebElements according to the search Criteria. In this method we firstly find the WebElements by SeleniumPlus-Library (the frame may get switched if the RS containing information about frame). In not found, we try to find WebElements in AI way, Criteria's component RS will be treated as the anchor-label to search components around.
org.openqa.selenium.WebElement	findTextFieldFromClass(java.lang.String textlabel) Not yet fully functional.
org.openqa.selenium.WebElement	findTextFieldFromLabel(java.lang.String textlabel) Find an EditBox-type field that is associated with the provided textlabel in some way. Possible matches can be a TEXTAREA or INPUT tag with a 'placeholder' attribute, or any type of tag with an 'aria-placeholder' attribute, with the attribute value matching the provided textlabel. We can also match on a field if the provided textlabel matches the contents (value) of the field. We can also match on a field if the provided textlabel matches the label-component around the text-field. This routine does not yet support partial text matching, but it probably should once fully evaluated. If the editbox is not found, we will attempt to look in a child iframe, if present.
java.util.List<org.openqa.selenium.WebElement>	findTextFieldsFromLabel(java.lang.String textlabel) Find all EditBox-type fields that are associated with the provided textlabel in some way. Possible matches can be a TEXTAREA or INPUT tag with a 'placeholder' attribute, or any type of tag with an 'aria-placeholder' attribute, with the attribute value matching the provided textlabel. We can also match on a field if the provided textlabel matches the contents (value) of the field. We can also match on a field if the provided textlabel matches the label-component around the text-field. This routine does not yet support partial text matching, but it probably should once fully evaluated. We will try to search in the current frame if 'bypass frame reset' is set to true, otherwise we search in each frame. If the editbox is not found, we will attempt to find the editbox with label matched the 'textlabel' parameter.
protected java.lang.String	getType()
protected void	initComponent(org.openqa.selenium.WebElement we)
protected static void	loadEditBoxMap()
protected void	localProcess(java.lang.String action, java.util.List<java.lang.String> parameters) Handle the specific keywords against a specific component.
void	type_in_editbox(java.lang.String action, java.lang.String contents, java.lang.String criteria, java.lang.String type) Handle the EditBoxFunctions against the text-field matching the provided textlabel. Some actions (such as typekeys, SetTextValue, SetUnverifiedTextValue) can handle special keys

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

checkForCoord, clearHighlight, doSetText, generateCriteria, generateCriteria, getComponentRectangle, highlight, ignoreCache, process, process, process, setText

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

addNonRepeatedElements, convertElementArrayToList, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, findElementInParent, 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

"EditBox"

See Also:

Constant Field Values

editbox

protected EditBox editbox

_editbox_map

protected static java.util.List<java.lang.String> _editbox_map

_editbox_elements_xpath

protected static java.lang.String _editbox_elements_xpath

Constructor Detail

AIEditBoxActions

public AIEditBoxActions()

Method Detail

initComponent

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

Overrides:

initComponent in class AIComponent

Throws:

SeleniumPlusException

getType

protected java.lang.String getType()

Overrides:

getType in class AIComponent

Returns:

String, represent this component's type.

findElements

protected java.util.List<org.openqa.selenium.WebElement> findElements(Criteria criteria)

Description copied from class: AISearchBase

Find the WebElements according to the search Criteria.
In this method we firstly find the WebElements by SeleniumPlus-Library (the frame may get switched if the RS containing information about frame).
In not found, we try to find WebElements in AI way, Criteria's component RS will be treated as the anchor-label to search components around.

Overrides:

findElements in class AISearchBase

Parameters:

criteria - Criteria, the conditions helping to find elements

Returns:

List a list of matched elements

localProcess

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

Description copied from class: AIComponent

Handle the specific keywords against a specific component.

Overrides:

localProcess in class AIComponent

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.

findTextFieldsFromLabel

public java.util.List<org.openqa.selenium.WebElement> findTextFieldsFromLabel(java.lang.String textlabel)

Find all EditBox-type fields that are associated with the provided textlabel in some way.
Possible matches can be a TEXTAREA or INPUT tag with a 'placeholder' attribute, or any type of tag with an 'aria-placeholder' attribute, with the attribute value matching the provided textlabel.
We can also match on a field if the provided textlabel matches the contents (value) of the field.
We can also match on a field if the provided textlabel matches the label-component around the text-field.
This routine does not yet support partial text matching, but it probably should once fully evaluated.

We will try to search in the current frame if 'bypass frame reset' is set to true, otherwise we search in each frame.
If the editbox is not found, we will attempt to find the editbox with label matched the 'textlabel' parameter.

Parameters:

textlabel - -- placeholder text or displayed text value or the label (associated with EditBox) to match against.

Returns:

the first editbox-type field matching the textlabel criteria, or null if not found.

findTextFieldFromLabel

public org.openqa.selenium.WebElement findTextFieldFromLabel(java.lang.String textlabel)

Find an EditBox-type field that is associated with the provided textlabel in some way.
Possible matches can be a TEXTAREA or INPUT tag with a 'placeholder' attribute, or any type of tag with an 'aria-placeholder' attribute, with the attribute value matching the provided textlabel.
We can also match on a field if the provided textlabel matches the contents (value) of the field.
We can also match on a field if the provided textlabel matches the label-component around the text-field.
This routine does not yet support partial text matching, but it probably should once fully evaluated.
If the editbox is not found, we will attempt to look in a child iframe, if present.

Parameters:

textlabel - -- placeholder text or displayed text value to match against.

Returns:

the first editbox-type field matching the textlabel criteria, or null if not found.

loadEditBoxMap

protected static void loadEditBoxMap()
                              throws SAFSObjectRecognitionException

Throws:

SAFSObjectRecognitionException

findTextFieldFromClass

public org.openqa.selenium.WebElement findTextFieldFromClass(java.lang.String textlabel)
                                                      throws SAFSException

Not yet fully functional. Intent is to be able to locate EditBox-type WebElements based on their CSS classes matching the Class2Type mappings loaded from external properties files or other sources. If the element is not found, and an embedded iframe exists, then we will attempt to switch to that iframe and continue the search there.

Parameters:

textlabel -

Returns:

WebElement matching or null if not found.

Throws:

SAFSException

type_in_editbox

@Then(value="{editbox_action} {var_or_string} in the {var_mapitem_or_string} {editbox}")
public void type_in_editbox(java.lang.String action,
                                                                                                                      java.lang.String contents,
                                                                                                                      java.lang.String criteria,
                                                                                                                      java.lang.String type)
                                                                                                               throws SAFSException

Handle the EditBoxFunctions against the text-field matching the provided textlabel.
Some actions (such as typekeys, SetTextValue, SetUnverifiedTextValue) can handle special keys

Cucumber Expression: "{editbox_action} {var_or_string} in the {mapitem_or_string} {editbox}"
{checkbox_action} Matches TypeRegistryConfiguration.REGEX_EDITBOX_ACTION
{var_or_string} represents a variable name (with an optional leading symbol ^) or a double-quoted-string or a single-quoted-string.
{var_mapitem_or_string} Matches TypeRegistryConfiguration.REGEX_VAR_MAPITEM_OR_STRING, represents a variable, or a map item, such as mapID:section.item or a double-quoted-string or a single-quoted-string. It will be parsed by TypeRegistryConfiguration
{editbox} Matches possible names referring to an "editbox", TypeRegistryConfiguration.REGEX_EDITBOX

Examples invocations:

• Then type "My Search Query" in the "Search" field
• And type "MyUserID" in the "UserId" box
• But type "Something Else" in the "Comment" textfield
• Then typechars "to delete things" in the "TextArea" textarea
• Then typekeys "^a{Delete}" in the "TextArea" textarea
• Then SetTextCharacters "+(Hello World) {a 10}" in the "TextArea" editbox
• Then SetTextValue "+(Hello World) {a 10}" in the "TextArea" editbox
• Then SetUnverifiedTextCharacters "+(Hello World)" in the "TextArea" textarea
• Then SetUnverifiedTextValue "+(Hello World)" in the "TextArea" textarea
• type something into the text-field identified by the value of map item SapDemoApp:SAPDemoPageAI.TextArea
== SapDemoApp.map file =========
[SAPDemoPageAI]
TextArea="TextArea"
================================
Then type "My Search Query" in the SapDemoApp:SAPDemoPageAI.TextArea field

Parameters:

action - String, the action to perform. It should be one of TypeRegistryConfiguration.REGEX_EDITBOX_ACTION.

contents - String, the characters/keys to input

criteria - String, the search-conditions helping to find the EditBox

type - String, the possible name referring to an "editbox"

Throws:

SAFSObjectNotFoundException - if the item is not found and abort on find failure is enabled.

SAFSException

See Also:

AIMiscActions.abort_testing_on_item_not_found(), AIMiscActions.continue_testing_on_item_not_found(), AIComponent.process(String, String, int, List)