com.atlassian.pageobjects.elements

Interface PageElementFinder

All Known Subinterfaces:

CheckboxElement, MultiSelectElement, PageElement, SelectElement

All Known Implementing Classes:

GlobalElementFinder, WebDriverCheckboxElement, WebDriverElement, WebDriverMultiSelectElement, WebDriverSelectElement

@PublicApi
public interface PageElementFinder

Encapsulates functionality for finding instances and collections of PageElement on the tested pages, or parts of pages.

A finder is associated with some search scope - it will find elements within this scope (e.g. globally, or within a parent page element).

Since:

2.0

Method Summary

Modifier and Type	Method and Description
PageElement	find(org.openqa.selenium.By by) Creates PageElement implementation using the specified locator and default timeout.
<T extends PageElement> T	find(org.openqa.selenium.By by, Class<T> elementClass) Creates PageElement extension of type T using the specified locator and default timeout.
<T extends PageElement> T	find(org.openqa.selenium.By by, Class<T> elementClass, TimeoutType timeoutType) Creates PageElement extension of type T using the specified locator and given timeoutType
PageElement	find(org.openqa.selenium.By by, TimeoutType timeoutType) Creates PageElement implementation using the specified locator and given timeoutType.
List<PageElement>	findAll(org.openqa.selenium.By by) Creates a PageElement for each element that matches the given locator using default timeout.
<T extends PageElement> List<T>	findAll(org.openqa.selenium.By by, Class<T> elementClass) Creates (@Link PageElement) extension of type T for each element that matches the given locator with default timeout
<T extends PageElement> List<T>	findAll(org.openqa.selenium.By by, Class<T> elementClass, TimeoutType timeoutType) Creates (@Link PageElement) extension of type T for each element that matches the given locator with timeoutType
List<PageElement>	findAll(org.openqa.selenium.By by, TimeoutType timeoutType) Creates a PageElement for each element that matches the given locator using timeoutType.

Method Detail

find

@Nonnull
PageElement find(@Nonnull
                          org.openqa.selenium.By by)

Creates PageElement implementation using the specified locator and default timeout.

Parameters:

by - Locator mechanism to use

Returns:

Element that waits until its present in the DOM before executing actions.

find

@Nonnull
PageElement find(@Nonnull
                          org.openqa.selenium.By by,
                          @Nonnull
                          TimeoutType timeoutType)

Creates PageElement implementation using the specified locator and given timeoutType.

Parameters:

by - Locator mechanism to use

timeoutType - timeout for the element's timed operations

Returns:

Element that waits until its present in the DOM before executing actions.

findAll

@Nonnull
List<PageElement> findAll(@Nonnull
                                   org.openqa.selenium.By by)

Creates a PageElement for each element that matches the given locator using default timeout.

Parameters:

by - Locator mechanism to use

Returns:

List of PageElements that match the given locator

findAll

@Nonnull
List<PageElement> findAll(@Nonnull
                                   org.openqa.selenium.By by,
                                   @Nonnull
                                   TimeoutType timeoutType)

Creates a PageElement for each element that matches the given locator using timeoutType.

Parameters:

by - Locator mechanism to use

timeoutType - timeout for the element's timed operations

Returns:

List of PageElements that match the given locator

find

@Nonnull
<T extends PageElement> T find(@Nonnull
                                        org.openqa.selenium.By by,
                                        @Nonnull
                                        Class<T> elementClass)

Creates PageElement extension of type T using the specified locator and default timeout.

Parameters:

by - Locator mechanism to use

elementClass - The class of the element to create

Returns:

An instance that implements specified PageElement interface

find

@Nonnull
<T extends PageElement> T find(@Nonnull
                                        org.openqa.selenium.By by,
                                        @Nonnull
                                        Class<T> elementClass,
                                        @Nonnull
                                        TimeoutType timeoutType)

Creates PageElement extension of type T using the specified locator and given timeoutType

Parameters:

by - Locator mechanism to use

elementClass - The class of the element to create

timeoutType - timeout for the element's timed operations

Returns:

An instance that implements specified PageElement interface

findAll

@Nonnull
<T extends PageElement> List<T> findAll(@Nonnull
                                                 org.openqa.selenium.By by,
                                                 @Nonnull
                                                 Class<T> elementClass)

Creates (@Link PageElement) extension of type T for each element that matches the given locator with default timeout

Parameters:

by - Locator mechanism to use

elementClass - The class of the element to create

Returns:

A list of objects that implement specified PageElement interface

findAll

@Nonnull
<T extends PageElement> List<T> findAll(@Nonnull
                                                 org.openqa.selenium.By by,
                                                 @Nonnull
                                                 Class<T> elementClass,
                                                 @Nonnull
                                                 TimeoutType timeoutType)

Creates (@Link PageElement) extension of type T for each element that matches the given locator with timeoutType

Parameters:

by - Locator mechanism to use

elementClass - The class of the element to create

timeoutType - timeout for the element's timed operations

Returns:

A list of objects that implement specified PageElement interface