Faire glisser les fragments à l'aide de ViewPager

Essayer Compose
Jetpack Compose est le kit d'outils d'interface utilisateur recommandé pour Android. Découvrez comment utiliser Pager dans Compose.
Pager →

Les diapositives d'écran sont des transitions entre un écran entier et sont courantes avec les interfaces utilisateur telles que les assistants de configuration ou les diaporamas. Cette leçon vous explique comment créer des diapositives d'écran avec un ViewPager fourni par la bibliothèque d'assistance. Les objets ViewPager peuvent animer automatiquement les diapositives. Voici à quoi ressemble une diapositive de contenu qui passe d'un écran de contenu à un autre:

Animation de glissement de l'écran
 

ViewPager fait partie d'AndroidX. Pour en savoir plus, consultez la page Utiliser AndroidX.

Créer les vues

Créez un fichier de mise en page que vous utiliserez ultérieurement pour le contenu d'un fragment. Vous devez également définir une chaîne pour le contenu du fragment. L'exemple suivant contient un affichage de texte permettant d'afficher du texte:

<!-- fragment_screen_slide_page.xml -->
<ScrollView xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/content"
    android:layout_width="match_parent"
    android:layout_height="match_parent" >

    <TextView style="?android:textAppearanceMedium"
        android:padding="16dp"
        android:lineSpacingMultiplier="1.2"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="@string/lorem_ipsum" />
</ScrollView>

Créer le fragment

Créez une classe Fragment qui renvoie la mise en page que vous venez de créer dans la méthode onCreateView(). Vous pouvez ensuite créer des instances de ce fragment dans l'activité parente chaque fois que vous avez besoin d'une nouvelle page à afficher pour l'utilisateur:

Kotlin

import android.support.v4.app.Fragment

class ScreenSlidePageFragment : Fragment() {

    override fun onCreateView(
            inflater: LayoutInflater,
            container: ViewGroup?,
            savedInstanceState: Bundle?
    ): View = inflater.inflate(R.layout.fragment_screen_slide_page, container, false)
}

Java

import android.support.v4.app.Fragment;
...
public class ScreenSlidePageFragment extends Fragment {

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
            Bundle savedInstanceState) {
        ViewGroup rootView = (ViewGroup) inflater.inflate(
                R.layout.fragment_screen_slide_page, container, false);

        return rootView;
    }
}

Ajouter un ViewPager

Les objets ViewPager disposent de gestes de balayage intégrés pour passer d'une page à l'autre et affichent par défaut des animations de diapositive à l'écran. Vous n'avez donc pas besoin de créer votre propre animation. ViewPager utilise des objets PagerAdapter pour fournir les nouvelles pages à afficher. PagerAdapter utilise donc la classe de fragment que vous avez créée précédemment.

Pour commencer, créez une mise en page contenant un ViewPager :

<!-- activity_screen_slide.xml -->
<android.support.v4.view.ViewPager
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/pager"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

Créez une activité qui effectue les opérations suivantes:

  • Définit la vue de contenu sur la mise en page avec ViewPager.
  • Elle crée une classe qui étend la classe abstraite FragmentStatePagerAdapter et implémente la méthode getItem() pour fournir des instances de ScreenSlidePageFragment en tant que nouvelles pages. L'adaptateur de pager nécessite également que vous implémentiez la méthode getCount(), qui renvoie le nombre de pages que l'adaptateur créera (cinq dans l'exemple).
  • Connecte PagerAdapter à ViewPager.

Kotlin

import android.support.v4.app.Fragment
import android.support.v4.app.FragmentManager
...
/**
 * The number of pages (wizard steps) to show in this demo.
 */
private const val NUM_PAGES = 5

class ScreenSlidePagerActivity : FragmentActivity() {

    /**
     * The pager widget, which handles animation and allows swiping horizontally to access previous
     * and next wizard steps.
     */
    private lateinit var mPager: ViewPager

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_screen_slide)

        // Instantiate a ViewPager and a PagerAdapter.
        mPager = findViewById(R.id.pager)

        // The pager adapter, which provides the pages to the view pager widget.
        val pagerAdapter = ScreenSlidePagerAdapter(supportFragmentManager)
        mPager.adapter = pagerAdapter
    }

    override fun onBackPressed() {
        if (mPager.currentItem == 0) {
            // If the user is currently looking at the first step, allow the system to handle the
            // Back button. This calls finish() on this activity and pops the back stack.
            super.onBackPressed()
        } else {
            // Otherwise, select the previous step.
            mPager.currentItem = mPager.currentItem - 1
        }
    }

    /**
     * A simple pager adapter that represents 5 ScreenSlidePageFragment objects, in
     * sequence.
     */
    private inner class ScreenSlidePagerAdapter(fm: FragmentManager) : FragmentStatePagerAdapter(fm) {
        override fun getCount(): Int = NUM_PAGES

        override fun getItem(position: Int): Fragment = ScreenSlidePageFragment()
    }
}

Java

import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
...
public class ScreenSlidePagerActivity extends FragmentActivity {
    /**
     * The number of pages (wizard steps) to show in this demo.
     */
    private static final int NUM_PAGES = 5;

    /**
     * The pager widget, which handles animation and allows swiping horizontally to access previous
     * and next wizard steps.
     */
    private ViewPager mPager;

    /**
     * The pager adapter, which provides the pages to the view pager widget.
     */
    private PagerAdapter pagerAdapter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_screen_slide);

        // Instantiate a ViewPager and a PagerAdapter.
        mPager = (ViewPager) findViewById(R.id.pager);
        pagerAdapter = new ScreenSlidePagerAdapter(getSupportFragmentManager());
        mPager.setAdapter(pagerAdapter);
    }

    @Override
    public void onBackPressed() {
        if (mPager.getCurrentItem() == 0) {
            // If the user is currently looking at the first step, allow the system to handle the
            // Back button. This calls finish() on this activity and pops the back stack.
            super.onBackPressed();
        } else {
            // Otherwise, select the previous step.
            mPager.setCurrentItem(mPager.getCurrentItem() - 1);
        }
    }

    /**
     * A simple pager adapter that represents 5 ScreenSlidePageFragment objects, in
     * sequence.
     */
    private class ScreenSlidePagerAdapter extends FragmentStatePagerAdapter {
        public ScreenSlidePagerAdapter(FragmentManager fm) {
            super(fm);
        }

        @Override
        public Fragment getItem(int position) {
            return new ScreenSlidePageFragment();
        }

        @Override
        public int getCount() {
            return NUM_PAGES;
        }
    }
}

Personnaliser l'animation à l'aide de PageTransformer

Pour afficher une animation différente de l'animation de diapositive d'écran par défaut, implémentez l'interface ViewPager.PageTransformer et fournissez-la au pager de vues. L'interface n'expose qu'une seule méthode, transformPage(). À chaque étape de la transition de l'écran, cette méthode est appelée une fois pour chaque page visible (en général, il n'y a qu'une seule page visible) et pour les pages adjacentes juste à côté de l'écran. Par exemple, si la page 3 est visible et que l'utilisateur la fait glisser vers la page 4, transformPage() est appelé pour les pages 2, 3 et 4 à chaque étape du geste.

Dans votre implémentation de transformPage(), vous pouvez ensuite créer des animations de diapositives personnalisées en déterminant les pages à transformer en fonction de leur position à l'écran, obtenue à partir du paramètre position de la méthode transformPage().

Le paramètre position indique l'emplacement d'une page donnée par rapport au centre de l'écran. Il s'agit d'une propriété dynamique qui change à mesure que l'utilisateur fait défiler les pages. Lorsqu'une page remplit l'écran, sa valeur de position est 0. Lorsqu'une page est dessinée juste à côté du côté droit de l'écran, sa valeur de position est 1. Si l'utilisateur fait défiler la page à mi-chemin entre les pages 1 et 2, la page 1 a une position de -0,5 et la page 2 une position de 0,5. En fonction de la position des pages à l'écran, vous pouvez créer des animations de diapositives personnalisées en définissant les propriétés de la page à l'aide de méthodes telles que setAlpha(), setTranslationX() ou setScaleY().

Lorsque vous avez une implémentation d'un PageTransformer, appelez setPageTransformer() avec votre implémentation pour appliquer vos animations personnalisées. Par exemple, si vous disposez d'un PageTransformer nommé ZoomOutPageTransformer, vous pouvez définir vos animations personnalisées comme suit :

Kotlin

val mPager: ViewPager = findViewById(R.id.pager)
...
mPager.setPageTransformer(true, ZoomOutPageTransformer())

Java

ViewPager mPager = (ViewPager) findViewById(R.id.pager);
...
mPager.setPageTransformer(true, new ZoomOutPageTransformer());

Consultez les sections Transformateur de page de zoom arrière et Transformateur de page de profondeur pour obtenir des exemples et des vidéos d'un PageTransformer.

Transformateur de page de zoom arrière

Ce transformateur de page réduit et estompe les pages lorsque vous faites défiler les pages adjacentes. À mesure qu'une page se rapproche du centre, elle retrouve sa taille normale et s'affiche progressivement.

Exemple ZoomOutPageTransformer
 

Kotlin

private const val MIN_SCALE = 0.85f
private const val MIN_ALPHA = 0.5f

class ZoomOutPageTransformer : ViewPager.PageTransformer {

    override fun transformPage(view: View, position: Float) {
        view.apply {
            val pageWidth = width
            val pageHeight = height
            when {
                position < -1 -> { // [-Infinity,-1)
                    // This page is way off-screen to the left.
                    alpha = 0f
                }
                position <= 1 -> { // [-1,1]
                    // Modify the default slide transition to shrink the page as well
                    val scaleFactor = Math.max(MIN_SCALE, 1 - Math.abs(position))
                    val vertMargin = pageHeight * (1 - scaleFactor) / 2
                    val horzMargin = pageWidth * (1 - scaleFactor) / 2
                    translationX = if (position < 0) {
                        horzMargin - vertMargin / 2
                    } else {
                        horzMargin + vertMargin / 2
                    }

                    // Scale the page down (between MIN_SCALE and 1)
                    scaleX = scaleFactor
                    scaleY = scaleFactor

                    // Fade the page relative to its size.
                    alpha = (MIN_ALPHA +
                            (((scaleFactor - MIN_SCALE) / (1 - MIN_SCALE)) * (1 - MIN_ALPHA)))
                }
                else -> { // (1,+Infinity]
                    // This page is way off-screen to the right.
                    alpha = 0f
                }
            }
        }
    }
}

Java

public class ZoomOutPageTransformer implements ViewPager.PageTransformer {
    private static final float MIN_SCALE = 0.85f;
    private static final float MIN_ALPHA = 0.5f;

    public void transformPage(View view, float position) {
        int pageWidth = view.getWidth();
        int pageHeight = view.getHeight();

        if (position < -1) { // [-Infinity,-1)
            // This page is way off-screen to the left.
            view.setAlpha(0f);

        } else if (position <= 1) { // [-1,1]
            // Modify the default slide transition to shrink the page as well
            float scaleFactor = Math.max(MIN_SCALE, 1 - Math.abs(position));
            float vertMargin = pageHeight * (1 - scaleFactor) / 2;
            float horzMargin = pageWidth * (1 - scaleFactor) / 2;
            if (position < 0) {
                view.setTranslationX(horzMargin - vertMargin / 2);
            } else {
                view.setTranslationX(-horzMargin + vertMargin / 2);
            }

            // Scale the page down (between MIN_SCALE and 1)
            view.setScaleX(scaleFactor);
            view.setScaleY(scaleFactor);

            // Fade the page relative to its size.
            view.setAlpha(MIN_ALPHA +
                    (scaleFactor - MIN_SCALE) /
                    (1 - MIN_SCALE) * (1 - MIN_ALPHA));

        } else { // (1,+Infinity]
            // This page is way off-screen to the right.
            view.setAlpha(0f);
        }
    }
}

Transformateur de page de profondeur

Ce transformateur de page utilise l'animation de diapositive par défaut pour les pages qui glissent vers la gauche, et une animation de "profondeur" pour les pages qui glissent vers la droite. Cette animation de profondeur fait disparaître la page en fondu et la réduit de manière linéaire.

Exemple d'utilisation de DepthPageTransformer
 

Pendant l'animation de profondeur, l'animation par défaut (un glissement d'écran) a toujours lieu. Vous devez donc contrecarrer le glissement d'écran avec une translation X négative. Exemple :

Kotlin

view.translationX = -1 * view.width * position

Java

view.setTranslationX(-1 * view.getWidth() * position);

L'exemple suivant montre comment contrebalancer l'animation de diapositive d'écran par défaut dans un transformateur de page fonctionnel:

Kotlin

private const val MIN_SCALE = 0.75f

class DepthPageTransformer : ViewPager.PageTransformer {

    override fun transformPage(view: View, position: Float) {
        view.apply {
            val pageWidth = width
            when {
                position < -1 -> { // [-Infinity,-1)
                    // This page is way off-screen to the left.
                    alpha = 0f
                }
                position <= 0 -> { // [-1,0]
                    // Use the default slide transition when moving to the left page
                    alpha = 1f
                    translationX = 0f
                    scaleX = 1f
                    scaleY = 1f
                }
                position <= 1 -> { // (0,1]
                    // Fade the page out.
                    alpha = 1 - position

                    // Counteract the default slide transition
                    translationX = pageWidth * -position

                    // Scale the page down (between MIN_SCALE and 1)
                    val scaleFactor = (MIN_SCALE + (1 - MIN_SCALE) * (1 - Math.abs(position)))
                    scaleX = scaleFactor
                    scaleY = scaleFactor
                }
                else -> { // (1,+Infinity]
                    // This page is way off-screen to the right.
                    alpha = 0f
                }
            }
        }
    }
}

Java

public class DepthPageTransformer implements ViewPager.PageTransformer {
    private static final float MIN_SCALE = 0.75f;

    public void transformPage(View view, float position) {
        int pageWidth = view.getWidth();

        if (position < -1) { // [-Infinity,-1)
            // This page is way off-screen to the left.
            view.setAlpha(0f);

        } else if (position <= 0) { // [-1,0]
            // Use the default slide transition when moving to the left page
            view.setAlpha(1f);
            view.setTranslationX(0f);
            view.setScaleX(1f);
            view.setScaleY(1f);

        } else if (position <= 1) { // (0,1]
            // Fade the page out.
            view.setAlpha(1 - position);

            // Counteract the default slide transition
            view.setTranslationX(pageWidth * -position);

            // Scale the page down (between MIN_SCALE and 1)
            float scaleFactor = MIN_SCALE
                    + (1 - MIN_SCALE) * (1 - Math.abs(position));
            view.setScaleX(scaleFactor);
            view.setScaleY(scaleFactor);

        } else { // (1,+Infinity]
            // This page is way off-screen to the right.
            view.setAlpha(0f);
        }
    }
}