org.finra.jtaf.ewd.widget

Interface IElement

All Known Subinterfaces:

IButton, ICalendar, ICheckBox, IDropDown, IEditableElement, IHyperLink, IImage, IInteractiveElement, IInteractiveTable, IRadioGroup, IReadableElement, ISelectList, ITable, ITextField

All Known Implementing Classes:

Button, CheckBox, DropDown, Element, HtmlList, HyperLink, Image, Input, InteractiveElement, InteractiveHtmlList, RadioGroup, Select, Table

public interface IElement

This is the base interface for all widgets

Method Summary

Modifier and Type	Method and Description
void	eval(String javascript) Implementing this method would allow to execute a javascript on the element
void	fireEvent(String event) Implementing this method would allow for forcing an element to fire a specific event
void	focusOn() Implementing this method would allow for the element to be brought into focus
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() Implementing this method would allow for getting the text of all of this element's child nodes
String	getCssValue(String propertyName) Implementing this method would allow for getting the CSS value given the properties name
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() Deprecated. getLocator is no longer reliable when IElements can be created from Bys
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() Implementing this method would allow for highlighting this element
void	highlight(String color) 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 useJavaXpath) Implementing this method would allow for checking if an element is present or not
boolean	isElementPresent(long time) 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 time) 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() Implementing this method would allow for checking whether an element is within the bounds of the window
void	scrollTo() Implementing this method would allow for the element to be scrolled to on the page
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 time) 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 time) 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
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) Implementing this method would allow for the test to wait a designated length of time until the element is no longer visible before progressing
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) Implementing this method would allow for the test to wait until a designated length of time the element is visible before progressing

Method Detail

getLocator

String getLocator()

Deprecated. getLocator is no longer reliable when IElements can be created from Bys

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

Returns:

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

getByLocator

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.

Returns:

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

isElementPresent

boolean isElementPresent()
                  throws WidgetException

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

Returns:

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

Throws:

WidgetException

isElementPresent

boolean isElementPresent(long time)
                  throws WidgetException

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

Parameters:

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

boolean isElementPresent(boolean useJavaXpath)
                  throws WidgetException

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

Parameters:

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

isElementNotPresent

boolean isElementNotPresent()
                     throws WidgetException

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

Returns:

Throws:

WidgetException

isElementNotPresent

boolean isElementNotPresent(long timeout)
                     throws WidgetException

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

Parameters:

timeout - Milliseconds

Returns:

Throws:

WidgetException

isElementVisible

boolean isElementVisible()
                  throws WidgetException

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

Returns:

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

Throws:

WidgetException

isElementVisible

boolean isElementVisible(long time)
                  throws WidgetException

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

Parameters:

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

boolean isWithinBoundsOfWindow()
                        throws WidgetException

Implementing this method would allow for checking whether an element is within the bounds of the window

Returns:

Throws:

WidgetException

waitForElementPresent

void waitForElementPresent()
                    throws WidgetException,
                           WidgetTimeoutException

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

Throws:

WidgetException

WidgetTimeoutException

waitForElementPresent

void waitForElementPresent(long time)
                    throws WidgetException,
                           WidgetTimeoutException

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

Parameters:

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

Throws:

WidgetException

WidgetTimeoutException

waitForElementNotPresent

void waitForElementNotPresent()
                       throws WidgetException,
                              WidgetTimeoutException

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

Throws:

WidgetException

WidgetTimeoutException

waitForElementNotPresent

void waitForElementNotPresent(long time)
                       throws WidgetException,
                              WidgetTimeoutException

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

Parameters:

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

Throws:

WidgetException

WidgetTimeoutException

waitForVisible

void waitForVisible()
             throws WidgetException,
                    WidgetTimeoutException

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

Throws:

WidgetException

WidgetTimeoutException

waitForVisible

void waitForVisible(long time)
             throws WidgetException

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

Parameters:

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

Throws:

WidgetException

waitForNotVisible

void waitForNotVisible()
                throws WidgetException,
                       WidgetTimeoutException

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

Throws:

WidgetException

WidgetTimeoutException

waitForNotVisible

void waitForNotVisible(long time)
                throws WidgetException

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

Parameters:

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

Throws:

WidgetException

getText

String getText()
        throws WidgetException

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

Returns:

the text of the element as a String

Throws:

WidgetException

isAttributePresent

boolean isAttributePresent(String attributeName)
                    throws WidgetException

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

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

String getAttribute(String attributeName)
             throws WidgetException

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

Parameters:

attributeName - - the attribute that is being grabbed

Returns:

the attribute's value

Throws:

WidgetException

waitForAttributeEqualTo

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

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

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:

WidgetException

WidgetTimeoutException

waitForAttributeEqualTo

void waitForAttributeEqualTo(String attributeName,
                             String attributeValue,
                             long time)
                      throws WidgetException,
                             WidgetTimeoutException

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

Parameters:

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

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

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

Throws:

WidgetException

WidgetTimeoutException

waitForAttributeNotEqualTo

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

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

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

WidgetTimeoutException

waitForAttributeNotEqualTo

void waitForAttributeNotEqualTo(String attributeName,
                                String attributeValue,
                                long time)
                         throws WidgetException,
                                WidgetTimeoutException

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

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

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

Throws:

WidgetException

WidgetTimeoutException

waitForAttribute

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

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

Parameters:

attributeName - Name of the attribute

pattern - String pattern to match

timeout - Milliseconds

Throws:

WidgetException

waitForAttribute

void waitForAttribute(String attributeName,
                      String pattern)
               throws WidgetException

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

Parameters:

attributeName - Name of the attribute

pattern - String pattern to match

Throws:

WidgetException

waitForNotAttribute

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

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

Parameters:

attributeName - Name of the attribute

pattern - String pattern to match

timeout - Milliseconds

Throws:

WidgetException

waitForNotAttribute

void waitForNotAttribute(String attributeName,
                         String pattern)
                  throws WidgetException

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

Parameters:

attributeName - Name of the attribute

pattern - String pattern to match

Throws:

WidgetException

waitForText

void waitForText()
          throws WidgetException,
                 WidgetTimeoutException

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

Throws:

WidgetException

WidgetTimeoutException

waitForText

void waitForText(long time)
          throws WidgetException,
                 WidgetTimeoutException

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

Parameters:

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

Throws:

WidgetException

WidgetTimeoutException

waitForEnabled

void waitForEnabled()
             throws WidgetException

Waits for element to be enabled within period of maxRequestTimeout

Throws:

WidgetException

waitForEnabled

void waitForEnabled(long time)
             throws WidgetException

Waits for element to be enabled within period of specified time

Parameters:

time - Milliseconds

Throws:

WidgetException

getLocationX

int getLocationX()
          throws WidgetException

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

Returns:

the element's X-coordinate as an integer

Throws:

WidgetException

getLocationY

int getLocationY()
          throws WidgetException

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

Returns:

the element's Y-coordinate as an integer

Throws:

WidgetException

hasText

boolean hasText(String text)
         throws WidgetException

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

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

String getCssValue(String propertyName)
            throws WidgetException

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

Parameters:

propertyName - - the property to be checked

Returns:

the value of the property

Throws:

WidgetException

highlight

void highlight()
        throws WidgetException

Implementing this method would allow for highlighting this element

Throws:

WidgetException

highlight

void highlight(String color)
        throws WidgetException

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

Parameters:

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

Throws:

WidgetException

getWebElement

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

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

Returns:

this element as a WebElement

Throws:

WidgetException

isEnabled

boolean isEnabled()
           throws WidgetException

Returns true if the element is enabled.

Returns:

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

Throws:

WidgetException

fireEvent

void fireEvent(String event)
        throws WidgetException

Implementing this method would allow for forcing an element to fire a specific event

Parameters:

event - - the event that this element should fire

Throws:

WidgetException

getChildNodesValuesText

String[] getChildNodesValuesText()
                          throws WidgetException

Implementing this method would allow for getting the text of all of this element's child nodes

Returns:

an array containing the text of all the child nodes

Throws:

WidgetException

getInnerHTML

String getInnerHTML()
             throws WidgetException

Returns inner HTML of the element

Returns:

the inner HTML as a string

Throws:

WidgetException

eval

void eval(String javascript)
   throws WidgetException

Implementing this method would allow to execute a javascript on the element

Parameters:

javascript - the javascript code you want to execute

Throws:

WidgetException

scrollTo

void scrollTo()
       throws WidgetException

Implementing this method would allow for the element to be scrolled to on the page

Throws:

WidgetException

focusOn

void focusOn()
      throws WidgetException

Implementing this method would allow for the element to be brought into focus

Throws:

WidgetException