com.assertthat.selenium_shutterbug.core

Class Shutterbug

java.lang.Object

com.assertthat.selenium_shutterbug.core.Shutterbug

public class Shutterbug
extends Object

Created by Glib_Briia on 26/06/2016.

Method Summary

Modifier and Type	Method and Description
static ElementSnapshot	shootElement(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element) To be used when need to screenshot particular element.
static ElementSnapshot	shootElement(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element, boolean useDevicePixelRatio) To be used when need to screenshot particular element.
static ElementSnapshot	shootElement(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element, Capture capture) To be used when need to screenshot particular element.
static ElementSnapshot	shootElement(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element, Capture capture, boolean useDevicePixelRatio) To be used when need to screenshot particular element.
static ElementSnapshot	shootElementVerticallyCentered(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element) To be used when need to screenshot particular element by vertically centering it in viewport.
static ElementSnapshot	shootElementVerticallyCentered(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element, boolean useDevicePixelRatio) To be used when need to screenshot particular element by vertically centering it within viewport.
static PageSnapshot	shootFrame(org.openqa.selenium.WebDriver driver, String frameId) To be used when screenshotting the frame Takes full frame screenshot be default
static PageSnapshot	shootFrame(org.openqa.selenium.WebDriver driver, String frameId, Capture capture) To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.
static PageSnapshot	shootFrame(org.openqa.selenium.WebDriver driver, String frameId, Capture capture, boolean useDevicePixelRatio) To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.
static PageSnapshot	shootFrame(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement frame, Capture capture) To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.
static PageSnapshot	shootFrame(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement frame, Capture capture, boolean useDevicePixelRatio) To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.
static PageSnapshot	shootFrame(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement frame, Capture capture, int betweenScrollTimeout, boolean useDevicePixelRatio) To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver) Make screenshot of the viewport only.
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, boolean useDevicePixelRatio) Make screenshot of the viewport only.
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, Capture capture) To be used when screenshotting the page and need to scroll while making screenshots, either vertically or horizontally or both directions.
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, Capture capture, boolean useDevicePixelRatio) To be used when screenshotting the page and need to scroll while making screenshots, either vertically or horizontally or both directions.
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, Capture capture, int betweenScrollTimeout) To be used when screenshotting the page and need to scroll while making screenshots, either vertically or horizontally or both directions.
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, Capture capture, int betweenScrollTimeout, boolean useDevicePixelRatio) To be used when screenshotting the page and need to scroll while making screenshots, either vertically or horizontally or both directions (Chrome).
static Shutterbug	wait(org.openqa.selenium.support.ui.ExpectedCondition<?> cond, int timeout) Wait for condition to be true before taking screenshot
static Shutterbug	wait(int timeout) Wait for before taking screenshot

Methods inherited from class java.lang.Object

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

Method Detail

shootPage

public static PageSnapshot shootPage(org.openqa.selenium.WebDriver driver)

Make screenshot of the viewport only. To be used when screenshotting the page and don't need to scroll while making screenshots.

Parameters:

driver - WebDriver instance

Returns:

PageSnapshot instance

shootPage

public static PageSnapshot shootPage(org.openqa.selenium.WebDriver driver,
                                     boolean useDevicePixelRatio)

Make screenshot of the viewport only. To be used when screenshotting the page and don't need to scroll while making screenshots.

Parameters:

driver - WebDriver instance

useDevicePixelRatio - whether to account for device pixel ratio

Returns:

PageSnapshot instance

shootPage

public static PageSnapshot shootPage(org.openqa.selenium.WebDriver driver,
                                     Capture capture)

To be used when screenshotting the page and need to scroll while making screenshots, either vertically or horizontally or both directions.

Parameters:

driver - WebDriver instance

capture - Capture type

Returns:

PageSnapshot instance

shootPage

public static PageSnapshot shootPage(org.openqa.selenium.WebDriver driver,
                                     Capture capture,
                                     int betweenScrollTimeout)

To be used when screenshotting the page and need to scroll while making screenshots, either vertically or horizontally or both directions.

Parameters:

driver - WebDriver instance

capture - Capture type

betweenScrollTimeout - Timeout to wait after scrolling and before taking screenshot

Returns:

PageSnapshot instance

wait

public static Shutterbug wait(org.openqa.selenium.support.ui.ExpectedCondition<?> cond,
                              int timeout)

Wait for condition to be true before taking screenshot

Parameters:

cond - condition

timeout - timeout wait for condition

Returns:

Shutterbug

wait

public static Shutterbug wait(int timeout)

Wait for before taking screenshot

Parameters:

timeout - timeout wait for condition

Returns:

Shutterbug

shootPage

public static PageSnapshot shootPage(org.openqa.selenium.WebDriver driver,
                                     Capture capture,
                                     boolean useDevicePixelRatio)

To be used when screenshotting the page and need to scroll while making screenshots, either vertically or horizontally or both directions.

Parameters:

driver - WebDriver instance

capture - Capture type

useDevicePixelRatio - whether to account for device pixel ratio

Returns:

PageSnapshot instance

shootPage

public static PageSnapshot shootPage(org.openqa.selenium.WebDriver driver,
                                     Capture capture,
                                     int betweenScrollTimeout,
                                     boolean useDevicePixelRatio)

To be used when screenshotting the page and need to scroll while making screenshots, either vertically or horizontally or both directions (Chrome).

Parameters:

driver - WebDriver instance

capture - Capture type

betweenScrollTimeout - Timeout to wait between each scrolling operation

useDevicePixelRatio - whether to account for device pixel ratio

Returns:

PageSnapshot instance

shootElementVerticallyCentered

public static ElementSnapshot shootElementVerticallyCentered(org.openqa.selenium.WebDriver driver,
                                                             org.openqa.selenium.WebElement element)

To be used when need to screenshot particular element by vertically centering it in viewport.

Parameters:

driver - WebDriver instance

element - WebElement instance to be screenshotted

Returns:

ElementSnapshot instance

shootElement

public static ElementSnapshot shootElement(org.openqa.selenium.WebDriver driver,
                                           org.openqa.selenium.WebElement element)

To be used when need to screenshot particular element.

Parameters:

driver - WebDriver instance

element - WebElement instance to be screenshotted

Returns:

ElementSnapshot instance

shootElement

public static ElementSnapshot shootElement(org.openqa.selenium.WebDriver driver,
                                           org.openqa.selenium.WebElement element,
                                           Capture capture)

To be used when need to screenshot particular element.

Parameters:

driver - WebDriver instance

element - WebElement instance to be screenshotted

Returns:

ElementSnapshot instance

shootElement

public static ElementSnapshot shootElement(org.openqa.selenium.WebDriver driver,
                                           org.openqa.selenium.WebElement element,
                                           boolean useDevicePixelRatio)

To be used when need to screenshot particular element. Doesn't account for scrollable elements.

Parameters:

driver - WebDriver instance

element - WebElement instance to be screenshot

useDevicePixelRatio - whether to account for device pixel ratio

Returns:

ElementSnapshot instance

shootElement

public static ElementSnapshot shootElement(org.openqa.selenium.WebDriver driver,
                                           org.openqa.selenium.WebElement element,
                                           Capture capture,
                                           boolean useDevicePixelRatio)

To be used when need to screenshot particular element. Can take screenshots of scrollable elements if Capture type is supplied.

Parameters:

driver - WebDriver instance

element - WebElement instance to be screenshot

capture - Capture type

useDevicePixelRatio - whether to account for device pixel ratio

Returns:

ElementSnapshot instance

shootElementVerticallyCentered

public static ElementSnapshot shootElementVerticallyCentered(org.openqa.selenium.WebDriver driver,
                                                             org.openqa.selenium.WebElement element,
                                                             boolean useDevicePixelRatio)

To be used when need to screenshot particular element by vertically centering it within viewport.

Parameters:

driver - WebDriver instance

element - WebElement instance to be screenshot

useDevicePixelRatio - whether to account for device pixel ratio

Returns:

ElementSnapshot instance

shootFrame

public static PageSnapshot shootFrame(org.openqa.selenium.WebDriver driver,
                                      String frameId,
                                      Capture capture,
                                      boolean useDevicePixelRatio)

To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.

Parameters:

driver - WebDriver instance

capture - Capture type

useDevicePixelRatio - whether to account for device pixel ratio

Returns:

PageSnapshot instance

shootFrame

public static PageSnapshot shootFrame(org.openqa.selenium.WebDriver driver,
                                      org.openqa.selenium.WebElement frame,
                                      Capture capture,
                                      boolean useDevicePixelRatio)

To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.

Parameters:

driver - WebDriver instance

capture - Capture type

useDevicePixelRatio - whether to account for device pixel ratio

Returns:

PageSnapshot instance

shootFrame

public static PageSnapshot shootFrame(org.openqa.selenium.WebDriver driver,
                                      org.openqa.selenium.WebElement frame,
                                      Capture capture)

To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.

Parameters:

driver - WebDriver instance

capture - Capture type

Returns:

PageSnapshot instance

shootFrame

public static PageSnapshot shootFrame(org.openqa.selenium.WebDriver driver,
                                      org.openqa.selenium.WebElement frame,
                                      Capture capture,
                                      int betweenScrollTimeout,
                                      boolean useDevicePixelRatio)

To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.

Parameters:

driver - WebDriver instance

frame - Frame WebElement

capture - Capture type

betweenScrollTimeout - Timeout to wait between each scrolling operation

useDevicePixelRatio - whether to account for device pixel ratio

Returns:

PageSnapshot instance

shootFrame

public static PageSnapshot shootFrame(org.openqa.selenium.WebDriver driver,
                                      String frameId,
                                      Capture capture)

To be used when screenshotting the frame and need to scroll while making screenshots, either vertically or horizontally or both directions.

Parameters:

driver - WebDriver instance

frameId - Id of the frame element

capture - Capture type

Returns:

PageSnapshot instance

shootFrame

public static PageSnapshot shootFrame(org.openqa.selenium.WebDriver driver,
                                      String frameId)

To be used when screenshotting the frame Takes full frame screenshot be default

Parameters:

driver - WebDriver instance

frameId - Id of the frame element

Returns:

PageSnapshot instance