com.assertthat.selenium_shutterbug.core

Class PageSnapshot

java.lang.Object

com.assertthat.selenium_shutterbug.core.Snapshot

com.assertthat.selenium_shutterbug.core.PageSnapshot

public class PageSnapshot
extends Snapshot

Created by Glib_Briia on 17/06/2016.

Field Summary

Fields inherited from class com.assertthat.selenium_shutterbug.core.Snapshot

driver, ELEMENT_OUT_OF_VIEWPORT_EX_MESSAGE, image, thumbnailImage

Method Summary

Modifier and Type	Method and Description
PageSnapshot	blur() Blur the entire page.
PageSnapshot	blur(org.openqa.selenium.WebElement element) Blur provided element within the page only.
PageSnapshot	blurExcept(org.openqa.selenium.WebElement element) Blurs all the page except the element provided.
PageSnapshot	cropAround(org.openqa.selenium.WebElement element, int offsetX, int offsetY) Crop the image around specified element with offset.
PageSnapshot	highlight(org.openqa.selenium.WebElement element) Highlights WebElement within the page with Color.red and line width 3.
PageSnapshot	highlight(org.openqa.selenium.WebElement element, java.awt.Color color, int lineWidth) Highlights WebElement within the page with provided color and line width.
PageSnapshot	highlightWithText(org.openqa.selenium.WebElement element, java.awt.Color elementColor, int lineWidth, java.lang.String text, java.awt.Color textColor, java.awt.Font textFont) Highlight WebElement within the page, same as in highlight(WebElement) but providing ability to override default color, font values.
PageSnapshot	highlightWithText(org.openqa.selenium.WebElement element, java.lang.String text) Highlight WebElement within the page (same as in highlight(WebElement)} and adding provided text above highlighted element.
PageSnapshot	monochrome(org.openqa.selenium.WebElement element) Makes an element withing a page 'monochrome' - applies gray-and-white filter.
protected PageSnapshot	self()

Methods inherited from class com.assertthat.selenium_shutterbug.core.Snapshot

equals, equals, equals, equals, equalsWithDiff, equalsWithDiff, equalsWithDiff, equalsWithDiff, getImage, hashCode, monochrome, save, save, setImage, withName, withThumbnail, withThumbnail, withThumbnail, withTitle

Methods inherited from class java.lang.Object

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

Method Detail

highlight

public PageSnapshot highlight(org.openqa.selenium.WebElement element)

Highlights WebElement within the page with Color.red and line width 3.

Parameters:

element - WebElement to be highlighted

Returns:

instance of type PageSnapshot

highlight

public PageSnapshot highlight(org.openqa.selenium.WebElement element,
                              java.awt.Color color,
                              int lineWidth)

Highlights WebElement within the page with provided color and line width.

Parameters:

element - WebElement to be highlighted

color - color of the line

lineWidth - width of the line

Returns:

instance of type PageSnapshot

highlightWithText

public PageSnapshot highlightWithText(org.openqa.selenium.WebElement element,
                                      java.lang.String text)

Highlight WebElement within the page (same as in highlight(WebElement)} and adding provided text above highlighted element.

Parameters:

element - WebElement to be highlighted with Color.red and line width 3

text - test to be places above highlighted element with Color.red, font "Serif", BOLD, size 20

Returns:

instance of type PageSnapshot

highlightWithText

public PageSnapshot highlightWithText(org.openqa.selenium.WebElement element,
                                      java.awt.Color elementColor,
                                      int lineWidth,
                                      java.lang.String text,
                                      java.awt.Color textColor,
                                      java.awt.Font textFont)

Highlight WebElement within the page, same as in highlight(WebElement) but providing ability to override default color, font values.

Parameters:

element - WebElement to be highlighted

elementColor - element highlight color

lineWidth - line width around the element

text - text to be placed above the highlighted element

textColor - color of the text

textFont - text font

Returns:

instance of type PageSnapshot

blur

public PageSnapshot blur()

Blur the entire page.

Returns:

instance of type PageSnapshot

blur

public PageSnapshot blur(org.openqa.selenium.WebElement element)

Blur provided element within the page only.

Parameters:

element - WebElement to be blurred

Returns:

instance of type PageSnapshot

monochrome

public PageSnapshot monochrome(org.openqa.selenium.WebElement element)

Makes an element withing a page 'monochrome' - applies gray-and-white filter. Original colors remain on the rest of the page.

Parameters:

element - WebElement within the page to be made 'monochrome'

Returns:

instance of type PageSnapshot

blurExcept

public PageSnapshot blurExcept(org.openqa.selenium.WebElement element)

Blurs all the page except the element provided.

Parameters:

element - WebElement to stay not blurred

Returns:

instance of type PageSnapshot

cropAround

public PageSnapshot cropAround(org.openqa.selenium.WebElement element,
                               int offsetX,
                               int offsetY)

Crop the image around specified element with offset.

Parameters:

element - WebElement to crop around

offsetX - offsetX around element in px

offsetY - offsetY around element in px

Returns:

instance of type PageSnapshot

self

protected PageSnapshot self()

Specified by:

self in class Snapshot