タッチ操作は、ユーザーがタッチスクリーンに 1 本以上の指を置いたときに発生し、アプリはこのタッチパターンを操作として解釈します。ジェスチャー検出には次の 2 つのフェーズがあります。
- タッチイベント データを収集しています。
- データを解釈して、アプリがサポートするジェスチャーの条件を満たしているかどうかを判断する。
AndroidX クラス
このドキュメントの例では、GestureDetectorCompat
クラスと MotionEventCompat
クラスを使用します。これらのクラスは AndroidX ライブラリにあります。可能な限り、AndroidX クラスを使用して、以前のデバイスとの互換性を確保します。
MotionEventCompat
は MotionEvent
クラスに代わるものではありません。代わりに、MotionEvent
オブジェクトを渡してイベントに関連付けられたアクションを受け取る静的ユーティリティ メソッドを提供します。
データを収集する
ユーザーが 1 本以上の指を画面に配置すると、タッチイベントを受け取るビューでコールバック onTouchEvent()
がトリガーされます。位置、圧力、サイズ、別の指の追加など、操作として識別される一連のタッチイベントに対して、onTouchEvent()
が複数回呼び出されます。
操作は、ユーザーが最初に画面に触れたときに開始され、システムがユーザーの指の位置を追跡し、最後の指が画面から離れる最後のイベントをキャプチャすることで終了します。このインタラクション全体を通して、onTouchEvent()
に配信される MotionEvent
は、すべてのインタラクションの詳細を提供します。アプリは、MotionEvent
から提供されたデータを使用して、対象の操作が発生しているかどうかを判断できます。
Activity または View のタップイベントをキャプチャする
Activity
または View
でタッチイベントをインターセプトするには、onTouchEvent()
コールバックをオーバーライドします。
次のコード スニペットでは、getAction()
を使用して、ユーザーが行うアクションを event
パラメータから抽出します。これにより、対象の操作が発生するかどうかを判断するために必要な元データが得られます。
Kotlin
class MainActivity : Activity() { ... // This example shows an Activity. You can use the same approach if you are // subclassing a View. override fun onTouchEvent(event: MotionEvent): Boolean { return when (event.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. You can use the same approach if you are // subclassing a View. @Override public boolean onTouchEvent(MotionEvent event){ switch(event.getAction()) { 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); } }
このコードは、ユーザーがタップ、長押し、ドラッグを行うと、Logcat に次のようなメッセージを生成します。
GESTURES D Action was DOWN GESTURES D Action was UP GESTURES D Action was MOVE
カスタム操作の場合、これらのイベントを独自に処理して、処理する必要がある操作を表しているかどうかを判断できます。ただし、アプリで一般的な操作(ダブルタップ、長押し、フリングなど)を使用する場合は、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_MOVE
および ACTION_UP
イベントのシーケンスではリスナーが呼び出されません。これは、ACTION_DOWN
がすべてのタッチイベントの開始点であるためです。
カスタムビューを作成する場合は、前述のように onTouchEvent()
をオーバーライドできます。
操作の検出
Android には、一般的な操作を検出するための GestureDetector
クラスが用意されています。サポートされている操作には、onDown()
、onLongPress()
、onFling()
などがあります。GestureDetector
は、前述の onTouchEvent()
メソッドと組み合わせて使用できます。
サポートされている操作をすべて検出する
GestureDetectorCompat
オブジェクトをインスタンス化する際に取るパラメータの 1 つは、GestureDetector.OnGestureListener
インターフェースを実装するクラスです。GestureDetector.OnGestureListener
は、特定のタッチイベントが発生するとユーザーに通知します。GestureDetector
オブジェクトがイベントを受信できるようにするには、ビューまたはアクティビティの 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
と GestureDetector.SimpleOnGestureListener
のどちらを使用する場合でも、true
を返す onDown()
メソッドを実装することをおすすめします。これは、すべての操作が onDown()
メッセージで始まるためです。onDown()
から false
を返す場合、GestureDetector.SimpleOnGestureListener
のデフォルトの動作のように、システムは残りの操作を無視すると想定し、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){ if (this.mDetector.onTouchEvent(event)) { return true; } 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; } } }