bootstrapのScrollTo

3618 ワード

ScrollTo

package io.appium.android.bootstrap.handler;

import com.android.uiautomator.core.UiObject;
import com.android.uiautomator.core.UiObjectNotFoundException;
import com.android.uiautomator.core.UiScrollable;
import com.android.uiautomator.core.UiSelector;
import io.appium.android.bootstrap.*;
import org.json.JSONException;

import java.util.Hashtable;

/**
 * This handler is used to scroll to elements in the Android UI.
 * 
 * Based on the element Id of the scrollable, scroll to the object with the
 * text.
 * 
 */
public class ScrollTo extends CommandHandler {

  /*
   * @param command The {@link AndroidCommand}
   * 
   * @return {@link AndroidCommandResult}
   * 
   * @throws JSONException
   * 
   * @see io.appium.android.bootstrap.CommandHandler#execute(io.appium.android.
   * bootstrap.AndroidCommand)
   */
  @Override
  public AndroidCommandResult execute(final AndroidCommand command)
      throws JSONException {
    if (!command.isElementCommand()) {
      return getErrorResult("A scrollable view is required for this command.");
    }

    try {
      Boolean result;
      final Hashtable<String, Object> params = command.params();
      final String text = params.get("text").toString();
      final String direction = params.get("direction").toString();

      final AndroidElement el = command.getElement();

      if (!el.getUiObject().isScrollable()) {
        return getErrorResult("The provided view is not scrollable.");
      }

      final UiScrollable view = new UiScrollable(el.getUiObject().getSelector());

      if (direction.toLowerCase().contentEquals("horizontal")
          || view.getClassName().contentEquals(
              "android.widget.HorizontalScrollView")) {
        view.setAsHorizontalList();
      }
      view.scrollToBeginning(100);
      view.setMaxSearchSwipes(100);
      result = view.scrollTextIntoView(text);
      view.waitForExists(5000);

      // make sure we can get to the item
      UiObject listViewItem = view.getChildByInstance(
          new UiSelector().text(text), 0);

      // We need to make sure that the item exists (visible)
      if (!(result && listViewItem.exists())) {
        return getErrorResult("Could not scroll element into view: " + text);
      }
      return getSuccessResult(result);
    } catch (final UiObjectNotFoundException e) {
      return new AndroidCommandResult(WDStatus.NO_SUCH_ELEMENT, e.getMessage());
    } catch (final NullPointerException e) { // el is null
      return new AndroidCommandResult(WDStatus.NO_SUCH_ELEMENT, e.getMessage());
    } catch (final Exception e) {
      return new AndroidCommandResult(WDStatus.UNKNOWN_ERROR, e.getMessage());
    }
  }
}

uiautomatorでは、スクロールリストにitemを見つける必要がある場合がありますが、このitemの位置は不定です.この場合、UiScrollableのscrollToで特定のtextのコントロールを見つけることができます.bootstrapのこのScrollToはこのようなニーズをパッケージ化しています.
まずコントロールがスクロール可能かどうかを判断し、UIScrolableオブジェクトを作成します.デフォルトのスクロール方式は垂直方向なので、水平方向が必要な場合は水平方向に設定します.
view.setAsHorizontalList();

次に、スクロールコントロールを最初の場所にスクロールし、永遠に検索できないため、最大検索範囲を100回に設定します.そして呼び出しを開始
view.scrollTextIntoView(text);

スクロールを開始し、最終的に目標を設定するまでスクロールするかどうかを確認します.
 view.waitForExists(5000);

時間にリフレッシュされる可能性があるため,呼び出しメソッドはその時点で5秒にわたって送信される.
UiObject listViewItem = view.getChildByInstance(
          new UiSelector().text(text), 0);

最後に結果をチェックし,textを作成したオブジェクトを取得し,存在するか否かを判断してクライアントに返す.