org.nuxeo.functionaltests

Class Locator

java.lang.Object

org.nuxeo.functionaltests.Locator

public class Locator
extends Object

Helper class providing find and wait methods with or without timeout. When requiring timeout, the polling frequency is every 100 milliseconds if not specified.

Since:

5.9.2

Field Summary

Fields

Modifier and Type	Field and Description
static int	URLCHANGE_MAX_WAIT

Constructor Summary

Constructors

Constructor and Description
Locator()

Method Summary

Modifier and Type	Method and Description
static org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By by)
static org.openqa.selenium.WebElement	findElementAndWaitUntilEnabled(org.openqa.selenium.By by) Finds the first WebElement using the given method, with the default timeout.
static org.openqa.selenium.WebElement	findElementAndWaitUntilEnabled(org.openqa.selenium.By by, int findElementTimeout, int waitUntilEnabledTimeout) Finds the first WebElement using the given method, with a findElementTimeout.
static org.openqa.selenium.WebElement	findElementAndWaitUntilEnabled(org.openqa.selenium.WebElement parentElement, org.openqa.selenium.By by, int findElementTimeout, int waitUntilEnabledTimeout) Finds the first WebElement using the given method, with a findElementTimeout, inside an optional parentElement.
static List<org.openqa.selenium.WebElement>	findElementsWithTimeout(org.openqa.selenium.By by)
static void	findElementWaitUntilEnabledAndClick(org.openqa.selenium.By by) Finds the first WebElement using the given method, with the default timeout.
static void	findElementWaitUntilEnabledAndClick(org.openqa.selenium.By by, int findElementTimeout, int waitUntilEnabledTimeout) Deprecated. since 8.3, use findElementWaitUntilEnabledAndClick(WebElement, By)
static void	findElementWaitUntilEnabledAndClick(org.openqa.selenium.WebElement parentElement, org.openqa.selenium.By by) Finds the first WebElement using the given method, with the default timeout, inside an optional parentElement.
static void	findElementWaitUntilEnabledAndClick(org.openqa.selenium.WebElement parentElement, org.openqa.selenium.By by, int findElementTimeout, int waitUntilEnabledTimeout) Finds the first WebElement using the given method, with a findElementTimeout, inside an optional parentElement.
static org.openqa.selenium.WebElement	findElementWithTimeout(org.openqa.selenium.By by) Finds the first WebElement using the given method, with a timeout.
static org.openqa.selenium.WebElement	findElementWithTimeout(org.openqa.selenium.By by, int timeout) Finds the first WebElement using the given method, with a timeout.
static org.openqa.selenium.WebElement	findElementWithTimeout(org.openqa.selenium.By by, int timeout, org.openqa.selenium.WebElement parentElement) Finds the first WebElement using the given method, with a timeout.
static org.openqa.selenium.WebElement	findElementWithTimeout(org.openqa.selenium.By by, org.openqa.selenium.WebElement parentElement) Finds the first WebElement using the given method, with a timeout.
static void	findElementWithTimeoutAndClick(org.openqa.selenium.By by) Finds the first WebElement using the given method, with a findElementTimeout.
static org.openqa.selenium.WebElement	findParentTag(org.openqa.selenium.WebElement elt, String tagName) Return parent element with given tag name.
static org.openqa.selenium.support.ui.FluentWait<org.openqa.selenium.WebDriver>	getFluentWait()
static boolean	hasElementWithTimeout(org.openqa.selenium.By by) Checks if a corresponding elements is present, with a timeout.
static boolean	hasElementWithTimeout(org.openqa.selenium.By by, int timeout) Checks if a corresponding elements is present, with a timeout.
static boolean	scrollAndForceClick(org.openqa.selenium.WebElement element) Forces a click on an element, to workaround non-effective clicks in miscellaneous situations, after having scrolled to it.
static void	scrollToElement(org.openqa.selenium.WebElement element) Scrolls to the element in the view: allows to safely click on it afterwards.
static void	waitForTextNotPresent(org.openqa.selenium.WebElement element, String text) Fluent wait for text to be not present in the given element.
static void	waitForTextPresent(org.openqa.selenium.By locator, String text) Fluent wait for text to be present in the element retrieved with the given method.
static void	waitForTextPresent(org.openqa.selenium.WebElement element, String text) Fluent wait for text to be present in the given element.
static void	waitUntilElementNotPresent(org.openqa.selenium.By locator) Fluent wait for an element not to be present, checking every 100 ms.
static void	waitUntilElementPresent(org.openqa.selenium.By locator) Fluent wait for an element to be present, checking every 100 ms.
static void	waitUntilEnabled(org.openqa.selenium.WebElement element) Waits until an element is enabled, with a timeout.
static void	waitUntilEnabled(org.openqa.selenium.WebElement element, int timeout) Waits until an element is enabled, with a timeout.
static void	waitUntilEnabledAndClick(org.openqa.selenium.WebElement element) Waits until the element is enabled, with a default timeout.
static void	waitUntilEnabledAndClick(org.openqa.selenium.WebElement element, int waitUntilEnabledTimeout) Waits until the element is enabled, with a waitUntilEnabledTimeout.
static void	waitUntilGivenFunction(com.google.common.base.Function<org.openqa.selenium.WebDriver,Boolean> function) Fluent wait on a the given function, checking every 100 ms.
static <K extends Throwable> void	waitUntilGivenFunctionIgnoreAll(com.google.common.base.Function<org.openqa.selenium.WebDriver,Boolean> function, Class<? extends K>... ignoredExceptions) Fluent wait on a the given function, checking every 100 ms.
static <K extends Throwable> void	waitUntilGivenFunctionIgnoring(com.google.common.base.Function<org.openqa.selenium.WebDriver,Boolean> function, Class<? extends K> ignoredException) Fluent wait on a the given function, checking every 100 ms.
static void	waitUntilURLContains(String string) Waits until the URL contains the string given in parameter, with a timeout.
static void	waitUntilURLDifferentFrom(String url) Waits until the URL is different from the one given in parameter, with a timeout.
static void	waitUntilURLNotContain(String string) Waits until the URL does not contain the string given in parameter, with a timeout.
static void	waitUntilWindowClosed(String windowHandle)

Methods inherited from class java.lang.Object

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

Field Detail

URLCHANGE_MAX_WAIT

public static final int URLCHANGE_MAX_WAIT

See Also:

Constant Field Values

Constructor Detail

Locator

public Locator()

Method Detail

findElement

public static org.openqa.selenium.WebElement findElement(org.openqa.selenium.By by)

findElementAndWaitUntilEnabled

public static org.openqa.selenium.WebElement findElementAndWaitUntilEnabled(org.openqa.selenium.By by)
                                                                     throws org.openqa.selenium.NotFoundException

Finds the first WebElement using the given method, with the default timeout. Then waits until the element is enabled, with the default timeout.

Parameters:

by - the locating mechanism

Returns:

the first matching element on the current page, if found

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

findElementAndWaitUntilEnabled

public static org.openqa.selenium.WebElement findElementAndWaitUntilEnabled(org.openqa.selenium.By by,
                                                                            int findElementTimeout,
                                                                            int waitUntilEnabledTimeout)
                                                                     throws org.openqa.selenium.NotFoundException

Finds the first WebElement using the given method, with a findElementTimeout. Then waits until the element is enabled, with a waitUntilEnabledTimeout.

Parameters:

by - the locating mechanism

findElementTimeout - the find element timeout in milliseconds

waitUntilEnabledTimeout - the wait until enabled timeout in milliseconds

Returns:

the first matching element on the current page, if found

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

findElementAndWaitUntilEnabled

public static org.openqa.selenium.WebElement findElementAndWaitUntilEnabled(org.openqa.selenium.WebElement parentElement,
                                                                            org.openqa.selenium.By by,
                                                                            int findElementTimeout,
                                                                            int waitUntilEnabledTimeout)
                                                                     throws org.openqa.selenium.NotFoundException

Finds the first WebElement using the given method, with a findElementTimeout, inside an optional parentElement. Then waits until the element is enabled, with a waitUntilEnabledTimeout.

Parameters:

parentElement - the parent element (can be null)

by - the locating mechanism

findElementTimeout - the find element timeout in milliseconds

waitUntilEnabledTimeout - the wait until enabled timeout in milliseconds

Returns:

the first matching element on the current page, if found, with optional parent element

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

Since:

8.3

findElementsWithTimeout

public static List<org.openqa.selenium.WebElement> findElementsWithTimeout(org.openqa.selenium.By by)
                                                                    throws org.openqa.selenium.NoSuchElementException

Throws:

org.openqa.selenium.NoSuchElementException

findElementWaitUntilEnabledAndClick

public static void findElementWaitUntilEnabledAndClick(org.openqa.selenium.By by)
                                                throws org.openqa.selenium.NotFoundException

Finds the first WebElement using the given method, with the default timeout. Then waits until the element is enabled, with the default timeout. Then clicks on the element.

Parameters:

by - the locating mechanism

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

findElementWaitUntilEnabledAndClick

public static void findElementWaitUntilEnabledAndClick(org.openqa.selenium.WebElement parentElement,
                                                       org.openqa.selenium.By by)
                                                throws org.openqa.selenium.NotFoundException

Finds the first WebElement using the given method, with the default timeout, inside an optional parentElement. Then waits until the element is enabled, with the default timeout. Then clicks on the element.

Parameters:

parentElement - the parent element (can be null)

by - the locating mechanism

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

Since:

8.3

findElementWithTimeout

public static org.openqa.selenium.WebElement findElementWithTimeout(org.openqa.selenium.By by)
                                                             throws org.openqa.selenium.NoSuchElementException

Finds the first WebElement using the given method, with a timeout.

Parameters:

by - the locating mechanism

Returns:

the first matching element on the current page, if found

Throws:

org.openqa.selenium.NoSuchElementException - when not found

hasElementWithTimeout

public static boolean hasElementWithTimeout(org.openqa.selenium.By by)

Checks if a corresponding elements is present, with a timeout.

Parameters:

by - the locating mechanism

Returns:

true if element exists, false otherwise

Since:

9.3

findElementWithTimeout

public static org.openqa.selenium.WebElement findElementWithTimeout(org.openqa.selenium.By by,
                                                                    int timeout)
                                                             throws org.openqa.selenium.NoSuchElementException

Finds the first WebElement using the given method, with a timeout.

Parameters:

by - the locating mechanism

timeout - the timeout in milliseconds

Returns:

the first matching element on the current page, if found

Throws:

org.openqa.selenium.NoSuchElementException - when not found

hasElementWithTimeout

public static boolean hasElementWithTimeout(org.openqa.selenium.By by,
                                            int timeout)

Checks if a corresponding elements is present, with a timeout.

Parameters:

by - the locating mechanism

timeout - the timeout in milliseconds

Returns:

true if element exists, false otherwise

Since:

9.3

findElementWithTimeout

public static org.openqa.selenium.WebElement findElementWithTimeout(org.openqa.selenium.By by,
                                                                    int timeout,
                                                                    org.openqa.selenium.WebElement parentElement)
                                                             throws org.openqa.selenium.NoSuchElementException

Finds the first WebElement using the given method, with a timeout.

Parameters:

by - the locating mechanism

timeout - the timeout in milliseconds

parentElement - find from the element

Returns:

the first matching element on the current page, if found

Throws:

org.openqa.selenium.NoSuchElementException - when not found

findElementWithTimeout

public static org.openqa.selenium.WebElement findElementWithTimeout(org.openqa.selenium.By by,
                                                                    org.openqa.selenium.WebElement parentElement)
                                                             throws org.openqa.selenium.NoSuchElementException

Finds the first WebElement using the given method, with a timeout.

Parameters:

by - the locating mechanism

timeout - the timeout in milliseconds

parentElement - find from the element

Returns:

the first matching element on the current page, if found

Throws:

org.openqa.selenium.NoSuchElementException - when not found

getFluentWait

public static org.openqa.selenium.support.ui.FluentWait<org.openqa.selenium.WebDriver> getFluentWait()

waitForTextNotPresent

public static void waitForTextNotPresent(org.openqa.selenium.WebElement element,
                                         String text)

Fluent wait for text to be not present in the given element.

Since:

5.7.3

waitForTextPresent

public static void waitForTextPresent(org.openqa.selenium.By locator,
                                      String text)

Fluent wait for text to be present in the element retrieved with the given method.

Since:

5.7.3

waitForTextPresent

public static void waitForTextPresent(org.openqa.selenium.WebElement element,
                                      String text)

Fluent wait for text to be present in the given element.

Since:

5.7.3

findElementWaitUntilEnabledAndClick

@Deprecated
public static void findElementWaitUntilEnabledAndClick(org.openqa.selenium.By by,
                                                                   int findElementTimeout,
                                                                   int waitUntilEnabledTimeout)
                                                            throws org.openqa.selenium.NotFoundException

Deprecated. since 8.3, use findElementWaitUntilEnabledAndClick(WebElement, By)

Finds the first WebElement using the given method, with a findElementTimeout. Then waits until the element is enabled, with a waitUntilEnabledTimeout. Scroll to it, then clicks on the element.

Parameters:

by - the locating mechanism

findElementTimeout - the find element timeout in milliseconds

waitUntilEnabledTimeout - the wait until enabled timeout in milliseconds

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

findElementWaitUntilEnabledAndClick

public static void findElementWaitUntilEnabledAndClick(org.openqa.selenium.WebElement parentElement,
                                                       org.openqa.selenium.By by,
                                                       int findElementTimeout,
                                                       int waitUntilEnabledTimeout)
                                                throws org.openqa.selenium.NotFoundException

Finds the first WebElement using the given method, with a findElementTimeout, inside an optional parentElement. Then waits until the element is enabled, with a waitUntilEnabledTimeout. Scroll to it, then clicks on the element.

Parameters:

parentElement - the parent element (can be null)

by - the locating mechanism

findElementTimeout - the find element timeout in milliseconds

waitUntilEnabledTimeout - the wait until enabled timeout in milliseconds

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

Since:

8.3

waitUntilEnabledAndClick

public static void waitUntilEnabledAndClick(org.openqa.selenium.WebElement element)
                                     throws org.openqa.selenium.NotFoundException

Waits until the element is enabled, with a default timeout. Then clicks on the element.

Parameters:

element - the element

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

Since:

8.3

waitUntilEnabledAndClick

public static void waitUntilEnabledAndClick(org.openqa.selenium.WebElement element,
                                            int waitUntilEnabledTimeout)
                                     throws org.openqa.selenium.NotFoundException

Waits until the element is enabled, with a waitUntilEnabledTimeout. Scroll to it, then clicks on the element.

Parameters:

element - the element

waitUntilEnabledTimeout - the wait until enabled timeout in milliseconds

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

Since:

8.3

findElementWithTimeoutAndClick

public static void findElementWithTimeoutAndClick(org.openqa.selenium.By by)
                                           throws org.openqa.selenium.NotFoundException

Finds the first WebElement using the given method, with a findElementTimeout. Then clicks on the element.

Parameters:

by - the locating mechanism

Throws:

org.openqa.selenium.NotFoundException - if the element is not found or not enabled

Since:

5.9.4

waitUntilElementNotPresent

public static void waitUntilElementNotPresent(org.openqa.selenium.By locator)

Fluent wait for an element not to be present, checking every 100 ms.

Since:

5.7.2

waitUntilWindowClosed

public static void waitUntilWindowClosed(String windowHandle)

Since:

9.3

waitUntilElementPresent

public static void waitUntilElementPresent(org.openqa.selenium.By locator)

Fluent wait for an element to be present, checking every 100 ms.

Since:

5.7.2

waitUntilEnabled

public static void waitUntilEnabled(org.openqa.selenium.WebElement element)
                             throws org.openqa.selenium.NotFoundException

Waits until an element is enabled, with a timeout.

Parameters:

element - the element

Throws:

org.openqa.selenium.NotFoundException

waitUntilEnabled

public static void waitUntilEnabled(org.openqa.selenium.WebElement element,
                                    int timeout)
                             throws org.openqa.selenium.NotFoundException

Waits until an element is enabled, with a timeout.

Parameters:

element - the element

timeout - the timeout in milliseconds

Throws:

org.openqa.selenium.NotFoundException

waitUntilGivenFunction

public static void waitUntilGivenFunction(com.google.common.base.Function<org.openqa.selenium.WebDriver,Boolean> function)

Fluent wait on a the given function, checking every 100 ms.

Parameters:

function -

Since:

5.9.2

waitUntilGivenFunctionIgnoreAll

@SafeVarargs
public static <K extends Throwable> void waitUntilGivenFunctionIgnoreAll(com.google.common.base.Function<org.openqa.selenium.WebDriver,Boolean> function,
                                                                                      Class<? extends K>... ignoredExceptions)

Fluent wait on a the given function, checking every 100 ms.

Parameters:

function -

ignoredExceptions - the types of exceptions to ignore.

Since:

5.9.2

waitUntilGivenFunctionIgnoring

public static <K extends Throwable> void waitUntilGivenFunctionIgnoring(com.google.common.base.Function<org.openqa.selenium.WebDriver,Boolean> function,
                                                                        Class<? extends K> ignoredException)

Fluent wait on a the given function, checking every 100 ms.

Parameters:

function -

ignoredException - the type of exception to ignore.

Since:

5.9.2

waitUntilURLContains

public static void waitUntilURLContains(String string)

Waits until the URL contains the string given in parameter, with a timeout.

Parameters:

string - the string that is to be contained

Since:

5.9.2

waitUntilURLDifferentFrom

public static void waitUntilURLDifferentFrom(String url)

Waits until the URL is different from the one given in parameter, with a timeout.

Parameters:

url - the URL to compare to

waitUntilURLNotContain

public static void waitUntilURLNotContain(String string)

Waits until the URL does not contain the string given in parameter, with a timeout.

Parameters:

string - the string that is not to be contained

Since:

5.9.2

findParentTag

public static org.openqa.selenium.WebElement findParentTag(org.openqa.selenium.WebElement elt,
                                                           String tagName)

Return parent element with given tag name.

Throws a NoSuchElementException error if no element found.

Since:

7.3

scrollToElement

public static final void scrollToElement(org.openqa.selenium.WebElement element)

Scrolls to the element in the view: allows to safely click on it afterwards.

Parameters:

executor - the javascript executor, usually WebDriver

element - the element to scroll to

Since:

8.3

scrollAndForceClick

public static final boolean scrollAndForceClick(org.openqa.selenium.WebElement element)

Forces a click on an element, to workaround non-effective clicks in miscellaneous situations, after having scrolled to it.

Parameters:

executor - the javascript executor, usually WebDriver

element - the element to scroll to

Returns:

true if element is clickable

Since:

8.3