org.openqa.selenium.support.events

Class AbstractWebDriverEventListener

java.lang.Object

org.openqa.selenium.support.events.AbstractWebDriverEventListener

All Implemented Interfaces:

WebDriverEventListener

public abstract class AbstractWebDriverEventListener
extends java.lang.Object
implements WebDriverEventListener

Use this class as base class, if you want to implement a WebDriverEventListener and are only interested in some events. All methods provided by this class have an empty method body.

Constructor Summary

Constructors

Constructor and Description
AbstractWebDriverEventListener()

Method Summary

Modifier and Type	Method and Description
void	afterAlertAccept(org.openqa.selenium.WebDriver driver) This action will be performed each time after Alert.accept()
void	afterAlertDismiss(org.openqa.selenium.WebDriver driver) This action will be performed each time before Alert.dismiss()
void	afterChangeValueOf(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver, java.lang.CharSequence[] keysToSend) Called after WebElement.clear(), WebElement.sendKeys(...)}.
void	afterClickOn(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver) Called after WebElement.click().
void	afterFindBy(org.openqa.selenium.By by, org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver) Called after WebDriver.findElement(...), or WebDriver.findElements(...), or WebElement.findElement(...), or WebElement.findElements(...).
<X> void	afterGetScreenshotAs(org.openqa.selenium.OutputType<X> target, X screenshot) Called after TakesScreenshot.getScreenshotAs(OutputType) allows the implementation to determine which type of output was generated and to access the output itself
void	afterGetText(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver, java.lang.String text) Called right after WebElement.getText() method is being called
void	afterNavigateBack(org.openqa.selenium.WebDriver driver) Called after navigate().back().
void	afterNavigateForward(org.openqa.selenium.WebDriver driver) Called after navigate().forward().
void	afterNavigateRefresh(org.openqa.selenium.WebDriver driver) Called after navigate().refresh().
void	afterNavigateTo(java.lang.String url, org.openqa.selenium.WebDriver driver) Called after get(String url) respectively navigate().to(String url).
void	afterScript(java.lang.String script, org.openqa.selenium.WebDriver driver) Called after RemoteWebDriver.executeScript(java.lang.String, java.lang.Object[]).
void	afterSwitchToWindow(java.lang.String windowName, org.openqa.selenium.WebDriver driver) This action will be performed each time after WebDriver.TargetLocator.window(java.lang.String)
void	beforeAlertAccept(org.openqa.selenium.WebDriver driver) This action will be performed each time before Alert.accept()
void	beforeAlertDismiss(org.openqa.selenium.WebDriver driver) This action will be performed each time after Alert.dismiss()
void	beforeChangeValueOf(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver, java.lang.CharSequence[] keysToSend) Called before WebElement.clear(), WebElement.sendKeys(...).
void	beforeClickOn(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver) Called before WebElement.click().
void	beforeFindBy(org.openqa.selenium.By by, org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver) Called before WebDriver.findElement(...), or WebDriver.findElements(...), or WebElement.findElement(...), or WebElement.findElements(...).
<X> void	beforeGetScreenshotAs(org.openqa.selenium.OutputType<X> target) Called before TakesScreenshot.getScreenshotAs(OutputType) allows the implementation to determine which type of output will be generated
void	beforeGetText(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver) Called before WebElement.getText() method is being called
void	beforeNavigateBack(org.openqa.selenium.WebDriver driver) Called before navigate().back().
void	beforeNavigateForward(org.openqa.selenium.WebDriver driver) Called before navigate().forward().
void	beforeNavigateRefresh(org.openqa.selenium.WebDriver driver) Called before navigate().refresh().
void	beforeNavigateTo(java.lang.String url, org.openqa.selenium.WebDriver driver) Called before get(String url) respectively navigate().to(String url).
void	beforeScript(java.lang.String script, org.openqa.selenium.WebDriver driver) Called before RemoteWebDriver.executeScript(java.lang.String, java.lang.Object[])
void	beforeSwitchToWindow(java.lang.String windowName, org.openqa.selenium.WebDriver driver) This action will be performed each time before WebDriver.TargetLocator.window(java.lang.String)
void	onException(java.lang.Throwable throwable, org.openqa.selenium.WebDriver driver) Called whenever an exception would be thrown.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWebDriverEventListener

public AbstractWebDriverEventListener()

Method Detail

beforeAlertAccept

public void beforeAlertAccept(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

This action will be performed each time before Alert.accept()

Specified by:

beforeAlertAccept in interface WebDriverEventListener

Parameters:

driver - WebDriver

afterAlertAccept

public void afterAlertAccept(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

This action will be performed each time after Alert.accept()

Specified by:

afterAlertAccept in interface WebDriverEventListener

Parameters:

driver - WebDriver

afterAlertDismiss

public void afterAlertDismiss(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

This action will be performed each time before Alert.dismiss()

Specified by:

afterAlertDismiss in interface WebDriverEventListener

Parameters:

driver - WebDriver

beforeAlertDismiss

public void beforeAlertDismiss(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

This action will be performed each time after Alert.dismiss()

Specified by:

beforeAlertDismiss in interface WebDriverEventListener

Parameters:

driver - WebDriver

beforeNavigateTo

public void beforeNavigateTo(java.lang.String url,
                             org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called before get(String url) respectively navigate().to(String url).

Specified by:

beforeNavigateTo in interface WebDriverEventListener

Parameters:

url - URL

driver - WebDriver

afterNavigateTo

public void afterNavigateTo(java.lang.String url,
                            org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called after get(String url) respectively navigate().to(String url). Not called, if an exception is thrown.

Specified by:

afterNavigateTo in interface WebDriverEventListener

Parameters:

url - URL

driver - WebDriver

beforeNavigateBack

public void beforeNavigateBack(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called before navigate().back().

Specified by:

beforeNavigateBack in interface WebDriverEventListener

Parameters:

driver - WebDriver

afterNavigateBack

public void afterNavigateBack(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called after navigate().back(). Not called, if an exception is thrown.

Specified by:

afterNavigateBack in interface WebDriverEventListener

Parameters:

driver - WebDriver

beforeNavigateForward

public void beforeNavigateForward(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called before navigate().forward().

Specified by:

beforeNavigateForward in interface WebDriverEventListener

Parameters:

driver - WebDriver

afterNavigateForward

public void afterNavigateForward(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called after navigate().forward(). Not called, if an exception is thrown.

Specified by:

afterNavigateForward in interface WebDriverEventListener

Parameters:

driver - WebDriver

beforeNavigateRefresh

public void beforeNavigateRefresh(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called before navigate().refresh().

Specified by:

beforeNavigateRefresh in interface WebDriverEventListener

Parameters:

driver - WebDriver

afterNavigateRefresh

public void afterNavigateRefresh(org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called after navigate().refresh(). Not called, if an exception is thrown.

Specified by:

afterNavigateRefresh in interface WebDriverEventListener

Parameters:

driver - WebDriver

beforeFindBy

public void beforeFindBy(org.openqa.selenium.By by,
                         org.openqa.selenium.WebElement element,
                         org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called before WebDriver.findElement(...), or WebDriver.findElements(...), or WebElement.findElement(...), or WebElement.findElements(...).

Specified by:

beforeFindBy in interface WebDriverEventListener

Parameters:

by - locator being used

element - will be null, if a find method of WebDriver is called.

driver - WebDriver

afterFindBy

public void afterFindBy(org.openqa.selenium.By by,
                        org.openqa.selenium.WebElement element,
                        org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called after WebDriver.findElement(...), or WebDriver.findElements(...), or WebElement.findElement(...), or WebElement.findElements(...).

Specified by:

afterFindBy in interface WebDriverEventListener

Parameters:

by - locator being used

element - will be null, if a find method of WebDriver is called.

driver - WebDriver

beforeClickOn

public void beforeClickOn(org.openqa.selenium.WebElement element,
                          org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called before WebElement.click().

Specified by:

beforeClickOn in interface WebDriverEventListener

Parameters:

element - the WebElement being used for the action

driver - WebDriver

afterClickOn

public void afterClickOn(org.openqa.selenium.WebElement element,
                         org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called after WebElement.click(). Not called, if an exception is thrown.

Specified by:

afterClickOn in interface WebDriverEventListener

Parameters:

element - the WebElement being used for the action

driver - WebDriver

beforeChangeValueOf

public void beforeChangeValueOf(org.openqa.selenium.WebElement element,
                                org.openqa.selenium.WebDriver driver,
                                java.lang.CharSequence[] keysToSend)

Description copied from interface: WebDriverEventListener

Called before WebElement.clear(), WebElement.sendKeys(...).

Specified by:

beforeChangeValueOf in interface WebDriverEventListener

Parameters:

element - the WebElement being used for the action

driver - WebDriver

afterChangeValueOf

public void afterChangeValueOf(org.openqa.selenium.WebElement element,
                               org.openqa.selenium.WebDriver driver,
                               java.lang.CharSequence[] keysToSend)

Description copied from interface: WebDriverEventListener

Called after WebElement.clear(), WebElement.sendKeys(...)}. Not called, if an exception is thrown.

Specified by:

afterChangeValueOf in interface WebDriverEventListener

Parameters:

element - the WebElement being used for the action

driver - WebDriver

beforeScript

public void beforeScript(java.lang.String script,
                         org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called before RemoteWebDriver.executeScript(java.lang.String, java.lang.Object[])

Specified by:

beforeScript in interface WebDriverEventListener

Parameters:

script - the script to be executed

driver - WebDriver

afterScript

public void afterScript(java.lang.String script,
                        org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called after RemoteWebDriver.executeScript(java.lang.String, java.lang.Object[]). Not called if an exception is thrown

Specified by:

afterScript in interface WebDriverEventListener

Parameters:

script - the script that was executed

driver - WebDriver

afterSwitchToWindow

public void afterSwitchToWindow(java.lang.String windowName,
                                org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

This action will be performed each time after WebDriver.TargetLocator.window(java.lang.String)

Specified by:

afterSwitchToWindow in interface WebDriverEventListener

driver - WebDriver

beforeSwitchToWindow

public void beforeSwitchToWindow(java.lang.String windowName,
                                 org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

This action will be performed each time before WebDriver.TargetLocator.window(java.lang.String)

Specified by:

beforeSwitchToWindow in interface WebDriverEventListener

driver - WebDriver

onException

public void onException(java.lang.Throwable throwable,
                        org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called whenever an exception would be thrown.

Specified by:

onException in interface WebDriverEventListener

Parameters:

throwable - the exception that will be thrown

driver - WebDriver

beforeGetScreenshotAs

public <X> void beforeGetScreenshotAs(org.openqa.selenium.OutputType<X> target)

Description copied from interface: WebDriverEventListener

Called before TakesScreenshot.getScreenshotAs(OutputType) allows the implementation to determine which type of output will be generated

Specified by:

beforeGetScreenshotAs in interface WebDriverEventListener

Type Parameters:

X - Return type for getScreenshotAs.

Parameters:

target - target type, @see OutputType

afterGetScreenshotAs

public <X> void afterGetScreenshotAs(org.openqa.selenium.OutputType<X> target,
                                     X screenshot)

Description copied from interface: WebDriverEventListener

Called after TakesScreenshot.getScreenshotAs(OutputType) allows the implementation to determine which type of output was generated and to access the output itself

Specified by:

afterGetScreenshotAs in interface WebDriverEventListener

Type Parameters:

X - Return type for getScreenshotAs.

Parameters:

target - target type, @see OutputType

screenshot - screenshot output of the specified type

beforeGetText

public void beforeGetText(org.openqa.selenium.WebElement element,
                          org.openqa.selenium.WebDriver driver)

Description copied from interface: WebDriverEventListener

Called before WebElement.getText() method is being called

Specified by:

beforeGetText in interface WebDriverEventListener

Parameters:

element - - WebElement against which call is being made

driver - - instance of WebDriver

afterGetText

public void afterGetText(org.openqa.selenium.WebElement element,
                         org.openqa.selenium.WebDriver driver,
                         java.lang.String text)

Description copied from interface: WebDriverEventListener

Called right after WebElement.getText() method is being called

Specified by:

afterGetText in interface WebDriverEventListener

Parameters:

element - - WebElement against which call is being made

driver - - instance of WebDriver

text - - String object extracted from respective WebElement