Package org.openqa.selenium.support.events

Interface WebDriverEventListener

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method 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(String, Object...).
      void afterSwitchToWindow​(java.lang.String windowName, org.openqa.selenium.WebDriver driver)
      This action will be performed each time after WebDriver.TargetLocator.window(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(String, Object...)
      void beforeSwitchToWindow​(java.lang.String windowName, org.openqa.selenium.WebDriver driver)
      This action will be performed each time before WebDriver.TargetLocator.window(String)
      void onException​(java.lang.Throwable throwable, org.openqa.selenium.WebDriver driver)
      Called whenever an exception would be thrown.

    • Method Detail

      • beforeAlertAccept

        void beforeAlertAccept​(org.openqa.selenium.WebDriver driver)
        This action will be performed each time before Alert.accept()
        Parameters:
        driver - WebDriver

      • afterAlertAccept

        void afterAlertAccept​(org.openqa.selenium.WebDriver driver)
        This action will be performed each time after Alert.accept()
        Parameters:
        driver - WebDriver

      • afterAlertDismiss

        void afterAlertDismiss​(org.openqa.selenium.WebDriver driver)
        This action will be performed each time before Alert.dismiss()
        Parameters:
        driver - WebDriver

      • beforeAlertDismiss

        void beforeAlertDismiss​(org.openqa.selenium.WebDriver driver)
        This action will be performed each time after Alert.dismiss()
        Parameters:
        driver - WebDriver

      • beforeNavigateTo

        void beforeNavigateTo​(java.lang.String url,
                      org.openqa.selenium.WebDriver driver)
        Called before get(String url) respectively navigate().to(String url).
        Parameters:
        url - URL
        driver - WebDriver

      • afterNavigateTo

        void afterNavigateTo​(java.lang.String url,
                     org.openqa.selenium.WebDriver driver)
        Called after get(String url) respectively navigate().to(String url). Not called, if an exception is thrown.
        Parameters:
        url - URL
        driver - WebDriver

      • beforeNavigateBack

        void beforeNavigateBack​(org.openqa.selenium.WebDriver driver)
        Called before navigate().back().
        Parameters:
        driver - WebDriver

      • afterNavigateBack

        void afterNavigateBack​(org.openqa.selenium.WebDriver driver)
        Called after navigate().back(). Not called, if an exception is thrown.
        Parameters:
        driver - WebDriver

      • beforeNavigateForward

        void beforeNavigateForward​(org.openqa.selenium.WebDriver driver)
        Called before navigate().forward().
        Parameters:
        driver - WebDriver

      • afterNavigateForward

        void afterNavigateForward​(org.openqa.selenium.WebDriver driver)
        Called after navigate().forward(). Not called, if an exception is thrown.
        Parameters:
        driver - WebDriver

      • beforeNavigateRefresh

        void beforeNavigateRefresh​(org.openqa.selenium.WebDriver driver)
        Called before navigate().refresh().
        Parameters:
        driver - WebDriver

      • afterNavigateRefresh

        void afterNavigateRefresh​(org.openqa.selenium.WebDriver driver)
        Called after navigate().refresh(). Not called, if an exception is thrown.
        Parameters:
        driver - WebDriver

      • beforeFindBy

        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(...).
        Parameters:
        element - will be null, if a find method of WebDriver is called.
        by - locator being used
        driver - WebDriver

      • afterFindBy

        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(...).
        Parameters:
        element - will be null, if a find method of WebDriver is called.
        by - locator being used
        driver - WebDriver

      • beforeClickOn

        void beforeClickOn​(org.openqa.selenium.WebElement element,
                   org.openqa.selenium.WebDriver driver)
        Called before WebElement.click().
        Parameters:
        driver - WebDriver
        element - the WebElement being used for the action

      • afterClickOn

        void afterClickOn​(org.openqa.selenium.WebElement element,
                  org.openqa.selenium.WebDriver driver)
        Called after WebElement.click(). Not called, if an exception is thrown.
        Parameters:
        driver - WebDriver
        element - the WebElement being used for the action

      • beforeChangeValueOf

        void beforeChangeValueOf​(org.openqa.selenium.WebElement element,
                         org.openqa.selenium.WebDriver driver,
                         java.lang.CharSequence[] keysToSend)
        Called before WebElement.clear(), WebElement.sendKeys(...).
        Parameters:
        driver - WebDriver
        element - the WebElement being used for the action

      • afterChangeValueOf

        void afterChangeValueOf​(org.openqa.selenium.WebElement element,
                        org.openqa.selenium.WebDriver driver,
                        java.lang.CharSequence[] keysToSend)
        Called after WebElement.clear(), WebElement.sendKeys(...)}. Not called, if an exception is thrown.
        Parameters:
        driver - WebDriver
        element - the WebElement being used for the action

      • beforeScript

        void beforeScript​(java.lang.String script,
                  org.openqa.selenium.WebDriver driver)
        Called before RemoteWebDriver.executeScript(String, Object...)
        Parameters:
        driver - WebDriver
        script - the script to be executed

      • afterScript

        void afterScript​(java.lang.String script,
                 org.openqa.selenium.WebDriver driver)
        Called after RemoteWebDriver.executeScript(String, Object...). Not called if an exception is thrown
        Parameters:
        driver - WebDriver
        script - the script that was executed

      • beforeSwitchToWindow

        void beforeSwitchToWindow​(java.lang.String windowName,
                          org.openqa.selenium.WebDriver driver)
        This action will be performed each time before WebDriver.TargetLocator.window(String)
        Parameters:
        windowName - The name of the window or the handle as returned by WebDriver.getWindowHandle() or null if switching to a new window created by WebDriver.TargetLocator.newWindow(WindowType)
        driver - WebDriver

      • afterSwitchToWindow

        void afterSwitchToWindow​(java.lang.String windowName,
                         org.openqa.selenium.WebDriver driver)
        This action will be performed each time after WebDriver.TargetLocator.window(String)
        Parameters:
        windowName - The name of the window or the handle as returned by WebDriver.getWindowHandle() or null if switching to a new window created by WebDriver.TargetLocator.newWindow(WindowType)
        driver - WebDriver

      • onException

        void onException​(java.lang.Throwable throwable,
                 org.openqa.selenium.WebDriver driver)
        Called whenever an exception would be thrown.
        Parameters:
        driver - WebDriver
        throwable - the exception that will be thrown

      • beforeGetScreenshotAs

        <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
        Type Parameters:
        X - Return type for getScreenshotAs.
        Parameters:
        target - target type, @see OutputType

      • afterGetScreenshotAs

        <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
        Type Parameters:
        X - Return type for getScreenshotAs.
        Parameters:
        target - target type, @see OutputType
        screenshot - screenshot output of the specified type

      • beforeGetText

        void beforeGetText​(org.openqa.selenium.WebElement element,
                   org.openqa.selenium.WebDriver driver)
        Called before WebElement.getText() method is being called
        Parameters:
        element - - WebElement against which call is being made
        driver - - instance of WebDriver

      • afterGetText

        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
        Parameters:
        element - - WebElement against which call is being made
        driver - - instance of WebDriver
        text - - String object extracted from respective WebElement