Android ScrollViewでスクロールが止まった時に処理を行いたい

Question

kotlinのScrollViewクラスで、スクロールが止まった時に処理が動くように実装することは可能でしょうか？
公式ドキュメントを調べても使えそうな関数は載っていませんでした。

https://developer.android.com/reference/kotlin/android/widget/ScrollView

やりたいことは、スクロールが止まった時の位置の取得です。

何か良い方法があれば教えていただきたいです。

よろしくお願いします。

Comments

[jimbe]

ご存じと思いますが, 人の目には動き続けているように見えて, 機械的には「少し動く←→止まる」を繰り返しています. なにをもって「スクロールが止まった」と判断するのでしょうか.

[takepon0209]

そうなんですね、知りませんでした。
人の目から見て止まった時に処理を行いたいのですが、
それは難しいということでしょうか？

[jimbe]

難しいかどうかは仕様次第ですが,
> 人の目から見て止まった時
という言われ方では, まだ抽象的です.
例えば...移動する場合に 10 秒おきに 1 mm 進む生物が居たとします. どのような場合に「この生物は止まった(=移動していない)」と言えるでしょうか.

[takepon0209]

なるほど、そうですね。
止まってから1秒動きがなかったらなど、止まってからの経過秒数で判定したいです。

Answer 1

jimbeさんの回答だとOnScrollChangeListenerを使用していてAndroid M（APIレベル23）以降でしか動かないので、それ以前のバージョンでも動作させたい場合は以下のようにScrollViewを拡張したクラスを実装して代わりに利用する方法があります。

class StopAwareScrollView(...) : ScrollView(...) {
    private var debounceTask: Runnable? = null

    var onStopListener: (Int, Int) -> Unit = { _, _ -> }

    override fun onScrollChanged(l: Int, t: Int, oldl: Int, oldt: Int) {
        super.onScrollChanged(l, t, oldl, oldt)

        removeCallbacks(debounceTask)
        debounceTask = Runnable { onStopListener(l, t) }
        postDelayed(debounceTask, 1000L)
    }

    override fun onDetachedFromWindow() {
        super.onDetachedFromWindow()
        removeCallbacks(debounceTask)
    }
}

• イベントを受け取る側

scrollView.onStopListener = { x, y ->
    // do something...
}

なお、こちらの実装ではThreadではなくHandlerを利用しているので、リスナーはメインスレッド上で呼ばれます。

Comments

[takepon0209]

ありがとうございました！

[jimbe]

私にも kotlin の勉強になりました. ありがとうございます.

Answer 2

時間の監視でよろしければ, スクロールしたらリセットするタイマーを作り, そのタイマーが1秒経過したら「停止中」と判断しては如何でしょうか.

kotlin が使えないため java で失礼します.
非常にざっくりです.

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context="com.teratail.q218060.MainActivity">

    <ScrollView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:id="@+id/scrollView">

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:id="@+id/textView"/>
    </ScrollView>
</androidx.constraintlayout.widget.ConstraintLayout>

MainActivity.java

package com.teratail.q218060;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.ScrollView;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity {
  private ScrollStopDetector scrollStopDetector;
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    TextView textView = findViewById(R.id.textView);
    for(int i=1; i<=50; i++) textView.append(i+"\n");

    ScrollView scrollView = findViewById(R.id.scrollView);
    scrollStopDetector = new ScrollStopDetector(scrollView, 1000, new ScrollStopDetector.Listener() {
      @Override
      public void stopped(View v) {
        Log.d("MainActivity", "Scroll STOP");
      }
    });
    scrollView.setOnScrollChangeListener(scrollStopDetector);

    scrollStopDetector.start();
  }
  @Override
  protected void onDestroy() {
    super.onDestroy();
    scrollStopDetector.finish();
  }
}

ScrollStopDetector.java

package com.teratail.q218060;

import android.view.View;
import android.widget.ScrollView;

class ScrollStopDetector implements View.OnScrollChangeListener {
  interface Listener {
    void stopped(View v);
  }

  private class Sleeper implements Runnable {
    @Override
    public void run() {
      while(!finish) {
        try {
          Thread.sleep(millis); //[ms]
          listener.stopped(view);
        } catch(InterruptedException ignore) {
        }
      }
    }
  }

  private ScrollView view;
  private long millis;
  private Listener listener;
  private Thread thread;
  private boolean finish;

  ScrollStopDetector(ScrollView view, long millis, Listener listener) {
    this.view = view;
    this.millis = millis;
    this.listener = listener;
  }
  void start() {
    thread = new Thread(new Sleeper());
    thread.start();
  }
  void finish() {
    finish = true;
  }

  @Override
  public void onScrollChange(View v, int scrollX, int scrollY, int oldScrollX, int oldScrollY) {
    if(thread != null) thread.interrupt();
  }
}

Comments

[takepon0209]

ありがとうございます！
無事解決しました。