com.whitestein.lsps.test.web.components

Class UIFinder

java.lang.Object

com.whitestein.lsps.test.web.components.UIFinder

Direct Known Subclasses:

UIComponent, UITester

public class UIFinder
extends Object

Finds components by ID. An instance of this class is provided for you, just read the com.whitestein.lsps.web.vaadin.tests.LspsVaadinTestCase#screen property. Following is true for all find methods found in this class: -- Only children and/or descendants of this component are searched. -- Only visible components are found successfully. These functions finds UI components by searching for a DOM element in the current browser DOM tree. When a LSPS UIComponent is invisible, its element (div or other) is removed from the DOM tree. This is why this function can't find invisible components.

Author:

mvy

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchContext	context The search context to search in, either the entire page (WebDriver) or a component.

Constructor Summary

Constructors

Constructor and Description
UIFinder(SearchContext context, WebDriver webDriver, boolean root)

Method Summary

Modifier and Type	Method and Description
<T extends AbstractElement> <any>	$(Class<T> clazz) Prepare a ElementQuery instance to use for locating components on the client.
UIActions	actions()
void	clickButton(String id) Deprecated.
boolean	contains(String id) Checks if there is any visible component with given ID, which is child or descendant of this component.
protected By	createIdLocator(String id)
List<UIComponent>	findAllByAttributeValue(String attribute, String value) Finds all elements that have attribute set to given value.
List<UIComponent>	findAllByClassname(String className) Finds all elements styled with css className.
List<UIComponent>	findAllByFormId(String id) Finds elements with given lsps form id.
List<UIComponent>	findAllById(String id) Finds element with given html id.
List<UIComponent>	findAllByIdPrefix(String prefix) Finds all elements whose html id starts with given prefix.
List<UIComponent>	findAllByLspsId(String id) Finds all elements rendered from component with given lsps id.
List<UIComponent>	findAllByTextContent(String content) Finds all elements containing content text.
List<UIComponent>	findAllByXpath(String xpath) Finds all elements by xpath.
UIComponent	findByAttributeValue(String attribute, String value) Finds element by attribute value.
UIComponent	findByClassname(String className) Finds an element styled with css className.
UIComponent	findByFormId(String id) Finds element with given form id.
UIComponent	findById(String id) Finds element with given html id.
UIComponent	findByIdPrefix(String prefix) Finds element whose html id starts with given prefix.
UIComponent	findByLspsId(String id) Finds element by given lsps id.
UIComponent	findByTextContent(String content) Finds element containing content text.
UIComponent	findByXpath(String xpath) Finds element by xpath.
LspsCaption	findCaptionByTextContent(String content) Finds caption with the exact text.
WebElement	findElement(By by)
List<WebElement>	findElements(By by)
UIComponent	findNthByTag(int nth, String tag) Finds nth instance of the html tag.
WebDriver	getDriver()
protected LspsCommandExecutor	getLspsCommandExecutor()
String	toString()
void	waitForVaadin() Should be invoked after every potential server contact.
protected List<WebElement>	webElementsByExactTextContent(String content)
protected List<WebElement>	webElementsByFormId(String id)
protected List<WebElement>	webElementsById(String id)
protected List<WebElement>	webElementsByIdPrefix(String prefix)
protected List<WebElement>	webElementsByLspsFormId(String id)
protected List<WebElement>	webElementsByLspsId(String id) Finds all components matching given ID
protected List<WebElement>	webElementsByTextContent(String content)
protected List<WebElement>	webElementsByXpath(String xpath)

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final SearchContext context

The search context to search in, either the entire page (WebDriver) or a component.

Constructor Detail

UIFinder

public UIFinder(SearchContext context,
                WebDriver webDriver,
                boolean root)

Method Detail

webElementsByLspsId

protected List<WebElement> webElementsByLspsId(String id)

Finds all components matching given ID

Parameters:

id - the component ID (your custom ID, not the modelingID).

Returns:

a list of root elements, not null, may be empty.

contains

public final boolean contains(String id)

Checks if there is any visible component with given ID, which is child or descendant of this component.

Parameters:

id - the component ID (your custom ID, not the modelingID).

Returns:

true if the current page contains visible component with given ID, false if all components with given ID are invisible or there are no components with given ID.

findByLspsId

public final UIComponent findByLspsId(String id)

Finds element by given lsps id. Throws exception if no or multiple elements are found. Use findAllByLspsId(String) if there may be multiple html nodes rendered from one lsps component. Lsps id is an identifier used to reference the component in expressions. For example, if `userName.getCaption()` is valid lsps expression, then 'userName' is lsps id. Lsps id is configured in PDS inside detail tab of component properties view. Note: id of html node corresponding to lsps component has lsps id as prefix.

Parameters:

id - the id, not null. your custom ID, not the modelingID

Returns:

the element, not null.

Throws:

NoSuchElementException - if there are no visible elements with given ID

IllegalArgumentException - if multiple elements match given ID.

findAllByLspsId

public final List<UIComponent> findAllByLspsId(String id)

Finds all elements rendered from component with given lsps id. Lsps id is an identifier used to reference the component in expressions. For example, if `userName.getCaption()` is valid lsps expression, then 'userName' is lsps id. Lsps id is configured in PDS inside detail tab of component properties view. Note: id of html node corresponding to lsps component has lsps id as prefix.

Parameters:

id - the id, not null. your custom ID, not the modelingID

Returns:

elements or an empty list

findByClassname

public UIComponent findByClassname(String className)

Finds an element styled with css className. Throws exception if no or multiple elements are found.

Parameters:

className - - css class to look for.

Returns:

element

findAllByClassname

public List<UIComponent> findAllByClassname(String className)

Finds all elements styled with css className. Returns an empty list if no such element is found.

Parameters:

className - - css class to look for.

Returns:

elements

findNthByTag

public UIComponent findNthByTag(int nth,
                                String tag)

Finds nth instance of the html tag.

Parameters:

nth - - which occurrence of html tag to return

tag - - html tag to look for.

Returns:

element

webElementsByTextContent

protected List<WebElement> webElementsByTextContent(String content)

findByTextContent

public UIComponent findByTextContent(String content)

Finds element containing content text. Throws exception if no or multiple elements are found.

Parameters:

content - - text to look for. Case sensitive.

Returns:

element

findAllByTextContent

public List<UIComponent> findAllByTextContent(String content)

Finds all elements containing content text.

Parameters:

content - - text to look for. Case sensitive.

Returns:

elements - a list of found elements or an empty list

webElementsById

protected List<WebElement> webElementsById(String id)

createIdLocator

protected By createIdLocator(String id)

findById

public UIComponent findById(String id)

Finds element with given html id. If the component is rendered only once, html id corresponds to modeling id. If the component is rendered multiple times, subsequent copies have id of the "__copy__" Throws exception if no or multiple elements are found.

Parameters:

id - - full id. Examples: estimatesTable__Lwxl4P9aEeaK3drkZpNeUw estimatesTable__Lwxl4P9aEeaK3drkZpNeUw__copy__3

Returns:

element

findAllById

public List<UIComponent> findAllById(String id)

Finds element with given html id. Note: Html ids should be unique and this method should not be needed at all. It is better to fix the page so that ids are not reused.

Parameters:

id - - full id. Examples: estimatesTable__Lwxl4P9aEeaK3drkZpNeUw estimatesTable__Lwxl4P9aEeaK3drkZpNeUw__copy__3

Returns:

elements

webElementsByFormId

protected List<WebElement> webElementsByFormId(String id)

webElementsByLspsFormId

protected List<WebElement> webElementsByLspsFormId(String id)

findByFormId

public UIComponent findByFormId(String id)

Finds element with given form id. Form id is generated on root element of reusable forms and correspond to reusable reference id. Throws exception if no or multiple elements are found.

Parameters:

id - - form id. Examples: reusable_call__Lwxl4P9aEeaK3drkZpNeUw call_that_with_parameter__Lwxl4P9aEeaK3drkZpNeUw__copy__3

Returns:

element

findAllByFormId

public List<UIComponent> findAllByFormId(String id)

Finds elements with given lsps form id.

Parameters:

id - - full id. Examples: reusable_call__Lwxl4P9aEeaK3drkZpNeUw call_that_with_parameter__Lwxl4P9aEeaK3drkZpNeUw__copy__3

Returns:

elements

webElementsByXpath

protected List<WebElement> webElementsByXpath(String xpath)

webElementsByIdPrefix

protected List<WebElement> webElementsByIdPrefix(String prefix)

findByIdPrefix

public UIComponent findByIdPrefix(String prefix)

Finds element whose html id starts with given prefix. Throws exception if no or multiple elements are found.

Parameters:

prefix - - id prefix.

Returns:

element

findAllByIdPrefix

public List<UIComponent> findAllByIdPrefix(String prefix)

Finds all elements whose html id starts with given prefix.

Parameters:

prefix - - id prefix.

Returns:

elements

findByXpath

public UIComponent findByXpath(String xpath)

Finds element by xpath. Throws exception if no or multiple elements are found.

Parameters:

xpath -

Returns:

element

findAllByXpath

public List<UIComponent> findAllByXpath(String xpath)

Finds all elements by xpath. If not element matches xpath, an empty list is returned.

Parameters:

xpath -

Returns:

elements

findByAttributeValue

public UIComponent findByAttributeValue(String attribute,
                                        String value)

Finds element by attribute value.

Parameters:

attribute - - attribute name.

value - - value

Returns:

element

findAllByAttributeValue

public List<UIComponent> findAllByAttributeValue(String attribute,
                                                 String value)

Finds all elements that have attribute set to given value.

Parameters:

attribute - - attribute name.

value - - value

Returns:

elements

clickButton

@Deprecated
public void clickButton(String id)

Deprecated.

Clicks a button with given id. Shortcut for find(id).as().button().click() or actions().clickButton().

Parameters:

id - the id, not null. your custom ID, not the modelingID

toString

public String toString()

Overrides:

toString in class Object

findElement

public WebElement findElement(By by)

findElements

public List<WebElement> findElements(By by)

waitForVaadin

public void waitForVaadin()

Should be invoked after every potential server contact. Not only waits for the server's response, it also checks if there are any error notifications - if yes, a RuntimeException is thrown.

getLspsCommandExecutor

protected LspsCommandExecutor getLspsCommandExecutor()

$

public <T extends AbstractElement> <any> $(Class<T> clazz)

Prepare a ElementQuery instance to use for locating components on the client. The returned object can be manipulated to uniquely identify the sought-after object. If this function gets called through an element, it uses the element as its search context. Otherwise the search context is the driver.

Type Parameters:

T -

Parameters:

clazz -

Returns:

an appropriate ElementQuery instance

webElementsByExactTextContent

protected List<WebElement> webElementsByExactTextContent(String content)

findCaptionByTextContent

public LspsCaption findCaptionByTextContent(String content)

Finds caption with the exact text. Throws exception if no or multiple elements are found.

Parameters:

content - - text to look for. Case sensitive.

Returns:

element

getDriver

public WebDriver getDriver()

actions

public UIActions actions()

Returns:

action helper with most often used actions