reimplemented ScrollTo() and ScrollToExact()

Author: Jonahss

src/main/java/io/appium/java_client/AppiumDriver.java

@@ -491,6 +491,20 @@ public void lockScreen(int seconds) {
 execute(LOCK, ImmutableMap.of("seconds", seconds));
 }
 
+ /**
+ * Scroll to an element which contains the given text.
+ * Implemented differently on iOS and Android, see docs for individual methods.
+ * @param text
+ */
+ public abstract void scrollTo(String text);
+
+ /**
+ * Scroll to an element with the given text.
+ * Implemented differently on iOS and Android, see docs for individual methods.
+ * @param text
+ */
+ public abstract void scrollToExact(String text);
+
 @Override
 public WebDriver context(String name) {
 if (!_isNotNullOrEmpty(name)) {

src/main/java/io/appium/java_client/MobileElement.java

@@ -17,16 +17,15 @@
 
 package io.appium.java_client;
 
-import java.util.List;
-
+import com.google.common.collect.ImmutableMap;
 import org.openqa.selenium.By;
 import org.openqa.selenium.Dimension;
 import org.openqa.selenium.Point;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.remote.FileDetector;
 import org.openqa.selenium.remote.RemoteWebElement;
 
-import com.google.common.collect.ImmutableMap;
+import java.util.List;
 
 public class MobileElement extends RemoteWebElement implements FindsByAccessibilityId, FindsByAndroidUIAutomator,
 FindsByIosUIAutomation {

src/main/java/io/appium/java_client/android/AndroidDriver.java

@@ -39,6 +39,34 @@ public AndroidDriver(URL remoteAddress, Capabilities desiredCapabilities) {
 ANDROID_PLATFORM));
 }
 
+ /**
+ * Scroll forward to the element which has a description or name which contains the input text.
+ * The scrolling is performed on the first scrollView present on the UI
+ * @param text
+ */
+ @Override
+ public void scrollTo(String text) {
+ String uiScrollables = UiScrollable("new UiSelector().descriptionContains(\"" + text + "\")") +
+ UiScrollable("new UiSelector().textContains(\"" + text + "\")");
+ findElementByAndroidUIAutomator(uiScrollables);
+ }
+
+ /**
+ * Scroll forward to the element which has a description or name which exactly matches the input text.
+ * The scrolling is performed on the first scrollView present on the UI
+ * @param text
+ */
+ @Override
+ public void scrollToExact(String text) {
+ String uiScrollables = UiScrollable("new UiSelector().description(\"" + text + "\")") +
+ UiScrollable("new UiSelector().text(\"" + text + "\")");
+ findElementByAndroidUIAutomator(uiScrollables);
+ }
+
+ private String UiScrollable(String uiSelector) {
+ return "new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(" + uiSelector + ".instance(0));";
+ }
+
  /**
  * @param key
  * code for the key pressed on the Android device

src/main/java/io/appium/java_client/ios/IOSDriver.java

@@ -23,6 +23,52 @@ public IOSDriver(URL remoteAddress, Capabilities desiredCapabilities) {
 IOS_PLATFORM));
  }
 
+ /**
+ * Scroll to the element whose 'text' attribute contains the input text.
+ * This scrolling happens within the first UIATableView on the UI. Use the additional 'context' param to specify a different scrollView.
+ * @param text input text contained in text attribute
+ */
+ @Override
+ public void scrollTo(String text) {
+ scrollTo(text, (MobileElement) findElementByClassName("UIATableView"));
+ }
+
+ /**
+ * Scroll to the element whose 'text' attribute is equal to the input text.
+ * This scrolling happens within the first UIATableView on the UI. Use the additional 'context' param to specify a different scrollView.
+ * @param text input text to match
+ */
+ @Override
+ public void scrollToExact(String text) {
+ scrollToExact(text, (MobileElement) findElementByClassName("UIATableView"));
+ }
+
+ /**
+ * Scroll to the element whose 'text' attribute contains the input text.
+ * @param text input text contained in text attribute
+ * @param context container element to scroll within
+ */
+ public void scrollTo(String text, MobileElement context) {
+ context.findElementByIosUIAutomation(".scrollToElementWithPredicate(\"name CONTAINS '" + text + "'\")");
+ }
+
+ /**
+ * Scroll to the element whose 'text' attribute is equal to the input text.
+ * @param text input text to match
+ * @param context container element to scroll within
+ */
+ public void scrollToExact(String text, MobileElement context) {
+ context.findElementByIosUIAutomation(".scrollToElementWithName(\"" + text + "\")");
+ }
+
+ /**
+ * Scroll to the given element.
+ * This scrolling happens within the first UIATableView on the UI. Use the ScrollToExactWithinContext() method to specify a different scrollView.
+ */
+ public void scrollTo(WebElement el) {
+ scrollToExact(el.getText());
+ }
+
  /**
  * @see IOSDeviceActionShortcuts#hideKeyboard(String, String)
  */

src/test/java/io/appium/java_client/UICatalog.app.zip

@@ -19,15 +19,12 @@
 
 import io.appium.java_client.AppiumSetting;
 import io.appium.java_client.NetworkConnectionSetting;
-import io.appium.java_client.android.AndroidDriver;
-import io.appium.java_client.android.AndroidKeyCode;
-import io.appium.java_client.android.AndroidKeyMetastate;
 import io.appium.java_client.remote.MobileCapabilityType;
-
 import org.apache.commons.codec.binary.Base64;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
+import org.openqa.selenium.WebElement;
 import org.openqa.selenium.remote.DesiredCapabilities;
 
 import java.io.File;
@@ -144,18 +141,32 @@ public void ignoreUnimportantViews() {
  }
 
  @Test
- public void startActivityInThisAppTest(){
+ public void startActivityInThisAppTest() {
  driver.startActivity("io.appium.android.apis", ".accessibility.AccessibilityNodeProviderActivity", null, null);
  String activity = driver.currentActivity();
  assertTrue(activity.contains("Node"));
  }
 
  @Test
- public void startActivityInAnotherAppTest(){
+ public void startActivityInAnotherAppTest() {
  driver.startActivity("com.android.contacts", ".ContactsListActivity", null, null);
  String activity = driver.currentActivity();
  assertTrue(activity.contains("Contact"));
  }
 
  //TODO hideKeyboard() test
+
+ @Test
+ public void scrollToTest() {
+ driver.scrollTo("View");
+ WebElement views = driver.findElementByAccessibilityId("Views");
+ assertNotNull(views);
+ }
+
+ @Test
+ public void scrollToExactTest() {
+ driver.scrollTo("Views");
+ WebElement views = driver.findElementByAccessibilityId("Views");
+ assertNotNull(views);
+ }
 }

src/test/java/io/appium/java_client/android/AndroidDriverTest.java

@@ -18,19 +18,19 @@
 package io.appium.java_client.ios;
 
 import io.appium.java_client.MobileElement;
-import io.appium.java_client.ios.IOSDriver;
 import io.appium.java_client.remote.HideKeyboardStrategy;
 import io.appium.java_client.remote.MobileCapabilityType;
-
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
+import org.openqa.selenium.Point;
 import org.openqa.selenium.remote.DesiredCapabilities;
 
 import java.io.File;
 import java.net.URL;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
 
 /**
  * Test Mobile Driver features
@@ -78,4 +78,22 @@ public void hideKeyboardWithParametersTest() {
  element.click();
  driver.hideKeyboard(HideKeyboardStrategy.PRESS_KEY, "Done");
  }
+
+ @Test
+ public void scrollToTest() {
+ MobileElement searchBar = (MobileElement) driver.findElementByName("Search Bars");
+ Point before = searchBar.getLocation();
+ driver.scrollTo("Search Ba");
+ Point after = searchBar.getLocation();
+ assertNotEquals(before, after);
+ }
+
+ @Test
+ public void scrollToExactTest() {
+ MobileElement searchBar = (MobileElement) driver.findElementByName("Search Bars");
+ Point before = searchBar.getLocation();
+ driver.scrollToExact("Search Bars");
+ Point after = searchBar.getLocation();
+ assertNotEquals(before, after);
+ }
 }