org.openqa.selenium.safari

Class SafariDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.safari.SafariDriver

All Implemented Interfaces:

HasCapabilities, HasInputDevices, FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText, FindsByName, FindsByTagName, FindsByXPath, JavascriptExecutor, SearchContext, TakesScreenshot, WebDriver

public class SafariDriver
extends RemoteWebDriver

A WebDriver implementation that controls Safari using a browser extension (consequently, only Safari 5.1+ is supported). This driver can be configured using the SafariOptions class.

Nested Class Summary

Nested classes/interfaces inherited from class org.openqa.selenium.remote.RemoteWebDriver

RemoteWebDriver.RemoteTargetLocator, RemoteWebDriver.RemoteWebDriverOptions, RemoteWebDriver.When

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

WebDriver.ImeHandler, WebDriver.Navigation, WebDriver.Options, WebDriver.TargetLocator, WebDriver.Timeouts, WebDriver.Window

Constructor Summary

Constructors

Constructor and Description
SafariDriver() Initializes a new SafariDriver} class with default SafariOptions.
SafariDriver(Capabilities desiredCapabilities) Converts the specified DesiredCapabilities to a SafariOptions instance and initializes a new SafariDriver using these options.
SafariDriver(SafariOptions safariOptions) Initializes a new SafariDriver using the specified SafariOptions.

Method Summary

Modifier and Type	Method and Description
<X> X	getScreenshotAs(OutputType<X> target) Capture the screenshot and store it in the specified location.
void	setFileDetector(FileDetector detector) Set the file detector to be used when sending keyboard input.
protected void	startClient() Method called before starting a new session.
protected void	stopClient() Method called after executing a RemoteWebDriver.quit() command.

Methods inherited from class org.openqa.selenium.remote.RemoteWebDriver

close, execute, execute, executeAsyncScript, executeScript, findElement, findElement, findElementByClassName, findElementByCssSelector, findElementById, findElementByLinkText, findElementByName, findElementByPartialLinkText, findElementByTagName, findElementByXPath, findElements, findElements, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getExecuteMethod, getFileDetector, getKeyboard, getMouse, getPageSource, getSessionId, getTitle, getW3CStandardComplianceLevel, getWindowHandle, getWindowHandles, log, manage, navigate, quit, setCommandExecutor, setElementConverter, setErrorHandler, setFoundBy, setLogLevel, setSessionId, startSession, startSession, switchTo, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SafariDriver

public SafariDriver()

Initializes a new SafariDriver} class with default SafariOptions.

SafariDriver

public SafariDriver(Capabilities desiredCapabilities)

Converts the specified DesiredCapabilities to a SafariOptions instance and initializes a new SafariDriver using these options.

Parameters:

desiredCapabilities - capabilities requested of the driver

See Also:

SafariOptions.fromCapabilities(org.openqa.selenium.Capabilities)

SafariDriver

public SafariDriver(SafariOptions safariOptions)

Initializes a new SafariDriver using the specified SafariOptions.

Parameters:

safariOptions - safari specific options / capabilities for the driver

Method Detail

setFileDetector

public void setFileDetector(FileDetector detector)

Description copied from class: RemoteWebDriver

Set the file detector to be used when sending keyboard input. By default, this is set to a file detector that does nothing.

Overrides:

setFileDetector in class RemoteWebDriver

Parameters:

detector - The detector to use. Must not be null.

See Also:

FileDetector, LocalFileDetector, UselessFileDetector

startClient

protected void startClient()

Description copied from class: RemoteWebDriver

Method called before starting a new session. The default implementation is a no-op, but subtypes should override this method to define custom behavior.

Overrides:

startClient in class RemoteWebDriver

stopClient

protected void stopClient()

Description copied from class: RemoteWebDriver

Method called after executing a RemoteWebDriver.quit() command. Subtypes

Overrides:

stopClient in class RemoteWebDriver

getScreenshotAs

public <X> X getScreenshotAs(OutputType<X> target)
                      throws WebDriverException

Description copied from interface: TakesScreenshot

Capture the screenshot and store it in the specified location.

For WebDriver extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference:

• Entire page
• Current window
• Visible portion of the current frame
• The screenshot of the entire display containing the browser

For WebElement extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference: - The entire content of the HTML element - The visisble portion of the HTML element

Specified by:

getScreenshotAs in interface TakesScreenshot

Overrides:

getScreenshotAs in class RemoteWebDriver

Type Parameters:

X - Return type for getScreenshotAs.

Parameters:

target - target type, @see OutputType

Returns:

Object in which is stored information about the screenshot.

Throws:

WebDriverException - on failure.