ru.yandex.qatools.htmlelements.element

Class HtmlElement

java.lang.Object

ru.yandex.qatools.htmlelements.element.HtmlElement

All Implemented Interfaces:

org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement, org.openqa.selenium.WrapsElement, Named

public class HtmlElement
extends Object
implements org.openqa.selenium.WebElement, org.openqa.selenium.WrapsElement, Named

The base class to be used for making blocks of elements. To make a class that will represent a block of elements (e.g. web form) create a descendant of this class, annotate it with Name annotation if necessary and fill it with elements. For example:

 @Name("Search Form")
 @FindBy(css = "form_css")
 public class SearchForm extends HtmlElement {
 @Name("Request Input")
 @FindBy(css = "request_input_css")
 private TextInput requestInput;
 
 @Name("Search Button")
 @FindBy(css = "search_button_css")
 private Button searchButton;
 
 public TextInput getRequestInput() {
 return requestInput;
 }
 
 public Button getSearchButton() {
 return searchButton;
 }
 }
 

Then you can use created blocks as fields of page objects or you can also initialize them directly with methods of HtmlElementLoader class. Note that this class implements WebElement interface so you can substitute instances of your block classes for WebElements where it's necessary.

Author:

Artem Eroshenko eroshenkoam@yandex-team.ru, Artem Koshelev artkoshelev@yandex-team.ru, Alexander Tolmachev starlight@yandex-team.ru

Constructor Summary

Constructors

Constructor and Description
HtmlElement()

Method Summary

Modifier and Type	Method and Description
void	clear() If this element is a text entry element, this will clear the value.
void	click() Clicks this element.
boolean	exists() Determines whether or not this element exists on page.
org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By by) Find the first WebElement using the given mechanism.
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by) Finds all elements within the current context using the given mechanism.
String	getAttribute(String name) Gets the value of a the given attribute of the element.
String	getCssValue(String name) Gets the value of a given CSS property.
org.openqa.selenium.Point	getLocation() Gets position of the top left-hand corner of the rendered element on page.
String	getName() Returns name of the entity.
org.openqa.selenium.Rectangle	getRect()
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> outputType)
org.openqa.selenium.Dimension	getSize() Gets width and height of the rendered element.
String	getTagName() Gets the tag name of this element.
String	getText() Gets the visible inner text of this element.
org.openqa.selenium.WebElement	getWrappedElement()
boolean	isDisplayed() Indicates if this element is displayed or not.
boolean	isEnabled() Indicates if the element is currently enabled or not.
boolean	isSelected() Indicates whether this element is selected or not.
void	sendKeys(CharSequence... charSequences) Simulates typing into an element.
void	setName(String name) Sets a name of a block.
void	setWrappedElement(org.openqa.selenium.WebElement wrappedElement) Sets the wrapped WebElement.
void	submit() If this element is a form, or an element within a form, then this will submit this form to the remote server.
String	toString() Returns specified name, actually the same as getName() method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openqa.selenium.WebElement

getAccessibleName, getAriaRole, getDomAttribute, getDomProperty, getShadowRoot

Constructor Detail

HtmlElement

public HtmlElement()

Method Detail

getWrappedElement

public org.openqa.selenium.WebElement getWrappedElement()

Specified by:

getWrappedElement in interface org.openqa.selenium.WrapsElement

setWrappedElement

public void setWrappedElement(org.openqa.selenium.WebElement wrappedElement)

Sets the wrapped WebElement. This method is used by initialization mechanism and is not intended to be used directly.

Parameters:

wrappedElement - WebElement to wrap.

getName

public String getName()

Description copied from interface: Named

Returns name of the entity.

Specified by:

getName in interface Named

Returns:

String representing name.

setName

public void setName(String name)

Sets a name of a block. This method is used by initialization mechanism and is not intended to be used directly.

Parameters:

name - Name to set.

exists

public boolean exists()

Determines whether or not this element exists on page.

Returns:

True if the element exists on page, false otherwise.

click

public void click()

Clicks this element. See WebElement.click() for more details.

Specified by:

click in interface org.openqa.selenium.WebElement

submit

public void submit()

If this element is a form, or an element within a form, then this will submit this form to the remote server. See WebElement.submit() for more details.

Specified by:

submit in interface org.openqa.selenium.WebElement

sendKeys

public void sendKeys(CharSequence... charSequences)

Simulates typing into an element. See WebElement.sendKeys(CharSequence...) for more details.

Specified by:

sendKeys in interface org.openqa.selenium.WebElement

Parameters:

charSequences - Symbols to be typed into an element.

clear

public void clear()

If this element is a text entry element, this will clear the value. See WebElement.clear() for more details.

Specified by:

clear in interface org.openqa.selenium.WebElement

getTagName

public String getTagName()

Gets the tag name of this element. See WebElement.getTagName() for more details.

Specified by:

getTagName in interface org.openqa.selenium.WebElement

Returns:

The tag name of this element.

getAttribute

public String getAttribute(String name)

Gets the value of a the given attribute of the element. See WebElement.getAttribute(String) for more details.

Specified by:

getAttribute in interface org.openqa.selenium.WebElement

Parameters:

name - The name of the attribute.

Returns:

Current value of the attribute or null if the value is not set.

isSelected

public boolean isSelected()

Indicates whether this element is selected or not. See WebElement.isSelected() for more details.

Specified by:

isSelected in interface org.openqa.selenium.WebElement

Returns:

True if the element is currently selected or checked, false otherwise.

isEnabled

public boolean isEnabled()

Indicates if the element is currently enabled or not. See WebElement.isEnabled() for more details.

Specified by:

isEnabled in interface org.openqa.selenium.WebElement

Returns:

True if the element is enabled, false otherwise.

getText

public String getText()

Gets the visible inner text of this element. See WebElement.getText() for more details.

Specified by:

getText in interface org.openqa.selenium.WebElement

Returns:

The inner text of this element.

findElements

public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by)

Finds all elements within the current context using the given mechanism. See WebElement.findElements(org.openqa.selenium.By) for more details.

Specified by:

findElements in interface org.openqa.selenium.SearchContext

Specified by:

findElements in interface org.openqa.selenium.WebElement

Parameters:

by - The locating mechanism to use.

Returns:

A list of all WebElements, or an empty list if nothing matches.

findElement

public org.openqa.selenium.WebElement findElement(org.openqa.selenium.By by)

Find the first WebElement using the given mechanism. See WebElement.findElement(org.openqa.selenium.By) for more details.

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebElement

Parameters:

by - The locating mechanism.

Returns:

The first matching element on the current context.

Throws:

org.openqa.selenium.NoSuchElementException - If no matching elements are found.

isDisplayed

public boolean isDisplayed()

Indicates if this element is displayed or not. See WebElement.isDisplayed() for more details.

Specified by:

isDisplayed in interface org.openqa.selenium.WebElement

Returns:

True if the element is displayed, false otherwise.

getLocation

public org.openqa.selenium.Point getLocation()

Gets position of the top left-hand corner of the rendered element on page. See WebElement.getLocation() for more details.

Specified by:

getLocation in interface org.openqa.selenium.WebElement

Returns:

A point, containing the location of the top left-hand corner of the element

getSize

public org.openqa.selenium.Dimension getSize()

Gets width and height of the rendered element. See WebElement.getSize() for more details.

Specified by:

getSize in interface org.openqa.selenium.WebElement

Returns:

The size of the element on the page.

getRect

public org.openqa.selenium.Rectangle getRect()

Specified by:

getRect in interface org.openqa.selenium.WebElement

Returns:

The location and size of the rendered element

getCssValue

public String getCssValue(String name)

Gets the value of a given CSS property. See WebElement.getCssValue(String) for more details.

Specified by:

getCssValue in interface org.openqa.selenium.WebElement

Parameters:

name - Name of the property.

Returns:

The current, computed value of the property.

toString

public String toString()

Returns specified name, actually the same as getName() method.

Overrides:

toString in class Object

Returns:

String representing name.

getScreenshotAs

public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> outputType)
                      throws org.openqa.selenium.WebDriverException

Specified by:

getScreenshotAs in interface org.openqa.selenium.TakesScreenshot

Throws:

org.openqa.selenium.WebDriverException