com.workfusion.rpa.helpers

Class UiElement

java.lang.Object

com.workfusion.rpa.helpers.UiElement

public class UiElement
extends java.lang.Object

This class wraps object of WebElement and provides new functionality.

Samples

$("#errorMessage").shouldBe(visible, enabled).click();

$("td").parent().doubleClick();

$(".edit").pressBackSpace();

Method Summary

Modifier and Type	Method and Description
UiElement	$(By selector) Driver Type: Desktop, Web
UiElement	$(By selector, int index) Driver Type: Desktop, Web
UiElement	$(java.lang.String cssSelector) Driver Type: Desktop, Web
UiElement	$(java.lang.String cssSelector, int index) Driver Type: Desktop, Web
UiElementCollection	$$(By selector) Driver Type: Desktop, Web
UiElementCollection	$$(java.lang.String cssSelector) Driver Type: Desktop, Web
UiElement	append(java.lang.Object text) Append given text to the text field.
java.lang.String	attr(java.lang.String attributeName) Get the attribute of the element.
int	bottom()
int	centerX()
int	centerY()
void	clear()
void	click() Click the element
UiElement	click(int clicks) Click the element number of times
UiElement	click(int offsetX, int offsetY) Click the element with offset Offset is calculated from TOP LEFT corner
UiElement	click(int clicks, int offsetX, int offsetY) Click the element number of times
UiElement	closest(java.lang.String tagOrClass) Find closes ancestor element matching given criteria.
UiElement	contextClick() Click with right mouse button on this element
UiElement	contextClick(int offsetX, int offsetY) Click with right mouse button by offset on this element
java.lang.String	copySelectedText() Copies selected text
UiElement	doubleClick() Double click the element
UiElement	doubleClick(int offsetX, int offsetY) Double click the element
boolean	equals(java.lang.Object o)
UiElement	find(By selector) Find the first matching element inside given element
UiElement	find(By selector, int index) Find the Nth matching element inside given element
UiElement	find(java.lang.String cssSelector) Find the first matching element inside given element
UiElement	find(java.lang.String cssSelector, int index) Find the Nth matching element inside given element
UiElementCollection	findAll(By selector) Short form of webDriver.findElements(thisElement, selector)
UiElementCollection	findAll(java.lang.String cssSelector) Short form of webDriver.findElements(thisElement, By.cssSelector(cssSelector))
WebElement	findElement(By by)
java.util.List<org.openqa.selenium.WebElement>	findElements(By by)
boolean	focus()
java.lang.String	getAccessibleName()
java.lang.String	getAriaRole()
java.lang.String	getAttribute(java.lang.String s)
Coordinates	getCoordinates()
java.lang.String	getCssValue(java.lang.String s)
java.lang.String	getDomAttribute(java.lang.String name)
java.lang.String	getDomProperty(java.lang.String name)
java.lang.String	getId()
Point	getLocation()
Rectangle	getRect()
<X> X	getScreenshotAs(<any> outputType)
UiElement	getSelectedOption() Find selected option from this select field
java.lang.String	getSelectedText() Get text of selected option in select field
java.lang.String	getSelectedValue() Get value of selected option in select field
SearchContext	getShadowRoot()
Dimension	getSize()
java.lang.String	getTagName()
java.lang.String	getText() Get the visible text of this element
java.lang.String	getTextSelected()
java.lang.String	getValue() Get the "value" attribute of the element
WebElement	getWrappedElement()
boolean	has(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition) Return true iff element matches given condition
int	hashCode()
UiElement	hover() Emulate "mouseOver" event.
java.lang.String	innerHtml() Get the HTML code of the element with children.
java.lang.String	innerText() Get the text code of the element with children.
boolean	is(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition) Return true if element matches given condition
boolean	isDisplayed()
boolean	isEnabled()
boolean	isExists() Deprecated. from 9.2, it will be delete in 10.0
boolean	isImageLoaded() Check if image is properly loaded.
boolean	isSelected()
int	left()
java.lang.String	name() Get the "name" attribute of the element
UiElement	parent() Get parent element of this element For example, $("td").parent() could give some "tr".
UiElement	pressBackSpace() Press BACK_SPACE.
UiElement	pressCtrlA() Send CTRL+A.
UiElement	pressCtrlC() Send CTRL+C.
UiElement	pressCtrlShiftZ() Send CTRL+SHIFT+Z.
UiElement	pressCtrlV() Send CTRL+V.
UiElement	pressCtrlX() Send CTRL+X.
UiElement	pressCtrlZ() Send CTRL+Z.
UiElement	pressEnter() Press ENTER.
UiElement	pressEscape() Press ESCAPE.
UiElement	pressSpace() Press SPACE.
UiElement	pressTab() Press TAB.
int	right()
UiElement	scrollDown(int times) Moves mouse cursor to the center of element and scrolls down number of times.
UiElement	scrollTo() Ask browser to scroll to this element
UiElement	scrollUp(int times) Moves mouse cursor to the center of element and scrolls up number of times.
java.lang.String	selectAllTextAndCopy() Sample: String selectedText = $("[CLASS:Edit; INSTANCE:1]") .append("some text") .selectAllTextAndCopy();
UiElement	selectOption(int index) Select an option from dropdown list (by index)
UiElement	selectOption(java.lang.String text) Select an option from dropdown list (by text)
UiElement	selectOptionByValue(java.lang.String value) Select an option from dropdown list (by value)
void	sendKeys(java.lang.CharSequence... charSequences)
UiElement	sendKeys(java.lang.Object text)
UiElement	sendKeysWithFocus(java.lang.Object text) It scrolls to the element, moves cursor to it and then performs sendKeys.
UiElement	setSelected(boolean selected) Set checkbox/radio state to CHECKED or UNCHECKED.
UiElement	setText(java.lang.Object text) Sets given text to a text field
UiElement	setValue(java.lang.Object text) Clear the text field and enter given text.
UiElement	should(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions)
UiElement	should(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition) Checks that given element meets all of given conditions.
UiElement	should(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition1, com.workfusion.rpa.helpers.conditionsnative.UiCondition condition2)
UiElement	shouldBe(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions) Synonym for should(UiCondition...)}.
UiElement	shouldBe(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)
UiElement	shouldHave(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions) Synonym for should(UiCondition...)}.
UiElement	shouldHave(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)
UiElement	shouldNot(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions) Checks that given element does not meet given conditions.
UiElement	shouldNot(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)
UiElement	shouldNotBe(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions) Synonym for shouldNot(UiCondition...).
UiElement	shouldNotBe(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)
UiElement	shouldNotHave(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions) Synonym for shouldNot(UiCondition...).
UiElement	shouldNotHave(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)
UiElement	singleClick() Single click the element.
UiElement	singleClick(int offsetX, int offsetY) Single click the element.
boolean	stillExists() Checks if element still exists on the current page.
void	submit()
java.lang.String	text() Short form of getText()
UiElement	text(java.lang.Object text) Driver Type: Desktop, Web
int	top()
Select	toSelectElement() Converts UI element to Select
java.lang.String	toString() Displays WebElement in human-readable format.
WebElement	toWebElement()
UiElement	tripleClick() Triple click the element
UiElement	tripleClick(int offsetX, int offsetY) Triple click the element
java.lang.String	val() Get the "value" attribute of the element Same as #getValue()
UiElement	val(java.lang.Object text) Driver Type: Desktop, Web
UiElement	waitUntil(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition) Wait until given element meets given conditions.
UiElement	waitUntil(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition, long timeoutMilliseconds) Wait until given element meets given conditions.
UiElement	waitUntil(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition, long timeoutMilliseconds, long pollingIntervalMilliseconds) Wait until given element meets given conditions.
UiElement	waitWhile(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition) Wait while given element meets given conditions.
UiElement	waitWhile(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition, long timeoutMilliseconds) Wait while given element meets given conditions.
UiElement	waitWhile(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition, long timeoutMilliseconds, long pollingIntervalMilliseconds) Wait while given element meets given conditions.
UiElement	wheelClick() Wheel click on the element
UiElement	wheelClick(int offsetX, int offsetY) Wheel click on the element

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

append

public UiElement append(java.lang.Object text)

Append given text to the text field.

This is the same as WebElement.sendKeys(text)

Driver Type: Desktop, Web

Parameters:

text - Any text to append into the text field.

setValue

public UiElement setValue(java.lang.Object text)

Clear the text field and enter given text.

Implementation details: this is the same as

   1. WebElement.clear()
   2. WebElement.sendKeys(text)

Driver Type: Desktop, Web

Parameters:

text - Any text to enter into the text field.

val

public UiElement val(java.lang.Object text)

Driver Type: Desktop, Web

Same as #setValue(java.lang.String)

text

public UiElement text(java.lang.Object text)

Driver Type: Desktop, Web

Same as #setValue(java.lang.String)

setText

public UiElement setText(java.lang.Object text)

Sets given text to a text field

Driver Type: Desktop, Web

Parameters:

text - Any text to enter into the text field.

pressEnter

public UiElement pressEnter()

Press ENTER. Useful for input field and textareas:

  $("query").val("Aikido techniques").pressEnter();

Implementation details: This is the same as

  WebElement.sendKeys(Keys.ENTER)

Driver Type: Desktop, Web

pressTab

public UiElement pressTab()

Press TAB. Useful for input field and textareas:

  $("#to").val("stiven@seagal.com").pressTab();

Implementation details: This is the same as

  WebElement.sendKeys(Keys.TAB)

Driver Type: Desktop, Web

pressEscape

public UiElement pressEscape()

Press ESCAPE. Useful for input field and textareas:

  $(".edit").click().pressEscape();

Implementation details: This is the same as

  WebElement.sendKeys(Keys.ESCAPE)

Driver Type: Desktop, Web

pressSpace

public UiElement pressSpace()

Press SPACE. Useful for input field and textareas:

  $(".edit").pressSpace();

Implementation details: This is the same as

  WebElement.sendKeys(Keys.SPACE)

Driver Type: Desktop, Web

pressBackSpace

public UiElement pressBackSpace()

Press BACK_SPACE. Useful for input field and textareas:

  $(".edit").pressBackSpace();

Implementation details: This is the same as

  WebElement.sendKeys(Keys.BACK_SPACE)

Driver Type: Desktop, Web

pressCtrlA

public UiElement pressCtrlA()

Send CTRL+A. Useful for input field and textareas:

 $(".edit").pressCtrlA();

Implementation details: This is the same as

 WebElement.sendKeys.sendKeys(Keys.chord(Keys.CONTROL, "a"))

Driver Type: Desktop, Web

pressCtrlC

public UiElement pressCtrlC()

Send CTRL+C. Useful for input field and textareas:

 $(".edit").pressCtrlC();

Implementation details: This is the same as

 WebElement.sendKeys.sendKeys(Keys.chord(Keys.CONTROL, "c"))

Driver Type: Desktop, Web

pressCtrlV

public UiElement pressCtrlV()

Send CTRL+V. Useful for input field and textareas:

 $(".edit").pressCtrlV();

Implementation details: This is the same as

 WebElement.sendKeys(Keys.chord(Keys.CONTROL, "v"))

Driver Type: Desktop, Web

pressCtrlX

public UiElement pressCtrlX()

Send CTRL+X. Useful for input field and textareas:

 $(".edit").pressCtrlX();

Implementation details: This is the same as

 WebElement.sendKeys(Keys.chord(Keys.CONTROL, "x"))

Driver Type: Desktop, Web

pressCtrlZ

public UiElement pressCtrlZ()

Send CTRL+Z. Useful for input field and textareas:

 $(".edit").pressCtrlZ();

Implementation details: This is the same as

 WebElement.sendKeys(Keys.chord(Keys.CONTROL, "z"))

Driver Type: Desktop, Web

pressCtrlShiftZ

public UiElement pressCtrlShiftZ()

Send CTRL+SHIFT+Z. Useful for input field and textareas:

 $(".edit").pressCtrlShiftZ();

Implementation details: This is the same as

 WebElement.sendKeys(Keys.chord(Keys.CONTROL, Keys.SHIFT, "z"))

Driver Type: Desktop, Web

getText

public java.lang.String getText()

Get the visible text of this element

Driver Type: Desktop, Web

Returns:

The text of this element

getTextSelected

public java.lang.String getTextSelected()

text

public java.lang.String text()

Short form of getText()

Driver Type: Desktop, Web

See Also:

WebElement#getText()

innerText

public java.lang.String innerText()

Get the text code of the element with children.

Driver Type: Web

Short form of getAttribute("textContent") or getAttribute("innerText") depending on browser.

innerHtml

public java.lang.String innerHtml()

Get the HTML code of the element with children.

Short form of getAttribute("innerHTML")

Driver Type: Web

attr

public java.lang.String attr(java.lang.String attributeName)

Get the attribute of the element. Synonym for getAttribute(String).

Driver Type: Desktop, Web

Returns:

null if attribute is missing

name

public java.lang.String name()

Get the "name" attribute of the element

Driver Type: Desktop, Web

Returns:

attribute "name" value or null if attribute is missing

val

public java.lang.String val()

Get the "value" attribute of the element Same as #getValue()

Driver Type: Desktop, Web

Returns:

attribute "value" value or null if attribute is missing

getValue

public java.lang.String getValue()

Get the "value" attribute of the element

Driver Type: Desktop, Web

Returns:

attribute "value" value or null if attribute is missing

isExists

@Deprecated
public boolean isExists()

Deprecated. from 9.2, it will be delete in 10.0

Checks if element exists true on the current page.

Driver Type: Desktop, Web

Returns:

false if element is not found, browser is closed or any WebDriver exception happened

stillExists

public boolean stillExists()

Checks if element still exists on the current page.

Driver Type: Desktop, Web

Returns:

false if element is not found, browser is closed or any WebDriver exception happened

Since:

9.2

is

public boolean is(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

Return true if element matches given condition

Driver Type: Desktop, Web

has

public boolean has(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

Return true iff element matches given condition

Driver Type: Desktop, Web

should

public UiElement should(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

Checks that given element meets all of given conditions.

IMPORTANT: Element matches these conditions immediately.

For example: $("#errorMessage").should(APPEAR);

Driver Type: Desktop, Web

Returns:

Given element, useful for chaining: $("#errorMessage").should(APPEAR).shouldBe(ENABLED);

Throws:

java.lang.IllegalStateException - if element is not matched to condition

should

public UiElement should(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions)

should

public UiElement should(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition1,
                        com.workfusion.rpa.helpers.conditionsnative.UiCondition condition2)

shouldHave

public UiElement shouldHave(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions)

Synonym for should(UiCondition...)}. Useful for better readability.

For example: $("#errorMessage").shouldHave(text("Hello"), text("World"));

Driver Type: Desktop, Web

See Also:

should(UiCondition...)

shouldHave

public UiElement shouldHave(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

shouldBe

public UiElement shouldBe(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions)

Synonym for should(UiCondition...)}. Useful for better readability.

For example: $("#errorMessage").shouldBe(visible, enabled);

Driver Type: Desktop, Web

See Also:

should(UiCondition...)

shouldBe

public UiElement shouldBe(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

shouldNot

public UiElement shouldNot(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions)

Checks that given element does not meet given conditions.

IMPORTANT: If element matches these conditions immediately.

For example: $("#errorMessage").should(exist);

Driver Type: Desktop, Web

shouldNot

public UiElement shouldNot(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

shouldNotHave

public UiElement shouldNotHave(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions)

Synonym for shouldNot(UiCondition...). Useful for better readability.

For example: $("#errorMessage").shouldNotHave(text("Exception"), text("Error"));

Driver Type: Desktop, Web

See Also:

shouldNot(UiCondition...)

shouldNotHave

public UiElement shouldNotHave(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

shouldNotBe

public UiElement shouldNotBe(com.workfusion.rpa.helpers.conditionsnative.UiCondition... conditions)

Synonym for shouldNot(UiCondition...). Useful for better readability.

For example: $("#errorMessage").shouldNotBe(visible, enabled);

Driver Type: Desktop, Web

See Also:

shouldNot(UiCondition...)

shouldNotBe

public UiElement shouldNotBe(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

waitUntil

public UiElement waitUntil(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

Wait until given element meets given conditions.

Driver Type: Desktop, Web

Parameters:

condition - e.g. enabled, visible, text() and so on

Throws:

java.lang.IllegalStateException - if element still is not matched to condition after the timeout

waitUntil

public UiElement waitUntil(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition,
                           long timeoutMilliseconds)

Wait until given element meets given conditions.

Driver Type: Desktop, Web

Parameters:

condition - e.g. enabled, visible, text() and so on

timeoutMilliseconds - timeout in milliseconds.

Throws:

java.lang.IllegalStateException - if element still is not matched to condition after the timeout

waitUntil

public UiElement waitUntil(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition,
                           long timeoutMilliseconds,
                           long pollingIntervalMilliseconds)

Wait until given element meets given conditions.

Driver Type: Desktop, Web

Parameters:

condition - e.g. enabled, visible, text() and so on

timeoutMilliseconds - timeout in milliseconds.

pollingIntervalMilliseconds - interval in milliseconds, when checking condition

Throws:

java.lang.IllegalStateException - if element still is not matched to condition after the timeout

waitWhile

public UiElement waitWhile(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition)

Wait while given element meets given conditions.

Driver Type: Desktop, Web

Parameters:

condition - e.g. enabled, visible, text() and so on

Throws:

java.lang.IllegalStateException - if element still is not matched to condition after the timeout

waitWhile

public UiElement waitWhile(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition,
                           long timeoutMilliseconds)

Wait while given element meets given conditions.

Driver Type: Desktop, Web

Parameters:

condition - e.g. enabled, visible, text() and so on

timeoutMilliseconds - timeout in milliseconds.

Throws:

java.lang.IllegalStateException - if element still is not matched to condition after the timeout

waitWhile

public UiElement waitWhile(com.workfusion.rpa.helpers.conditionsnative.UiCondition condition,
                           long timeoutMilliseconds,
                           long pollingIntervalMilliseconds)

Wait while given element meets given conditions.

Driver Type: Desktop, Web

Parameters:

condition - e.g. enabled, visible, text() and so on

timeoutMilliseconds - timeout in milliseconds.

pollingIntervalMilliseconds - interval in milliseconds, when checking condition

Throws:

java.lang.IllegalStateException - if element still is not matched to condition after the timeout

parent

public UiElement parent()

Get parent element of this element For example, $("td").parent() could give some "tr".

Driver Type: Web

Returns:

Parent element

closest

public UiElement closest(java.lang.String tagOrClass)

Find closes ancestor element matching given criteria. For example, $("td").closest("table") could give some "table".

Driver Type: Web

Parameters:

tagOrClass - Either HTML tag or CSS class. E.g. "form" or ".active".

Returns:

Matching ancestor element

find

public UiElement find(java.lang.String cssSelector)

Find the first matching element inside given element

Short form of webElement.findElement(By.cssSelector(cssSelector))

Driver Type: Desktop, Web

find

public UiElement find(java.lang.String cssSelector,
                      int index)

Find the Nth matching element inside given element

Driver Type: Desktop, Web

find

public UiElement find(By selector)

Find the first matching element inside given element

Short form of webElement.findElement(By.cssSelector(cssSelector))

Driver Type: Desktop, Web

find

public UiElement find(By selector,
                      int index)

Find the Nth matching element inside given element

Driver Type: Desktop, Web

$

public UiElement $(java.lang.String cssSelector)

Driver Type: Desktop, Web

See Also:

find(java.lang.String)

$

public UiElement $(java.lang.String cssSelector,
                   int index)

Driver Type: Desktop, Web

UiElement#find(java.lang.String)

$

public UiElement $(By selector)

Driver Type: Desktop, Web

UiElement#find(java.lang.String)

$

public UiElement $(By selector,
                   int index)

Driver Type: Desktop, Web

UiElement#find(java.lang.String)

findAll

public UiElementCollection findAll(java.lang.String cssSelector)

Short form of webDriver.findElements(thisElement, By.cssSelector(cssSelector))

For example, $("#multirowTable").findAll("tr.active").shouldHave(size(2));

Driver Type: Desktop, Web

Returns:

list of elements inside given element matching given CSS selector

findAll

public UiElementCollection findAll(By selector)

Short form of webDriver.findElements(thisElement, selector)

For example, $("#multirowTable").findAll(By.className("active")).shouldHave(size(2));

Driver Type: Desktop, Web

Returns:

list of elements inside given element matching given criteria

$$

public UiElementCollection $$(java.lang.String cssSelector)

Driver Type: Desktop, Web

UiElement#findAll(java.lang.String)

$$

public UiElementCollection $$(By selector)

Driver Type: Desktop, Web

UiElement#findAll(java.lang.String)

setSelected

public UiElement setSelected(boolean selected)

Set checkbox/radio state to CHECKED or UNCHECKED.

Driver Type: Desktop, Web

Parameters:

selected - true for checked and false for unchecked

toSelectElement

public Select toSelectElement()

Converts UI element to Select

Driver Type: Web

Returns:

Select object that Models a SELECT tag, providing helper methods to select and deselect options.

selectOption

public UiElement selectOption(int index)

Select an option from dropdown list (by index)

Driver Type: Web

Parameters:

index - 0..N (0 means first option)

selectOption

public UiElement selectOption(java.lang.String text)

Select an option from dropdown list (by text)

Driver Type: Web

Parameters:

text - visible text of option

selectOptionByValue

public UiElement selectOptionByValue(java.lang.String value)

Select an option from dropdown list (by value)

Driver Type: Web

Parameters:

value - "value" attribute of option

getSelectedOption

public UiElement getSelectedOption()

Find selected option from this select field

Driver Type: Web

Returns:

WebElement for selected <option> element

getSelectedValue

public java.lang.String getSelectedValue()

Get value of selected option in select field

Driver Type: Web

getSelectedText

public java.lang.String getSelectedText()

Get text of selected option in select field

Driver Type: Web

scrollTo

public UiElement scrollTo()

Ask browser to scroll to this element

Driver Type: Web

scrollDown

public UiElement scrollDown(int times)

Moves mouse cursor to the center of element and scrolls down number of times.

Driver Type: Desktop, Web

Parameters:

times - how many times need to scroll (ticks of the mouse wheel)

Returns:

this element

scrollUp

public UiElement scrollUp(int times)

Moves mouse cursor to the center of element and scrolls up number of times.

Driver Type: Desktop, Web

Parameters:

times - how many times need to scroll (ticks of the mouse wheel)

Returns:

this element

toWebElement

public WebElement toWebElement()

Returns:

the original Selenium WebElement wrapped by this object

getWrappedElement

public WebElement getWrappedElement()

click

public UiElement click(int offsetX,
                       int offsetY)

Click the element with offset Offset is calculated from TOP LEFT corner

Driver Type: Desktop, Web

Parameters:

offsetX - is offset from Left

offsetY - is offset from Top

Since:

9.2

click

public void click()

Click the element

By default it uses default Selenium method click.

contextClick

public UiElement contextClick(int offsetX,
                              int offsetY)

Click with right mouse button by offset on this element

Driver Type: Desktop, Web

Parameters:

offsetX - is offset from Left

offsetY - is offset from Top

Returns:

this element

Since:

9.2

contextClick

public UiElement contextClick()

Click with right mouse button on this element

Returns:

this element

singleClick

public UiElement singleClick(int offsetX,
                             int offsetY)

Single click the element. The same as click(int, int), but returns UiElement. Helpful for chaining

Sample

$("[CLASS:Edit; INSTANCE:1]").singleClick(10, 10).sendKeys(text);

Driver Type: Desktop, Web

Parameters:

offsetX - is offset from Left

offsetY - is offset from Top

Returns:

this UiElement

Since:

9.2

singleClick

public UiElement singleClick()

Single click the element. The same as click(), but returns UiElement. Helpful for chaining

Sample

$("[CLASS:Edit; INSTANCE:1]").singleClick().sendKeys(text);

Returns:

this UiElement

doubleClick

public UiElement doubleClick(int offsetX,
                             int offsetY)

Double click the element

Driver Type: Desktop, Web

Parameters:

offsetX - is offset from Left

offsetY - is offset from Top

Returns:

this UiElement

Since:

9.2

doubleClick

public UiElement doubleClick()

Double click the element

Returns:

this element

tripleClick

public UiElement tripleClick(int offsetX,
                             int offsetY)

Triple click the element

Driver Type: Desktop, Web

Parameters:

offsetX - is offset from Left

offsetY - is offset from Top

Returns:

this UiElement

Since:

9.2

tripleClick

public UiElement tripleClick()

Triple click the element

Driver Type: Desktop, Web

Returns:

this element

click

public UiElement click(int clicks,
                       int offsetX,
                       int offsetY)

Click the element number of times

Driver Type: Desktop, Web

Parameters:

clicks - number of clicks

offsetX - is offset from Left

offsetY - is offset from Top

Returns:

this UiElement

Since:

9.2

click

public UiElement click(int clicks)

Click the element number of times

Driver Type: Desktop, Web

Parameters:

clicks - number of clicks

Returns:

this element

wheelClick

public UiElement wheelClick(int offsetX,
                            int offsetY)

Wheel click on the element

Driver Type: Desktop, Web

Parameters:

offsetX - is offset from Left

offsetY - is offset from Top

Returns:

this UiElement

Since:

9.2

wheelClick

public UiElement wheelClick()

Wheel click on the element

Driver Type: Desktop, Web

Returns:

this element

hover

public UiElement hover()

Emulate "mouseOver" event. In other words, move mouse cursor over this element (without clicking it).

Returns:

this element

isImageLoaded

public boolean isImageLoaded()

Check if image is properly loaded.

Driver Type: Web

Throws:

java.lang.IllegalArgumentException - if argument is not an "img" element

submit

public void submit()

sendKeys

public void sendKeys(java.lang.CharSequence... charSequences)

sendKeys

public UiElement sendKeys(java.lang.Object text)

sendKeysWithFocus

public UiElement sendKeysWithFocus(java.lang.Object text)

It scrolls to the element, moves cursor to it and then performs sendKeys. Above actions help to maintain focus on the element before sendKeys is invoked, which leads to improved reliability of sendKeys action.

Driver Type: Web

Returns:

this element

Throws:

java.lang.IllegalStateException - if driver different than Web is used

Since:

10.2.7

clear

public void clear()

getTagName

public java.lang.String getTagName()

getAttribute

public java.lang.String getAttribute(java.lang.String s)

getDomAttribute

public java.lang.String getDomAttribute(java.lang.String name)

getDomProperty

public java.lang.String getDomProperty(java.lang.String name)

getAriaRole

public java.lang.String getAriaRole()

getAccessibleName

public java.lang.String getAccessibleName()

getShadowRoot

public SearchContext getShadowRoot()

isSelected

public boolean isSelected()

isEnabled

public boolean isEnabled()

focus

public boolean focus()

isDisplayed

public boolean isDisplayed()

findElements

public java.util.List<org.openqa.selenium.WebElement> findElements(By by)

findElement

public WebElement findElement(By by)

getLocation

public Point getLocation()

getSize

public Dimension getSize()

getRect

public Rectangle getRect()

getCssValue

public java.lang.String getCssValue(java.lang.String s)

getScreenshotAs

public <X> X getScreenshotAs(<any> outputType)

getId

public java.lang.String getId()

getCoordinates

public Coordinates getCoordinates()

copySelectedText

public java.lang.String copySelectedText()

Copies selected text

Driver Type: Desktop

Returns:

selected text

selectAllTextAndCopy

public java.lang.String selectAllTextAndCopy()

Sample: String selectedText = $("[CLASS:Edit; INSTANCE:1]") .append("some text") .selectAllTextAndCopy();

Driver Type: Desktop

Returns:

selected text

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

top

public int top()

left

public int left()

bottom

public int bottom()

right

public int right()

centerX

public int centerX()

centerY

public int centerY()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Displays WebElement in human-readable format. Useful for logging and debugging. Not recommended to use for test verifications.

Overrides:

toString in class java.lang.Object