Package org.fluentlenium.core.domain

Class FluentListImpl<E extends FluentWebElement>

java.lang.Object

org.fluentlenium.core.domain.ListImpl<T>

org.fluentlenium.core.domain.DelegatingList<T>

org.fluentlenium.core.domain.ComponentList<E>

org.fluentlenium.core.domain.FluentListImpl<E>

Type Parameters:

E - type of fluent element the list contains

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, FluentActions<FluentList<E>,E>, FluentJavascriptActions, LazyComponents, FluentList<E>, WrapsElements, HookControl<FluentList<E>>, FluentLabel<FluentList<E>>, FluentProxyState<FluentList<E>>, SearchControl<E>

public class FluentListImpl<E extends FluentWebElement>
extends ComponentList<E>
implements FluentList<E>

Default implementation of FluentList and ComponentList.

It offers convenience methods to work with a collection of elements, like click(), submit(), value() ...

It also offers capability to add labels and hooks to an object having this type.

Field Summary

Fields inherited from class org.fluentlenium.core.domain.ComponentList

componentClass, control, instantiator, proxy

Fields inherited from class org.fluentlenium.core.domain.DelegatingList

list

Constructor Summary

Constructors

Constructor	Description
FluentListImpl(java.lang.Class<E> componentClass, java.util.List<E> list, FluentControl control, ComponentInstantiator instantiator)	Creates a new fluent list.

Method Summary

Modifier and Type	Method	Description
FluentList<E>	$(java.util.List<org.openqa.selenium.WebElement> rawElements)	Wrap raw selenium elements into a list of elements.
<T extends FluentWebElement> FluentList<T>	as(java.lang.Class<T> componentClass)	Wrap all underlying elements in a component.
FluentWaitElementList	await()	Build a wait object to wait for a condition of this element list.
FluentListConditions	awaitUntilEach()	Build a condition object on this element list that will match if each underlying element match, automatically waiting for condition to be verified.
FluentListConditions	awaitUntilOne()	Build a condition object on this element list that will match if one or more underlying element match, automatically waiting for condition to be verified.
void	clear()	Clear visible elements on the list
FluentList<E>	clearAll()	Clear all elements on the list
FluentList<E>	clearAllReactInputs()	Clear all React elements on the list
void	clearList()	Calls List.clear() from underlying List implementation.
FluentList<E>	click()	Click on all elements on the list Only the clickable elements are clicked
FluentList<E>	contextClick()	context click on all elements on the list Only the clickable elements are clicked
int	count()	Count elements without actually loading the lazy list.
FluentList<E>	doubleClick()	double click on all elements on the list Only the clickable elements are clicked
FluentListConditions	each()	Build a condition object on this element list that will match if each underlying element match.
E	el(org.openqa.selenium.WebElement rawElement)	Wrap existing raw selenium element into an element.
Fill	fill()	Construct a Fill Builder in order to allow easy fill of visible input fields.
FillSelect	fillSelect()	Construct a Fill Select Builder in order to allow easy fill of visible input fields.
FluentList<E>	find(java.lang.String selector, SearchFilter... filters)	find elements into the children with the corresponding filters
FluentList<E>	find(java.util.List<org.openqa.selenium.WebElement> rawElements)	Wrap raw selenium elements into a list of elements.
FluentList<E>	find(SearchFilter... filters)	find elements in the children with the corresponding filters
FluentList<E>	find(org.openqa.selenium.By locator, SearchFilter... filters)	Find list of elements with Selenium locator and filters.
E	first()	Retrieve the first element.
FluentList<E>	frame()	Select a frame using this element.
E	get(int index)
E	index(int index)	Retrieve an element at given index.
E	last()	Retrieve the last element.
boolean	loaded()	Check if the element is loaded.
FluentList<E>	modifyAttribute(java.lang.String attributeName, java.lang.String attributeValue)	Modifies attributes of first element only
FluentList<E>	noHook()	Disable all hooks from actual element.
FluentList<E>	noHook(java.lang.Class<? extends FluentHook>... hooks)	Disable given hook from actual element.
<R> R	noHook(java.lang.Class<? extends FluentHook> hook, java.util.function.Function<FluentList<E>,R> function)	Invoke a function with no hook.
<R> R	noHook(java.util.function.Function<FluentList<E>,R> function)	Invoke a function with no hook.
FluentList<E>	noHookInstance()	Creates a new element locator instance with all hooks disabled.
FluentList<E>	noHookInstance(java.lang.Class<? extends FluentHook>... hooks)	Creates a new element locator instance with given hook disabled.
FluentList<E>	now()	Search for the element now, actually performing the search on the WebDriver.
FluentList<E>	now(boolean force)	Search for the element now, actually performing the search on the WebDriver.
FluentListConditions	one()	Build a condition object on this element list that will match if one or more underlying element match.
java.util.Optional<FluentList<E>>	optional()	Builds an optional.
boolean	present()	Check if the element is present in the DOM.
FluentList<E>	reset()	Reset the element.
FluentList<E>	restoreHooks()	Retore hooks that were defined initially.
FluentList<E>	scrollIntoView()	Scrolls to first element of list
FluentList<E>	scrollIntoView(boolean alignWithTop)	Scrolls to first element of list
FluentList<E>	scrollToCenter()	Scrolls to first element of list
E	single()	Retrieve the first element and checks is it exactly one element in the list
FluentList<E>	submit()	submit on all elements on the list Only the visible elements are submitted
java.lang.String	toString()
FluentList<E>	waitAndClick()	Helper method that: a) waits at most 5 seconds for element b) scrolls centrally into it c) clicks on it
FluentList<E>	waitAndClick(java.time.Duration duration)	Helper method that: a) waits for element b) scrolls centrally into it c) clicks on it
<O,H extends FluentHook<O>> FluentList<E>	withHook(java.lang.Class<H> hook)	Enable a hook with default options.
<O,H extends FluentHook<O>> FluentList<E>	withHook(java.lang.Class<H> hook, O options)	Enable a hook with given options.
FluentList<E>	withLabel(java.lang.String label)	Apply a label that will be displayed as the representation of this object for error message.
FluentList<E>	withLabelHint(java.lang.String... labelHint)	Add a label hint that will be appended to the representation of this object for error message.
FluentList<E>	write(java.lang.String... with)	Fill all elements on the list with the corresponding cell in the with array.

Methods inherited from class org.fluentlenium.core.domain.ComponentList

addLazyComponentsListener, getWrappedElements, isLazy, isLazyInitialized, removeLazyComponentsListener

Methods inherited from class org.fluentlenium.core.domain.DelegatingList

getList

Methods inherited from class org.fluentlenium.core.domain.ListImpl

add, add, addAll, addAll, contains, containsAll, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.fluentlenium.core.domain.FluentList

attributes, dimensions, hoverOver, ids, names, tagNames, textContents, texts, toElements, values

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface org.fluentlenium.core.search.SearchControl

$, $, $, $, el, el, el, el

Constructor Detail

FluentListImpl

public FluentListImpl(java.lang.Class<E> componentClass,
                      java.util.List<E> list,
                      FluentControl control,
                      ComponentInstantiator instantiator)

Creates a new fluent list.

Parameters:

componentClass - component class

list - list of fluent element

control - control interface

instantiator - component instantiator

Method Detail

await

public FluentWaitElementList await()

Description copied from interface: FluentList

Build a wait object to wait for a condition of this element list.

Specified by:

await in interface FluentList<E extends FluentWebElement>

Returns:

a wait object

first

public E first()

Description copied from interface: FluentList

Retrieve the first element.

Specified by:

first in interface FluentList<E extends FluentWebElement>

Returns:

first element

single

public E single()

Description copied from interface: FluentList

Retrieve the first element and checks is it exactly one element in the list

Specified by:

single in interface FluentList<E extends FluentWebElement>

Returns:

first element

last

public E last()

Description copied from interface: FluentList

Retrieve the last element.

Specified by:

last in interface FluentList<E extends FluentWebElement>

Returns:

last element

get

public E get(int index)

Specified by:

get in interface java.util.List<E extends FluentWebElement>

Overrides:

get in class ListImpl<E extends FluentWebElement>

index

public E index(int index)

Description copied from interface: FluentList

Retrieve an element at given index.

Specified by:

index in interface FluentList<E extends FluentWebElement>

Parameters:

index - position of the element to retrieve

Returns:

element at given index

count

public int count()

Description copied from interface: FluentList

Count elements without actually loading the lazy list.

This method ignore defined hooks.

Specified by:

count in interface FluentList<E extends FluentWebElement>

Returns:

elements count

present

public boolean present()

Description copied from interface: FluentProxyState

Check if the element is present in the DOM.

Specified by:

present in interface FluentProxyState<E extends FluentWebElement>

Returns:

true if the element is present, false otherwise

now

public FluentList<E> now()

Description copied from interface: FluentProxyState

Search for the element now, actually performing the search on the WebDriver.

It has no effect if the element is already loaded.

Specified by:

now in interface FluentProxyState<E extends FluentWebElement>

Returns:

this object reference to chain calls.

now

public FluentList<E> now(boolean force)

Description copied from interface: FluentProxyState

Search for the element now, actually performing the search on the WebDriver.

It has no effect if the element is already loaded.

Specified by:

now in interface FluentProxyState<E extends FluentWebElement>

Parameters:

force - force the search even if element is already loaded

Returns:

this object reference to chain calls.

reset

public FluentList<E> reset()

Description copied from interface: FluentProxyState

Reset the element. Subsequent calls will perform the search again, instead of using the cached result.

Specified by:

reset in interface FluentProxyState<E extends FluentWebElement>

Returns:

this object reference to chain calls.

loaded

public boolean loaded()

Description copied from interface: FluentProxyState

Check if the element is loaded.

Specified by:

loaded in interface FluentProxyState<E extends FluentWebElement>

Returns:

true if the element is loaded, false otherwise

click

public FluentList<E> click()

Description copied from interface: FluentList

Click on all elements on the list Only the clickable elements are clicked

Specified by:

click in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Specified by:

click in interface FluentList<E extends FluentWebElement>

Returns:

the current instance of FluentList to provide capability for chaining calls

See Also:

WebElement.click()

doubleClick

public FluentList<E> doubleClick()

Description copied from interface: FluentList

double click on all elements on the list Only the clickable elements are clicked

Specified by:

doubleClick in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Specified by:

doubleClick in interface FluentList<E extends FluentWebElement>

Returns:

the current instance of FluentList to provide capability for chaining calls

contextClick

public FluentList<E> contextClick()

Description copied from interface: FluentList

context click on all elements on the list Only the clickable elements are clicked

Specified by:

contextClick in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Specified by:

contextClick in interface FluentList<E extends FluentWebElement>

Returns:

the current instance of FluentList to provide capability for chaining calls

waitAndClick

public FluentList<E> waitAndClick()

Description copied from interface: FluentActions

Helper method that: a) waits at most 5 seconds for element b) scrolls centrally into it c) clicks on it

Specified by:

waitAndClick in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Returns:

this object reference to chain methods calls

waitAndClick

public FluentList<E> waitAndClick(java.time.Duration duration)

Description copied from interface: FluentActions

Helper method that: a) waits for element b) scrolls centrally into it c) clicks on it

Specified by:

waitAndClick in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Parameters:

duration - - enabled to override default 5 seconds of waiting

Returns:

this object reference to chain methods calls

write

public FluentList<E> write(java.lang.String... with)

Description copied from interface: FluentList

Fill all elements on the list with the corresponding cell in the with array. Only the visible elements are filled If there are more elements on the list than in the with array, the last element of the table is repeated

Specified by:

write in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Specified by:

write in interface FluentList<E extends FluentWebElement>

Parameters:

with - one or many text to send.

Returns:

the current instance of FluentList to provide capability for chaining calls

See Also:

WebElement.sendKeys(CharSequence...)

clearAll

public FluentList<E> clearAll()

Description copied from interface: FluentList

Clear all elements on the list

Only the visible elements are cleared.

Specified by:

clearAll in interface FluentList<E extends FluentWebElement>

Returns:

extended by FluentWebElement object

clearAllReactInputs

public FluentList<E> clearAllReactInputs()

Description copied from interface: FluentList

Clear all React elements on the list

Only the visible elements are cleared.

Specified by:

clearAllReactInputs in interface FluentList<E extends FluentWebElement>

Returns:

extended by FluentWebElement object

clearList

public void clearList()

Description copied from interface: FluentList

Calls List.clear() from underlying List implementation.

Specified by:

clearList in interface FluentList<E extends FluentWebElement>

See Also:

List.clear()

each

public FluentListConditions each()

Description copied from interface: FluentList

Build a condition object on this element list that will match if each underlying element match.

Specified by:

each in interface FluentList<E extends FluentWebElement>

Returns:

a condition object

one

public FluentListConditions one()

Description copied from interface: FluentList

Build a condition object on this element list that will match if one or more underlying element match.

Specified by:

one in interface FluentList<E extends FluentWebElement>

Returns:

a condition object

awaitUntilEach

public FluentListConditions awaitUntilEach()

Description copied from interface: FluentList

Build a condition object on this element list that will match if each underlying element match, automatically waiting for condition to be verified.

Specified by:

awaitUntilEach in interface FluentList<E extends FluentWebElement>

Returns:

a condition object

awaitUntilOne

public FluentListConditions awaitUntilOne()

Description copied from interface: FluentList

Build a condition object on this element list that will match if one or more underlying element match, automatically waiting for condition to be verified.

Specified by:

awaitUntilOne in interface FluentList<E extends FluentWebElement>

Returns:

a condition object

submit

public FluentList<E> submit()

Description copied from interface: FluentList

submit on all elements on the list Only the visible elements are submitted

Specified by:

submit in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Specified by:

submit in interface FluentList<E extends FluentWebElement>

Returns:

the current instance of FluentList to provide capability for chaining calls

See Also:

WebElement.submit()

find

public FluentList<E> find(java.util.List<org.openqa.selenium.WebElement> rawElements)

Description copied from interface: SearchControl

Wrap raw selenium elements into a list of elements.

Specified by:

find in interface SearchControl<E extends FluentWebElement>

Parameters:

rawElements - raw selenium elements

Returns:

list of element

$

public FluentList<E> $(java.util.List<org.openqa.selenium.WebElement> rawElements)

Description copied from interface: SearchControl

Wrap raw selenium elements into a list of elements.

Specified by:

$ in interface SearchControl<E extends FluentWebElement>

Parameters:

rawElements - raw selenium elements

Returns:

list of element

el

public E el(org.openqa.selenium.WebElement rawElement)

Description copied from interface: SearchControl

Wrap existing raw selenium element into an element.

Specified by:

el in interface SearchControl<E extends FluentWebElement>

Parameters:

rawElement - raw selenium element

Returns:

element

find

public FluentList<E> find(java.lang.String selector,
                          SearchFilter... filters)

Description copied from interface: FluentList

find elements into the children with the corresponding filters

Specified by:

find in interface FluentList<E extends FluentWebElement>

Specified by:

find in interface SearchControl<E extends FluentWebElement>

Parameters:

selector - element name

filters - set of filters

Returns:

extended by FluentWebElement objects list

find

public FluentList<E> find(org.openqa.selenium.By locator,
                          SearchFilter... filters)

Description copied from interface: SearchControl

Find list of elements with Selenium locator and filters.

Specified by:

find in interface SearchControl<E extends FluentWebElement>

Parameters:

locator - elements locator

filters - filters set

Returns:

list of elements

find

public FluentList<E> find(SearchFilter... filters)

Description copied from interface: FluentList

find elements in the children with the corresponding filters

Specified by:

find in interface FluentList<E extends FluentWebElement>

Specified by:

find in interface SearchControl<E extends FluentWebElement>

Parameters:

filters - set of filters

Returns:

extended by FluentWebElement objects list

fill

public Fill fill()

Description copied from interface: FluentActions

Construct a Fill Builder in order to allow easy fill of visible input fields.

Specified by:

fill in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Returns:

Fill builder

fillSelect

public FillSelect fillSelect()

Description copied from interface: FluentActions

Construct a Fill Select Builder in order to allow easy fill of visible input fields.

Specified by:

fillSelect in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Returns:

Fill select builder

frame

public FluentList<E> frame()

Description copied from interface: FluentActions

Select a frame using this element.

Specified by:

frame in interface FluentActions<FluentList<E extends FluentWebElement>,E extends FluentWebElement>

Returns:

this object reference to chain methods calls.

optional

public java.util.Optional<FluentList<E>> optional()

Description copied from interface: FluentProxyState

Builds an optional. If underlying element is lazy, search will be perfomed when invoking this method.

Specified by:

optional in interface FluentProxyState<E extends FluentWebElement>

Returns:

An optional wrapping this.

See Also:

FluentProxyState.present(), FluentProxyState.now()

as

public <T extends FluentWebElement> FluentList<T> as(java.lang.Class<T> componentClass)

Description copied from interface: FluentList

Wrap all underlying elements in a component.

Specified by:

as in interface FluentList<E extends FluentWebElement>

Type Parameters:

T - type of component

Parameters:

componentClass - component class

Returns:

fluent list of elements as components.

clear

public void clear()

Description copied from interface: FluentList

Clear visible elements on the list

Specified by:

clear in interface java.util.Collection<E extends FluentWebElement>

Specified by:

clear in interface FluentList<E extends FluentWebElement>

Specified by:

clear in interface java.util.List<E extends FluentWebElement>

Overrides:

clear in class ListImpl<E extends FluentWebElement>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

withLabel

public FluentList<E> withLabel(java.lang.String label)

Description copied from interface: FluentLabel

Apply a label that will be displayed as the representation of this object for error message.

Specified by:

withLabel in interface FluentLabel<E extends FluentWebElement>

Parameters:

label - label to use

Returns:

reference to this object to chain calls

withLabelHint

public FluentList<E> withLabelHint(java.lang.String... labelHint)

Description copied from interface: FluentLabel

Add a label hint that will be appended to the representation of this object for error message.

Specified by:

withLabelHint in interface FluentLabel<E extends FluentWebElement>

Parameters:

labelHint - label hints to add

Returns:

reference to this object to chain calls

noHookInstance

public FluentList<E> noHookInstance()

Description copied from interface: HookControl

Creates a new element locator instance with all hooks disabled.

Specified by:

noHookInstance in interface HookControl<E extends FluentWebElement>

Returns:

new element locator with hook disabled.

noHook

public FluentList<E> noHook()

Description copied from interface: HookControl

Disable all hooks from actual element.

Specified by:

noHook in interface HookControl<E extends FluentWebElement>

Returns:

this object reference to chain calls

withHook

public <O,H extends FluentHook<O>> FluentList<E> withHook(java.lang.Class<H> hook)

Description copied from interface: HookControl

Enable a hook with default options.

Specified by:

withHook in interface HookControl<E extends FluentWebElement>

Type Parameters:

O - Type of the hook

H - Type of the hook options

Parameters:

hook - hook class to enable

Returns:

this object reference to chain calls

noHook

public <R> R noHook(java.lang.Class<? extends FluentHook> hook,
                    java.util.function.Function<FluentList<E>,R> function)

Description copied from interface: HookControl

Invoke a function with no hook.

Specified by:

noHook in interface HookControl<E extends FluentWebElement>

Type Parameters:

R - return type

Parameters:

hook - hook class to disable

function - function to invoke

Returns:

return value of the given function

restoreHooks

public FluentList<E> restoreHooks()

Description copied from interface: HookControl

Retore hooks that were defined initially.

Specified by:

restoreHooks in interface HookControl<E extends FluentWebElement>

Returns:

this object reference to chain calls

withHook

public <O,H extends FluentHook<O>> FluentList<E> withHook(java.lang.Class<H> hook,
                                                                O options)

Description copied from interface: HookControl

Enable a hook with given options.

Specified by:

withHook in interface HookControl<E extends FluentWebElement>

Type Parameters:

O - Type of the hook

H - Type of the hook options

Parameters:

hook - hook class to enable

options - hook options to apply

Returns:

this object reference to chain calls

noHook

public FluentList<E> noHook(java.lang.Class<? extends FluentHook>... hooks)

Description copied from interface: HookControl

Disable given hook from actual element.

Specified by:

noHook in interface HookControl<E extends FluentWebElement>

Parameters:

hooks - hook classes to disable

Returns:

this object reference to chain calls

noHookInstance

public FluentList<E> noHookInstance(java.lang.Class<? extends FluentHook>... hooks)

Description copied from interface: HookControl

Creates a new element locator instance with given hook disabled.

Specified by:

noHookInstance in interface HookControl<E extends FluentWebElement>

Parameters:

hooks - hook classes to disable

Returns:

new element locator with hook disabled.

noHook

public <R> R noHook(java.util.function.Function<FluentList<E>,R> function)

Description copied from interface: HookControl

Invoke a function with no hook.

Specified by:

noHook in interface HookControl<E extends FluentWebElement>

Type Parameters:

R - return type

Parameters:

function - function to invoke

Returns:

return value of the given function

scrollToCenter

public FluentList<E> scrollToCenter()

Scrolls to first element of list

Specified by:

scrollToCenter in interface FluentJavascriptActions<E extends FluentWebElement>

Returns:

this object reference to chain methods calls

scrollIntoView

public FluentList<E> scrollIntoView(boolean alignWithTop)

Scrolls to first element of list

Specified by:

scrollIntoView in interface FluentJavascriptActions<E extends FluentWebElement>

Parameters:

alignWithTop - If true, the top of the element will be aligned to the top of the visible area of the scrollable ancestor. If false, the bottom of the element will be aligned to the bottom of the visible area of the scrollable ancestor.

Returns:

this object reference to chain methods calls

See Also:

element.scrollIntoView

modifyAttribute

public FluentList<E> modifyAttribute(java.lang.String attributeName,
                                     java.lang.String attributeValue)

Modifies attributes of first element only

Specified by:

modifyAttribute in interface FluentJavascriptActions<E extends FluentWebElement>

Parameters:

attributeName - attribute to be change

attributeValue - new attribute value

Returns:

this object reference to chain methods calls

scrollIntoView

public FluentList<E> scrollIntoView()

Scrolls to first element of list

Specified by:

scrollIntoView in interface FluentJavascriptActions<E extends FluentWebElement>

Returns:

this object reference to chain methods calls

See Also:

element.scrollIntoView