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, LspsAccordion, LspsButton, LspsCaption, LspsGrid, LspsGrid.LspsGridCell, LspsGrid.LspsGridRow, LspsNavigationLink, LspsOutputText, LspsPopup, LspsTabbedLayout, LspsTable, LspsTable.LspsTableCell, LspsTable.LspsTableRow, LspsTableColumn, LspsTabSheet, LspsTokenField, LspsUITable

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
WebDriver	driver
WebElement	seleniumElement 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(WebElement element, WebDriver webDriver)

Method Summary

Modifier and Type	Method and Description
UICast	as() Use to cast this component to a more specific component.
void	click() Click this element.
protected void	click(int x, int y, Keys... modifiers)
void	doubleClick() Double click this element.
protected WebElement	extractedSeleniumIfTestBench()
protected WebElement	extractedSeleniumIfTestBench(WebElement element)
void	focus() Gives element the focus.
String	getAttribute(String name)
LspsCaption	getCaption() Finds caption corresponding to this component.
Set<String>	getClassNames() Gets all the class names set for this element.
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.
String	getText() Get the visible (i.e.
boolean	hasClassName(String cssClassName)
boolean	isEnabled() Returns whether the Vaadin component is enabled or not.
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.
void	rightClick() Performs right click on the element.
void	scrollIntoView() Scrolls the page so that the element is in the view.
void	sleep(long time) Same as Thread.sleep except does not throw checked exception.
String	toHTML() Returns this component as a HTML.
String	toInnerHTML() Content of this element as html.
String	toString()
protected List<WebElement>	webElementsByLspsId(String id) Finds all components matching given ID

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

$, actions, clickButton, contains, createIdLocator, findAllByAttributeValue, findAllByClassname, findAllByFormId, findAllById, findAllByIdPrefix, findAllByLspsId, findAllByTextContent, findAllByXpath, findByAttributeValue, findByClassname, findByFormId, findById, findByIdPrefix, findByLspsId, findByTextContent, findByXpath, findCaptionByTextContent, findElement, findElements, findNthByTag, getDriver, getLspsCommandExecutor, waitForVaadin, webElementsByExactTextContent, webElementsByFormId, webElementsById, webElementsByIdPrefix, webElementsByLspsFormId, webElementsByTextContent, webElementsByXpath

Methods inherited from class java.lang.Object

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

Field Detail

seleniumElement

public final WebElement seleniumElement

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

driver

public final WebDriver driver

Constructor Detail

UIComponent

public UIComponent(WebElement element,
                   WebDriver webDriver)

Method Detail

webElementsByLspsId

protected List<WebElement> webElementsByLspsId(String id)

Description copied from class: UIFinder

Finds all components matching given ID

Overrides:

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

sleep

public void sleep(long time)

Same as Thread.sleep except does not throw checked exception.

Parameters:

time -

isValid

public boolean isValid()

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

Returns:

true if getErrorMessage() is null.

extractedSeleniumIfTestBench

protected WebElement extractedSeleniumIfTestBench(WebElement element)

extractedSeleniumIfTestBench

protected WebElement extractedSeleniumIfTestBench()

focus

public void focus()

Gives element the focus.

scrollIntoView

public void scrollIntoView()

Scrolls the page so that the element is in the view.

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()

Content of this element as html. Not the element itself, only what is found inside it.

Returns:

inner

toString

public String toString()

Overrides:

toString in class UIFinder

getAttribute

public String getAttribute(String name)

Parameters:

name -

Returns:

html attribute value

getText

public String getText()

Get the visible (i.e. not hidden by CSS) innerText of this element, including sub-elements, without any leading or trailing whitespace.

Returns:

The innerText of this element.

hasClassName

public boolean hasClassName(String cssClassName)

Parameters:

cssClassName - - css class name without leading dot. Example "v-required"

Returns:

true if the has given css class

getClassNames

public Set<String> getClassNames()

Gets all the class names set for this element.

Returns:

a set of class names

isEnabled

public boolean isEnabled()

Returns whether the Vaadin component is enabled or not. Same logic as testbench used to have.

Returns:

true if the component is enabled.

click

public void click()

Click this element. If this causes a new page to load, you should discard all references to this element and any further operations performed on this element will throw a StaleElementReferenceException. Note that if click() is done by sending a native event (which is the default on most browsers/platforms) then the method will _not_ wait for the next page to load and the caller should verify that themselves. There are some preconditions for an element to be clicked. The element must be visible and it must have a height and width greater then 0.

click

protected void click(int x,
                     int y,
                     Keys... modifiers)

doubleClick

public void doubleClick()

Double click this element. If this causes a new page to load, you should discard all references to this element and any further operations performed on this element will throw a StaleElementReferenceException. Note that if click() is done by sending a native event (which is the default on most browsers/platforms) then the method will _not_ wait for the next page to load and the caller should verify that themselves. There are some preconditions for an element to be clicked. The element must be visible and it must have a height and width greater then 0.

rightClick

public void rightClick()

Performs right click on the element.

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.findByLspsId(String) method, which only works when the component is actually visible and present in the DOM tree.

Returns:

always true.

getCaption

public LspsCaption getCaption()

Finds caption corresponding to this component. Based on AbstractComponentElement#getCaption()

Returns:

caption