com.applitools.eyes.selenium

Class EyesSeleniumUtils

java.lang.Object

com.applitools.eyes.selenium.EyesSeleniumUtils

public class EyesSeleniumUtils
extends Object

We named this class EyesSeleniumUtils because there's a SeleniumUtils class, and it caused collision.

Constructor Summary

Constructors

Constructor and Description
EyesSeleniumUtils()

Method Summary

Modifier and Type	Method and Description
static RectangleSize	getCurrentFrameContentEntireSize(IEyesJsExecutor executor)
static Location	getCurrentScrollPosition(IEyesJsExecutor executor)
static Map<String,String>	getCurrentTransform(IEyesJsExecutor executor)
static float	getDevicePixelRatio(IEyesJsExecutor executor)
static Location	getPageLocation(org.openqa.selenium.interactions.internal.Coordinates coordinates) Extracts the location relative to the entire page from the coordinates (e.g.
static String	getPlatformVersion(org.openqa.selenium.HasCapabilities driver)
static org.openqa.selenium.WebDriver	getUnderlyingDriver(org.openqa.selenium.WebDriver driver) For EyesWebDriver instances, returns the underlying WebDriver.
static Location	getViewportLocation(org.openqa.selenium.interactions.internal.Coordinates coordinates) Extracts the location relative to the viewport from the coordinates (e.g.
static RectangleSize	getViewportSize(org.openqa.selenium.JavascriptExecutor executor)
static RectangleSize	getViewportSizeOrDisplaySize(Logger logger, org.openqa.selenium.WebDriver driver)
static String	hideScrollbars(org.openqa.selenium.JavascriptExecutor executor, int stabilizationTimeout) Hides the scrollbars of the current context's document element.
static boolean	isAndroid(org.openqa.selenium.WebDriver driver)
static boolean	isIOS(org.openqa.selenium.WebDriver driver)
static boolean	isLandscapeOrientation(org.openqa.selenium.WebDriver driver)
static boolean	isMobileDevice(org.openqa.selenium.WebDriver driver)
static boolean	setBrowserSize(Logger logger, org.openqa.selenium.WebDriver driver, RectangleSize requiredSize)
static boolean	setBrowserSizeByViewportSize(Logger logger, org.openqa.selenium.WebDriver driver, RectangleSize actualViewportSize, RectangleSize requiredViewportSize)
static void	setCurrentScrollPosition(IEyesJsExecutor executor, Location location) Sets the scroll position of the current frame.
static String	setOverflow(org.openqa.selenium.JavascriptExecutor executor, String value) Sets the overflow of the current context's body.
static void	setTransform(IEyesJsExecutor executor, String transform) Set the given transform to document.documentElement for all style keys defined in JS_TRANSFORM_KEYS .
static void	setTransforms(IEyesJsExecutor executor, Map<String,String> transforms) Sets transforms for document.documentElement according to the given map of style keys and values.
static void	setViewportSize(Logger logger, org.openqa.selenium.WebDriver driver, RectangleSize size)
static void	translateTo(IEyesJsExecutor executor, Location position) Translates the current documentElement to the given position.

Methods inherited from class java.lang.Object

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

Constructor Detail

EyesSeleniumUtils

public EyesSeleniumUtils()

Method Detail

getPageLocation

public static Location getPageLocation(org.openqa.selenium.interactions.internal.Coordinates coordinates)

Extracts the location relative to the entire page from the coordinates (e.g. as opposed to viewport)

Parameters:

coordinates - The coordinates from which location is extracted.

Returns:

The location relative to the entire page

getViewportLocation

public static Location getViewportLocation(org.openqa.selenium.interactions.internal.Coordinates coordinates)

Extracts the location relative to the viewport from the coordinates (e.g. as opposed to the entire page).

Parameters:

coordinates - The coordinates from which location is extracted.

Returns:

The location relative to the viewport.

getUnderlyingDriver

public static org.openqa.selenium.WebDriver getUnderlyingDriver(org.openqa.selenium.WebDriver driver)

For EyesWebDriver instances, returns the underlying WebDriver. For all other types - return the driver received as parameter.

Parameters:

driver - The driver instance for which to get the underlying WebDriver.

Returns:

The underlying WebDriver

isMobileDevice

public static boolean isMobileDevice(org.openqa.selenium.WebDriver driver)

Parameters:

driver - The driver for which to check if it represents a mobile device.

Returns:

true if the platform running the test is a mobile platform. false otherwise.

isLandscapeOrientation

public static boolean isLandscapeOrientation(org.openqa.selenium.WebDriver driver)

Parameters:

driver - The driver for which to check the orientation.

Returns:

true if this is a mobile device and is in landscape orientation. false otherwise.

setOverflow

public static String setOverflow(org.openqa.selenium.JavascriptExecutor executor,
                                 String value)

Sets the overflow of the current context's body.

Parameters:

executor - The executor to use for setting the overflow.

value - The overflow value to set.

Returns:

The previous overflow value (could be null if undefined).

hideScrollbars

public static String hideScrollbars(org.openqa.selenium.JavascriptExecutor executor,
                                    int stabilizationTimeout)

Hides the scrollbars of the current context's document element.

Parameters:

executor - The executor to use for hiding the scrollbars.

stabilizationTimeout - The amount of time to wait for the "hide scrollbars" action to take effect (Milliseconds). Zero/negative values are ignored.

Returns:

The previous value of the overflow property (could be null).

getCurrentScrollPosition

public static Location getCurrentScrollPosition(IEyesJsExecutor executor)

Parameters:

executor - The executor to use.

Returns:

The current scroll position of the current frame.

setCurrentScrollPosition

public static void setCurrentScrollPosition(IEyesJsExecutor executor,
                                            Location location)

Sets the scroll position of the current frame.

Parameters:

executor - The executor to use.

location - The position to be set.

getCurrentFrameContentEntireSize

public static RectangleSize getCurrentFrameContentEntireSize(IEyesJsExecutor executor)

Parameters:

executor - The executor to use.

Returns:

The size of the entire content.

getViewportSize

public static RectangleSize getViewportSize(org.openqa.selenium.JavascriptExecutor executor)

Parameters:

executor - The executor to use.

Returns:

The viewport size.

getViewportSizeOrDisplaySize

public static RectangleSize getViewportSizeOrDisplaySize(Logger logger,
                                                         org.openqa.selenium.WebDriver driver)

Parameters:

logger - The logger to use.

driver - The web driver to use.

Returns:

The viewport size of the current context, or the display size if the viewport size cannot be retrieved.

setBrowserSize

public static boolean setBrowserSize(Logger logger,
                                     org.openqa.selenium.WebDriver driver,
                                     RectangleSize requiredSize)

setBrowserSizeByViewportSize

public static boolean setBrowserSizeByViewportSize(Logger logger,
                                                   org.openqa.selenium.WebDriver driver,
                                                   RectangleSize actualViewportSize,
                                                   RectangleSize requiredViewportSize)

setViewportSize

public static void setViewportSize(Logger logger,
                                   org.openqa.selenium.WebDriver driver,
                                   RectangleSize size)

Parameters:

logger - The logger to use.

driver - The web driver to use.

size - The size to set as the viewport size.

isAndroid

public static boolean isAndroid(org.openqa.selenium.WebDriver driver)

Parameters:

driver - The driver to test.

Returns:

true if the driver is an Android driver. false otherwise.

isIOS

public static boolean isIOS(org.openqa.selenium.WebDriver driver)

Parameters:

driver - The driver to test.

Returns:

true if the driver is an iOS driver. false otherwise.

getPlatformVersion

public static String getPlatformVersion(org.openqa.selenium.HasCapabilities driver)

Parameters:

driver - The driver to get the platform version from.

Returns:

The platform version or null if it is undefined.

getDevicePixelRatio

public static float getDevicePixelRatio(IEyesJsExecutor executor)

Parameters:

executor - The executor to use.

Returns:

The device pixel ratio.

getCurrentTransform

public static Map<String,String> getCurrentTransform(IEyesJsExecutor executor)

Parameters:

executor - The executor to use.

Returns:

The current documentElement transform values, according to JS_TRANSFORM_KEYS.

setTransforms

public static void setTransforms(IEyesJsExecutor executor,
                                 Map<String,String> transforms)

Sets transforms for document.documentElement according to the given map of style keys and values.

Parameters:

executor - The executor to use.

transforms - The transforms to set. Keys are used as style keys, and values are the values for those styles.

setTransform

public static void setTransform(IEyesJsExecutor executor,
                                String transform)

Set the given transform to document.documentElement for all style keys defined in JS_TRANSFORM_KEYS .

Parameters:

executor - The executor to use.

transform - The transform value to set.

translateTo

public static void translateTo(IEyesJsExecutor executor,
                               Location position)

Translates the current documentElement to the given position.

Parameters:

executor - The executor to use.

position - The position to translate to.