org.fluentlenium.core

Class FluentDriver

java.lang.Object

org.fluentlenium.core.FluentDriver

All Implemented Interfaces:

Configuration, ConfigurationMutator, ConfigurationProperties, InputControl, AlertControl, CapabilitiesControl, ComponentInstantiator, CssControl, EventsControl, FluentControl, FluentInjectControl, NavigationControl, JavascriptControl, SearchControl<FluentWebElement>, SeleniumDriverControl, SnapshotControl, AwaitControl

public class FluentDriver
extends java.lang.Object
implements FluentControl

Util Class which offers some shortcut to webdriver methods

Nested Class Summary

Nested classes/interfaces inherited from interface org.fluentlenium.configuration.ConfigurationProperties

ConfigurationProperties.DriverLifecycle, ConfigurationProperties.TriggerMode

Constructor Summary

Constructors

Constructor and Description
FluentDriver(org.openqa.selenium.WebDriver driver, Configuration configuration, FluentControl adapter) Wrap the driver into a Fluent driver.

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>	$(java.util.List<org.openqa.selenium.WebElement> rawElements) Wrap raw selenium elements into a list of elements.
FluentList<FluentWebElement>	$(SearchFilter... filters) Find list of elements with filters.
FluentList<FluentWebElement>	$(java.lang.String selector, SearchFilter... filters) Find list of elements with CSS selector and filters.
Alert	alert() Get an object to control the alert window.
FluentWait	await() wait for an asynchronous call
boolean	canTakeScreenShot() Check if underlying WebDriver can take screenshot.
org.openqa.selenium.Capabilities	capabilities() Get the actual capabilities of the underlying Selenium WebDriver.
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(java.lang.String selector, SearchFilter... filters) Find first element with CSS selector and filters.
FluentWebElement	el(org.openqa.selenium.WebElement rawElement) Wrap existing raw selenium element into an element.
EventsRegistry	events() Retrieves an event registry to register event listeners.
FluentJavascript	executeAsyncScript(java.lang.String script, java.lang.Object... args) Execute a script, asynchronously.
FluentJavascript	executeScript(java.lang.String script, java.lang.Object... args) Execute a script, synchronously.
FluentList<FluentWebElement>	find(org.openqa.selenium.By locator, SearchFilter... filters) Find list of elements with Selenium locator and filters.
FluentList<FluentWebElement>	find(java.util.List<org.openqa.selenium.WebElement> rawElements) Wrap raw selenium elements into a list of elements.
FluentList<FluentWebElement>	find(SearchFilter... filters) Find list of elements with filters.
FluentList<FluentWebElement>	find(java.lang.String selector, SearchFilter... filters) Find list of elements with CSS selector and filters.
org.openqa.selenium.Cookie	getCookie(java.lang.String name) return the corresponding cookie given a name
java.util.Set<org.openqa.selenium.Cookie>	getCookies() return the cookies as a set
org.openqa.selenium.WebDriver	getDriver() Get the actual underlying Selenium WebDriver.
<P extends FluentPage> P	goTo(P page) Open the page, using the url defined in the page
void	goTo(java.lang.String url) Open the url page
void	goToInNewTab(java.lang.String url) Open the url page in a new tab
KeyboardActions	keyboard() Execute keyboard actions
MouseActions	mouse() Execute mouse actions
java.lang.String	pageSource() Return the source of the page
void	quit() Quit the underlying web driver and release fluent driver resources.
void	releaseFluent() Release fluent driver resources.
void	switchTo() Switch to the default element
void	switchTo(FluentList<? extends FluentWebElement> elements) Switch to the first selected Element (if element is null or not an iframe, or haven't an id then switch to the default)
void	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)
void	switchToDefault() Switch to the default element
void	takeHtmlDump() Take a html dump of the browser DOM.
void	takeHtmlDump(java.lang.String fileName) Take a html dump of the browser DOM into a file given by the fileName param.
void	takeScreenshot() Take a snapshot of the browser.
void	takeScreenshot(java.lang.String fileName) Take a snapshot of the browser into a file given by the fileName param.
java.lang.String	url() Return the url of the page.
WindowAction	window() Exposes methods on browser window

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fluentlenium.core.css.CssControl

css

Methods inherited from interface org.fluentlenium.core.inject.FluentInjectControl

inject, injectComponent, newInstance

Methods inherited from interface org.fluentlenium.core.components.ComponentInstantiator

asComponentList, asComponentList, asComponentList, asComponentList, asComponentList, asComponentList, asFluentList, asFluentList, asFluentList, asFluentList, asFluentList, asFluentList, isComponentClass, isComponentListClass, newComponent, newComponentList, newComponentList, newComponentList, newComponentList, newComponentList, newComponentList, newFluent, newFluentList, newFluentList, newFluentList, newFluentList, newFluentList, newFluentList

Methods inherited from interface org.fluentlenium.configuration.ConfigurationProperties

getAwaitAtMost, getAwaitPollingEvery, getBaseUrl, getBrowserTimeout, getBrowserTimeoutRetries, getCapabilities, getConfigurationDefaults, getConfigurationFactory, getCustomProperty, getDeleteCookies, getDriverLifecycle, getEventsEnabled, getHtmlDumpMode, getHtmlDumpPath, getImplicitlyWait, getPageLoadTimeout, getRemoteUrl, getScreenshotMode, getScreenshotPath, getScriptTimeout, getWebDriver

Methods inherited from interface org.fluentlenium.configuration.ConfigurationMutator

setAwaitAtMost, setAwaitPollingEvery, setBaseUrl, setBrowserTimeout, setBrowserTimeoutRetries, setCapabilities, setConfigurationFactory, setCustomProperty, setDeleteCookies, setDriverLifecycle, setEventsEnabled, setHtmlDumpMode, setHtmlDumpPath, setImplicitlyWait, setPageLoadTimeout, setRemoteUrl, setScreenshotMode, setScreenshotPath, setScriptTimeout, setWebDriver

Constructor Detail

FluentDriver

public FluentDriver(org.openqa.selenium.WebDriver driver,
                    Configuration configuration,
                    FluentControl adapter)

Wrap the driver into a Fluent driver.

Parameters:

driver - underlying selenium driver

configuration - configuration

adapter - adapter fluent control interface

Method Detail

takeHtmlDump

public void takeHtmlDump()

Description copied from interface: SnapshotControl

Take a html dump of the browser DOM. By default the file will be a html named by the current timestamp.

Specified by:

takeHtmlDump in interface SnapshotControl

takeHtmlDump

public void takeHtmlDump(java.lang.String fileName)

Description copied from interface: SnapshotControl

Take a html dump of the browser DOM into a file given by the fileName param.

Specified by:

takeHtmlDump in interface SnapshotControl

Parameters:

fileName - file name for html dump

canTakeScreenShot

public boolean canTakeScreenShot()

Description copied from interface: SnapshotControl

Check if underlying WebDriver can take screenshot.

Specified by:

canTakeScreenShot in interface SnapshotControl

Returns:

true if screenshot can be taken, false otherwise

takeScreenshot

public void takeScreenshot()

Description copied from interface: SnapshotControl

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

Specified by:

takeScreenshot in interface SnapshotControl

takeScreenshot

public void takeScreenshot(java.lang.String fileName)

Description copied from interface: SnapshotControl

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

Specified by:

takeScreenshot in interface SnapshotControl

Parameters:

fileName - file name for screenshot

getDriver

public org.openqa.selenium.WebDriver getDriver()

Description copied from interface: SeleniumDriverControl

Get the actual underlying Selenium WebDriver.

To customize the WebDriver, you should configure ConfigurationProperties.getWebDriver() or override FluentAdapter.newWebDriver().

This method can't be override to customize the WebDriver.

Specified by:

getDriver in interface SeleniumDriverControl

Returns:

The actual underlying Selenium WebDriver

events

public EventsRegistry events()

Description copied from interface: EventsControl

Retrieves an event registry to register event listeners.

Specified by:

events in interface EventsControl

Returns:

the event registry.

mouse

public MouseActions mouse()

Description copied from interface: InputControl

Execute mouse actions

Specified by:

mouse in interface InputControl

Returns:

mouse actions object

keyboard

public KeyboardActions keyboard()

Description copied from interface: InputControl

Execute keyboard actions

Specified by:

keyboard in interface InputControl

Returns:

mouse keyboard object

window

public WindowAction window()

Description copied from interface: NavigationControl

Exposes methods on browser window

Specified by:

window in interface NavigationControl

Returns:

Window actions

await

public FluentWait await()

Description copied from interface: AwaitControl

wait for an asynchronous call

Specified by:

await in interface AwaitControl

Returns:

FluentWait element

getCookies

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

Description copied from interface: NavigationControl

return the cookies as a set

Specified by:

getCookies in interface NavigationControl

Returns:

set of cookies

getCookie

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

Description copied from interface: NavigationControl

return the corresponding cookie given a name

Specified by:

getCookie in interface NavigationControl

Parameters:

name - cookie name

Returns:

cookie selected by name

url

public java.lang.String url()

Description copied from interface: NavigationControl

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

Specified by:

url in interface NavigationControl

Returns:

current URL

pageSource

public java.lang.String pageSource()

Description copied from interface: NavigationControl

Return the source of the page

Specified by:

pageSource in interface NavigationControl

Returns:

source of the page under test

goTo

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

Description copied from interface: NavigationControl

Open the page, using the url defined in the page

Specified by:

goTo in interface NavigationControl

Type Parameters:

P - Type of FluentPage

Parameters:

page - page to open

Returns:

Opened page.

See Also:

FluentPage.getUrl()

goTo

public void goTo(java.lang.String url)

Description copied from interface: NavigationControl

Open the url page

Specified by:

goTo in interface NavigationControl

Parameters:

url - page URL to visit

goToInNewTab

public void goToInNewTab(java.lang.String url)

Description copied from interface: NavigationControl

Open the url page in a new tab

Specified by:

goToInNewTab in interface NavigationControl

Parameters:

url - the url of the page to

capabilities

public org.openqa.selenium.Capabilities capabilities()

Description copied from interface: CapabilitiesControl

Get the actual capabilities of the underlying Selenium WebDriver.

Specified by:

capabilities in interface CapabilitiesControl

Returns:

actual capabilities.

See Also:

HasCapabilities.getCapabilities()

executeScript

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

Description copied from interface: JavascriptControl

Execute a script, synchronously.

Specified by:

executeScript in interface JavascriptControl

Parameters:

script - script source to execute

args - script arguments

Returns:

an object wrapping the result

executeAsyncScript

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

Description copied from interface: JavascriptControl

Execute a script, asynchronously.

Specified by:

executeAsyncScript in interface JavascriptControl

Parameters:

script - script source to execute

args - script arguments

Returns:

an object wrapping the result

$

public FluentList<FluentWebElement> $(java.lang.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(java.lang.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(java.lang.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(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(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

find

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

Parameters:

rawElements - raw selenium elements

Returns:

list of element

$

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

Parameters:

rawElements - raw selenium elements

Returns:

list of element

el

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

Parameters:

rawElement - raw selenium element

Returns:

element

switchTo

public void switchTo(FluentList<? extends FluentWebElement> elements)

Description copied from interface: NavigationControl

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

Specified by:

switchTo in interface NavigationControl

Parameters:

elements - fluent web element

switchTo

public void switchTo(FluentWebElement element)

Description copied from interface: NavigationControl

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

Specified by:

switchTo in interface NavigationControl

Parameters:

element - fluent web element

switchTo

public void switchTo()

Description copied from interface: NavigationControl

Switch to the default element

Specified by:

switchTo in interface NavigationControl

switchToDefault

public void switchToDefault()

Description copied from interface: NavigationControl

Switch to the default element

Specified by:

switchToDefault in interface NavigationControl

alert

public Alert alert()

Description copied from interface: AlertControl

Get an object to control the alert window.

Specified by:

alert in interface AlertControl

Returns:

an alert object

quit

public void quit()

Quit the underlying web driver and release fluent driver resources.

releaseFluent

public void releaseFluent()

Release fluent driver resources.