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	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	shootPage(org.openqa.selenium.WebDriver driver) Make screen shot of the viewport only.
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, boolean useDevicePixelRatio) Make screen shot of the viewport only.
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, ScrollStrategy scroll) To be used when screen shooting the page and need to scroll while making screen shots, either vertically or horizontally or both directions (Chrome).
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, ScrollStrategy scroll, boolean useDevicePixelRatio) To be used when screen shooting the page and need to scroll while making screen shots, either vertically or horizontally or both directions (Chrome).
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, ScrollStrategy scroll, int betweenScrollTimeout) To be used when screen shooting the page and need to scroll while making screen shots, either vertically or horizontally or both directions (Chrome).
static PageSnapshot	shootPage(org.openqa.selenium.WebDriver driver, ScrollStrategy scroll, int betweenScrollTimeout, boolean useDevicePixelRatio) To be used when screen shooting the page and need to scroll while making screen shots, 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 screen shot of the viewport only. To be used when screen shooting the page and don't need to scroll while making screen shots (FF, IE).

Parameters:

driver - WebDriver instance

Returns:

PageSnapshot instance

shootPage

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

Make screen shot of the viewport only. To be used when screen shooting the page and don't need to scroll while making screen shots (FF, IE).

Parameters:

driver - WebDriver instance

useDevicePixelRatio - whether or not take into account device pixel ratio

Returns:

PageSnapshot instance

shootPage

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

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

Parameters:

driver - WebDriver instance

scroll - ScrollStrategy How you need to scroll

Returns:

PageSnapshot instance

shootPage

public static PageSnapshot shootPage(org.openqa.selenium.WebDriver driver,
                                     ScrollStrategy scroll,
                                     int betweenScrollTimeout)

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

Parameters:

driver - WebDriver instance

scroll - ScrollStrategy How you need to scroll

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,
                                     ScrollStrategy scroll,
                                     boolean useDevicePixelRatio)

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

Parameters:

driver - WebDriver instance

scroll - ScrollStrategy How you need to scroll

useDevicePixelRatio - whether or not take into account device pixel ratio

Returns:

PageSnapshot instance

shootPage

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

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

Parameters:

driver - WebDriver instance

scroll - ScrollStrategy How you need to scroll

betweenScrollTimeout - Timeout to wait between each scrolling operation

useDevicePixelRatio - whether or not take into account 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,
                                           boolean useDevicePixelRatio)

To be used when need to screenshot particular element.

Parameters:

driver - WebDriver instance

element - WebElement instance to be screen shot

useDevicePixelRatio - whether or not take into account 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 screen shot

useDevicePixelRatio - whether or not take into account device pixel ratio

Returns:

ElementSnapshot instance