com.codeborne.selenide

Interface SelenideElement

All Superinterfaces:

org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.internal.Locatable, org.openqa.selenium.SearchContext, org.openqa.selenium.WebElement, org.openqa.selenium.internal.WrapsDriver

public interface SelenideElement
extends org.openqa.selenium.WebElement, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.internal.WrapsDriver, org.openqa.selenium.internal.Locatable

Method Summary

Methods

Modifier and Type	Method and Description
SelenideElement	$(org.openqa.selenium.By selector) com.codeborne.selenide.SelenideElement#find(java.lang.String)
SelenideElement	$(org.openqa.selenium.By selector, int index) com.codeborne.selenide.SelenideElement#find(java.lang.String)
SelenideElement	$(java.lang.String cssSelector)
SelenideElement	$(java.lang.String cssSelector, int index) com.codeborne.selenide.SelenideElement#find(java.lang.String)
ElementsCollection	$$(org.openqa.selenium.By selector) com.codeborne.selenide.SelenideElement#findAll(java.lang.String)
ElementsCollection	$$(java.lang.String cssSelector) com.codeborne.selenide.SelenideElement#findAll(java.lang.String)
SelenideElement	append(java.lang.String text) Append given test to the text field and trigger "change" event.
java.lang.String	attr(java.lang.String attributeName) Get the attribute of the element.
java.lang.String	data(java.lang.String dataAttributeName) Get value of attribute "data-dataAttributeName"
java.io.File	download() Download file linked by "href" attribute of this element
boolean	exists() Checks if element exists true on the current page.
SelenideElement	find(org.openqa.selenium.By selector) com.codeborne.selenide.SelenideElement#find(java.lang.String)
SelenideElement	find(org.openqa.selenium.By selector, int index) com.codeborne.selenide.SelenideElement#find(java.lang.String)
SelenideElement	find(java.lang.String cssSelector) Find the first matching element inside given element
SelenideElement	find(java.lang.String cssSelector, int index) Find the Nth matching element inside given element
ElementsCollection	findAll(org.openqa.selenium.By selector) Short form of webDriver.findElements(thisElement, selector)
ElementsCollection	findAll(java.lang.String cssSelector) Short form of webDriver.findElements(thisElement, By.cssSelector(cssSelector))
void	followLink() Actual for <a href> elements.
SelenideElement	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
boolean	isDisplayed() Check if this element exists and visible.
java.lang.String	name() Get the "name" attribute of the element
SelenideElement	pressEnter() Press ENTER.
SelenideElement	pressTab() Press TAB.
SelenideElement	scrollTo() Ask browser to scroll to this element
void	selectOption(java.lang.String text) Select an option from dropdown list
void	selectOptionByValue(java.lang.String value) Select an option by value from dropdown list
SelenideElement	setValue(java.lang.String text) Clear the text field, enter given text and trigger "change" event.
SelenideElement	should(Condition... condition) Checks that given element meets all of given conditions.
SelenideElement	shouldBe(Condition... condition) Synonym for #should.
SelenideElement	shouldHave(Condition... condition) Synonym for #should.
SelenideElement	shouldNot(Condition... condition) Checks that given element does not meet given conditions.
SelenideElement	shouldNotBe(Condition... condition) Synonym for #shouldNot.
SelenideElement	shouldNotHave(Condition... condition) Synonym for #shouldNot.
java.lang.String	text() Short form of getText()
java.lang.String	toString() Displays WebElement in human-readable format.
org.openqa.selenium.WebElement	toWebElement()
java.io.File	uploadFromClasspath(java.lang.String fileName) Upload file into file upload field.
java.lang.String	val() Get the "value" attribute of the element
SelenideElement	val(java.lang.String text) Same as #setValue(java.lang.String)
SelenideElement	waitUntil(Condition condition, long timeoutMilliseconds) Wait until given element meets given conditions.
SelenideElement	waitWhile(Condition condition, long timeoutMilliseconds) Wait until given element does not meet given conditions.

Methods inherited from interface org.openqa.selenium.WebElement

clear, click, findElement, findElements, getAttribute, getCssValue, getLocation, getSize, getTagName, getText, isEnabled, isSelected, sendKeys, submit

Methods inherited from interface org.openqa.selenium.internal.FindsByLinkText

findElementByLinkText, findElementByPartialLinkText, findElementsByLinkText, findElementsByPartialLinkText

Methods inherited from interface org.openqa.selenium.internal.FindsById

findElementById, findElementsById

Methods inherited from interface org.openqa.selenium.internal.FindsByName

findElementByName, findElementsByName

Methods inherited from interface org.openqa.selenium.internal.FindsByTagName

findElementByTagName, findElementsByTagName

Methods inherited from interface org.openqa.selenium.internal.FindsByClassName

findElementByClassName, findElementsByClassName

Methods inherited from interface org.openqa.selenium.internal.FindsByCssSelector

findElementByCssSelector, findElementsByCssSelector

Methods inherited from interface org.openqa.selenium.internal.FindsByXPath

findElementByXPath, findElementsByXPath

Methods inherited from interface org.openqa.selenium.internal.WrapsDriver

getWrappedDriver

Methods inherited from interface org.openqa.selenium.internal.Locatable

getCoordinates

Method Detail

followLink

void followLink()

Actual for <a href> elements. Navigates browser by clicking this link.

In some situations just clicking is not enough: $.click() doesn't take effect for <a href>. In these cases use #followLink that actually navigates browser to @href value.

setValue

SelenideElement setValue(java.lang.String text)

Clear the text field, enter given text and trigger "change" event.

Implementation details: this is the same as

   1. WebElement.clear()
   2. WebElement.sendKeys(text)
   3. Trigger change event

Parameters:

text - Any text to enter into the text field.

val

SelenideElement val(java.lang.String text)

Same as #setValue(java.lang.String)

append

SelenideElement append(java.lang.String text)

Append given test to the text field and trigger "change" event.

Implementation details: This is the same as

   1. WebElement.sendKeys(text)
   2. Trigger change event

Parameters:

text - Any text to append into the text field.

pressEnter

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

pressTab

SelenideElement pressTab()

Press TAB. Useful for input field and textareas:

  $("#to").val("[email protected]").pressTab();

Implementation details: This is the same as

  WebElement.sendKeys(Keys.TAB)

text

java.lang.String text()

Short form of getText()

See Also:

WebElement.getText()

attr

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

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

Returns:

null if attribute is missing

name

java.lang.String name()

Get the "name" attribute of the element

Returns:

attribute "name" value or null if attribute is missing

val

java.lang.String val()

Get the "value" attribute of the element

Returns:

attribute "value" value or null if attribute is missing

data

java.lang.String data(java.lang.String dataAttributeName)

Get value of attribute "data-dataAttributeName"

exists

boolean exists()

Checks if element exists true on the current page.

Returns:

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

isDisplayed

boolean isDisplayed()

Check if this element exists and visible.

Specified by:

isDisplayed in interface org.openqa.selenium.WebElement

Returns:

false if element does not exists, is invisible, browser is closed or any WebDriver exception happened.

should

SelenideElement should(Condition... condition)

Checks that given element meets all of given conditions.

IMPORTANT: If element does not match then conditions immediately, waits up to 4 seconds until element meets the conditions. It's extremely useful for dynamic content.

Timeout is configurable via Configuration#timeout

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

Returns:

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

See Also:

Configuration.timeout

shouldHave

SelenideElement shouldHave(Condition... condition)

Synonym for #should. Useful for better readability.

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

See Also:

should(com.codeborne.selenide.Condition...)

shouldBe

SelenideElement shouldBe(Condition... condition)

Synonym for #should. Useful for better readability.

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

See Also:

should(com.codeborne.selenide.Condition...)

shouldNot

SelenideElement shouldNot(Condition... condition)

Checks that given element does not meet given conditions.

IMPORTANT: If element does match the conditions, waits up to 4 seconds until element does not meet the conditions. It's extremely useful for dynamic content.

Timeout is configurable via Configuration#timeout

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

See Also:

Configuration.timeout

shouldNotHave

SelenideElement shouldNotHave(Condition... condition)

Synonym for #shouldNot. Useful for better readability.

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

See Also:

shouldNot(com.codeborne.selenide.Condition...)

shouldNotBe

SelenideElement shouldNotBe(Condition... condition)

Synonym for #shouldNot. Useful for better readability.

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

See Also:

shouldNot(com.codeborne.selenide.Condition...)

waitUntil

SelenideElement waitUntil(Condition condition,
                        long timeoutMilliseconds)

Wait until given element meets given conditions.

IMPORTANT: in most cases you don't need this method because all should- methods wait too. You need to use #waitUntil or #waitFor methods only if you need another timeout.

Parameters:

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

timeoutMilliseconds - timeout in milliseconds.

waitWhile

SelenideElement waitWhile(Condition condition,
                        long timeoutMilliseconds)

Wait until given element does not meet given conditions.

IMPORTANT: in most cases you don't need this method because all shouldNot- methods wait too. You need to use #waitUntil or #waitFor methods only if you need another timeout.

Parameters:

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

timeoutMilliseconds - timeout in milliseconds.

toString

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

Returns:

e.g. Order has been confirmed

find

SelenideElement find(java.lang.String cssSelector)

Find the first matching element inside given element

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

find

SelenideElement find(java.lang.String cssSelector,
                   int index)

Find the Nth matching element inside given element

find

SelenideElement find(org.openqa.selenium.By selector)

com.codeborne.selenide.SelenideElement#find(java.lang.String)

find

SelenideElement find(org.openqa.selenium.By selector,
                   int index)

com.codeborne.selenide.SelenideElement#find(java.lang.String)

$

SelenideElement $(java.lang.String cssSelector)

See Also:

find(java.lang.String)

$

SelenideElement $(java.lang.String cssSelector,
                int index)

com.codeborne.selenide.SelenideElement#find(java.lang.String)

$

SelenideElement $(org.openqa.selenium.By selector)

com.codeborne.selenide.SelenideElement#find(java.lang.String)

$

SelenideElement $(org.openqa.selenium.By selector,
                int index)

com.codeborne.selenide.SelenideElement#find(java.lang.String)

findAll

ElementsCollection findAll(java.lang.String cssSelector)

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

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

Returns:

list of elements inside given element matching given CSS selector

findAll

ElementsCollection findAll(org.openqa.selenium.By selector)

Short form of webDriver.findElements(thisElement, selector)

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

Returns:

list of elements inside given element matching given criteria

$$

ElementsCollection $$(java.lang.String cssSelector)

com.codeborne.selenide.SelenideElement#findAll(java.lang.String)

$$

ElementsCollection $$(org.openqa.selenium.By selector)

com.codeborne.selenide.SelenideElement#findAll(java.lang.String)

uploadFromClasspath

java.io.File uploadFromClasspath(java.lang.String fileName)

Upload file into file upload field. File is searched from classpath.

Short form of webElement.sendKeys("c:/files/my-file.txt");

selectOption

void selectOption(java.lang.String text)

Select an option from dropdown list

Parameters:

text - visible text of option

selectOptionByValue

void selectOptionByValue(java.lang.String value)

Select an option by value from dropdown list

Parameters:

value - "value" attribute of option

getSelectedOption

SelenideElement getSelectedOption()

Find selected option from this select field

Returns:

WebElement for selected <option> element

Throws:

org.openqa.selenium.NoSuchElementException - if no options are selected

getSelectedValue

java.lang.String getSelectedValue()

Get value of selected option in select field

getSelectedText

java.lang.String getSelectedText()

Get text of selected option in select field

scrollTo

SelenideElement scrollTo()

Ask browser to scroll to this element

download

java.io.File download()

Download file linked by "href" attribute of this element

toWebElement

org.openqa.selenium.WebElement toWebElement()

Returns:

the original Selenium WebElement wrapped by this object