org.fluentlenium.core.domain

Class FluentWebElement

java.lang.Object

org.fluentlenium.core.domain.Component

org.fluentlenium.core.domain.FluentWebElement

All Implemented Interfaces:

FluentActions<FluentWebElement,FluentWebElement>, FluentJavascriptActions, HookControl<FluentWebElement>, FluentLabel<FluentWebElement>, FluentProxyState<FluentWebElement>, SearchControl<FluentWebElement>, org.openqa.selenium.internal.WrapsElement

public class FluentWebElement
extends Component
implements org.openqa.selenium.internal.WrapsElement, FluentActions<FluentWebElement,FluentWebElement>, FluentProxyState<FluentWebElement>, SearchControl<FluentWebElement>, HookControl<FluentWebElement>, FluentLabel<FluentWebElement>

Wraps a Selenium WebElement. It provides an enhanced API to control selenium element.

Field Summary

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

control, instantiator, webElement

Constructor Summary

Constructors

Constructor and Description
FluentWebElement(org.openqa.selenium.WebElement element, FluentControl control, ComponentInstantiator instantiator) Creates a new fluent web element.

Method Summary

Modifier and Type	Method and Description
FluentList<FluentWebElement>	$(org.openqa.selenium.By locator, SearchFilter... filters) Find list of elements with Selenium locator and filters.
FluentList<FluentWebElement>	$(SearchFilter... filters) Find list of elements with filters.
FluentList<FluentWebElement>	$(String selector, SearchFilter... filters) Find list of elements with CSS selector and filters.
<T> T	as(Class<T> componentClass) Wrap all underlying elements in a componen..
FluentList<FluentWebElement>	asList() Converts this element as a single element list.
String	attribute(String name) return any value of custom attribute (generated=true will return "true" if attribute("generated") is called.
FluentWaitElement	await() Build a wait object to wait for a condition of this element.
Axes	axes() XPath Axes accessor (parent, ancestors, preceding, following, ...).
FluentWebElement	clear() Clear the element
FluentWebElement	click() Perform a click.
boolean	clickable() Check that this element is visible and enabled such that you can click it.
FluentConditions	conditions() Get a conditions object used to verify condition on this element.
FluentWebElement	contextClick() Perform a context click.
boolean	displayed() return true if the element is displayed, other way return false
FluentWebElement	doubleClick() Perform a double click.
FluentWebElement	el(org.openqa.selenium.By locator, SearchFilter... filters) Find first element with Selenium locator and filters.
FluentWebElement	el(SearchFilter... filters) Find first element with filters.
FluentWebElement	el(String selector, SearchFilter... filters) Find first element with CSS selector and filters.
boolean	enabled() return true if the element is enabled, other way return false
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<FluentWebElement>	find(org.openqa.selenium.By locator, SearchFilter... filters) Find list of elements with Selenium locator and filters.
FluentList<FluentWebElement>	find(SearchFilter... filters) Find list of elements with filters.
FluentList<FluentWebElement>	find(String selector, SearchFilter... filters) Find list of elements with CSS selector and filters.
FluentWebElement	frame() Select a frame using this element.
org.openqa.selenium.WebElement	getElement() return the webElement
org.openqa.selenium.WebElement	getWrappedElement()
String	html() Get the HTML of a the element
String	id() return the id of the elements
KeyboardElementActions	keyboard() Execute keyboard actions on the element
boolean	loaded() Check if the element is loaded.
MouseElementActions	mouse() Execute mouse actions on the element
String	name() return the name of the element
FluentWebElement	now() Search for the element now, actually performing the search on the WebDriver.
FluentWebElement	now(boolean force) Search for the element now, actually performing the search on the WebDriver.
com.google.common.base.Optional<FluentWebElement>	optional() Builds an optional.
boolean	present() Check if the element is present in the DOM.
FluentWebElement	reset() Reset the element.
boolean	selected() return true if the element is selected, other way false
org.openqa.selenium.Dimension	size() return the size of the element
boolean	stale() Check that this element is no longer attached to the DOM.
FluentWebElement	submit() Submit the element
String	tagName() return the tag name
String	text() return the visible text of the element
String	textContent() return the text content of the element (even invisible through textContent attribute)
String	toString()
String	value() return the value of the elements
FluentWebElement	write(String... text) Set the text element

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fluentlenium.core.action.FluentJavascriptActions

scrollIntoView, scrollIntoView, scrollToElement

Methods inherited from interface org.fluentlenium.core.hook.HookControl

noHook, noHook, noHook, noHook, noHookInstance, noHookInstance, restoreHooks, withHook, withHook

Methods inherited from interface org.fluentlenium.core.label.FluentLabel

withLabel, withLabelHint

Constructor Detail

FluentWebElement

public FluentWebElement(org.openqa.selenium.WebElement element,
                        FluentControl control,
                        ComponentInstantiator instantiator)

Creates a new fluent web element.

Parameters:

element - underlying element

control - controle interface

instantiator - component instantiator

Method Detail

click

public FluentWebElement click()

Description copied from interface: FluentActions

Perform a click.

Specified by:

click in interface FluentActions<FluentWebElement,FluentWebElement>

Returns:

this object reference to chain methods calls

See Also:

WebElement.click()

doubleClick

public FluentWebElement doubleClick()

Description copied from interface: FluentActions

Perform a double click.

Specified by:

doubleClick in interface FluentActions<FluentWebElement,FluentWebElement>

Returns:

this object reference to chain methods calls

contextClick

public FluentWebElement contextClick()

Description copied from interface: FluentActions

Perform a context click.

Specified by:

contextClick in interface FluentActions<FluentWebElement,FluentWebElement>

Returns:

this object reference to chain methods calls

present

public boolean present()

Description copied from interface: FluentProxyState

Check if the element is present in the DOM.

Specified by:

present in interface FluentProxyState<FluentWebElement>

Returns:

true if the element is present, false otherwise

now

public FluentWebElement 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<FluentWebElement>

Returns:

this object reference to chain calls.

now

public FluentWebElement 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<FluentWebElement>

Parameters:

force - force the search even if element is already loaded

Returns:

this object reference to chain calls.

reset

public FluentWebElement 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<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<FluentWebElement>

Returns:

true if the element is loaded, false otherwise

axes

public Axes axes()

XPath Axes accessor (parent, ancestors, preceding, following, ...).

Returns:

object to perform XPath Axes transformations.

conditions

public FluentConditions conditions()

Get a conditions object used to verify condition on this element.

Returns:

conditions object

await

public FluentWaitElement await()

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

Returns:

a wait object

mouse

public MouseElementActions mouse()

Execute mouse actions on the element

Returns:

mouse actions object

keyboard

public KeyboardElementActions keyboard()

Execute keyboard actions on the element

Returns:

keyboard actions object

as

public <T> T as(Class<T> componentClass)

Wrap all underlying elements in a componen..

Type Parameters:

T - type of component

Parameters:

componentClass - component class

Returns:

element as component.

clear

public FluentWebElement clear()

Clear the element

Returns:

fluent web element

submit

public FluentWebElement submit()

Submit the element

Specified by:

submit in interface FluentActions<FluentWebElement,FluentWebElement>

Returns:

fluent web element

See Also:

WebElement.submit()

write

public FluentWebElement write(String... text)

Set the text element

Specified by:

write in interface FluentActions<FluentWebElement,FluentWebElement>

Parameters:

text - value to set

Returns:

fluent web element

See Also:

WebElement.sendKeys(CharSequence...)

name

public String name()

return the name of the element

Returns:

name of the element

attribute

public String attribute(String name)

return any value of custom attribute (generated=true will return "true" if attribute("generated") is called.

Parameters:

name - custom attribute name

Returns:

name value

id

public String id()

return the id of the elements

Returns:

id of element

text

public String text()

return the visible text of the element

Returns:

text of element

textContent

public String textContent()

return the text content of the element (even invisible through textContent attribute)

Returns:

text content of element

value

public String value()

return the value of the elements

Returns:

value of attribute

displayed

public boolean displayed()

return true if the element is displayed, other way return false

Returns:

boolean value of displayed check

enabled

public boolean enabled()

return true if the element is enabled, other way return false

Returns:

boolean value of enabled check

selected

public boolean selected()

return true if the element is selected, other way false

Returns:

boolean value of selected check

clickable

public boolean clickable()

Check that this element is visible and enabled such that you can click it.

Returns:

true if the element can be clicked, false otherwise.

stale

public boolean stale()

Check that this element is no longer attached to the DOM.

Returns:

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

tagName

public String tagName()

return the tag name

Returns:

string value of tag name

getElement

public org.openqa.selenium.WebElement getElement()

return the webElement

Returns:

web element

getWrappedElement

public org.openqa.selenium.WebElement getWrappedElement()

Specified by:

getWrappedElement in interface org.openqa.selenium.internal.WrapsElement

size

public org.openqa.selenium.Dimension size()

return the size of the element

Returns:

dimension/size of element

asList

public FluentList<FluentWebElement> asList()

Converts this element as a single element list.

Returns:

list of element

$

public FluentList<FluentWebElement> $(String selector,
                                      SearchFilter... filters)

Description copied from interface: SearchControl

Find list of elements with CSS selector and filters.

Specified by:

$ in interface SearchControl<FluentWebElement>

Parameters:

selector - CSS selector

filters - set of filters

Returns:

list of element

el

public FluentWebElement el(String selector,
                           SearchFilter... filters)

Description copied from interface: SearchControl

Find first element with CSS selector and filters.

Specified by:

el in interface SearchControl<FluentWebElement>

Parameters:

selector - CSS selector

filters - set of filters

Returns:

element

$

public FluentList<FluentWebElement> $(SearchFilter... filters)

Description copied from interface: SearchControl

Find list of elements with filters.

Specified by:

$ in interface SearchControl<FluentWebElement>

Parameters:

filters - set of filters in the current context

Returns:

list of elements

el

public FluentWebElement el(SearchFilter... filters)

Description copied from interface: SearchControl

Find first element with filters.

Specified by:

el in interface SearchControl<FluentWebElement>

Parameters:

filters - set of filters in the current context

Returns:

element

$

public FluentList<FluentWebElement> $(org.openqa.selenium.By locator,
                                      SearchFilter... filters)

Description copied from interface: SearchControl

Find list of elements with Selenium locator and filters.

Specified by:

$ in interface SearchControl<FluentWebElement>

Parameters:

locator - elements locator

filters - filters set

Returns:

list of elements

el

public FluentWebElement el(org.openqa.selenium.By locator,
                           SearchFilter... filters)

Description copied from interface: SearchControl

Find first element with Selenium locator and filters.

Specified by:

el in interface SearchControl<FluentWebElement>

Parameters:

locator - elements locator

filters - filters set

Returns:

element

find

public FluentList<FluentWebElement> 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<FluentWebElement>

Parameters:

locator - elements locator

filters - filters set

Returns:

list of elements

find

public FluentList<FluentWebElement> find(String selector,
                                         SearchFilter... filters)

Description copied from interface: SearchControl

Find list of elements with CSS selector and filters.

Specified by:

find in interface SearchControl<FluentWebElement>

Parameters:

selector - CSS selector

filters - set of filters

Returns:

list of element

find

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

Description copied from interface: SearchControl

Find list of elements with filters.

Specified by:

find in interface SearchControl<FluentWebElement>

Parameters:

filters - set of filters in the current context

Returns:

list of elements

html

public String html()

Get the HTML of a the element

Returns:

the underlying html content

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<FluentWebElement,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<FluentWebElement,FluentWebElement>

Returns:

Fill select builder

frame

public FluentWebElement frame()

Description copied from interface: FluentActions

Select a frame using this element.

Specified by:

frame in interface FluentActions<FluentWebElement,FluentWebElement>

Returns:

this object reference to chain methods calls.

optional

public com.google.common.base.Optional<FluentWebElement> 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<FluentWebElement>

Returns:

An optional wrapping this.

See Also:

FluentProxyState.present(), FluentProxyState.now()

toString

public String toString()

Overrides:

toString in class Object