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

Go to download
/*
 * Applitools SDK for Selenium integration.
 */
package com.applitools.eyes.selenium;

import com.applitools.eyes.Location;
import com.applitools.eyes.Logger;
import com.applitools.eyes.MouseAction;
import com.applitools.eyes.Region;
import com.applitools.utils.ArgumentGuard;
import org.openqa.selenium.interactions.TouchScreen;
import org.openqa.selenium.interactions.internal.Coordinates;


/**
 * A wrapper class for TouchScreen implementation. This class will record
 * certain events such as tap.
 */
public class EyesTouchScreen implements TouchScreen {

    private final Logger logger;
    private final EyesWebDriver driver;
    private final TouchScreen touch;

    public EyesTouchScreen(Logger logger, EyesWebDriver driver,
                           TouchScreen touch) {
        ArgumentGuard.notNull(logger, "logger");
        ArgumentGuard.notNull(driver, "driver");
        ArgumentGuard.notNull(touch, "touch");

        this.logger = logger;
        this.driver = driver;
        this.touch = touch;
    }

    /**
     * A tap action. From our point of view, it is the same as a click.
     * @param where Where to tap.
     */
    public void singleTap(Coordinates where) {
        // This is not a mistake - Appium only supports getPageLocation (and
        // the result is relative to the viewPort)
        Location location = EyesSeleniumUtils.getPageLocation(where);
        logger.verbose("tap(" + location + ")");

        driver.getEyes().addMouseTrigger(MouseAction.Click, Region.EMPTY,
                location);

        touch.singleTap(where);
    }

    public void down(int x, int y) {
        touch.down(x, y);
    }

    public void up(int x, int y) {
        touch.up(x, y);
    }

    public void move(int x, int y) {
        touch.move(x, y);
    }

    public void scroll(Coordinates where, int xOffset, int yOffset) {
        touch.scroll(where, xOffset, yOffset);
    }

    /**
     * Double tap action. We treat it the same as a double click.
     * @param where Where to double click.
     */
    public void doubleTap(Coordinates where) {
        // This is not a mistake - Appium only supports getPageLocation (and
        // the result is relative to the viewPort)
        Location location = EyesSeleniumUtils.getPageLocation(where);
        logger.verbose("tap(" + location + ")");

        driver.getEyes().addMouseTrigger(MouseAction.DoubleClick,
                Region.EMPTY, location);

        touch.doubleTap(where);
    }

    public void longPress(Coordinates where) {
        touch.longPress(where);
    }

    public void scroll(int xOffset, int yOffset) {
        touch.scroll(xOffset, yOffset);
    }

    public void flick(int xSpeed, int ySpeed) {
        touch.flick(xSpeed, ySpeed);
    }

    public void flick(Coordinates where, int xOffset, int yOffset, int speed) {
        touch.flick(where, xOffset, yOffset, speed);
    }
}