ViewPager2 を使用してフラグメント間をスライドする

Compose を試す

Jetpack Compose は Android で推奨される UI ツールキットです。Compose で Pager を使用する方法について学習します。

ポケベル →

画面スライドは、ある画面から別の画面への移行であり、設定ウィザードやスライドショーなどの UI でよく使用されます。このトピックでは、ViewPager2 オブジェクトを使用して画面スライドを行う方法について説明します。ViewPager2 オブジェクトを使用すると、画面スライドを自動的にアニメーション化できます。ある画面から次のコンテンツ画面に遷移する画面スライドの例を次に示します。

図 1. 画面スライドのアニメーション。

 

完全に機能する例については、GitHub のサンプルアプリを表示してください。

注: アプリですでに ViewPager を使用している場合は、ViewPager から ViewPager2 に移行するをご覧ください。

ViewPager2 を使用するには、プロジェクトに AndroidX 依存関係を追加する必要があります。その後、次のセクションで説明する手順を行います。

ビューを作成する

後でフラグメントのコンテンツに使用するレイアウト ファイルを作成します。また、フラグメントのコンテンツを示す文字列を定義する必要があります。次のサンプルには、テキストを表示するテキストビューが含まれています。

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

フラグメントを作成する

onCreateView() メソッドで作成したレイアウトを返す Fragment クラスを作成します。その後、ユーザーに表示する新しいページが必要になったときに、親アクティビティ内にこのフラグメントのインスタンスを作成します。

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 を追加する

ViewPager2 オブジェクトには、ページ間を移動するためのスワイプ操作が組み込まれており、デフォルトで画面スライド アニメーションが表示されるため、独自のアニメーションを作成する必要はありません。ViewPager2 は、表示する新しいページの供給源として FragmentStateAdapter オブジェクトを使用するため、FragmentStateAdapter は作成したフラグメント クラスを使用します。

まず、ViewPager2 オブジェクトを含むレイアウトを作成します。

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

次の処理を行うアクティビティを作成します。

• ViewPager2 を使用して、レイアウト用のコンテンツ ビューを設定します。
• FragmentStateAdapter 抽象クラスを拡張するクラスを作成し、createFragment() メソッドを実装して、ScreenSlidePageFragment のインスタンスを新しいページとして提供します。ページャー アダプターには、アダプターが作成するページ数を返す getItemCount() メソッドを実装する必要があります。この例では 5 個あります。
• FragmentStateAdapter を ViewPager2 オブジェクトに接続します。

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

PageTransformer を使用してアニメーションをカスタマイズする

デフォルトの画面スライド アニメーションとは異なるアニメーションを表示するには、ViewPager2.PageTransformer インターフェースを実装して ViewPager2 オブジェクトに渡します。このインターフェースは、単一のメソッド transformPage() を公開します。このメソッドは、画面遷移の各ポイントで、表示されるページ（通常は表示されるページは 1 つだけ）と画面外の隣接ページに対して 1 回呼び出されます。たとえば、ページ 3 が表示されている状態でユーザーが 4 ページ目にドラッグすると、操作の各ステップでページ 2、3、4 に対して transformPage() が呼び出されます。

transformPage() の実装で、画面上のページの位置に基づいて変換が必要なページを決定することで、カスタム スライド アニメーションを作成できます。ページ位置は、transformPage() メソッドの position パラメータから取得します。

position パラメータは、画面の中心を基準とした相対位置で特定のページの位置を示します。このパラメータは、ユーザーが一連のページをスクロールすると変化する動的プロパティです。ページが画面全体に表示されると、その位置の値は 0 になります。ページが画面の右側外に描画される場合、その位置の値は 1 になります。ユーザーが 1 ページ目と 2 ページ目の間を途中までスクロールした場合、1 ページ目の位置は -0.5、2 ページ目の位置は 0.5 になります。画面上のページの位置に基づいて、setAlpha()、setTranslationX()、setScaleY() などのメソッドでページ プロパティを設定することで、カスタム スライド アニメーションを作成できます。

PageTransformer を実装している場合は、その実装を使用して setPageTransformer() を呼び出して、カスタム アニメーションを適用します。たとえば、ZoomOutPageTransformer という名前の PageTransformer がある場合、カスタム アニメーションを次のように設定できます。

Kotlin

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

Java

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

PageTransformer の例については、ズームアウト ページ トランスフォーマーと奥行きページ トランスフォーマーのセクションをご覧ください。

ズームアウト ページ トランスフォーマー

このページ トランスフォーマーは、隣接するページ間をスクロールするときにページを縮小またはフェードします。ページが中央に近づくと、通常のサイズに戻り、フェードインします。

図 2. 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);
        }
    }
}

奥行きページ トランスフォーマー

このページ トランスフォーマーでは、ページを左にスライドする場合はデフォルトのスライド アニメーションを使用し、ページを右にスライドする場合は「深度」アニメーションを使用します。この奥行きアニメーションは、ページをフェードアウトし、線形にスケールダウンします。

図 3. DepthPageTransformer の例。

 

奥行きアニメーションの最中もデフォルトのアニメーション（画面スライド）は引き続き行われるため、マイナスの X 変換で画面スライドを相殺する必要があります。次に例を示します。

Kotlin

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

Java

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

次の例は、動作中のページ トランスフォーマーでデフォルトの画面スライド アニメーションを無効にする方法を示しています。

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

参考情報

ViewPager2 の詳細については、以下の参考リンクをご覧ください。

サンプル

• ViewPager2 サンプル（GitHub）

動画

• ページをめくる: ViewPager2 への移行（Android Dev Summit 2019）