[java] use convenience methods for scrolling

titusfortner · titusfortner · commit 5519babbacc3 · 2022-05-24T17:53:13.000-05:00
diff --git a/java/src/org/openqa/selenium/interactions/Actions.java b/java/src/org/openqa/selenium/interactions/Actions.java
@@ -272,19 +272,42 @@ public Actions release(WebElement target) {
   }
 
   /**
-   * Scrolls by the provided amount from a designated origination point.
-   * The scroll origin is either the center of an element or the upper left of the viewport plus offsets.
+   * If the element is outside the viewport, scrolls the bottom of the element to the bottom of the viewport.
+   *
+   * @param element Which element to scroll into the viewport.
+   * @return A self reference.
+   */
+  public Actions scrollToElement(WebElement element) {
+    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromElement(element);
+    return tick(getActiveWheel().createScroll(0, 0, 0, 0, Duration.ofMillis(250), scrollOrigin));
+  }
+
+  /**
+   * Scrolls by provided amounts with the origin in the top left corner of the viewport.
+   *
+   * @param deltaX The distance along X axis to scroll using the wheel. A negative value scrolls left.
+   * @param deltaY The distance along Y axis to scroll using the wheel. A negative value scrolls up.
+   * @return A self reference.
+   */
+  public Actions scrollByAmount(int deltaX, int deltaY) {
+    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromViewport();
+    return tick(getActiveWheel().createScroll(0, 0, deltaX, deltaY, Duration.ofMillis(250), scrollOrigin));
+  }
+
+  /**
+   * Scrolls by provided amount based on a provided origin.
+   * The scroll origin is either the center of an element or the upper left of the viewport plus any offsets.
    * If the origin is an element, and the element is not in the viewport, the bottom of the element will first
    *   be scrolled to the bottom of the viewport.
-   *
-   * @param x The horizontal offset from the origin from which to start the scroll.
-   * @param y The vertical offset from the origin from which to start the scroll.
+   * @param scrollOrigin Where scroll originates (viewport or element center) plus provided offsets.
    * @param deltaX The distance along X axis to scroll using the wheel. A negative value scrolls left.
    * @param deltaY The distance along Y axis to scroll using the wheel. A negative value scrolls up.
-   * @param scrollOrigin Where scroll originates, either the viewport or the center of an element.
    * @return A self reference.
+   * @throws MoveTargetOutOfBoundsException If the origin with offset is outside the viewport.
    */
-  public Actions scroll( int x, int y, int deltaX, int deltaY, WheelInput.ScrollOrigin scrollOrigin) {
+  public Actions scrollFromOrigin(WheelInput.ScrollOrigin scrollOrigin, int deltaX, int deltaY) {
+    int x = scrollOrigin.getxOffset();
+    int y = scrollOrigin.getyOffset();
     return tick(getActiveWheel().createScroll(x, y, deltaX, deltaY, Duration.ofMillis(250), scrollOrigin));
   }
 
diff --git a/java/src/org/openqa/selenium/interactions/WheelInput.java b/java/src/org/openqa/selenium/interactions/WheelInput.java
@@ -109,6 +109,8 @@ public Map<String, Object> encode() {
 
   public static final class ScrollOrigin {
     private final Object originObject;
+    private int xOffset = 0;
+    private int yOffset = 0;
 
     public Object asArg() {
       Object arg = originObject;
@@ -118,16 +120,38 @@ public Object asArg() {
       return arg;
     }
 
-    private ScrollOrigin(Object originObject) {
+    private ScrollOrigin(Object originObject, int xOffset, int yOffset) {
       this.originObject = originObject;
+      this.xOffset = xOffset;
+      this.yOffset = yOffset;
     }
 
     public static ScrollOrigin fromViewport() {
-      return new ScrollOrigin("viewport");
+      return new ScrollOrigin("viewport", 0, 0);
+    }
+
+    public static ScrollOrigin fromViewport(int xOffset, int yOffset) {
+      return new ScrollOrigin("viewport",
+        Require.nonNull("xOffset", xOffset),
+        Require.nonNull("yOffset", yOffset));
     }
 
     public static ScrollOrigin fromElement(WebElement element) {
-      return new ScrollOrigin(Require.nonNull("Element", element));
+      return new ScrollOrigin(Require.nonNull("Element", element), 0, 0);
+    }
+
+    public static ScrollOrigin fromElement(WebElement element, int xOffset, int yOffset) {
+      return new ScrollOrigin(Require.nonNull("Element", element),
+        Require.nonNull("xOffset", xOffset),
+        Require.nonNull("yOffset", yOffset));
+    }
+
+    public int getxOffset() {
+      return xOffset;
+    }
+
+    public int getyOffset() {
+      return yOffset;
     }
   }
 }
diff --git a/java/test/org/openqa/selenium/interactions/DefaultWheelTest.java b/java/test/org/openqa/selenium/interactions/DefaultWheelTest.java
@@ -43,8 +43,7 @@ public void shouldScrollToElement() {
 
     assertFalse(inViewport(iframe));
 
-    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromElement(iframe);
-    getBuilder(driver).scroll(0, 0, 0, 0, scrollOrigin).perform();
+    getBuilder(driver).scrollToElement(iframe).perform();
 
     assertTrue(inViewport(iframe));
   }
@@ -55,7 +54,7 @@ public void shouldScrollFromElementByGivenAmount() {
     WebElement iframe = driver.findElement(By.tagName("iframe"));
     WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromElement(iframe);
 
-    getBuilder(driver).scroll(0, 0, 0, 200, scrollOrigin).perform();
+    getBuilder(driver).scrollFromOrigin(scrollOrigin, 0, 200).perform();
 
     driver.switchTo().frame(iframe);
     WebElement checkbox = driver.findElement(By.name("scroll_checkbox"));
@@ -66,9 +65,9 @@ public void shouldScrollFromElementByGivenAmount() {
   public void shouldScrollFromElementByGivenAmountWithOffset() {
     driver.get(appServer.whereIs("scrolling_tests/frame_with_nested_scrolling_frame_out_of_view.html"));
     WebElement footer = driver.findElement(By.tagName("footer"));
-    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromElement(footer);
+    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromElement(footer, 0, -50);
 
-    getBuilder(driver).scroll(0, -50, 0, 200, scrollOrigin).perform();
+    getBuilder(driver).scrollFromOrigin(scrollOrigin,0, 200).perform();
 
     WebElement iframe = driver.findElement(By.tagName("iframe"));
     driver.switchTo().frame(iframe);
@@ -80,29 +79,28 @@ public void shouldScrollFromElementByGivenAmountWithOffset() {
   public void throwErrorWhenElementOriginIsOutOfViewport() {
     driver.get(appServer.whereIs("scrolling_tests/frame_with_nested_scrolling_frame_out_of_view.html"));
     WebElement footer = driver.findElement(By.tagName("footer"));
-    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromElement(footer);
+    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromElement(footer, 0, 50);
 
-    getBuilder(driver).scroll(0, 50, 0, 200, scrollOrigin).perform();
+    getBuilder(driver).scrollFromOrigin(scrollOrigin, 0, 200).perform();
   }
 
   @Test
   public void shouldScrollFromViewportByGivenAmount() {
     driver.get(appServer.whereIs("scrolling_tests/frame_with_nested_scrolling_frame_out_of_view.html"));
     WebElement footer = driver.findElement(By.tagName("footer"));
     int deltaY = footer.getRect().y;
-    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromViewport();
 
-    getBuilder(driver).scroll(0, 0, 0, deltaY, scrollOrigin).perform();
+    getBuilder(driver).scrollByAmount(0, deltaY).perform();
 
     assertTrue(inViewport(footer));
   }
 
   @Test
   public void shouldScrollFromViewportByGivenAmountFromOrigin() {
     driver.get(appServer.whereIs("scrolling_tests/frame_with_nested_scrolling_frame.html"));
-    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromViewport();
+    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromViewport(10, 10);
 
-    getBuilder(driver).scroll(10, 10, 0, 200, scrollOrigin).perform();
+    getBuilder(driver).scrollFromOrigin(scrollOrigin, 0, 200).perform();
 
     WebElement iframe = driver.findElement(By.tagName("iframe"));
     driver.switchTo().frame(iframe);
@@ -113,9 +111,9 @@ public void shouldScrollFromViewportByGivenAmountFromOrigin() {
   @Test(expected = MoveTargetOutOfBoundsException.class)
   public void throwErrorWhenOriginOffsetIsOutOfViewport() {
     driver.get(appServer.whereIs("scrolling_tests/frame_with_nested_scrolling_frame.html"));
-    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromViewport();
+    WheelInput.ScrollOrigin scrollOrigin = WheelInput.ScrollOrigin.fromViewport(-10, -10);
 
-    getBuilder(driver).scroll(-10, -10, 0, 200, scrollOrigin).perform();
+    getBuilder(driver).scrollFromOrigin(scrollOrigin, 0, 200).perform();
   }
 
   private boolean inViewport(WebElement element) {
