com.github.mkolisnyk.sirius.client.ui.controls

Class Control

java.lang.Object

com.github.mkolisnyk.sirius.client.ui.controls.Control

Direct Known Subclasses:

Editable, TableView

public class Control
extends java.lang.Object

Major class for all control objects. All other control classes should be extended from this class.

Author:

Mykola Kolisnyk

Constructor Summary

Constructors

Constructor and Description
Control(Page parentValue, org.openqa.selenium.By locatorValue) Default constructor which binds page the control belongs to and the locator to find the element on page.

Method Summary

Modifier and Type	Method and Description
void	addSubItems(SubItem[] items) Adds sub-items assigned using SubItem annotation.
org.openqa.selenium.WebElement	element() Gets direct reference to the WebElement instance for current control object.
org.openqa.selenium.WebElement	element(int index) Gets direct reference to the WebElement instance for current control object.
<T> T	get(Operation<T,Control> predicate) .
org.openqa.selenium.WebDriver	getDriver() Gets the direct reference to the WebDriver object.
java.lang.String	getFormat() Gets the string which can be used in custom controls when the data is to be retrieved based on some specific format (e.g.
java.lang.String	getItemLocatorText() Gets string representation of item locator.
org.openqa.selenium.By	getLocator() Gets actual locator to be used for element location on page.
java.lang.String	getLocatorText() Gets the string representation of the locator.
Page	getParent() Gets reference to the parent Page object.
java.awt.Rectangle	getRect() Gets rectangular dimensions of current control.
ScrollTo	getScrollDirection() Gets the direction of scrolling.
java.lang.String	getScrollTo() Gets text to scroll to in case element isn't immediately available on page.
java.lang.String	getText() Gets element text.
java.lang.String	getValue() Gets element value.
boolean	is(Operation<java.lang.Boolean,Control> predicate) Checks some state of control depending on predicate specified.
boolean	isExcludeFromSearch() Defines whether current control is supposed to be excluded from search while using Page#isCurrent(long) method.
<T> T	perform(Operation<T,Control> predicate) .
void	scrollTo() Scrolls screen to current element.
void	setExcludeFromSearch(boolean excludeFromSearchValue) Sets the state whether current control is supposed to be excluded from search while using Page#isCurrent(long) method.
void	setFormat(java.lang.String formatValue) Sets the string which can be used in custom controls when the data is to be retrieved based on some specific format (e.g.
void	setItemLocatorText(java.lang.String subItemLocatorText) Sets item locator value.
void	setScrollDirection(ScrollTo scrollDirectionValue) Sets the direction of scrolling.
void	setScrollTo(java.lang.String scrollToValue) Sets text to scroll to in case element isn't immediately available on page.
Control	verify(Operation<java.lang.Boolean,Control> predicate) Verifies that field has some specific state and asserts the error if condition is not met.
boolean	waitUntil(org.openqa.selenium.support.ui.ExpectedCondition<?> condition, long timeout) Common method for various actions waiting for some element event to happen.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Control

public Control(Page parentValue,
               org.openqa.selenium.By locatorValue)

Default constructor which binds page the control belongs to and the locator to find the element on page.

Parameters:

parentValue - the instance of the page class containing current control.

locatorValue - the string used to locate current control.

Method Detail

getDriver

public org.openqa.selenium.WebDriver getDriver()

Gets the direct reference to the WebDriver object.

Returns:

direct reference to the WebDriver object.

getParent

public Page getParent()

Gets reference to the parent Page object.

Returns:

parent page object instance.

getLocator

public org.openqa.selenium.By getLocator()

Gets actual locator to be used for element location on page.

Returns:

actual locator.

getLocatorText

public java.lang.String getLocatorText()

Gets the string representation of the locator.

Returns:

string representation of the locator.

getItemLocatorText

public java.lang.String getItemLocatorText()

Gets string representation of item locator. It is used for compound elements processing.

Returns:

string representation of item locator.

setItemLocatorText

public void setItemLocatorText(java.lang.String subItemLocatorText)

Sets item locator value.

Parameters:

subItemLocatorText - item locator string value.

getScrollTo

public java.lang.String getScrollTo()

Gets text to scroll to in case element isn't immediately available on page.

Returns:

text to scroll to.

setScrollTo

public void setScrollTo(java.lang.String scrollToValue)

Sets text to scroll to in case element isn't immediately available on page.

Parameters:

scrollToValue - text to scroll to.

getScrollDirection

public ScrollTo getScrollDirection()

Gets the direction of scrolling.

Returns:

direction of scrolling.

setScrollDirection

public void setScrollDirection(ScrollTo scrollDirectionValue)

Sets the direction of scrolling.

Parameters:

scrollDirectionValue - direction of scrolling.

See Also:

ScrollTo

getFormat

public java.lang.String getFormat()

Gets the string which can be used in custom controls when the data is to be retrieved based on some specific format (e.g. date, duration).

Returns:

format string.

setFormat

public void setFormat(java.lang.String formatValue)

Sets the string which can be used in custom controls when the data is to be retrieved based on some specific format (e.g. date, duration).

Parameters:

formatValue - format string.

isExcludeFromSearch

public boolean isExcludeFromSearch()

Defines whether current control is supposed to be excluded from search while using Page#isCurrent(long) method.

Returns:

exclude from search flag.

setExcludeFromSearch

public void setExcludeFromSearch(boolean excludeFromSearchValue)

Sets the state whether current control is supposed to be excluded from search while using Page#isCurrent(long) method.

Parameters:

excludeFromSearchValue - exclude from search flag.

addSubItems

public void addSubItems(SubItem[] items)

Adds sub-items assigned using SubItem annotation.

Parameters:

items - sub-items to add.

element

public org.openqa.selenium.WebElement element()

Gets direct reference to the WebElement instance for current control object.

Returns:

direct reference to the WebElement instance.

element

public org.openqa.selenium.WebElement element(int index)

Gets direct reference to the WebElement instance for current control object. Unlike element(), this method is applicable when multiple elements can match the same locator. In this case the index is used to define which element from the array of possible options should be taken.

Parameters:

index - element index.

Returns:

direct reference to the WebElement instance.

waitUntil

public boolean waitUntil(org.openqa.selenium.support.ui.ExpectedCondition<?> condition,
                         long timeout)

Common method for various actions waiting for some element event to happen.

Parameters:

condition - the expected condition predicate.

timeout - the time limit to wait for event to happen.

Returns:

true if condition is met, false - otherwise.

perform

public <T> T perform(Operation<T,Control> predicate)

.

Type Parameters:

T - .

Parameters:

predicate - .

Returns:

.

get

public <T> T get(Operation<T,Control> predicate)

.

Type Parameters:

T - .

Parameters:

predicate - .

Returns:

.

is

public boolean is(Operation<java.lang.Boolean,Control> predicate)

Checks some state of control depending on predicate specified.

Parameters:

predicate - Operation expression returning boolean state value.

Returns:

true if condition is met, false - otherwise.

verify

public Control verify(Operation<java.lang.Boolean,Control> predicate)

Verifies that field has some specific state and asserts the error if condition is not met.

Parameters:

predicate - Operation expression returning boolean state value.

Returns:

current control.

getText

public java.lang.String getText()

Gets element text.

Returns:

element text.

getValue

public java.lang.String getValue()

Gets element value. It can be either value attribute or any other converted string depending on each particular control implementation.

Returns:

element value.

getRect

public java.awt.Rectangle getRect()

Gets rectangular dimensions of current control.

Returns:

current control dimantions.

scrollTo

public void scrollTo()

Scrolls screen to current element.

NOTE: applicable for Android only.