com.whitestein.lsps.test.web.components

Class UIComponent

java.lang.Object

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

com.whitestein.lsps.test.web.components.UIComponent

Direct Known Subclasses:

AbstractOrderedLayout, InputComponent, LspsButton, LspsNavigationLink, LspsOutputText, LspsPopup, LspsTabbedLayout, LspsTable, LspsTableColumn, LspsTree

public class UIComponent
extends UIFinder

Client-side UIComponent image. There is nothing besides modeling ID that can be extracted from the UIComponent.

Author:

mvy

Field Summary

Fields

Modifier and Type	Field and Description
TestBenchElement	element The underlying Selenium Web element - the root element of this component.

Fields inherited from class com.whitestein.lsps.test.web.components.UIFinder

context

Constructor Summary

Constructors

Constructor and Description
UIComponent(TestBenchElement element)

Method Summary

Modifier and Type	Method and Description
UICast	as() Use to cast this component to a more specific component.
protected List<WebElement>	findAll(String id) Finds all components matching given ID
String	getErrorMessage() Returns the error message associated with this component (if any).
String	getHint() Returns the hint message associated with this component (if any).
String	getId() Returns the PDS component ID, e.g.
String	getModelingId() Returns the full modelingID, e.g.
boolean	isValid() Checks if there are no validation errors attached to this component.
boolean	isVisible() Deprecated. do not rely on visibility of UI components in your tests. Do not call this method, it always returns true.
String	toHTML() Returns this component as a HTML.
String	toInnerHTML()
String	toString()

Methods inherited from class com.whitestein.lsps.test.web.components.UIFinder

$, clickButton, contains, find, getDriver, waitForVaadin

Methods inherited from class java.lang.Object

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

Field Detail

element

public final TestBenchElement element

The underlying Selenium Web element - the root element of this component.

Constructor Detail

UIComponent

public UIComponent(TestBenchElement element)

Method Detail

findAll

protected List<WebElement> findAll(String id)

Description copied from class: UIFinder

Finds all components matching given ID

Overrides:

findAll in class UIFinder

Parameters:

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

Returns:

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

getModelingId

public String getModelingId()

Returns the full modelingID, e.g. BUTTON__CWCfsAqvEeWCjqufrHvQlQ. This ID always starts with getId(), followed by two underscores '_'.

Returns:

the modeling ID, may be null.

getId

public String getId()

Returns the PDS component ID, e.g. BUTTON.

Returns:

the ID, may be null.

as

public UICast as()

Use to cast this component to a more specific component.

Warning: the type correctness is nearly impossible to check on client and is therefore not checked upon cast - you can e.g. lookup a table and cast it to a multi-select list - the cast will succeed but the multi-select list methods will probably fail or return incorrect results.

Returns:

fluent object which you can use to cast this component to a more specific component. Never null.

getErrorMessage

public String getErrorMessage()

Returns the error message associated with this component (if any).

Returns:

the error message or null if there is no error message.

getHint

public String getHint()

Returns the hint message associated with this component (if any).

Returns:

the hint message or null if there is no hint message.

isValid

public boolean isValid()

Checks if there are no validation errors attached to this component.

Returns:

true if getErrorMessage() is null.

toHTML

public String toHTML()

Returns this component as a HTML. When writing testers for custom components, this will help you writing proper xpath selectors.

Returns:

the HTML text, including all sub-components, not null.

toInnerHTML

public String toInnerHTML()

toString

public String toString()

Overrides:

toString in class UIFinder

isVisible

@Deprecated
public boolean isVisible()

Deprecated. do not rely on visibility of UI components in your tests. Do not call this method, it always returns true.

Always returns true.

Instances of this class are only obtained by calling the UIFinder.find(String) method, which only works when the component is actually visible and present in the DOM tree.

Returns:

always true.