org.fluentlenium.core

Class Fluent

java.lang.Object

org.fluentlenium.core.Fluent

All Implemented Interfaces:

SearchActions

Direct Known Subclasses:

FillConstructor, FillSelectConstructor, FluentAdapter, FluentJavascript, FluentPage

public abstract class Fluent
extends Object
implements SearchActions

Util Class which offers some shortcut to webdriver methods

Constructor Summary

Constructors

Constructor and Description
Fluent()
Fluent(org.openqa.selenium.WebDriver driver)

Method Summary

Modifier and Type	Method and Description
FluentList<FluentWebElement>	$(Filter... filters) Central methods to find elements on the page with filters.
FluentWebElement	$(Integer number, Filter... filters) Central method to find an element on the page with filters.
FluentList<FluentWebElement>	$(String name, Filter... filters) Central methods to find elements on the page.
FluentWebElement	$(String name, Integer number, Filter... filters) Central methods a find element on the page, the number indicate the index of the desired element on the list.
Alert	alert()
FluentWait	await() wait for an asynchronous call
void	cleanupDriver()
Fluent	clear(Filter... filters) Clear texts of the all elements filtered by the specified filters.
Fluent	clear(FluentList<FluentWebElement> fluentObject) Clear all elements that are in the list Be careful - only the visible elements are cleared
Fluent	clear(FluentWebElement fluentObject) Clear the given parameters elements that are in the list Be careful - only the visible elements are cleared
Fluent	clear(String cssSelector, Filter... filters) Submit all elements that are in cssSelector with its filters Be careful - only the visible elements are cleared
Fluent	click(Filter... filters) Click all elements filtered by the specified filters.
Fluent	click(FluentDefaultActions fluentObject) click all elements that are in the list Be careful - only the visible elements are clicked
Fluent	click(String cssSelector, Filter... filters) click all elements that are in cssSelector with its filters Be careful - only the visible elements are clicked
protected <T extends FluentPage> T	constructPageWithParams(Class<T> cls, Object[] params)
<T extends FluentPage> T	createPage(Class<T> classOfPage, Object... params)
FluentJavascript	executeAsyncScript(String script, Object... args)
FluentJavascript	executeScript(String script, Object... args)
FillConstructor	fill(Filter... filters) Construct a FillConstructor with filters in order to allow easy fill.
FillConstructor	fill(FluentDefaultActions list, Filter... filters) Construct a FillConstructor in order to allow easy fill Be careful - only the visible elements are filled
FillConstructor	fill(String cssSelector, Filter... filters) Construct a FillConstructor in order to allow easy fill Be careful - only the visible elements are filled
FillSelectConstructor	fillSelect(Filter... filters) Construct a FillSelectConstructor with filters in order to allow easy fill.
FillSelectConstructor	fillSelect(String cssSelector, Filter... filters) Construct a FillSelectConstructor in order to allow easy fill Be careful - only the visible elements are filled
FluentList<FluentWebElement>	find(Filter... filters) Return the list filtered by the specified filters.
FluentWebElement	find(Integer number, Filter... filters) Return the element at the number position in the list filtered by the specified filters.
FluentList<FluentWebElement>	find(String name, Filter... filters) return the lists corresponding to the cssSelector with it filters
FluentWebElement	find(String name, Integer number, Filter... filters) Return the elements at the number position into the lists corresponding to the cssSelector with it filters
FluentWebElement	findFirst(Filter... filters) Return the first element corresponding to the filters.
FluentWebElement	findFirst(String name, Filter... filters) Return the first element corresponding to the name and the filters
String	getBaseUrl() Get the base URL to use when visiting relative URLs, if one is configured
org.openqa.selenium.Cookie	getCookie(String name) return the corresponding cookie given a name
Set<org.openqa.selenium.Cookie>	getCookies() return the cookies as a set
org.openqa.selenium.WebDriver	getDriver()
Search	getSearch()
<P extends FluentPage> P	goTo(P page)
Fluent	goTo(String url) Open the url page
protected <T extends FluentPage> T	initClass(Class<T> cls, Object... params)
protected Fluent	initFluent(org.openqa.selenium.WebDriver driver)
protected void	initTest()
Fluent	maximizeWindow() Maximize browser window using webdriver
String	pageSource() Return the source of the page
void	quit()
Fluent	submit(Filter... filters) Submit all elements filtered by the specified filters.
Fluent	submit(FluentDefaultActions fluentObject) Submit all elements that are in the list Be careful - only the visible elements are submitted
Fluent	submit(String cssSelector, Filter... filters) Submit all elements that are in cssSelector with its filters Be careful - only the visible elements are submitted
Fluent	switchTo() Switch to the default element
Fluent	switchTo(FluentWebElement element) Switch to the selected Element (if element is null or not an iframe, or haven't an id then switch to the default)
Fluent	switchToDefault() Switch to the default element
Fluent	takeScreenShot() Take a snapshot of the browser.
Fluent	takeScreenShot(String fileName) Take a snapshot of the browser into a file given by the fileName param.
List<String>	text(Filter... filters) Get all texts of the elements filtered by the specified filters.
List<String>	text(String cssSelector, Filter... filters) get a list all elements that are in cssSelector with its filters Be careful - only the visible elements are submitted //TODO UTILITY ?
String	title() Return the title of the page
String	url() Return the url of the page.
List<String>	value(Filter... filters) Get all values of the elements filtered by the specified filters.
List<String>	value(String cssSelector, Filter... filters) Value all elements that are in cssSelector with its filters Be careful - only the visible elements are returned //TODO UTILITY ?
Fluent	withDefaultPageWait(long l, TimeUnit timeUnit) Define an implicit time to wait for a page to be loaded
Fluent	withDefaultSearchWait(long l, TimeUnit timeUnit) Define an implicit time to wait when searching an element
Fluent	withDefaultUrl(String baseUrl) Define the default url that will be used in the test and in the relative pages

Methods inherited from class java.lang.Object

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

Constructor Detail

Fluent

public Fluent(org.openqa.selenium.WebDriver driver)

Fluent

public Fluent()

Method Detail

withDefaultUrl

public Fluent withDefaultUrl(String baseUrl)

Define the default url that will be used in the test and in the relative pages

Parameters:

baseUrl - base URL

Returns:

Fluent element

withDefaultPageWait

public Fluent withDefaultPageWait(long l,
                                  TimeUnit timeUnit)

Define an implicit time to wait for a page to be loaded

Parameters:

l - timeout value

timeUnit - time unit for wait

Returns:

Fluent element

withDefaultSearchWait

public Fluent withDefaultSearchWait(long l,
                                    TimeUnit timeUnit)

Define an implicit time to wait when searching an element

Parameters:

l - timeout value

timeUnit - time unit for wait

Returns:

Fluent element

takeScreenShot

public Fluent takeScreenShot()

Take a snapshot of the browser. By default the file will be a png named by the current timestamp.

Returns:

fluent object

takeScreenShot

public Fluent takeScreenShot(String fileName)

Take a snapshot of the browser into a file given by the fileName param.

Parameters:

fileName - file name for screenshot

Returns:

fluent object

initFluent

protected Fluent initFluent(org.openqa.selenium.WebDriver driver)

getDriver

public org.openqa.selenium.WebDriver getDriver()

getSearch

public Search getSearch()

initTest

protected void initTest()

createPage

public <T extends FluentPage> T createPage(Class<T> classOfPage,
                                           Object... params)

initClass

protected <T extends FluentPage> T initClass(Class<T> cls,
                                             Object... params)

constructPageWithParams

protected <T extends FluentPage> T constructPageWithParams(Class<T> cls,
                                                           Object[] params)
                                                    throws NoSuchMethodException,
                                                           InstantiationException,
                                                           IllegalAccessException,
                                                           InvocationTargetException

Throws:

NoSuchMethodException

InstantiationException

IllegalAccessException

InvocationTargetException

getBaseUrl

public String getBaseUrl()

Get the base URL to use when visiting relative URLs, if one is configured

Returns:

The base URL, or null if none configured

await

public FluentWait await()

wait for an asynchronous call

Returns:

FluentWait element

title

public String title()

Return the title of the page

Returns:

browser window title

getCookies

public Set<org.openqa.selenium.Cookie> getCookies()

return the cookies as a set

Returns:

set of cookies

getCookie

public org.openqa.selenium.Cookie getCookie(String name)

return the corresponding cookie given a name

Parameters:

name - cookie name

Returns:

cookie selected by name

url

public String url()

Return the url of the page. If a base url is provided, the current url will be relative to that base url.

Returns:

current URL

pageSource

public String pageSource()

Return the source of the page

Returns:

source of the page under test

goTo

public <P extends FluentPage> P goTo(P page)

goTo

public Fluent goTo(String url)

Open the url page

Parameters:

url - page URL to visit

Returns:

fluent object

executeScript

public FluentJavascript executeScript(String script,
                                      Object... args)

executeAsyncScript

public FluentJavascript executeAsyncScript(String script,
                                           Object... args)

$

public FluentList<FluentWebElement> $(String name,
                                      Filter... filters)

Central methods to find elements on the page. Can provide some filters. Able to use css1, css2, css3, see WebDriver restrictions

Parameters:

name - item selector

filters - set of filters

Returns:

list of fluent elements

$

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

Central methods to find elements on the page with filters.

Parameters:

filters - set of filters in the current context

Returns:

list of fluent elements

$

public FluentWebElement $(String name,
                          Integer number,
                          Filter... filters)

Central methods a find element on the page, the number indicate the index of the desired element on the list. Can provide some filters. Able to use css1, css2, css3, see WebDriver restrictions

Parameters:

name - item selector

number - index of the desired element

filters - set of filters in the current context

Returns:

fluent web element

$

public FluentWebElement $(Integer number,
                          Filter... filters)

Central method to find an element on the page with filters. The number indicates the index of the desired element on the list.

Parameters:

number - index of element from obtained list

filters - set of filters in the current context

Returns:

fluent web element

find

public FluentList<FluentWebElement> find(String name,
                                         Filter... filters)

return the lists corresponding to the cssSelector with it filters

Specified by:

find in interface SearchActions

Parameters:

name - cssSelector

filters - set of filters in current context

Returns:

list of fluent web elements

find

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

Return the list filtered by the specified filters.

Specified by:

find in interface SearchActions

Parameters:

filters - set of filters in the current context

Returns:

list of fluent web elements

find

public FluentWebElement find(String name,
                             Integer number,
                             Filter... filters)

Return the elements at the number position into the lists corresponding to the cssSelector with it filters

Specified by:

find in interface SearchActions

Parameters:

name - cssSelector

number - index in the retrieved items list

filters - set of filters in the current context

Returns:

fluent web element

find

public FluentWebElement find(Integer number,
                             Filter... filters)

Return the element at the number position in the list filtered by the specified filters.

Specified by:

find in interface SearchActions

Parameters:

number - index in the retrieved items list

filters - set of filters in the current context

Returns:

fluent web element

findFirst

public FluentWebElement findFirst(String name,
                                  Filter... filters)

Return the first element corresponding to the name and the filters

Specified by:

findFirst in interface SearchActions

Parameters:

name - cssSelector

filters - set of filters in the current context

Returns:

fluent web element

findFirst

public FluentWebElement findFirst(Filter... filters)

Return the first element corresponding to the filters.

Specified by:

findFirst in interface SearchActions

Parameters:

filters - set of filters in the current context

Returns:

fluent web element

fill

public FillConstructor fill(String cssSelector,
                            Filter... filters)

Construct a FillConstructor in order to allow easy fill Be careful - only the visible elements are filled

Parameters:

cssSelector - cssSelector

filters - set of filters in the current context

Returns:

fill constructor

fill

public FillConstructor fill(Filter... filters)

Construct a FillConstructor with filters in order to allow easy fill. Be careful - only the visible elements are filled

Parameters:

filters - set of filters in the current context

Returns:

fill constructor

fill

public FillConstructor fill(FluentDefaultActions list,
                            Filter... filters)

Construct a FillConstructor in order to allow easy fill Be careful - only the visible elements are filled

Parameters:

list - FluentDefaultActions list

filters - set of filters in the current context

Returns:

fill constructor

fillSelect

public FillSelectConstructor fillSelect(String cssSelector,
                                        Filter... filters)

Construct a FillSelectConstructor in order to allow easy fill Be careful - only the visible elements are filled

Parameters:

cssSelector - cssSelector

filters - set of filters in the current context

Returns:

fill constructor

fillSelect

public FillSelectConstructor fillSelect(Filter... filters)

Construct a FillSelectConstructor with filters in order to allow easy fill. Be careful - only the visible elements are filled

Parameters:

filters - set of filters in the current context

Returns:

fill constructor

click

public Fluent click(String cssSelector,
                    Filter... filters)

click all elements that are in cssSelector with its filters Be careful - only the visible elements are clicked

Parameters:

cssSelector - cssSelector

filters - set of filters in the current context

Returns:

fluent object

click

public Fluent click(Filter... filters)

Click all elements filtered by the specified filters. Be careful - only the visible elements are clicked

Parameters:

filters - set of filters in the current context

Returns:

fluent object

clear

public Fluent clear(String cssSelector,
                    Filter... filters)

Submit all elements that are in cssSelector with its filters Be careful - only the visible elements are cleared

Parameters:

cssSelector - cssSelector

filters - set of filters in the current context

Returns:

fluent object

clear

public Fluent clear(Filter... filters)

Clear texts of the all elements filtered by the specified filters. Be careful - only the visible elements are cleared

Parameters:

filters - set of filters in the current context

Returns:

fluent object

submit

public Fluent submit(String cssSelector,
                     Filter... filters)

Submit all elements that are in cssSelector with its filters Be careful - only the visible elements are submitted

Parameters:

cssSelector - cssSelector

filters - set of filters in the current context

Returns:

fluent object

submit

public Fluent submit(Filter... filters)

Submit all elements filtered by the specified filters. Be careful - only the visible elements are submitted

Parameters:

filters - set of filters in the current context

Returns:

fluent object

text

public List<String> text(String cssSelector,
                         Filter... filters)

get a list all elements that are in cssSelector with its filters Be careful - only the visible elements are submitted //TODO UTILITY ? Deprecated ?

Parameters:

cssSelector - cssSelector

filters - set of filters in the current context

Returns:

list of strings

text

public List<String> text(Filter... filters)

Get all texts of the elements filtered by the specified filters. Be careful - only the visible elements are submitted //TODO UTILITY ? Deprecated ?

Parameters:

filters - set of filters in the current context

Returns:

list of strings

value

public List<String> value(String cssSelector,
                          Filter... filters)

Value all elements that are in cssSelector with its filters Be careful - only the visible elements are returned //TODO UTILITY ? Deprecated ?

Parameters:

cssSelector - cssSelector

filters - set of filters in the current context

Returns:

list of strings

value

public List<String> value(Filter... filters)

Get all values of the elements filtered by the specified filters. Be careful - only the visible elements are submitted //TODO UTILITY ? Deprecated ?

Parameters:

filters - set of filters in the current context

Returns:

list of strings

click

public Fluent click(FluentDefaultActions fluentObject)

click all elements that are in the list Be careful - only the visible elements are clicked

Parameters:

fluentObject - fluent object to click

Returns:

fluent object

clear

public Fluent clear(FluentList<FluentWebElement> fluentObject)

Clear all elements that are in the list Be careful - only the visible elements are cleared

Parameters:

fluentObject - list of fluent web elements to clear

Returns:

fluent object

clear

public Fluent clear(FluentWebElement fluentObject)

Clear the given parameters elements that are in the list Be careful - only the visible elements are cleared

Parameters:

fluentObject - fluent web element to clear

Returns:

fluent object

submit

public Fluent submit(FluentDefaultActions fluentObject)

Submit all elements that are in the list Be careful - only the visible elements are submitted

Parameters:

fluentObject - fluent default actions

Returns:

fluent object

switchTo

public Fluent switchTo(FluentWebElement element)

Switch to the selected Element (if element is null or not an iframe, or haven't an id then switch to the default)

Parameters:

element - fluent web element

Returns:

fluent object

switchTo

public Fluent switchTo()

Switch to the default element

Returns:

fluent object

switchToDefault

public Fluent switchToDefault()

Switch to the default element

Returns:

fluent object

alert

public Alert alert()

maximizeWindow

public Fluent maximizeWindow()

Maximize browser window using webdriver

Returns:

fluent object

quit

public void quit()

cleanupDriver

public void cleanupDriver()