org.finra.jtaf.ewd.utils

Class ScreenshotUtils

java.lang.Object

org.finra.jtaf.ewd.utils.ScreenshotUtils

public class ScreenshotUtils
extends Object

Utilities to take and compare screenshots of elements

Author:

Pulitand

Constructor Summary

Constructors

Constructor and Description
ScreenshotUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	isSimilarToScreenshot(IElement element, File controlPicture, File toSaveAs) Prereq: The page on which you are taking the screenshot is fully loaded Take a screenshot of the element identified by element and save the file as toSaveAs (Note that this file should be saved as a png).
static boolean	isSimilarToScreenshot(IElement element, File controlPicture, File toSaveAs, double threshold) Prereq: The page on which you are taking the screenshot is fully loaded Take a screenshot of the element identified by element and save the file as toSaveAs (Note that this file should be saved as a png).
static void	takeScreenshotOfElement(IElement element, File toSaveAs) You can use this method to take your control pictures.
static void	takeScreenshotOfPage(File toSaveAs) Take a screenshot of the browser content.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenshotUtils

public ScreenshotUtils()

Method Detail

takeScreenshotOfElement

public static void takeScreenshotOfElement(IElement element,
                                           File toSaveAs)
                                    throws IOException,
                                           WidgetException

You can use this method to take your control pictures. Note that the file should be a png.

Parameters:

element -

toSaveAs -

Throws:

IOException

WidgetException

takeScreenshotOfPage

public static void takeScreenshotOfPage(File toSaveAs)
                                 throws IOException

Take a screenshot of the browser content. Note that while using RemoteWebDriver sessions (ie: with Sauce Labs), the screenshot will be a full page of content--not only the visible content where the page is scrolled (as when using a non-RemoteWebDriver session).

Parameters:

toSaveAs - - name of the file to save the picture in (Note: must be PNG)

Throws:

IOException

isSimilarToScreenshot

public static boolean isSimilarToScreenshot(IElement element,
                                            File controlPicture,
                                            File toSaveAs,
                                            double threshold)
                                     throws IOException,
                                            WidgetException

Prereq: The page on which you are taking the screenshot is fully loaded Take a screenshot of the element identified by element and save the file as toSaveAs (Note that this file should be saved as a png). Test that the control picture, controlPicture, is both the same size as, and, has a similarity value greater than or equal to the threshold.

Parameters:

element - - the element to be tested

controlPicture - - the file of the picture that will serve as the control

toSaveAs - - for example, save the file at "testData/textFieldWidget/screenshot.png"

threshold - - you are asserting that the similarity between the two pictures is a double greater than or equal to this double (between 0.0 and 1.0)

Throws:

IOException

WidgetException

isSimilarToScreenshot

public static boolean isSimilarToScreenshot(IElement element,
                                            File controlPicture,
                                            File toSaveAs)
                                     throws IOException,
                                            WidgetException

Prereq: The page on which you are taking the screenshot is fully loaded Take a screenshot of the element identified by element and save the file as toSaveAs (Note that this file should be saved as a png). Test that the control picture, controlPicture, is both the same size as, and, has a similarity value greater than or equal to the default threshold of .85.

Parameters:

element - - the element to be tested

controlPicture - - the file of the picture that will serve as the control

toSaveAs - - for example, save the file at "testData/textFieldWidget/screenshot.png"

Throws:

IOException

WidgetException