Android Dev Summit, October 23-24: two days of technical content, directly from the Android team. Sign-up for livestream updates.

一般的な操作の検出

ユーザーがタッチ スクリーンに指を 1 本以上置くと「タップ操作」が発生し、アプリケーションはそのタップパターンを特定の操作として解釈します。これに対応して、ジェスチャ検出には 2 つのフェーズがあります。

  1. タップイベントに関するデータを収集します。
  2. データを解釈して、アプリがサポートする操作のいずれかの基準を満たしているかどうかを確認します。

以下の関連リソースもご覧ください。

サポート ライブラリ クラス

このレッスンの例では、GestureDetectorCompat クラスと MotionEventCompat クラスを使用します。これらのクラスはサポート ライブラリにあります。サポート ライブラリ クラスは、Android 1.6 以降を搭載したデバイスとの互換性を提供できる場合に使用してください。MotionEventCompatMotionEvent クラスの代替ではありません。むしろ、そのイベントに関連付けられた目的のアクションを受け取るために、MotionEvent オブジェクトを渡す静的ユーティリティ メソッドを提供します。

データの収集

ユーザーが画面に指を 1 本以上置くと、タップイベントを受け取った View で onTouchEvent() コールバックがトリガーされます。最終的に操作として識別されるタップイベントの各シーケンス(位置、圧力、サイズ、別の指の追加など)に対して onTouchEvent() が数回発生します。

操作は、ユーザーが最初に画面に触れたときに開始し、システムがユーザーの指の位置を追跡している間継続し、ユーザーの指が画面を離れる最後のイベントをキャプチャすると終了します。この操作全体を通じて、操作の詳細はすべて、onTouchEvent() に配信される MotionEvent から提供されます。アプリは、MotionEvent から提供されるデータを使用して、対象の操作が発生したかどうかを判断できます。

Activity または View のタップイベントをキャプチャする

Activity または View でタップイベントをインターセプトするには、onTouchEvent() コールバックをオーバーライドします。

次のスニペットは、getActionMasked() を使用して、ユーザーがとったアクションを event パラメータから抽出しています。これにより、対象の操作が発生したかどうかを判断するために必要な生データが得られます。

Kotlin

    class MainActivity : Activity() {
        ...
        // This example shows an Activity, but you would use the same approach if
        // you were subclassing a View.
        override fun onTouchEvent(event: MotionEvent): Boolean {

            val action: Int = MotionEventCompat.getActionMasked(event)

            return when (action) {
                MotionEvent.ACTION_DOWN -> {
                    Log.d(DEBUG_TAG, "Action was DOWN")
                    true
                }
                MotionEvent.ACTION_MOVE -> {
                    Log.d(DEBUG_TAG, "Action was MOVE")
                    true
                }
                MotionEvent.ACTION_UP -> {
                    Log.d(DEBUG_TAG, "Action was UP")
                    true
                }
                MotionEvent.ACTION_CANCEL -> {
                    Log.d(DEBUG_TAG, "Action was CANCEL")
                    true
                }
                MotionEvent.ACTION_OUTSIDE -> {
                    Log.d(DEBUG_TAG, "Movement occurred outside bounds of current screen element")
                    true
                }
                else -> super.onTouchEvent(event)
            }
        }
    }
    

Java

    public class MainActivity extends Activity {
    ...
    // This example shows an Activity, but you would use the same approach if
    // you were subclassing a View.
    @Override
    public boolean onTouchEvent(MotionEvent event){

        int action = MotionEventCompat.getActionMasked(event);

        switch(action) {
            case (MotionEvent.ACTION_DOWN) :
                Log.d(DEBUG_TAG,"Action was DOWN");
                return true;
            case (MotionEvent.ACTION_MOVE) :
                Log.d(DEBUG_TAG,"Action was MOVE");
                return true;
            case (MotionEvent.ACTION_UP) :
                Log.d(DEBUG_TAG,"Action was UP");
                return true;
            case (MotionEvent.ACTION_CANCEL) :
                Log.d(DEBUG_TAG,"Action was CANCEL");
                return true;
            case (MotionEvent.ACTION_OUTSIDE) :
                Log.d(DEBUG_TAG,"Movement occurred outside bounds " +
                        "of current screen element");
                return true;
            default :
                return super.onTouchEvent(event);
        }
    }
    

その後、このようなイベントを独自に処理して、操作が発生したかどうかを判断できます。これはカスタム操作に対して行う必要がある処理の一種です。ただし、ダブルタップ、長押し、フリングなどの一般的な操作をアプリで使用する場合は、GestureDetector クラスを利用できます。GestureDetector を使用すると、個々のタップイベントを独自に処理しなくても、一般的な操作を簡単に検出できます。これについては操作の検出で説明します。

単一のビューのタップイベントをキャプチャする

onTouchEvent() の代わりに、setOnTouchListener() メソッドを使用して View.OnTouchListener オブジェクトを任意の View オブジェクトにアタッチできます。これにより、既存の View をサブクラス化せずにタップイベントをリッスンできます。次に例を示します。

Kotlin

    findViewById<View>(R.id.my_view).setOnTouchListener { v, event ->
        // ... Respond to touch events
        true
    }
    

Java

    View myView = findViewById(R.id.my_view);
    myView.setOnTouchListener(new OnTouchListener() {
        public boolean onTouch(View v, MotionEvent event) {
            // ... Respond to touch events
            return true;
        }
    });
    

ACTION_DOWN イベントに対して false を返すリスナーを作成しないようにご注意ください。これを行うと、イベントの後続の ACTION_MOVEACTION_UP の文字列に対してリスナーが呼び出されません。これは、ACTION_DOWN がすべてのタップイベントの開始点であるためです。

カスタム View を作成している場合、前述のように onTouchEvent() をオーバーライドできます。

操作の検出

Android には、一般的な操作を検出するための GestureDetector クラスが用意されています。サポートされる操作には、onDown()onLongPress()onFling() などがあります。GestureDetector は、前述の onTouchEvent() と組み合わせて使用できます。

サポートされている操作をすべて検出する

GestureDetectorCompat オブジェクトをインスタンス化する場合、取るパラメータのうち 1 つは、GestureDetector.OnGestureListener インターフェースを実装するクラスです。 GestureDetector.OnGestureListener は特定のタップイベントが発生したとき、ユーザーに通知します。GestureDetector オブジェクトがイベントを受信できるようにするには、View または Activity の onTouchEvent() メソッドをオーバーライドし、確認されたイベントをすべて検出インスタンスに渡します。

次のスニペットでは、個々の on<TouchEvent> メソッドからの戻り値が true の場合、タップイベントが処理されたことを示します。戻り値が false の場合、タップが正常に処理されるまで、イベントをビュースタックに渡します。

次のスニペットを実行すると、タッチ スクリーンを操作したときにアクションがどのようにトリガーされるかと、各タップイベントに対する MotionEvent の内容を把握できます。単純な操作であっても、どれだけのデータが生成されているかを理解できます。

Kotlin

    private const val DEBUG_TAG = "Gestures"

    class MainActivity :
            Activity(),
            GestureDetector.OnGestureListener,
            GestureDetector.OnDoubleTapListener {

        private lateinit var mDetector: GestureDetectorCompat

        // Called when the activity is first created.
        public override fun onCreate(savedInstanceState: Bundle?) {
            super.onCreate(savedInstanceState)
            setContentView(R.layout.activity_main)
            // Instantiate the gesture detector with the
            // application context and an implementation of
            // GestureDetector.OnGestureListener
            mDetector = GestureDetectorCompat(this, this)
            // Set the gesture detector as the double tap
            // listener.
            mDetector.setOnDoubleTapListener(this)
        }

        override fun onTouchEvent(event: MotionEvent): Boolean {
            return if (mDetector.onTouchEvent(event)) {
                true
            } else {
                super.onTouchEvent(event)
            }
        }

        override fun onDown(event: MotionEvent): Boolean {
            Log.d(DEBUG_TAG, "onDown: $event")
            return true
        }

        override fun onFling(
                event1: MotionEvent,
                event2: MotionEvent,
                velocityX: Float,
                velocityY: Float
        ): Boolean {
            Log.d(DEBUG_TAG, "onFling: $event1 $event2")
            return true
        }

        override fun onLongPress(event: MotionEvent) {
            Log.d(DEBUG_TAG, "onLongPress: $event")
        }

        override fun onScroll(
                event1: MotionEvent,
                event2: MotionEvent,
                distanceX: Float,
                distanceY: Float
        ): Boolean {
            Log.d(DEBUG_TAG, "onScroll: $event1 $event2")
            return true
        }

        override fun onShowPress(event: MotionEvent) {
            Log.d(DEBUG_TAG, "onShowPress: $event")
        }

        override fun onSingleTapUp(event: MotionEvent): Boolean {
            Log.d(DEBUG_TAG, "onSingleTapUp: $event")
            return true
        }

        override fun onDoubleTap(event: MotionEvent): Boolean {
            Log.d(DEBUG_TAG, "onDoubleTap: $event")
            return true
        }

        override fun onDoubleTapEvent(event: MotionEvent): Boolean {
            Log.d(DEBUG_TAG, "onDoubleTapEvent: $event")
            return true
        }

        override fun onSingleTapConfirmed(event: MotionEvent): Boolean {
            Log.d(DEBUG_TAG, "onSingleTapConfirmed: $event")
            return true
        }

    }
    

Java

    public class MainActivity extends Activity implements
            GestureDetector.OnGestureListener,
            GestureDetector.OnDoubleTapListener{

        private static final String DEBUG_TAG = "Gestures";
        private GestureDetectorCompat mDetector;

        // Called when the activity is first created.
        @Override
        public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            // Instantiate the gesture detector with the
            // application context and an implementation of
            // GestureDetector.OnGestureListener
            mDetector = new GestureDetectorCompat(this,this);
            // Set the gesture detector as the double tap
            // listener.
            mDetector.setOnDoubleTapListener(this);
        }

        @Override
        public boolean onTouchEvent(MotionEvent event){
            if (this.mDetector.onTouchEvent(event)) {
                return true;
            }
            return super.onTouchEvent(event);
        }

        @Override
        public boolean onDown(MotionEvent event) {
            Log.d(DEBUG_TAG,"onDown: " + event.toString());
            return true;
        }

        @Override
        public boolean onFling(MotionEvent event1, MotionEvent event2,
                float velocityX, float velocityY) {
            Log.d(DEBUG_TAG, "onFling: " + event1.toString() + event2.toString());
            return true;
        }

        @Override
        public void onLongPress(MotionEvent event) {
            Log.d(DEBUG_TAG, "onLongPress: " + event.toString());
        }

        @Override
        public boolean onScroll(MotionEvent event1, MotionEvent event2, float distanceX,
                float distanceY) {
            Log.d(DEBUG_TAG, "onScroll: " + event1.toString() + event2.toString());
            return true;
        }

        @Override
        public void onShowPress(MotionEvent event) {
            Log.d(DEBUG_TAG, "onShowPress: " + event.toString());
        }

        @Override
        public boolean onSingleTapUp(MotionEvent event) {
            Log.d(DEBUG_TAG, "onSingleTapUp: " + event.toString());
            return true;
        }

        @Override
        public boolean onDoubleTap(MotionEvent event) {
            Log.d(DEBUG_TAG, "onDoubleTap: " + event.toString());
            return true;
        }

        @Override
        public boolean onDoubleTapEvent(MotionEvent event) {
            Log.d(DEBUG_TAG, "onDoubleTapEvent: " + event.toString());
            return true;
        }

        @Override
        public boolean onSingleTapConfirmed(MotionEvent event) {
            Log.d(DEBUG_TAG, "onSingleTapConfirmed: " + event.toString());
            return true;
        }
    }
    

サポートされている操作のサブセットを検出する

処理する操作が少数の場合は、GestureDetector.OnGestureListener インターフェースを実装する代わりに、GestureDetector.SimpleOnGestureListener を拡張できます。

GestureDetector.SimpleOnGestureListener では、すべてに false を返すことで on<TouchEvent> メソッドを実装します。したがって、重要なメソッドのみをオーバーライドできます。たとえば下記のスニペットは、GestureDetector.SimpleOnGestureListener を拡張し、onFling()onDown() をオーバーライドするクラスを作成します。

GestureDetector.OnGestureListener を使用するかどうかにかかわらず、true を返す onDown() メソッドを実装することをおすすめします。これは、すべての操作が onDown() メッセージで始まるためです。GestureDetector.SimpleOnGestureListener がデフォルトで行うように、onDown() から false を返すと、システムは残りの操作を無視するものとみなし、GestureDetector.OnGestureListener の他のメソッドは呼び出されません。これは、アプリで予期せぬ問題を引き起こすおそれがあります。onDown() から false を返す必要があるのは、操作全体を本当に無視する場合だけです。

Kotlin

    private const val DEBUG_TAG = "Gestures"

    class MainActivity : Activity() {

        private lateinit var mDetector: GestureDetectorCompat

        public override fun onCreate(savedInstanceState: Bundle?) {
            super.onCreate(savedInstanceState)
            setContentView(R.layout.activity_main)
            mDetector = GestureDetectorCompat(this, MyGestureListener())
        }

        override fun onTouchEvent(event: MotionEvent): Boolean {
            mDetector.onTouchEvent(event)
            return super.onTouchEvent(event)
        }

        private class MyGestureListener : GestureDetector.SimpleOnGestureListener() {

            override fun onDown(event: MotionEvent): Boolean {
                Log.d(DEBUG_TAG, "onDown: $event")
                return true
            }

            override fun onFling(
                    event1: MotionEvent,
                    event2: MotionEvent,
                    velocityX: Float,
                    velocityY: Float
            ): Boolean {
                Log.d(DEBUG_TAG, "onFling: $event1 $event2")
                return true
            }
        }
    }
    

Java

    public class MainActivity extends Activity {

        private GestureDetectorCompat mDetector;

        @Override
        public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            mDetector = new GestureDetectorCompat(this, new MyGestureListener());
        }

        @Override
        public boolean onTouchEvent(MotionEvent event){
            this.mDetector.onTouchEvent(event);
            return super.onTouchEvent(event);
        }

        class MyGestureListener extends GestureDetector.SimpleOnGestureListener {
            private static final String DEBUG_TAG = "Gestures";

            @Override
            public boolean onDown(MotionEvent event) {
                Log.d(DEBUG_TAG,"onDown: " + event.toString());
                return true;
            }

            @Override
            public boolean onFling(MotionEvent event1, MotionEvent event2,
                    float velocityX, float velocityY) {
                Log.d(DEBUG_TAG, "onFling: " + event1.toString() + event2.toString());
                return true;
            }
        }
    }