Mit ViewPager2 zwischen Fragmenten wechseln

Schreiben Sie jetzt
Jetpack Compose ist das empfohlene UI-Toolkit für Android. Weitere Informationen zur Verwendung von Pager in Compose
Pager →

Bildschirmfolien sind Übergänge von einem ganzen Bildschirm zum anderen und werden häufig bei Benutzeroberflächen wie Einrichtungsassistenten und Bildschirmpräsentationen verwendet. In diesem Thema erfahren Sie, wie Sie Bildschirmfolien mit einem ViewPager2-Objekt erstellen. ViewPager2-Objekte können Bildschirmfolien automatisch animieren. Hier ist ein Beispiel für eine Bildschirmfolie, die von einem Bildschirm mit Inhalt zum nächsten wechselt:

Abbildung 1: Bildschirmfolienanimation.
 

Wenn Sie gleich ein vollständiges funktionierendes Beispiel sehen möchten, können Sie sich diese Beispielanwendung auf GitHub ansehen.

Wenn Sie ViewPager2 verwenden möchten, müssen Sie Ihrem Projekt einige AndroidX-Abhängigkeiten hinzufügen. Führen Sie dann die in den folgenden Abschnitten beschriebenen Schritte aus.

Ansichten erstellen

Erstellen Sie eine Layoutdatei, die später für den Inhalt eines Fragments verwendet werden soll. Außerdem müssen Sie einen String für den Inhalt des Fragments definieren. Das folgende Beispiel enthält eine Textansicht, die etwas Text anzeigt:

<!-- 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>

Fragment erstellen

Erstellen Sie eine Fragment-Klasse, die das Layout zurückgibt, das Sie mit der Methode onCreateView() erstellt haben. Wenn Sie dem Nutzer eine neue Seite anzeigen möchten, können Sie dann Instanzen dieses Fragments in der übergeordneten Aktivität erstellen:

Kotlin

import androidx.fragment.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 androidx.fragment.app.Fragment;
...
public class ScreenSlidePageFragment extends Fragment {

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

ViewPager2 hinzufügen

ViewPager2-Objekte haben integrierte Wischgesten für den Wechsel zwischen Seiten. Außerdem werden standardmäßig Folienanimationen auf dem Bildschirm angezeigt, sodass Sie keine eigene Animation erstellen müssen. ViewPager2 verwendet FragmentStateAdapter-Objekte als Bereitstellung für neue Seiten, die angezeigt werden sollen. Für FragmentStateAdapter wird also die von dir erstellte Fragmentklasse verwendet.

Erstellen Sie zuerst ein Layout, das ein ViewPager2-Objekt enthält:

<!-- activity_screen_slide.xml -->
<androidx.viewpager2.widget.ViewPager2
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/pager"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

Erstellen Sie eine Aktivität mit folgenden Eigenschaften:

  • Legt das Layout mit ViewPager2 als Inhaltsansicht fest.
  • Erstellt eine Klasse, die die abstrakte Klasse FragmentStateAdapter erweitert und die Methode createFragment() implementiert, um Instanzen von ScreenSlidePageFragment als neue Seiten bereitzustellen. Sie müssen die Methode getItemCount() für den Pager-Adapter implementieren, die die Anzahl der vom Adapter erstellten Seiten zurückgibt. Im Beispiel gibt es fünf.
  • Verbindet FragmentStateAdapter mit den ViewPager2-Objekten.

Kotlin

import androidx.fragment.app.Fragment
import androidx.fragment.app.FragmentActivity
...
/**
 * 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 viewPager: ViewPager2

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

        // Instantiate a ViewPager2 and a PagerAdapter.
        viewPager = findViewById(R.id.pager)

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

    override fun onBackPressed() {
        if (viewPager.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.
            viewPager.currentItem = viewPager.currentItem - 1
        }
    }

    /**
     * A simple pager adapter that represents 5 ScreenSlidePageFragment objects, in
     * sequence.
     */
    private inner class ScreenSlidePagerAdapter(fa: FragmentActivity) : FragmentStateAdapter(fa) {
        override fun getItemCount(): Int = NUM_PAGES

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

Java

import androidx.fragment.app.Fragment;
import androidx.fragment.app.FragmentActivity;
...
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 ViewPager2 viewPager;

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

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

        // Instantiate a ViewPager2 and a PagerAdapter.
        viewPager = findViewById(R.id.pager);
        pagerAdapter = new ScreenSlidePagerAdapter(this);
        viewPager.setAdapter(pagerAdapter);
    }

    @Override
    public void onBackPressed() {
        if (viewPager.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.
            viewPager.setCurrentItem(viewPager.getCurrentItem() - 1);
        }
    }

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

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

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

Animation mit PageTransformer anpassen

Wenn eine andere Animation als die standardmäßige Bildschirmfolienanimation angezeigt werden soll, müssen Sie die ViewPager2.PageTransformer-Oberfläche implementieren und dem ViewPager2-Objekt hinzufügen. Die Schnittstelle stellt die Methode transformPage() zur Verfügung. An jedem Punkt des Bildschirmübergangs wird diese Methode einmal für jede sichtbare Seite – normalerweise nur eine sichtbare Seite – und für benachbarte Seiten außerhalb des Bildschirms aufgerufen. Wenn beispielsweise Seite 3 sichtbar ist und der Nutzer zu Seite 4 zieht, wird bei jedem Schritt der Geste transformPage() für die Seiten 2, 3 und 4 aufgerufen.

In der Implementierung von transformPage() können Sie dann benutzerdefinierte Folienanimationen erstellen. Dazu legen Sie fest, welche Seiten basierend auf der Position der Seite auf dem Bildschirm umgewandelt werden müssen. Rufen Sie die Seitenposition aus dem Parameter position der Methode transformPage() ab.

Der Parameter position gibt an, wo sich eine bestimmte Seite relativ zur Bildschirmmitte befindet. Dieser Parameter ist eine dynamische Eigenschaft, die sich ändert, wenn der Nutzer durch eine Reihe von Seiten scrollt. Wenn eine Seite den Bildschirm ausfüllt, hat der Positionswert 0. Wenn eine Seite über die rechte Seite des Bildschirms hinaus gezeichnet wird, ist der Positionswert 1. Scrollt er halb zwischen den Seiten 1 und 2, hat Seite 1 die Position -0.5 und Seite 2 die Position 0.5. Je nach Position der Seiten auf dem Bildschirm können Sie benutzerdefinierte Folienanimationen erstellen. Dazu legen Sie Seiteneigenschaften mit Methoden wie setAlpha(), setTranslationX() oder setScaleY() fest.

Wenn du eine PageTransformer-Implementierung hast, rufe setPageTransformer() mit deiner Implementierung auf, um deine benutzerdefinierten Animationen anzuwenden. Wenn Sie beispielsweise eine PageTransformer namens ZoomOutPageTransformer haben, können Sie Ihre benutzerdefinierten Animationen so festlegen:

Kotlin

val viewPager: ViewPager2 = findViewById(R.id.pager)
...
viewPager.setPageTransformer(ZoomOutPageTransformer())

Java

ViewPager2 viewPager = findViewById(R.id.pager);
...
viewPager.setPageTransformer(new ZoomOutPageTransformer());

Beispiele für eine PageTransformer finden Sie in den Abschnitten Seitentransformator zum Herauszoomen und Tiefenseitentransformator.

Seitentransformator zum Herauszoomen

Mit diesem Page Transformer werden Seiten beim Scrollen zwischen benachbarten Seiten verkleinert und ausgeblendet. Sobald sich eine Seite der Mitte nähert, nimmt sie ihre normale Größe an und verblasst.

Abbildung 2: Beispiel für ZoomOutPageTransformer.
 

Kotlin

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

class ZoomOutPageTransformer : ViewPager2.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 ViewPager2.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);
        }
    }
}

Tiefenseiten-Transformator

Dieser Page Transformer verwendet die Standardfolienanimation, um Seiten nach links zu verschieben, und eine „Tiefe“-Animation, um Seiten nach rechts zu verschieben. Diese Tiefenanimation blendet die Seite aus und skaliert sie linear herunter.

Abbildung 3: Beispiel für DepthPageTransformer.
 

Während der Tiefenanimation findet weiterhin die Standardanimation (eine Bildschirmfolie) statt. Sie müssen der Bildschirmfolie also eine negative X-Verschiebung entgegenwirken. Beispiel:

Kotlin

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

Java

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

Das folgende Beispiel zeigt, wie Sie der standardmäßigen Bildschirmfolienanimation in einem funktionierenden Page Transformer umgehen können:

Kotlin

private const val MIN_SCALE = 0.75f

@RequiresApi(21)
class DepthPageTransformer : ViewPager2.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
                    translationZ = 0f
                    scaleX = 1f
                    scaleY = 1f
                }
                position <= 1 -> { // (0,1]
                    // Fade the page out.
                    alpha = 1 - position

                    // Counteract the default slide transition.
                    translationX = pageWidth * -position
                    // Move it behind the left page.
                    translationZ = -1f

                    // 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

@RequiresApi(21)
public class DepthPageTransformer implements ViewPager2.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.setTranslationZ(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);
            // Move it behind the left page
            view.setTranslationZ(-1f);

            // 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);
        }
    }
}

Zusätzliche Ressourcen

Weitere Informationen zu ViewPager2 finden Sie in den folgenden zusätzlichen Ressourcen.

Produktproben

Videos