org.finra.jtaf.ewd.widget.element

Class Element

java.lang.Object

org.finra.jtaf.ewd.widget.element.Element

All Implemented Interfaces:

IElement

Direct Known Subclasses:

HtmlList, InteractiveElement

public class Element
extends Object
implements IElement

This is the base class for any element

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Element.HIGHLIGHT_MODES

Constructor Summary

Constructors

Constructor and Description
Element(org.openqa.selenium.By locator)
Element(String locator)

Method Summary

Modifier and Type	Method and Description
void	eval(String javascript) Executes JavaScript code on the current element in the current frame or window.
protected org.openqa.selenium.WebElement	findElement() Find the element using xpath, id, name, class name or tag name
void	fireEvent(String event) Fires a javascript event on a web element
void	focusOn() Focus on this element
String	getAttribute(String attributeName) Implementing this method would allow for getting an attribute of an element
org.openqa.selenium.By	getByLocator() Implementing this method would allow for obtaining the XPath, ID, name, CSS Selector, class name, or tag name to the element as By-Object.
String[]	getChildNodesValuesText() Returns the text contained in the child nodes of the current element
String	getCssValue(String propertyName) Implementing this method would allow for getting the CSS value given the properties name
ExtWebDriver	getGUIDriver() Get the WebDriver object to interact with the UI elements
String	getInnerHTML() Returns inner HTML of the element
int	getLocationX() Implementing this method would allow for obtaining the X-coordinate of the element
int	getLocationY() Implementing this method would allow for obtaining the Y-coordinate of the element
String	getLocator() Implementing this method would allow for obtaining the XPath, ID, name, CSS Selector, class name, or tag name to the element
String	getText() Implementing this method would allow for obtaining the text of the Element
org.openqa.selenium.WebElement	getWebElement() Implementing this method would allow for getting this element as a WebElement
boolean	hasText(String text) Implementing this method would allow for checking to see if the element's text contains a specific substring
void	highlight() highlight an element for the FIND mode
void	highlight(Element.HIGHLIGHT_MODES mode) Find the current element and highlight it according to the mode If mode is NONE, do nothing
void	highlight(String colorMode) Implementing this method would allow for highlighting this element a specific color
boolean	isAttributePresent(String attributeName) Implementing this method would allow for checking if the element has a specific attribute
boolean	isElementNotPresent() Implementing this method would allow for checking if an element is Not present
boolean	isElementNotPresent(long timeout) Implementing this method would allow for checking if an element is Not present within [timeout] milliseconds
boolean	isElementPresent() Implementing this method would allow for checking if an element is present or not
boolean	isElementPresent(boolean isJavaXPath) Implementing this method would allow for checking if an element is present or not
boolean	isElementPresent(long timeout) Implementing this method would allow for checking if an element is present or not
boolean	isElementVisible() Implementing this method would allow for checking if an element is visible or not
boolean	isElementVisible(long timeout) Implementing this method would allow for checking if an element is visible or not within a designated length of time
boolean	isEnabled() Returns true if the element is enabled.
boolean	isWithinBoundsOfWindow() Determine if the element is within the bounds of the window
void	scrollTo() Scroll to this element
void	setGUIDriver(ExtWebDriver guiDriver) Tell Selenium to use the provided WebDriver instance
void	waitForAttribute(String attributeName, String pattern) Waits for specific attribute value o match specific pattern within period of maxRequestTimeout
void	waitForAttribute(String attributeName, String pattern, long timeout) Waits for specific attribute value to match specific pattern within period of specified timeout
void	waitForAttributeEqualTo(String attributeName, String attributeValue) Implementing this method would allow for keeping the test from progressing until an element's attribute has the desired value
void	waitForAttributeEqualTo(String attributeName, String attributeValue, long timeout) Implementing this method would allow for keeping the test from progressing until an element's attribute has the desired value by the specified amount of time
void	waitForAttributeNotEqualTo(String attributeName, String attributeValue) Implementing this method would allow for keeping the test from progressing until an element's attribute no longer has the desired value
void	waitForAttributeNotEqualTo(String attributeName, String attributeValue, long timeout) Implementing this method would allow for keeping the test from progressing until an element's attribute no longer has the desired value by the specified amount of time
protected void	waitForCommand(WaitForConditionTimer.ITimerCallback callback, long timeout) wait for timeout amount of time
void	waitForElementNotPresent() Implementing this method would allow for the test to wait until the element is no longer present before progressing
void	waitForElementNotPresent(long time) Implementing this method would allow for the test to wait a designated length of time until the element is no longer present before progressing
void	waitForElementPresent() Implementing this method would allow for the test to wait until the element is present before progressing
void	waitForElementPresent(long time) Implementing this method would allow for the test to wait a designated length of time until the element is present before progressing
void	waitForEnabled() Waits for element to be enabled within period of maxRequestTimeout
void	waitForEnabled(long time) Waits for element to be enabled within period of specified time
void	waitForNotAttribute(String attributeName, String pattern) Waits for specific attribute value to not match specific pattern within period of maxRequestTimeout
void	waitForNotAttribute(String attributeName, String pattern, long timeout) Waits for specific attribute value not match specific pattern within period of specified timeout
void	waitForNotVisible() Implementing this method would allow for the test to wait until the element is no longer visible before progressing
void	waitForNotVisible(long time) Waits for specific element at locator to be not visible within period of specified time
void	waitForText() Implementing this method would allow for keeping the test from progressing until an element has text
void	waitForText(long time) Implementing this method would allow for keeping the test from progressing until an element has text
void	waitForVisible() Implementing this method would allow for the test to wait until the element is visible before progressing
void	waitForVisible(long time) Waits for specific element at locator to be visible within period of specified time

Methods inherited from class java.lang.Object

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

Constructor Detail

Element

public Element(String locator)

Parameters:

locator - XPath, ID, name, CSS Selector, class name, or tag name

Element

public Element(org.openqa.selenium.By locator)

Parameters:

locator - a By which defines this element by its first match

Method Detail

getLocator

public String getLocator()

Description copied from interface: IElement

Implementing this method would allow for obtaining the XPath, ID, name, CSS Selector, class name, or tag name to the element

Specified by:

getLocator in interface IElement

Returns:

the locator to the element in the form of a String.

getByLocator

public org.openqa.selenium.By getByLocator()

Description copied from interface: IElement

Implementing this method would allow for obtaining the XPath, ID, name, CSS Selector, class name, or tag name to the element as By-Object.

Specified by:

getByLocator in interface IElement

Returns:

the locator to the element in the form of a By-Object.

isElementPresent

public boolean isElementPresent()
                         throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for checking if an element is present or not

Specified by:

isElementPresent in interface IElement

Returns:

true if the element is present or false if it isn't

Throws:

WidgetException

isElementPresent

public boolean isElementPresent(long timeout)
                         throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for checking if an element is present or not

Specified by:

isElementPresent in interface IElement

Parameters:

timeout - - the length of time this method will wait for this element to be present

Returns:

true if the element is present or false if it isn't

Throws:

WidgetException

isElementPresent

public boolean isElementPresent(boolean isJavaXPath)
                         throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for checking if an element is present or not

Specified by:

isElementPresent in interface IElement

Parameters:

isJavaXPath - - if true, it attempts to find element using Java XPath API and if false it attempts to find the element using the WebDriver's API

Returns:

true if the element is present or false if it isn't

Throws:

WidgetException

isElementVisible

public boolean isElementVisible()
                         throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for checking if an element is visible or not

Specified by:

isElementVisible in interface IElement

Returns:

true if the element is visible or false if it isn't

Throws:

WidgetException

isElementVisible

public boolean isElementVisible(long timeout)
                         throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for checking if an element is visible or not within a designated length of time

Specified by:

isElementVisible in interface IElement

Parameters:

timeout - - the length of time this method will wait for this element to be present

Returns:

true if the element is visible or false if it isn't

Throws:

WidgetException

isWithinBoundsOfWindow

public boolean isWithinBoundsOfWindow()
                               throws WidgetException

Determine if the element is within the bounds of the window

Specified by:

isWithinBoundsOfWindow in interface IElement

Returns:

true or false

Throws:

WidgetException

waitForElementPresent

public void waitForElementPresent()
                           throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for the test to wait until the element is present before progressing

Specified by:

waitForElementPresent in interface IElement

Throws:

WidgetException

waitForElementPresent

public void waitForElementPresent(long time)
                           throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for the test to wait a designated length of time until the element is present before progressing

Specified by:

waitForElementPresent in interface IElement

Parameters:

time - - the length of time this method will wait for this element to be present

Throws:

WidgetException

waitForElementNotPresent

public void waitForElementNotPresent()
                              throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for the test to wait until the element is no longer present before progressing

Specified by:

waitForElementNotPresent in interface IElement

Throws:

WidgetException

waitForElementNotPresent

public void waitForElementNotPresent(long time)
                              throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for the test to wait a designated length of time until the element is no longer present before progressing

Specified by:

waitForElementNotPresent in interface IElement

Parameters:

time - - the length of time this method will wait for this element to be present

Throws:

WidgetException

waitForVisible

public void waitForVisible()
                    throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for the test to wait until the element is visible before progressing

Specified by:

waitForVisible in interface IElement

Throws:

WidgetException

waitForVisible

public void waitForVisible(long time)
                    throws WidgetException

Waits for specific element at locator to be visible within period of specified time

Specified by:

waitForVisible in interface IElement

Parameters:

time - Milliseconds

Throws:

WidgetException

waitForNotVisible

public void waitForNotVisible()
                       throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for the test to wait until the element is no longer visible before progressing

Specified by:

waitForNotVisible in interface IElement

Throws:

WidgetException

waitForNotVisible

public void waitForNotVisible(long time)
                       throws WidgetException

Waits for specific element at locator to be not visible within period of specified time

Specified by:

waitForNotVisible in interface IElement

Parameters:

time - Milliseconds

Throws:

WidgetException

isAttributePresent

public boolean isAttributePresent(String attributeName)
                           throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for checking if the element has a specific attribute

Specified by:

isAttributePresent in interface IElement

Parameters:

attributeName - - the attribute that is being checked for

Returns:

true if the element has this attribute and false if it does not

Throws:

WidgetException

getAttribute

public String getAttribute(String attributeName)
                    throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for getting an attribute of an element

Specified by:

getAttribute in interface IElement

Parameters:

attributeName - - the attribute that is being grabbed

Returns:

the attribute's value

Throws:

WidgetException

getLocationX

public int getLocationX()
                 throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for obtaining the X-coordinate of the element

Specified by:

getLocationX in interface IElement

Returns:

the element's X-coordinate as an integer

Throws:

WidgetException

getLocationY

public int getLocationY()
                 throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for obtaining the Y-coordinate of the element

Specified by:

getLocationY in interface IElement

Returns:

the element's Y-coordinate as an integer

Throws:

WidgetException

setGUIDriver

public void setGUIDriver(ExtWebDriver guiDriver)

Tell Selenium to use the provided WebDriver instance

Parameters:

guiDriver - ExtendedWebDriver object

getGUIDriver

public final ExtWebDriver getGUIDriver()

Get the WebDriver object to interact with the UI elements

Returns:

ExtendedWebDriver specific type of WebDriver object (browser-specific)

getText

public String getText()
               throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for obtaining the text of the Element

Specified by:

getText in interface IElement

Returns:

the text of the element as a String

Throws:

WidgetException

hasText

public boolean hasText(String text)
                throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for checking to see if the element's text contains a specific substring

Specified by:

hasText in interface IElement

Parameters:

text - - the text that is being checked for

Returns:

true if the text is present and false if it is not

Throws:

WidgetException

getCssValue

public String getCssValue(String propertyName)
                   throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for getting the CSS value given the properties name

Specified by:

getCssValue in interface IElement

Parameters:

propertyName - - the property to be checked

Returns:

the value of the property

Throws:

WidgetException

waitForAttributeEqualTo

public void waitForAttributeEqualTo(String attributeName,
                                    String attributeValue)
                             throws WidgetTimeoutException

Description copied from interface: IElement

Implementing this method would allow for keeping the test from progressing until an element's attribute has the desired value

Specified by:

waitForAttributeEqualTo in interface IElement

Parameters:

attributeName - - the attribute that is having it's value waited on

attributeValue - - the value that the test waits for the attribute to have

Throws:

WidgetTimeoutException

waitForAttributeEqualTo

public void waitForAttributeEqualTo(String attributeName,
                                    String attributeValue,
                                    long timeout)
                             throws WidgetTimeoutException

Description copied from interface: IElement

Implementing this method would allow for keeping the test from progressing until an element's attribute has the desired value by the specified amount of time

Specified by:

waitForAttributeEqualTo in interface IElement

Parameters:

attributeName - - the attribute that is having it's value waited on

attributeValue - - the value that the test waits for the attribute to have

timeout - - the length of time this method will wait for the attribute to be equal to the desired value

Throws:

WidgetTimeoutException

waitForAttributeNotEqualTo

public void waitForAttributeNotEqualTo(String attributeName,
                                       String attributeValue)
                                throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for keeping the test from progressing until an element's attribute no longer has the desired value

Specified by:

waitForAttributeNotEqualTo in interface IElement

Parameters:

attributeName - - the attribute that is having it's value waited on

attributeValue - - the value that the test waits for the attribute to no longer have

Throws:

WidgetException

waitForText

public void waitForText()
                 throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for keeping the test from progressing until an element has text

Specified by:

waitForText in interface IElement

Throws:

WidgetException

findElement

protected org.openqa.selenium.WebElement findElement()
                                              throws WidgetException

Find the element using xpath, id, name, class name or tag name

Returns:

WebElement the element identified by any of the properties

Throws:

WidgetException

highlight

public void highlight()
               throws WidgetException

highlight an element for the FIND mode

Specified by:

highlight in interface IElement

Throws:

WidgetException

eval

public void eval(String javascript)
          throws WidgetException

Executes JavaScript code on the current element in the current frame or window.

Specified by:

eval in interface IElement

Parameters:

javascript - the javascript code to be executed

Throws:

WidgetException

getWebElement

public org.openqa.selenium.WebElement getWebElement()
                                             throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for getting this element as a WebElement

Specified by:

getWebElement in interface IElement

Returns:

this element as a WebElement

Throws:

WidgetException

waitForCommand

protected void waitForCommand(WaitForConditionTimer.ITimerCallback callback,
                              long timeout)
                       throws WidgetTimeoutException

wait for timeout amount of time

Parameters:

callback -

timeout -

Throws:

WidgetTimeoutException

waitForText

public void waitForText(long time)
                 throws WidgetException,
                        WidgetTimeoutException

Description copied from interface: IElement

Implementing this method would allow for keeping the test from progressing until an element has text

Specified by:

waitForText in interface IElement

Parameters:

time - -the length of time this method will wait for the text

Throws:

WidgetException

WidgetTimeoutException

waitForNotAttribute

public void waitForNotAttribute(String attributeName,
                                String pattern,
                                long timeout)
                         throws WidgetException

Description copied from interface: IElement

Waits for specific attribute value not match specific pattern within period of specified timeout

Specified by:

waitForNotAttribute in interface IElement

Parameters:

attributeName - Name of the attribute

pattern - String pattern to match

timeout - Milliseconds

Throws:

WidgetException

waitForNotAttribute

public void waitForNotAttribute(String attributeName,
                                String pattern)
                         throws WidgetException

Description copied from interface: IElement

Waits for specific attribute value to not match specific pattern within period of maxRequestTimeout

Specified by:

waitForNotAttribute in interface IElement

Parameters:

attributeName - Name of the attribute

pattern - String pattern to match

Throws:

WidgetException

waitForAttribute

public void waitForAttribute(String attributeName,
                             String pattern,
                             long timeout)
                      throws WidgetException

Description copied from interface: IElement

Waits for specific attribute value to match specific pattern within period of specified timeout

Specified by:

waitForAttribute in interface IElement

Parameters:

attributeName - Name of the attribute

pattern - String pattern to match

timeout - Milliseconds

Throws:

WidgetException

waitForAttribute

public void waitForAttribute(String attributeName,
                             String pattern)
                      throws WidgetException

Description copied from interface: IElement

Waits for specific attribute value o match specific pattern within period of maxRequestTimeout

Specified by:

waitForAttribute in interface IElement

Parameters:

attributeName - Name of the attribute

pattern - String pattern to match

Throws:

WidgetException

waitForEnabled

public void waitForEnabled()
                    throws WidgetException

Description copied from interface: IElement

Waits for element to be enabled within period of maxRequestTimeout

Specified by:

waitForEnabled in interface IElement

Throws:

WidgetException

waitForEnabled

public void waitForEnabled(long time)
                    throws WidgetException

Description copied from interface: IElement

Waits for element to be enabled within period of specified time

Specified by:

waitForEnabled in interface IElement

Parameters:

time - Milliseconds

Throws:

WidgetException

isEnabled

public boolean isEnabled()
                  throws WidgetException

Description copied from interface: IElement

Returns true if the element is enabled.

Specified by:

isEnabled in interface IElement

Returns:

true if this element is enabled and false if it is not

Throws:

WidgetException

waitForAttributeNotEqualTo

public void waitForAttributeNotEqualTo(String attributeName,
                                       String attributeValue,
                                       long timeout)
                                throws WidgetTimeoutException

Description copied from interface: IElement

Implementing this method would allow for keeping the test from progressing until an element's attribute no longer has the desired value by the specified amount of time

Specified by:

waitForAttributeNotEqualTo in interface IElement

Parameters:

attributeName - - the attribute that is having it's value waited on

attributeValue - - the value that the test waits for the attribute to no longer have

timeout - - the length of time this method will wait for the attribute to be no longer have to the desired value

Throws:

WidgetTimeoutException

isElementNotPresent

public boolean isElementNotPresent()
                            throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for checking if an element is Not present

Specified by:

isElementNotPresent in interface IElement

Returns:

Throws:

WidgetException

isElementNotPresent

public boolean isElementNotPresent(long timeout)
                            throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for checking if an element is Not present within [timeout] milliseconds

Specified by:

isElementNotPresent in interface IElement

Parameters:

timeout - Milliseconds

Returns:

Throws:

WidgetException

fireEvent

public void fireEvent(String event)
               throws WidgetException

Fires a javascript event on a web element

Specified by:

fireEvent in interface IElement

Parameters:

event - the javascript code for the event

Throws:

WidgetException

getChildNodesValuesText

public String[] getChildNodesValuesText()
                                 throws WidgetException

Returns the text contained in the child nodes of the current element

Specified by:

getChildNodesValuesText in interface IElement

Returns:

Array of texts in children nodes

Throws:

WidgetException

getInnerHTML

public String getInnerHTML()
                    throws WidgetException

Description copied from interface: IElement

Returns inner HTML of the element

Specified by:

getInnerHTML in interface IElement

Returns:

the inner HTML as a string

Throws:

WidgetException

highlight

public void highlight(String colorMode)
               throws WidgetException

Description copied from interface: IElement

Implementing this method would allow for highlighting this element a specific color

Specified by:

highlight in interface IElement

Parameters:

colorMode - - the color to be used when highlighting the element

Throws:

WidgetException

highlight

public void highlight(Element.HIGHLIGHT_MODES mode)
               throws WidgetException

Find the current element and highlight it according to the mode If mode is NONE, do nothing

Parameters:

mode -

Throws:

WidgetException

scrollTo

public void scrollTo()
              throws WidgetException

Scroll to this element

Specified by:

scrollTo in interface IElement

Throws:

WidgetException

focusOn

public void focusOn()
             throws WidgetException

Focus on this element

Specified by:

focusOn in interface IElement

Throws:

WidgetException