Package com.codeborne.selenide

Class SelenideDriver

java.lang.Object

com.codeborne.selenide.SelenideDriver

public class SelenideDriver
extends Object

"Selenide driver" is a container for WebDriver + proxy server + settings

Constructor Summary

Constructors

Constructor	Description
SelenideDriver(Config config)
SelenideDriver(Config config, Driver driver)
SelenideDriver(Config config, Driver driver, ScreenShotLaboratory screenshots)
SelenideDriver(Config config, List<org.openqa.selenium.support.events.WebDriverListener> listeners)
SelenideDriver(Config config, List<org.openqa.selenium.support.events.WebDriverListener> listeners, ScreenShotLaboratory screenshots)
SelenideDriver(Config config, org.openqa.selenium.WebDriver webDriver, @Nullable SelenideProxyServer selenideProxy)
SelenideDriver(Config config, org.openqa.selenium.WebDriver webDriver, @Nullable SelenideProxyServer selenideProxy, DownloadsFolder browserDownloadsFolder)
SelenideDriver(Config config, org.openqa.selenium.WebDriver webDriver, @Nullable SelenideProxyServer selenideProxy, DownloadsFolder browserDownloadsFolder, ScreenShotLaboratory screenshots)
SelenideDriver(Config config, org.openqa.selenium.WebDriver webDriver, @Nullable SelenideProxyServer selenideProxy, ScreenShotLaboratory screenshots)

Method Summary

Modifier and Type	Method	Description
SelenideElement	$(String cssSelector)
SelenideElement	$(String cssSelector, int index)
SelenideElement	$(org.openqa.selenium.By seleniumSelector)
SelenideElement	$(org.openqa.selenium.By seleniumSelector, int index)
SelenideElement	$(org.openqa.selenium.WebElement webElement)
ElementsCollection	$$(String cssSelector)
ElementsCollection	$$(Collection<? extends org.openqa.selenium.WebElement> elements)
ElementsCollection	$$(org.openqa.selenium.By criteria)
ElementsCollection	$$x(String xpathExpression)
<ContainerClass extends Container> List<ContainerClass>	$$x(String xpathExpression, Class<ContainerClass> containerClass)
SelenideElement	$x(String xpathExpression)
<ContainerClass extends Container> ContainerClass	$x(String xpathExpression, Class<ContainerClass> containerClass)
boolean	atBottom()
void	back()
Browser	browser()
void	clearBrowserLocalStorage()	Deprecated. Use getLocalStorage().clear() instead
void	clearCookies()
BrowserClock	clock()
void	close()
Config	config()
<ContainerClass extends Container> ContainerClass	container(String cssSelector, int index, Class<ContainerClass> containerClass)
<ContainerClass extends Container> ContainerClass	container(String cssSelector, Class<ContainerClass> containerClass)
<ContainerClass extends Container> ContainerClass	container(org.openqa.selenium.By seleniumSelector, int index, Class<ContainerClass> containerClass)
<ContainerClass extends Container> ContainerClass	container(org.openqa.selenium.By seleniumSelector, Class<ContainerClass> containerClass)
<ContainerClass extends Container> ContainerClass	container(org.openqa.selenium.WebElement webElement, Class<ContainerClass> containerClass)
<ContainerClass extends Container> List<ContainerClass>	containers(String cssSelector, Class<ContainerClass> containerClass)
<ContainerClass extends Container> List<ContainerClass>	containers(Collection<? extends org.openqa.selenium.WebElement> elements, Class<ContainerClass> containerClass)
<ContainerClass extends Container> List<ContainerClass>	containers(org.openqa.selenium.By seleniumSelector, Class<ContainerClass> containerClass)
String	copy()	Copy selected text or empty string if no text is selected to clipboard.
File	download(String url)
File	download(String url, long timeoutMs)
File	download(URI url)
File	download(URI url, long timeoutMs)
Driver	driver()
void	emulateDevice(Device device)
<T> @Nullable T	executeAsyncJavaScript(String jsCode, Object... arguments)
<T> @Nullable T	executeJavaScript(String jsCode, Object... arguments)
SelenideElement	find(String cssSelector)
SelenideElement	find(org.openqa.selenium.By criteria)
SelenideElement	find(org.openqa.selenium.By criteria, int index)
ElementsCollection	findAll(String cssSelector)
ElementsCollection	findAll(org.openqa.selenium.By seleniumSelector)
void	forward()
org.openqa.selenium.WebDriver	getAndCheckWebDriver()
Clipboard	getClipboard()
CookieStore	getCookieStore()
String	getCurrentFrameUrl()
SelenideElement	getFocusedElement()
LocalStorage	getLocalStorage()
SelenideProxyServer	getProxy()
@Nullable SelenideElement	getSelectedRadio(org.openqa.selenium.By radioField)
String	getSelectedText()	Returns selected text or empty string if no text is selected.
org.openqa.selenium.remote.SessionId	getSessionId()
SessionStorage	getSessionStorage()
String	getUserAgent()
org.openqa.selenium.WebDriver	getWebDriver()
WebDriverLogs	getWebDriverLogs()
boolean	hasWebDriverStarted()
Modal	modal()
void	open()
void	open(String relativeOrAbsoluteUrl)
void	open(String relativeOrAbsoluteUrl, AuthenticationType authenticationType, Credentials credentials)
void	open(String relativeOrAbsoluteUrl, OpenOptions options)	Open the given page with given options, e.g.
<PageObjectClass> PageObjectClass	open(String relativeOrAbsoluteUrl, Class<PageObjectClass> pageObjectClassClass)
void	open(String relativeOrAbsoluteUrl, String domain, String login, String password)
<PageObjectClass> PageObjectClass	open(String relativeOrAbsoluteUrl, String domain, String login, String password, Class<PageObjectClass> pageObjectClassClass)
void	open(URL absoluteUrl)
<PageObjectClass> PageObjectClass	open(URL absoluteUrl, Class<PageObjectClass> pageObjectClassClass)
void	open(URL absoluteUrl, String domain, String login, String password)
<PageObjectClass> PageObjectClass	open(URL absoluteUrl, String domain, String login, String password, Class<PageObjectClass> pageObjectClassClass)
<PageObjectClass> PageObjectClass	page(Class<PageObjectClass> pageObjectClass)
final <PageObjectClass> PageObjectClass	page(PageObjectClass... reified)
<PageObjectClass, T extends PageObjectClass> PageObjectClass	page(T pageObject)
void	refresh()
void	resetEmulation()
@Nullable String	screenshot(String fileName)	Take a screenshot of the current page and save to file "fileName.png" (and optionally, "fileName.html")
<T> @Nullable T	screenshot(org.openqa.selenium.OutputType<T> outputType)	Take a screenshot of the current page
@Nullable String	source()
SelenideTargetLocator	switchTo()
@Nullable String	title()
void	updateHash(String hash)
String	url()
SelenideWait	Wait()
BrowserSession	webdriver()
void	zoom(double factor)

Methods inherited from class java.lang.Object

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

Constructor Details

SelenideDriver

public SelenideDriver(Config config)

SelenideDriver

public SelenideDriver(Config config,
 List<org.openqa.selenium.support.events.WebDriverListener> listeners)

SelenideDriver

public SelenideDriver(Config config,
 Driver driver)

SelenideDriver

public SelenideDriver(Config config,
 List<org.openqa.selenium.support.events.WebDriverListener> listeners,
 ScreenShotLaboratory screenshots)

SelenideDriver

public SelenideDriver(Config config,
 org.openqa.selenium.WebDriver webDriver,
 @Nullable SelenideProxyServer selenideProxy)

SelenideDriver

public SelenideDriver(Config config,
 org.openqa.selenium.WebDriver webDriver,
 @Nullable SelenideProxyServer selenideProxy,
 DownloadsFolder browserDownloadsFolder)

SelenideDriver

public SelenideDriver(Config config,
 org.openqa.selenium.WebDriver webDriver,
 @Nullable SelenideProxyServer selenideProxy,
 ScreenShotLaboratory screenshots)

SelenideDriver

public SelenideDriver(Config config,
 org.openqa.selenium.WebDriver webDriver,
 @Nullable SelenideProxyServer selenideProxy,
 DownloadsFolder browserDownloadsFolder,
 ScreenShotLaboratory screenshots)

SelenideDriver

public SelenideDriver(Config config,
 Driver driver,
 ScreenShotLaboratory screenshots)

Method Details

config

public Config config()

driver

public Driver driver()

open

public void open()

open

public void open(String relativeOrAbsoluteUrl)

open

public void open(URL absoluteUrl)

open

public void open(String relativeOrAbsoluteUrl,
 String domain,
 String login,
 String password)

open

public void open(String relativeOrAbsoluteUrl,
 AuthenticationType authenticationType,
 Credentials credentials)

open

public void open(URL absoluteUrl,
 String domain,
 String login,
 String password)

open

public void open(String relativeOrAbsoluteUrl,
 OpenOptions options)

Open the given page with given options, e.g. restore browser state (cookies, localStorage, sessionStorage) before.

If options contain OpenOptions.loggedInIf(java.util.function.BooleanSupplier) and OpenOptions.orLogin(java.lang.Runnable), also checks that user is logged in. If not (or the state file doesn't exist yet), logs in, saves the fresh state to the file and opens the page again.

 open("/dashboard", withBrowserState("build/auth.json")
   .loggedInIf(() -> $("#logout").is(visible, Duration.ofSeconds(2)))
   .orLogin(() -> login("bob", "secret")));
 

Parameters:

relativeOrAbsoluteUrl - page to open. Must belong to the same origin as the browser state.

Since:

7.19.0

open

public <PageObjectClass> PageObjectClass open(String relativeOrAbsoluteUrl,
 Class<PageObjectClass> pageObjectClassClass)

open

public <PageObjectClass> PageObjectClass open(URL absoluteUrl,
 Class<PageObjectClass> pageObjectClassClass)

open

public <PageObjectClass> PageObjectClass open(String relativeOrAbsoluteUrl,
 String domain,
 String login,
 String password,
 Class<PageObjectClass> pageObjectClassClass)

open

public <PageObjectClass> PageObjectClass open(URL absoluteUrl,
 String domain,
 String login,
 String password,
 Class<PageObjectClass> pageObjectClassClass)

page

public <PageObjectClass> PageObjectClass page(Class<PageObjectClass> pageObjectClass)

page

@SafeVarargs
public final <PageObjectClass> PageObjectClass page(PageObjectClass... reified)

Parameters:

reified - Don't pass any values here. It's Java Magic :)

page

public <PageObjectClass,
T extends PageObjectClass>
PageObjectClass page(T pageObject)

container

public <ContainerClass extends Container>
ContainerClass container(org.openqa.selenium.WebElement webElement,
 Class<ContainerClass> containerClass)

container

public <ContainerClass extends Container>
ContainerClass container(org.openqa.selenium.By seleniumSelector,
 Class<ContainerClass> containerClass)

container

public <ContainerClass extends Container>
ContainerClass container(org.openqa.selenium.By seleniumSelector,
 int index,
 Class<ContainerClass> containerClass)

container

public <ContainerClass extends Container>
ContainerClass container(String cssSelector,
 Class<ContainerClass> containerClass)

container

public <ContainerClass extends Container>
ContainerClass container(String cssSelector,
 int index,
 Class<ContainerClass> containerClass)

$x

public <ContainerClass extends Container>
ContainerClass $x(String xpathExpression,
 Class<ContainerClass> containerClass)

containers

public <ContainerClass extends Container>
List<ContainerClass> containers(Collection<? extends org.openqa.selenium.WebElement> elements,
 Class<ContainerClass> containerClass)

containers

public <ContainerClass extends Container>
List<ContainerClass> containers(org.openqa.selenium.By seleniumSelector,
 Class<ContainerClass> containerClass)

containers

public <ContainerClass extends Container>
List<ContainerClass> containers(String cssSelector,
 Class<ContainerClass> containerClass)

$$x

public <ContainerClass extends Container>
List<ContainerClass> $$x(String xpathExpression,
 Class<ContainerClass> containerClass)

refresh

public void refresh()

back

public void back()

forward

public void forward()

updateHash

public void updateHash(String hash)

browser

public Browser browser()

getProxy

public SelenideProxyServer getProxy()

hasWebDriverStarted

public boolean hasWebDriverStarted()

getWebDriver

public org.openqa.selenium.WebDriver getWebDriver()

getAndCheckWebDriver

@CanIgnoreReturnValue
public org.openqa.selenium.WebDriver getAndCheckWebDriver()

clearCookies

public void clearCookies()

close

public void close()

executeJavaScript

@CanIgnoreReturnValue
public <T> @Nullable T executeJavaScript(String jsCode,
 Object... arguments)

executeAsyncJavaScript

@CanIgnoreReturnValue
public <T> @Nullable T executeAsyncJavaScript(String jsCode,
 Object... arguments)

getFocusedElement

public SelenideElement getFocusedElement()

getSelectedText

public String getSelectedText()

Returns selected text or empty string if no text is selected.

Returns:

selected text

copy

@CanIgnoreReturnValue
public String copy()

Copy selected text or empty string if no text is selected to clipboard.

Returns:

the copied text

See Also:

• getClipboard()
• Clipboard

Wait

public SelenideWait Wait()

zoom

public void zoom(double factor)

title

public @Nullable String title()

$

public SelenideElement $(org.openqa.selenium.WebElement webElement)

$

public SelenideElement $(String cssSelector)

find

public SelenideElement find(String cssSelector)

$x

public SelenideElement $x(String xpathExpression)

$

public SelenideElement $(org.openqa.selenium.By seleniumSelector)

$

public SelenideElement $(org.openqa.selenium.By seleniumSelector,
 int index)

$

public SelenideElement $(String cssSelector,
 int index)

find

public SelenideElement find(org.openqa.selenium.By criteria)

find

public SelenideElement find(org.openqa.selenium.By criteria,
 int index)

$$

public ElementsCollection $$(Collection<? extends org.openqa.selenium.WebElement> elements)

$$

public ElementsCollection $$(String cssSelector)

$$x

public ElementsCollection $$x(String xpathExpression)

findAll

public ElementsCollection findAll(org.openqa.selenium.By seleniumSelector)

findAll

public ElementsCollection findAll(String cssSelector)

$$

public ElementsCollection $$(org.openqa.selenium.By criteria)

getSelectedRadio

public @Nullable SelenideElement getSelectedRadio(org.openqa.selenium.By radioField)

modal

public Modal modal()

getWebDriverLogs

public WebDriverLogs getWebDriverLogs()

clearBrowserLocalStorage

@Deprecated
public void clearBrowserLocalStorage()

Deprecated.

Use getLocalStorage().clear() instead

atBottom

public boolean atBottom()

switchTo

public SelenideTargetLocator switchTo()

url

public String url()

source

public @Nullable String source()

getCurrentFrameUrl

public String getCurrentFrameUrl()

getUserAgent

public String getUserAgent()

getSessionId

public org.openqa.selenium.remote.SessionId getSessionId()

screenshot

public @Nullable String screenshot(String fileName)

Take a screenshot of the current page and save to file "fileName.png" (and optionally, "fileName.html")

Parameters:

fileName - Name of file (without extension) to save PNG (and HTML) to

Returns:

URL of the screenshot taken, or null if failed to create screenshot

screenshot

public <T> @Nullable T screenshot(org.openqa.selenium.OutputType<T> outputType)

Take a screenshot of the current page

Returns:

The screenshot (as bytes, base64 or temporary file)

download

public File download(String url)
              throws URISyntaxException

Throws:

URISyntaxException

download

public File download(String url,
 long timeoutMs)
              throws URISyntaxException

Throws:

URISyntaxException

download

public File download(URI url)

download

public File download(URI url,
 long timeoutMs)

getLocalStorage

public LocalStorage getLocalStorage()

getSessionStorage

public SessionStorage getSessionStorage()

getCookieStore

public CookieStore getCookieStore()

getClipboard

public Clipboard getClipboard()

webdriver

public BrowserSession webdriver()

clock

public BrowserClock clock()

emulateDevice

public void emulateDevice(Device device)

resetEmulation

public void resetEmulation()