Gérer les événements tactiles dans un ViewGroup

La gestion des événements tactiles dans un ViewGroup nécessite une attention particulière, car il est courant qu'un ViewGroup ait des enfants qui sont des cibles d'événements tactiles différents de ceux du ViewGroup lui-même. Pour vous assurer que chaque vue reçoit correctement les événements tactiles qui lui sont destinés, remplacez la méthode onInterceptTouchEvent().

Interception des événements tactiles dans un ViewGroup

La méthode onInterceptTouchEvent() est appelée chaque fois qu'un événement tactile est détecté à la surface d'un ViewGroup, y compris à la surface de ses enfants. Si onInterceptTouchEvent() renvoie true, MotionEvent est intercepté, ce qui signifie qu'il n'est pas transmis à l'enfant, mais plutôt à la méthode onTouchEvent() du parent.

La méthode onInterceptTouchEvent() permet à un parent de voir les événements tactiles avant ses enfants. Si vous renvoyez true à partir de onInterceptTouchEvent(), la vue enfant qui gérait auparavant les événements tactiles reçoit un ACTION_CANCEL, et les événements à partir de ce point sont envoyés à la méthode onTouchEvent() du parent pour la gestion habituelle. onInterceptTouchEvent() peut également renvoyer false et espionner les événements lorsqu'ils descendent dans la hiérarchie des vues vers leurs cibles habituelles, qui gèrent les événements avec leur propre onTouchEvent().

Dans l'extrait de code suivant, la classe MyViewGroup étend ViewGroup. MyViewGroup contient plusieurs vues enfants. Si vous faites glisser votre doigt horizontalement sur une vue enfant, la vue enfant ne reçoit plus d'événements tactiles, et MyViewGroup gère les événements tactiles en faisant défiler son contenu. Toutefois, si vous appuyez sur des boutons dans la vue enfant ou que vous faites défiler la vue enfant verticalement, le parent n'intercepte pas ces événements tactiles, car l'enfant est la cible prévue. Dans ce cas, onInterceptTouchEvent() renvoie false, et l'onTouchEvent() de la classe MyViewGroup n'est pas appelé.

class MyViewGroup @JvmOverloads constructor(
        context: Context,
        private val mTouchSlop: Int = ViewConfiguration.get(context).scaledTouchSlop
) : ViewGroup(context) {
    ...
    override fun onInterceptTouchEvent(ev: MotionEvent): Boolean {
        // This method only determines whether you want to intercept the motion.
        // If this method returns true, onTouchEvent is called and you can do
        // the actual scrolling there.
        return when (ev.actionMasked) {
            // Always handle the case of the touch gesture being complete.
            MotionEvent.ACTION_CANCEL, MotionEvent.ACTION_UP -> {
                // Release the scroll.
                mIsScrolling = false
                false // Don't intercept the touch event. Let the child handle it.
            }
            MotionEvent.ACTION_MOVE -> {
                if (mIsScrolling) {
                    // You're currently scrolling, so intercept the touch event.
                    true
                } else {

                    // If the user drags their finger horizontally more than the
                    // touch slop, start the scroll.

                    // Left as an exercise for the reader.
                    val xDiff: Int = calculateDistanceX(ev)

                    // Touch slop is calculated using ViewConfiguration constants.
                    if (xDiff > mTouchSlop) {
                        // Start scrolling!
                        mIsScrolling = true
                        true
                    } else {
                        false
                    }
                }
            }
            ...
            else -> {
                // In general, don't intercept touch events. The child view
                // handles them.
                false
            }
        }
    }

    override fun onTouchEvent(event: MotionEvent): Boolean {
        // Here, you actually handle the touch event. For example, if the action
        // is ACTION_MOVE, scroll this container. This method is only called if
        // the touch event is intercepted in onInterceptTouchEvent.
        ...
    }
}

public class MyViewGroup extends ViewGroup {

    private int mTouchSlop;
    ...
    ViewConfiguration vc = ViewConfiguration.get(view.getContext());
    mTouchSlop = vc.getScaledTouchSlop();
    ...
    @Override
    public boolean onInterceptTouchEvent(MotionEvent ev) {
        // This method only determines whether you want to intercept the motion.
        // If this method returns true, onTouchEvent is called and you can do
        // the actual scrolling there.

        final int action = MotionEventCompat.getActionMasked(ev);

        // Always handle the case of the touch gesture being complete.
        if (action == MotionEvent.ACTION_CANCEL || action == MotionEvent.ACTION_UP) {
            // Release the scroll.
            mIsScrolling = false;
            return false; // Don't intercept touch event. Let the child handle it.
        }

        switch (action) {
            case MotionEvent.ACTION_MOVE: {
                if (mIsScrolling) {
                    // You're currently scrolling, so intercept the touch event.
                    return true;
                }

                // If the user drags their finger horizontally more than the
                // touch slop, start the scroll.

                // Left as an exercise for the reader.
                final int xDiff = calculateDistanceX(ev);

                // Touch slop is calculated using ViewConfiguration constants.
                if (xDiff > mTouchSlop) {
                    // Start scrolling.
                    mIsScrolling = true;
                    return true;
                }
                break;
            }
            ...
        }

        // In general, don't intercept touch events. The child view handles them.
        return false;
    }

    @Override
    public boolean onTouchEvent(MotionEvent ev) {
        // Here, you actually handle the touch event. For example, if the
        // action is ACTION_MOVE, scroll this container. This method is only
        // called if the touch event is intercepted in onInterceptTouchEvent.
        ...
    }
}

Notez que ViewGroup fournit également une méthode requestDisallowInterceptTouchEvent(). ViewGroup appelle cette méthode lorsqu'un enfant ne souhaite pas que le parent et ses ancêtres interceptent les événements tactiles avec onInterceptTouchEvent().

Traiter les événements ACTION_OUTSIDE

Si une ViewGroup reçoit une MotionEvent avec un ACTION_OUTSIDE, l'événement n'est pas envoyé par défaut à ses enfants. Pour traiter un MotionEvent avec ACTION_OUTSIDE, remplacez dispatchTouchEvent(MotionEvent event) pour distribuer à l'View approprié ou gérez-le dans le Window.Callback approprié (par exemple, Activity).

Utiliser des constantes ViewConfiguration

L'extrait de code précédent utilise l'ViewConfiguration actuelle pour initialiser une variable appelée mTouchSlop. Vous pouvez utiliser la classe ViewConfiguration pour accéder aux distances, vitesses et temps courants utilisés par le système Android.

Le "décalage tactile" fait référence à la distance en pixels que le toucher de l'utilisateur peut parcourir avant que le geste ne soit interprété comme un défilement. La marge de glissement tactile est généralement utilisée pour éviter le défilement accidentel lorsque l'utilisateur effectue une autre opération tactile, comme appuyer sur des éléments à l'écran.

Deux autres méthodes ViewConfiguration couramment utilisées sont getScaledMinimumFlingVelocity() et getScaledMaximumFlingVelocity(). Ces méthodes renvoient respectivement la vitesse minimale et maximale pour lancer un fling mesuré en pixels par seconde. Exemple :

private val vc: ViewConfiguration = ViewConfiguration.get(context)
private val mSlop: Int = vc.scaledTouchSlop
private val mMinFlingVelocity: Int = vc.scaledMinimumFlingVelocity
private val mMaxFlingVelocity: Int = vc.scaledMaximumFlingVelocity
...
MotionEvent.ACTION_MOVE -> {
    ...
    val deltaX: Float = motionEvent.rawX - mDownX
    if (Math.abs(deltaX) > mSlop) {
        // A swipe occurs, do something.
    }
    return false
}
...
MotionEvent.ACTION_UP -> {
    ...
    if (velocityX in mMinFlingVelocity..mMaxFlingVelocity && velocityY < velocityX) {
        // The criteria are satisfied, do something.
    }
}

ViewConfiguration vc = ViewConfiguration.get(view.getContext());
private int mSlop = vc.getScaledTouchSlop();
private int mMinFlingVelocity = vc.getScaledMinimumFlingVelocity();
private int mMaxFlingVelocity = vc.getScaledMaximumFlingVelocity();
...
case MotionEvent.ACTION_MOVE: {
    ...
    float deltaX = motionEvent.getRawX() - mDownX;
    if (Math.abs(deltaX) > mSlop) {
        // A swipe occurs, do something.
    }
...
case MotionEvent.ACTION_UP: {
    ...
    } if (mMinFlingVelocity <= velocityX && velocityX <= mMaxFlingVelocity
            && velocityY < velocityX) {
        // The criteria are satisfied, do something.
    }
}

Étendre la zone tactile d'une vue enfant

Android fournit la classe TouchDelegate pour permettre à un parent d'étendre la zone tactile d'une vue enfant au-delà des limites de l'enfant. Cela est utile lorsque l'enfant doit être petit, mais qu'il a besoin d'une zone tactile plus grande. Vous pouvez également utiliser cette approche pour réduire la zone tactile de l'enfant.

Dans l'exemple suivant, un ImageButton est la _vue déléguée_, c'est-à-dire l'enfant dont la zone tactile est étendue par le parent. Voici le fichier de mise en page:

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
     android:id="@+id/parent_layout"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     tools:context=".MainActivity" >

     <ImageButton android:id="@+id/button"
          android:layout_width="wrap_content"
          android:layout_height="wrap_content"
          android:background="@null"
          android:src="@drawable/icon" />
</RelativeLayout>

L'extrait de code suivant permet d'effectuer ces tâches:

• Récupère la vue parente et publie un Runnable sur le thread d'UI. Vous vous assurez ainsi que le parent met en page ses enfants avant d'appeler la méthode getHitRect(). La méthode getHitRect() extrait le rectangle d'accès (ou zone tactile) de l'enfant parmi les coordonnées du parent.
• Recherche la vue enfant ImageButton et appelle getHitRect() pour déterminer les limites de la zone tactile de l'enfant.
• Élargit les limites du rectangle de la vue enfant ImageButton.
• Instantie un TouchDelegate, en transmettant le rectangle de la zone de sélection agrandie et la vue enfant ImageButton en tant que paramètres.
• Définit TouchDelegate sur la vue parente afin que les gestes dans les limites du délégué tactile soient acheminés vers l'enfant.

En tant que délégué tactile pour la vue enfant ImageButton, la vue parent reçoit tous les événements tactiles. Si l'événement tactile se produit dans le rectangle de l'enfant, le parent transmet l'événement tactile à l'enfant pour qu'il soit géré.

public class MainActivity : Activity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // Post in the parent's message queue to make sure the parent lays out
        // its children before you call getHitRect().
        findViewById<View>(R.id.parent_layout).post {
            // The bounds for the delegate view, which is an ImageButton in this
            // example.
            val delegateArea = Rect()
            val myButton = findViewById<ImageButton>(R.id.button).apply {
                isEnabled = true
                setOnClickListener {
                    Toast.makeText(
                            this@MainActivity,
                            "Touch occurred within ImageButton touch region.",
                            Toast.LENGTH_SHORT
                    ).show()
                }

                // The hit rectangle for the ImageButton.
                getHitRect(delegateArea)
            }

            // Extend the touch area of the ImageButton beyond its bounds on the
            // right and bottom.
            delegateArea.right += 100
            delegateArea.bottom += 100

            // Set the TouchDelegate on the parent view so that touches within
            // the touch delegate bounds are routed to the child.
            (myButton.parent as? View)?.apply {
                // Instantiate a TouchDelegate. "delegateArea" is the bounds in
                // local coordinates of the containing view to be mapped to the
                // delegate view. "myButton" is the child view that receives
                // motion events.
                touchDelegate = TouchDelegate(delegateArea, myButton)
            }
        }
    }
}

public class MainActivity extends Activity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        // Get the parent view.
        View parentView = findViewById(R.id.parent_layout);

        parentView.post(new Runnable() {
            // Post in the parent's message queue to make sure the parent lays
            // out its children before you call getHitRect().
            @Override
            public void run() {
                // The bounds for the delegate view, which is an ImageButton in
                // this example.
                Rect delegateArea = new Rect();
                ImageButton myButton = (ImageButton) findViewById(R.id.button);
                myButton.setEnabled(true);
                myButton.setOnClickListener(new View.OnClickListener() {
                    @Override
                    public void onClick(View view) {
                        Toast.makeText(MainActivity.this,
                                "Touch occurred within ImageButton touch region.",
                                Toast.LENGTH_SHORT).show();
                    }
                });

                // The hit rectangle for the ImageButton.
                myButton.getHitRect(delegateArea);

                // Extend the touch area of the ImageButton beyond its bounds on
                // the right and bottom.
                delegateArea.right += 100;
                delegateArea.bottom += 100;

                // Instantiate a TouchDelegate. "delegateArea" is the bounds in
                // local coordinates of the containing view to be mapped to the
                // delegate view. "myButton" is the child view that receives
                // motion events.
                TouchDelegate touchDelegate = new TouchDelegate(delegateArea,
                        myButton);

                // Set the TouchDelegate on the parent view so that touches
                // within the touch delegate bounds are routed to the child.
                if (View.class.isInstance(myButton.getParent())) {
                    ((View) myButton.getParent()).setTouchDelegate(touchDelegate);
                }
            }
        });
    }
}