Added method for scrolling the window until a certain element is displayed

Author: slu-it

webtester-core/src/main/java/info/novatec/testit/webtester/browser/operations/JavaScript.java

@@ -55,7 +55,7 @@ public Browser execute(String script, PageFragment fragment, Object... parameter
      * @see JavascriptExecutor#executeScript(String, Object...)
      * @since 2.0
      */
-    public Object executeWithReturn(String script, PageFragment fragment, Object... parameters) {
+    public <T> T executeWithReturn(String script, PageFragment fragment, Object... parameters) {
         Object[] parameterArray = new Object[parameters.length + 1];
         parameterArray[0] = fragment.webElement();
         System.arraycopy(parameters, 0, parameterArray, 1, parameters.length);
@@ -87,12 +87,12 @@ public Browser execute(String script, Object... parameters) {
      * @see JavascriptExecutor#executeScript(String, Object...)
      * @since 2.0
      */
-    public Object executeWithReturn(String script, Object... parameters) {
+    public <T> T executeWithReturn(String script, Object... parameters) {
         if (!(webDriver() instanceof JavascriptExecutor)) {
             throw new UnsupportedOperationException("WebDriver does not support JavaScript execution!");
         }
         JavascriptExecutor javascriptExecutor = ( JavascriptExecutor ) webDriver();
-        return javascriptExecutor.executeScript(script, parameters);
+        return (T) javascriptExecutor.executeScript(script, parameters);
     }
 
 }

webtester-core/src/main/java/info/novatec/testit/webtester/browser/operations/Window.java

@@ -16,6 +16,7 @@
 import info.novatec.testit.webtester.events.browser.SetWindowPositionEvent;
 import info.novatec.testit.webtester.events.browser.SetWindowSizeEvent;
 import info.novatec.testit.webtester.internal.ActionTemplate;
+import info.novatec.testit.webtester.pagefragments.PageFragment;
 
 
 /**
@@ -142,6 +143,23 @@ public Browser setSize(int width, int height) {
         return browser();
     }
 
+    /**
+     * Scrolls the window to the given {@link PageFragment}.
+     * <p>
+     * This is done by using the {@code scrollIntoView(true)} JavaScript function on the underlying element.
+     * Since all JavaScript functionality depends heavily on the used browser this might not work in all environments.
+     * See <a href="https://developer.mozilla.org/en/docs/Web/API/Element/scrollIntoView">MDN Web API</a> for details.
+     *
+     * @param fragment the fragment to scroll into view
+     * @return the original browser of this operation
+     * @see JavaScript
+     * @since 2.0
+     */
+    public Browser scrollTo(PageFragment fragment) {
+        log.debug("scrolling [{}] into view", fragment.getName().orElse(fragment.toString()));
+        return browser().javaScript().execute("arguments[0].scrollIntoView(true)", fragment);
+    }
+
     /**
      * Closes the currently focused window. If that window was the last open window, the browser wil be closed as well
      * making it unusable in the future. Use this method with care!

webtester-core/src/test/java/integration/browser/operations/WindowIntegrationTest.java

@@ -0,0 +1,40 @@
+package integration.browser.operations;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.Test;
+
+import integration.BaseIntegrationTest;
+
+import info.novatec.testit.webtester.pagefragments.Button;
+import info.novatec.testit.webtester.pagefragments.annotations.IdentifyUsing;
+import info.novatec.testit.webtester.pages.Page;
+
+
+public class WindowIntegrationTest extends BaseIntegrationTest {
+
+    @Override
+    protected String getHTMLFilePath() {
+        return "html/browser/window.html";
+    }
+
+    @Test
+    public void scrollIntoView() {
+        Button outOfView = create(TestPage.class).outOfView();
+        assertThat(elementIsInView()).isFalse();
+        browser().currentWindow().scrollTo(outOfView);
+        assertThat(elementIsInView()).isTrue();
+    }
+
+    Boolean elementIsInView() {
+        return browser().javaScript().executeWithReturn("return isScrolledIntoView()");
+    }
+
+    private interface TestPage extends Page {
+
+        @IdentifyUsing("#outOfView")
+        Button outOfView();
+
+    }
+
+}

webtester-core/src/test/resources/html/browser/window.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <link rel="stylesheet" href="../../_style.css">
+    <script type="text/javascript">
+        function isScrolledIntoView() {
+            var el = document.getElementById('outOfView');
+            var elemTop = el.getBoundingClientRect().top;
+            var elemBottom = el.getBoundingClientRect().bottom;
+
+            var isVisible = (elemTop >= 0) && (elemBottom <= window.innerHeight);
+            return isVisible;
+        }
+    </script>
+</head>
+<body>
+
+<!-- Many breaks to move button out of view -->
+<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
+<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
+<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
+<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
+<button id="outOfView" onshow="alert('Foo')">Out of View</button>
+<br><br><br><br><br>
+
+</body>
+</html>