com.applitools.eyes.selenium.capture

Class FullPageCaptureAlgorithm

java.lang.Object

com.applitools.eyes.selenium.capture.FullPageCaptureAlgorithm

public class FullPageCaptureAlgorithm
extends Object

Constructor Summary

Constructors

Constructor and Description
FullPageCaptureAlgorithm(Logger logger, UserAgent userAgent)

Method Summary

Modifier and Type

Method and Description

BufferedImage

getStitchedRegion(ImageProvider imageProvider, Region region, PositionProvider originProvider, PositionProvider positionProvider, ScaleProviderFactory scaleProviderFactory, CutProvider cutProvider, int waitBeforeScreenshots, DebugScreenshotsProvider debugScreenshotsProvider, EyesScreenshotFactory screenshotFactory, int stitchingOverlap, RegionPositionCompensation regionPositionCompensation) Returns a stitching of a region.

Methods inherited from class java.lang.Object

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

Constructor Detail

FullPageCaptureAlgorithm

public FullPageCaptureAlgorithm(Logger logger,
                                UserAgent userAgent)

Method Detail

getStitchedRegion

public BufferedImage getStitchedRegion(ImageProvider imageProvider,
                                       Region region,
                                       PositionProvider originProvider,
                                       PositionProvider positionProvider,
                                       ScaleProviderFactory scaleProviderFactory,
                                       CutProvider cutProvider,
                                       int waitBeforeScreenshots,
                                       DebugScreenshotsProvider debugScreenshotsProvider,
                                       EyesScreenshotFactory screenshotFactory,
                                       int stitchingOverlap,
                                       RegionPositionCompensation regionPositionCompensation)

Returns a stitching of a region.

Parameters:

imageProvider - The provider for the screenshot.

region - The region to stitch. If Region.EMPTY, the entire image will be stitched.

originProvider - A provider for scrolling to initial position before starting the actual stitching.

positionProvider - A provider of the scrolling implementation.

scaleProviderFactory - A factory for getting the scale provider.

waitBeforeScreenshots - Time to wait before each screenshot (milliseconds).

screenshotFactory - The factory to use for creating screenshots from the images.

stitchingOverlap - The width of the overlapping parts when stitching an image.

regionPositionCompensation - A strategy for compensating region positions for some browsers.

Returns:

An image which represents the stitched region.