com.coveros.selenified.element

Class Element

java.lang.Object

com.coveros.selenified.element.Element

public class Element
extends Object

Element an object representative of a web element on a particular page that is under test. Elements should be directly interacted with, with actions performed on them, and assertions make about their current state

Version:

3.0.0

Author:

Max Saperstone

Constructor Summary

Constructors

Constructor and Description
Element(org.openqa.selenium.WebDriver driver, OutputFile file, Locator type, String locator) Sets up the element object.
Element(org.openqa.selenium.WebDriver driver, OutputFile file, Locator type, String locator, int match) Sets up the element object.

Method Summary

Modifier and Type	Method and Description
Contains	assertContains() Verifies that the element has a particular value contained within it.
Equals	assertEquals() Verifies that the element has a particular value associated with it.
Excludes	assertExcludes() Verifies that the element doesn't have a particular value contained within it.
State	assertState() Verifies that the element has a particular state associated to it.
void	blur() Blurs (focuses and then unfocuses) the element, but only if the element is present, displayed, enabled, and an input.
void	clear() Clears text from the element, but only if the element is present, displayed, enabled, and an input.
void	click() Clicks on the element, but only if the element is present, displayed and enabled.
Get	get() Retrieves information about a particular element.
org.openqa.selenium.WebDriver	getDriver() Retrieves the Selenium driver instance
String	getLocator() Retrieves the selector set for this element
int	getMatch() Retrieves the uniqueness set for this element
Locator	getType() Retrieves the Locator set for this element
protected org.openqa.selenium.WebElement	getWebElement() Retrieves the identified matching web element using Webdriver
protected List<org.openqa.selenium.WebElement>	getWebElements() Retrieves all matching web elements using Webdriver
void	hover() Hovers over the element, but only if the element is present and displayed.
Is	is() Retrieves information about a particular element.
void	move() Scrolls the page to the element, making it displayed on the current viewport, but only if the element is present.
void	move(long position) Scrolls the page to the element, leaving X pixels at the top of the viewport above it, making it displayed on the current viewport, but only if the element is present.
String	prettyOutput() Retrieves a nicely HTML formatted output which identifies the element by locator and selector, framed with spaces, which can be used anywhere in a sentence
String	prettyOutputEnd() Retrieves a nicely HTML formatted output which identifies the element by locator and selector, which should be used to end a sentence
String	prettyOutputLowercase() Retrieves a nicely HTML formatted output which identifies the element by locator and selector, which can be used anywhere in a sentence
String	prettyOutputStart() Retrieves a nicely HTML formatted output which identifies the element by locator and selector, which should be used at the beginning of a sentence
void	select(int index) Selects the Nth option from the element, starting from 0, but only if the element is present, displayed, enabled, and an input.
void	selectFrame() Selects the frame represented by the element, but only if the element is present and displayed.
void	selectOption(String option) Selects the option from the dropdown matching the provided value, but only if the element is present, displayed, enabled, and an input.
void	selectValue(String value) Selects the value from the dropdown matching the provided value, but only if the element is present, displayed, enabled, and an input.
void	setMatch(int match) Indicates the uniqueness match of the element to interact with.
void	submit() Submits the element, but only if the element is present, displayed and enabled.
void	type(org.openqa.selenium.Keys key) Type the supplied key into the element, but only if the element is present, enabled, and an input.
void	type(String text) Type the supplied text into the element, but only if the element is present, enabled, and an input.
WaitFor	waitFor() Performs dyanamic waits on a particular element, until a particular condition is met.

Methods inherited from class java.lang.Object

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

Constructor Detail

Element

public Element(org.openqa.selenium.WebDriver driver,
               OutputFile file,
               Locator type,
               String locator)

Sets up the element object. Driver, and Output are defined here, which will control actions and all logging and records. Additionally, information about the element, the locator type, and the actual selector are defined to indicate which element to interact with on the current page

Parameters:

driver - - the selenium web driver, the underlying way all actions and assertions are controlled

file - - the TestOutput file. This is provided by the SeleniumTestBase functionality

type - - the locator type e.g. Locator.id, Locator.xpath

locator - - the locator string e.g. login, //input[@id='login']

Element

public Element(org.openqa.selenium.WebDriver driver,
               OutputFile file,
               Locator type,
               String locator,
               int match)

Sets up the element object. Driver, and Output are defined here, which will control actions and all logging and records. Additionally, information about the element, the locator type, the actual selector, and the element's uniqueness match are defined to indicate which element to interact with on the current page

Parameters:

driver - - the selenium web driver, the underlying way all actions and assertions are controlled

file - - the TestOutput file. This is provided by the SeleniumTestBase functionality

type - - the locator type e.g. Locator.id, Locator.xpath

locator - - the locator string e.g. login, //input[@id='login']

match - - if there are multiple matches of the selector, this is which match (starting at 0) to interact with

Method Detail

setMatch

public void setMatch(int match)

Indicates the uniqueness match of the element to interact with. By default this is set to 0, meaning the first element matching the locator and selector assumed

Parameters:

match - - if there are multiple matches of the selector, this is which match (starting at 0) to interact with

getType

public Locator getType()

Retrieves the Locator set for this element

Returns:

Locator: the locator for the element

getLocator

public String getLocator()

Retrieves the selector set for this element

Returns:

String: the selector for the element

getMatch

public int getMatch()

Retrieves the uniqueness set for this element

Returns:

Integer: the uniqueness match for the element

getDriver

public org.openqa.selenium.WebDriver getDriver()

Retrieves the Selenium driver instance

Returns:

WebDriver: access to the driver controlling the browser via webdriver

prettyOutputStart

public String prettyOutputStart()

Retrieves a nicely HTML formatted output which identifies the element by locator and selector, which should be used at the beginning of a sentence

Returns:

String: text identifying how the element was located

prettyOutputLowercase

public String prettyOutputLowercase()

Retrieves a nicely HTML formatted output which identifies the element by locator and selector, which can be used anywhere in a sentence

Returns:

String: text identifying how the element was located

prettyOutput

public String prettyOutput()

Retrieves a nicely HTML formatted output which identifies the element by locator and selector, framed with spaces, which can be used anywhere in a sentence

Returns:

String: text identifying how the element was located

prettyOutputEnd

public String prettyOutputEnd()

Retrieves a nicely HTML formatted output which identifies the element by locator and selector, which should be used to end a sentence

Returns:

String: text identifying how the element was located

is

public Is is()

Retrieves information about a particular element. A boolean is always returning, indicating if an object is present or not

waitFor

public WaitFor waitFor()

Performs dyanamic waits on a particular element, until a particular condition is met. Nothing is ever returned. The default wait is 5 seconds, but can be overridden. If the condition is not met in the allotted time, still nothing is returned, but an error is logged

get

public Get get()

Retrieves information about a particular element. If an object isn't present, null will be returned

assertState

public State assertState()

Verifies that the element has a particular state associated to it. These asserts are custom to the framework, and in addition to providing easy object oriented capabilities, they take screenshots with each verification to provide additional traceability, and assist in troubleshooting and debugging failing tests.

assertContains

public Contains assertContains()

Verifies that the element has a particular value contained within it. These asserts are custom to the framework, and in addition to providing easy object oriented capabilities, they take screenshots with each verification to provide additional traceability, and assist in troubleshooting and debugging failing tests.

assertExcludes

public Excludes assertExcludes()

Verifies that the element doesn't have a particular value contained within it. These asserts are custom to the framework, and in addition to providing easy object oriented capabilities, they take screenshots with each verification to provide additional traceability, and assist in troubleshooting and debugging failing tests.

assertEquals

public Equals assertEquals()

Verifies that the element has a particular value associated with it. These asserts are custom to the framework, and in addition to providing easy object oriented capabilities, they take screenshots with each verification to provide additional traceability, and assist in troubleshooting and debugging failing tests.

getWebElement

protected org.openqa.selenium.WebElement getWebElement()

Retrieves the identified matching web element using Webdriver

Returns:

WebElement: the element object, and all associated values with it

getWebElements

protected List<org.openqa.selenium.WebElement> getWebElements()

Retrieves all matching web elements using Webdriver

Returns:

List: a list of WebElement objects, and all associated values with them

click

public void click()

Clicks on the element, but only if the element is present, displayed and enabled. If those conditions are not met, the click action will be logged, but skipped and the test will continue.

submit

public void submit()

Submits the element, but only if the element is present, displayed and enabled. If those conditions are not met, the submit action will be logged, but skipped and the test will continue.

hover

public void hover()

Hovers over the element, but only if the element is present and displayed. If those conditions are not met, the hover action will be logged, but skipped and the test will continue.

blur

public void blur()

Blurs (focuses and then unfocuses) the element, but only if the element is present, displayed, enabled, and an input. If those conditions are not met, the blur action will be logged, but skipped and the test will continue.

type

public void type(String text)

Type the supplied text into the element, but only if the element is present, enabled, and an input. If those conditions are not met, the type action will be logged, but skipped and the test will continue. If the element is not displayed, a warning will be written in the log, to indicate this is not a normal action as could be performed by the user.

Parameters:

text - - the text to be typed in

type

public void type(org.openqa.selenium.Keys key)

Type the supplied key into the element, but only if the element is present, enabled, and an input. If those conditions are not met, the type action will be logged, but skipped and the test will continue. If the element is not displayed, a warning will be written in the log, to indicate this is not a normal action as could be performed by the user.

Parameters:

key - - the key to be pressed

clear

public void clear()

Clears text from the element, but only if the element is present, displayed, enabled, and an input. If those conditions are not met, the clear action will be logged, but skipped and the test will continue.

select

public void select(int index)

Selects the Nth option from the element, starting from 0, but only if the element is present, displayed, enabled, and an input. If those conditions are not met, the select action will be logged, but skipped and the test will continue.

Parameters:

index - - the select option to be selected - note, row numbering starts at 0

selectOption

public void selectOption(String option)

Selects the option from the dropdown matching the provided value, but only if the element is present, displayed, enabled, and an input. If those conditions are not met, the select action will be logged, but skipped and the test will continue.

Parameters:

option - - the select option to be selected

selectValue

public void selectValue(String value)

Selects the value from the dropdown matching the provided value, but only if the element is present, displayed, enabled, and an input. If those conditions are not met, the select action will be logged, but skipped and the test will continue.

Parameters:

value - - the select value to be selected

move

public void move()

Scrolls the page to the element, making it displayed on the current viewport, but only if the element is present. If that condition is not met, the move action will be logged, but skipped and the test will continue.

move

public void move(long position)

Scrolls the page to the element, leaving X pixels at the top of the viewport above it, making it displayed on the current viewport, but only if the element is present. If that condition is not met, the move action will be logged, but skipped and the test will continue.

Parameters:

position - - how many pixels above the element to scroll to

selectFrame

public void selectFrame()

Selects the frame represented by the element, but only if the element is present and displayed. If these conditions are not met, the move action will be logged, but skipped and the test will continue.