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.

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, 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.
void	clickButton(String id) Clicks a button with given id.
boolean	contains(String id) Checks if there is any visible component with given ID, which is child or descendant of this component.
UIComponent	find(String id) Finds element by given lsps id (your custom ID, not the modelingID).
protected List<WebElement>	findAll(String id) Finds all components matching given ID
WebDriver	getDriver()
String	toString()
protected void	waitForVaadin() Should be invoked after every potential server contact.

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,
                boolean root)

Method Detail

findAll

protected List<WebElement> findAll(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.

find

public final UIComponent find(String id)

Finds element by given lsps id (your custom ID, not the modelingID). Only children and/or descendants of this component are searched. Only visible components are found succesfully.

Visibility

This function finds UI components by searching for a DOM element in the current browser DOM tree. However, 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. Also see UIComponent.isVisible() for more details.

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.

clickButton

public void clickButton(String id)

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

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object

waitForVaadin

protected 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.

$

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

getDriver

public WebDriver getDriver()