com.applitools.eyes.selenium.ContextBasedScaleProviderFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eyes-selenium-java5 Show documentation

Applitools Eyes SDK for Selenium Java WebDriver

There is a newer version: 5.73.0

package com.applitools.eyes.selenium;

import com.applitools.eyes.Logger;
import com.applitools.eyes.RectangleSize;
import com.applitools.eyes.ScaleProvider;
import com.applitools.eyes.ScaleProviderFactory;
import com.applitools.utils.PropertyHandler;

/**
 * Factory implementation for creating {@link ContextBasedScaleProvider} instances.
 */
public class ContextBasedScaleProviderFactory extends ScaleProviderFactory {

    private final RectangleSize topLevelContextEntireSize;
    private final RectangleSize viewportSize;
    private final double devicePixelRatio;
    private final boolean isMobileDevice;

    /**
     * @param topLevelContextEntireSize The total size of the top level
     *                                  context. E.g., for selenium this
     *                                  would be the document size of the top
     *                                  level frame.
     * @param viewportSize              The viewport size.
     * @param devicePixelRatio          The device pixel ratio of the
     *                                  platform on which the application is
     *                                  running.
     * @param isMobileDevice            is Mobile device
     * @param logger                    the logger.
     *
     * @param scaleProviderHandler      the scale provider handler.
     *
     */
    public ContextBasedScaleProviderFactory(Logger logger, RectangleSize topLevelContextEntireSize,
                                            RectangleSize viewportSize, double devicePixelRatio, boolean isMobileDevice,
                                            PropertyHandler scaleProviderHandler) {
        super(logger, scaleProviderHandler);
        this.topLevelContextEntireSize = topLevelContextEntireSize;
        this.viewportSize = viewportSize;
        this.devicePixelRatio = devicePixelRatio;
        this.isMobileDevice = isMobileDevice;
    }

    @Override
    protected ScaleProvider getScaleProviderImpl(int imageToScaleWidth) {
        ContextBasedScaleProvider scaleProvider = new ContextBasedScaleProvider(logger, topLevelContextEntireSize,
                viewportSize, devicePixelRatio, isMobileDevice);
        scaleProvider.updateScaleRatio(imageToScaleWidth);
        return scaleProvider;
    }
}