org.openqa.selenium.support.ui

Class ExpectedConditions

java.lang.Object

org.openqa.selenium.support.ui.ExpectedConditions

public class ExpectedConditions
extends Object

Canned ExpectedConditions which are generally useful within webdriver tests.

Method Summary

Methods

Modifier and Type	Method and Description
static ExpectedCondition<org.openqa.selenium.Alert>	alertIsPresent()
static ExpectedCondition<Boolean>	elementSelectionStateToBe(org.openqa.selenium.By locator, boolean selected)
static ExpectedCondition<Boolean>	elementSelectionStateToBe(org.openqa.selenium.WebElement element, boolean selected) An expectation for checking if the given element is selected.
static ExpectedCondition<org.openqa.selenium.WebElement>	elementToBeClickable(org.openqa.selenium.By locator) An expectation for checking an element is visible and enabled such that you can click it.
static ExpectedCondition<org.openqa.selenium.WebElement>	elementToBeClickable(org.openqa.selenium.WebElement element) An expectation for checking an element is visible and enabled such that you can click it.
static ExpectedCondition<Boolean>	elementToBeSelected(org.openqa.selenium.By locator)
static ExpectedCondition<Boolean>	elementToBeSelected(org.openqa.selenium.WebElement element) An expectation for checking if the given element is selected.
static ExpectedCondition<org.openqa.selenium.WebDriver>	frameToBeAvailableAndSwitchToIt(org.openqa.selenium.By locator) An expectation for checking whether the given frame is available to switch to.
static ExpectedCondition<org.openqa.selenium.WebDriver>	frameToBeAvailableAndSwitchToIt(String frameLocator) An expectation for checking whether the given frame is available to switch to.
static ExpectedCondition<Boolean>	invisibilityOfElementLocated(org.openqa.selenium.By locator) An expectation for checking that an element is either invisible or not present on the DOM.
static ExpectedCondition<Boolean>	invisibilityOfElementWithText(org.openqa.selenium.By locator, String text) An expectation for checking that an element with text is either invisible or not present on the DOM.
static ExpectedCondition<Boolean>	not(ExpectedCondition<?> condition) An expectation with the logical opposite condition of the given condition.
static ExpectedCondition<List<org.openqa.selenium.WebElement>>	presenceOfAllElementsLocatedBy(org.openqa.selenium.By locator) An expectation for checking that there is at least one element present on a web page.
static ExpectedCondition<org.openqa.selenium.WebElement>	presenceOfElementLocated(org.openqa.selenium.By locator) An expectation for checking that an element is present on the DOM of a page.
static <T> ExpectedCondition<T>	refreshed(ExpectedCondition<T> condition) Wrapper for a condition, which allows for elements to update by redrawing.
static ExpectedCondition<Boolean>	stalenessOf(org.openqa.selenium.WebElement element) Wait until an element is no longer attached to the DOM.
static ExpectedCondition<Boolean>	textToBePresentInElement(org.openqa.selenium.By locator, String text) Deprecated. Use textToBePresentInElementLocated(By, String) instead
static ExpectedCondition<Boolean>	textToBePresentInElement(org.openqa.selenium.WebElement element, String text) An expectation for checking if the given text is present in the specified element.
static ExpectedCondition<Boolean>	textToBePresentInElementLocated(org.openqa.selenium.By locator, String text) An expectation for checking if the given text is present in the element that matches the given locator.
static ExpectedCondition<Boolean>	textToBePresentInElementValue(org.openqa.selenium.By locator, String text) An expectation for checking if the given text is present in the specified elements value attribute.
static ExpectedCondition<Boolean>	textToBePresentInElementValue(org.openqa.selenium.WebElement element, String text) An expectation for checking if the given text is present in the specified elements value attribute.
static ExpectedCondition<Boolean>	titleContains(String title) An expectation for checking that the title contains a case-sensitive substring
static ExpectedCondition<Boolean>	titleIs(String title) An expectation for checking the title of a page.
static ExpectedCondition<Boolean>	urlContains(String fraction) An expectation for the URL of the current page to contain specific text.
static ExpectedCondition<Boolean>	urlMatches(String regex) Expectation for the URL to match a specific regular expression
static ExpectedCondition<Boolean>	urlToBe(String url) An expectation for the URL of the current page to be a specific url.
static ExpectedCondition<org.openqa.selenium.WebElement>	visibilityOf(org.openqa.selenium.WebElement element) An expectation for checking that an element, known to be present on the DOM of a page, is visible.
static ExpectedCondition<List<org.openqa.selenium.WebElement>>	visibilityOfAllElements(List<org.openqa.selenium.WebElement> elements) An expectation for checking that all elements present on the web page that match the locator are visible.
static ExpectedCondition<List<org.openqa.selenium.WebElement>>	visibilityOfAllElementsLocatedBy(org.openqa.selenium.By locator) An expectation for checking that all elements present on the web page that match the locator are visible.
static ExpectedCondition<org.openqa.selenium.WebElement>	visibilityOfElementLocated(org.openqa.selenium.By locator) An expectation for checking that an element is present on the DOM of a page and visible.

Methods inherited from class java.lang.Object

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

Method Detail

titleIs

public static ExpectedCondition<Boolean> titleIs(String title)

An expectation for checking the title of a page.

Parameters:

title - the expected title, which must be an exact match

Returns:

true when the title matches, false otherwise

titleContains

public static ExpectedCondition<Boolean> titleContains(String title)

An expectation for checking that the title contains a case-sensitive substring

Parameters:

title - the fragment of title expected

Returns:

true when the title matches, false otherwise

urlToBe

public static ExpectedCondition<Boolean> urlToBe(String url)

An expectation for the URL of the current page to be a specific url.

Parameters:

url - the url that the page should be on

Returns:

true when the URL is what it should be

urlContains

public static ExpectedCondition<Boolean> urlContains(String fraction)

An expectation for the URL of the current page to contain specific text.

Parameters:

fraction - the fraction of the url that the page should be on

Returns:

true when the URL contains the text

urlMatches

public static ExpectedCondition<Boolean> urlMatches(String regex)

Expectation for the URL to match a specific regular expression

Parameters:

regex - the regular expression that the URL should match

Returns:

true if the URL matches the specified regular expression

presenceOfElementLocated

public static ExpectedCondition<org.openqa.selenium.WebElement> presenceOfElementLocated(org.openqa.selenium.By locator)

An expectation for checking that an element is present on the DOM of a page. This does not necessarily mean that the element is visible.

Parameters:

locator - used to find the element

Returns:

the WebElement once it is located

visibilityOfElementLocated

public static ExpectedCondition<org.openqa.selenium.WebElement> visibilityOfElementLocated(org.openqa.selenium.By locator)

An expectation for checking that an element is present on the DOM of a page and visible. Visibility means that the element is not only displayed but also has a height and width that is greater than 0.

Parameters:

locator - used to find the element

Returns:

the WebElement once it is located and visible

visibilityOfAllElementsLocatedBy

public static ExpectedCondition<List<org.openqa.selenium.WebElement>> visibilityOfAllElementsLocatedBy(org.openqa.selenium.By locator)

An expectation for checking that all elements present on the web page that match the locator are visible. Visibility means that the elements are not only displayed but also have a height and width that is greater than 0.

Parameters:

locator - used to find the element

Returns:

the list of WebElements once they are located

visibilityOfAllElements

public static ExpectedCondition<List<org.openqa.selenium.WebElement>> visibilityOfAllElements(List<org.openqa.selenium.WebElement> elements)

An expectation for checking that all elements present on the web page that match the locator are visible. Visibility means that the elements are not only displayed but also have a height and width that is greater than 0.

Parameters:

elements - list of WebElements

Returns:

the list of WebElements once they are located

visibilityOf

public static ExpectedCondition<org.openqa.selenium.WebElement> visibilityOf(org.openqa.selenium.WebElement element)

An expectation for checking that an element, known to be present on the DOM of a page, is visible. Visibility means that the element is not only displayed but also has a height and width that is greater than 0.

Parameters:

element - the WebElement

Returns:

the (same) WebElement once it is visible

presenceOfAllElementsLocatedBy

public static ExpectedCondition<List<org.openqa.selenium.WebElement>> presenceOfAllElementsLocatedBy(org.openqa.selenium.By locator)

An expectation for checking that there is at least one element present on a web page.

Parameters:

locator - used to find the element

Returns:

the list of WebElements once they are located

textToBePresentInElement

public static ExpectedCondition<Boolean> textToBePresentInElement(org.openqa.selenium.WebElement element,
                                                  String text)

An expectation for checking if the given text is present in the specified element.

Parameters:

element - the WebElement

text - to be present in the element

Returns:

true once the element contains the given text

textToBePresentInElement

@Deprecated
public static ExpectedCondition<Boolean> textToBePresentInElement(org.openqa.selenium.By locator,
                                                             String text)

Deprecated. Use textToBePresentInElementLocated(By, String) instead

An expectation for checking if the given text is present in the element that matches the given locator.

Parameters:

locator - used to find the element

text - to be present in the element found by the locator

Returns:

the WebElement once it is located and visible

textToBePresentInElementLocated

public static ExpectedCondition<Boolean> textToBePresentInElementLocated(org.openqa.selenium.By locator,
                                                         String text)

An expectation for checking if the given text is present in the element that matches the given locator.

Parameters:

locator - used to find the element

text - to be present in the element found by the locator

Returns:

true once the first element located by locator contains the given text

textToBePresentInElementValue

public static ExpectedCondition<Boolean> textToBePresentInElementValue(org.openqa.selenium.WebElement element,
                                                       String text)

An expectation for checking if the given text is present in the specified elements value attribute.

Parameters:

element - the WebElement

text - to be present in the element's value attribute

Returns:

true once the element's value attribute contains the given text

textToBePresentInElementValue

public static ExpectedCondition<Boolean> textToBePresentInElementValue(org.openqa.selenium.By locator,
                                                       String text)

An expectation for checking if the given text is present in the specified elements value attribute.

Parameters:

locator - used to find the element

text - to be present in the value attribute of the element found by the locator

Returns:

true once the value attribute of the first element located by locator contains the given text

frameToBeAvailableAndSwitchToIt

public static ExpectedCondition<org.openqa.selenium.WebDriver> frameToBeAvailableAndSwitchToIt(String frameLocator)

An expectation for checking whether the given frame is available to switch to.

If the frame is available it switches the given driver to the specified frame.

Parameters:

frameLocator - used to find the frame (id or name)

frameToBeAvailableAndSwitchToIt

public static ExpectedCondition<org.openqa.selenium.WebDriver> frameToBeAvailableAndSwitchToIt(org.openqa.selenium.By locator)

An expectation for checking whether the given frame is available to switch to.

If the frame is available it switches the given driver to the specified frame.

Parameters:

locator - used to find the frame

invisibilityOfElementLocated

public static ExpectedCondition<Boolean> invisibilityOfElementLocated(org.openqa.selenium.By locator)

An expectation for checking that an element is either invisible or not present on the DOM.

Parameters:

locator - used to find the element

invisibilityOfElementWithText

public static ExpectedCondition<Boolean> invisibilityOfElementWithText(org.openqa.selenium.By locator,
                                                       String text)

An expectation for checking that an element with text is either invisible or not present on the DOM.

Parameters:

locator - used to find the element

text - of the element

elementToBeClickable

public static ExpectedCondition<org.openqa.selenium.WebElement> elementToBeClickable(org.openqa.selenium.By locator)

An expectation for checking an element is visible and enabled such that you can click it.

Parameters:

locator - used to find the element

Returns:

the WebElement once it is located and clickable (visible and enabled)

elementToBeClickable

public static ExpectedCondition<org.openqa.selenium.WebElement> elementToBeClickable(org.openqa.selenium.WebElement element)

An expectation for checking an element is visible and enabled such that you can click it.

Parameters:

element - the WebElement

Returns:

the (same) WebElement once it is clickable (visible and enabled)

stalenessOf

public static ExpectedCondition<Boolean> stalenessOf(org.openqa.selenium.WebElement element)

Wait until an element is no longer attached to the DOM.

Parameters:

element - The element to wait for.

Returns:

false is the element is still attached to the DOM, true otherwise.

refreshed

public static <T> ExpectedCondition<T> refreshed(ExpectedCondition<T> condition)

Wrapper for a condition, which allows for elements to update by redrawing. This works around the problem of conditions which have two parts: find an element and then check for some condition on it. For these conditions it is possible that an element is located and then subsequently it is redrawn on the client. When this happens a StaleElementReferenceException is thrown when the second part of the condition is checked.

elementToBeSelected

public static ExpectedCondition<Boolean> elementToBeSelected(org.openqa.selenium.WebElement element)

An expectation for checking if the given element is selected.

elementSelectionStateToBe

public static ExpectedCondition<Boolean> elementSelectionStateToBe(org.openqa.selenium.WebElement element,
                                                   boolean selected)

An expectation for checking if the given element is selected.

elementToBeSelected

public static ExpectedCondition<Boolean> elementToBeSelected(org.openqa.selenium.By locator)

elementSelectionStateToBe

public static ExpectedCondition<Boolean> elementSelectionStateToBe(org.openqa.selenium.By locator,
                                                   boolean selected)

alertIsPresent

public static ExpectedCondition<org.openqa.selenium.Alert> alertIsPresent()

not

public static ExpectedCondition<Boolean> not(ExpectedCondition<?> condition)

An expectation with the logical opposite condition of the given condition. Note that if the Condition your are inverting throws an exception that is caught by the Ignored Exceptions, the inversion will not take place and lead to confusing results.