AndroidのLinearLayoutManagerでRecyclerViewを最上部までスクロールする方法

はじめに：AndroidにおけるRecyclerViewとは

具体例に入る前に、まずAndroidのRecyclerViewについて簡単に確認しておきましょう。RecyclerViewはListViewの進化版にあたるUIコンポーネントで、ViewHolderデザインパターンに基づいて動作します。RecyclerViewを使うことで、グリッド形式やリスト形式のアイテムを効率よく表示できます。

本記事では、学生の名前と年齢を一覧表示するサンプルアプリを作成しながら、LinearLayoutManagerを使用したRecyclerViewで特定の位置（最上部）へスクロールする方法を解説します。

実装手順

ステップ1：新規プロジェクトの作成

Android Studioで新しいプロジェクトを作成します。メニューから「File」→「New Project」を選択し、必要な情報を入力してプロジェクトを作成してください。

ステップ2：build.gradleに依存関係を追加

build.gradleファイルを開き、RecyclerViewとCardViewのライブラリ依存関係を追加します。

apply plugin: 'com.android.application'

android {
    compileSdkVersion 28
    defaultConfig {
        applicationId "com.example.andy.tutorialspoint"
        minSdkVersion 19
        targetSdkVersion 28
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'com.android.support:appcompat-v7:28.0.0'
    implementation 'com.android.support:design:28.0.0'
    implementation 'com.android.support.constraint:constraint-layout:1.1.3'
    implementation 'com.android.support:cardview-v7:28.0.0'
    implementation 'com.android.support:recyclerview-v7:28.0.0'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}

ステップ3：activity_main.xmlにレイアウトを記述

res/layout/activity_main.xml に以下のコードを追加します。

<?xml version = "1.0" encoding = "utf-8"?>
<android.support.design.widget.CoordinatorLayout
    xmlns:android = "https://schemas.android.com/apk/res/android"
    xmlns:tools = "https://schemas.android.com/tools"
    xmlns:app = "https://schemas.android.com/apk/res-auto"
    android:layout_width = "match_parent"
    android:layout_height = "match_parent"
    app:layout_behavior = "@string/appbar_scrolling_view_behavior"
    tools:showIn = "@layout/activity_main"
    android:fitsSystemWindows = "true"
    tools:context = ".MainActivity">
    <android.support.v7.widget.RecyclerView
        android:id = "@+id/recycler_view"
        android:layout_width = "match_parent"
        android:layout_height = "wrap_content"
        android:scrollbars = "horizontal" />
    <android.support.design.widget.FloatingActionButton
        android:id = "@+id/top"
        app:backgroundTint = "#FFFF00"
        android:layout_width = "wrap_content"
        android:layout_height = "wrap_content"
        android:layout_gravity = "bottom|end"
        android:src = "@android:drawable/arrow_up_float" />
</android.support.design.widget.CoordinatorLayout >

上記のコードでは、親レイアウトとしてCoordinatorLayoutを使用し、その中にRecyclerViewとFloatingActionButtonを配置しています。FloatingActionButtonはCoordinatorLayoutとの相性が良いため、この構成を採用しました。ボタンをタップすると、RecyclerViewが最上部までスクロールする仕組みです。

ステップ4：MainActivity.javaにコードを追加

src/MainActivity.java に以下のコードを記述します。

package com.example.andy.tutorialspoint;

import android.annotation.TargetApi;
import android.os.Build;
import android.os.Bundle;
import android.support.annotation.RequiresApi;
import android.support.design.widget.FloatingActionButton;
import android.support.v7.app.AppCompatActivity;
import android.support.v7.widget.DividerItemDecoration;
import android.support.v7.widget.GridLayoutManager;
import android.support.v7.widget.LinearLayoutManager;
import android.support.v7.widget.RecyclerView;
import android.view.View;
import android.widget.Button;
import android.widget.LinearLayout;
import android.widget.Toast;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

public class MainActivity extends AppCompatActivity {
    private RecyclerView recyclerView;
    private StudentAdapter studentAdapter;
    private List studentDataList = new ArrayList<>();
    @TargetApi(Build.VERSION_CODES.O)
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        FloatingActionButton moveTop = findViewById(R.id.top);
        recyclerView = findViewById(R.id.recycler_view);
        studentAdapter = new StudentAdapter(studentDataList,MainActivity.this);
        RecyclerView.LayoutManager manager = new LinearLayoutManager(this);
        recyclerView.setLayoutManager(manager);
        recyclerView.setAdapter(studentAdapter);
        StudentDataPrepare();
        moveTop.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                recyclerView.smoothScrollToPosition(0);
            }
        });
    }
    @RequiresApi(api = Build.VERSION_CODES.N)
    private void StudentDataPrepare() {
        studentData data = new studentData("sai", 25);
        studentDataList.add(data);
        data = new studentData("sai raj", 25);
        studentDataList.add(data);
        data = new studentData("raghu", 20);
        studentDataList.add(data);
        data = new studentData("raj", 28);
        studentDataList.add(data);
        data = new studentData("amar", 15);
        studentDataList.add(data);
        data = new studentData("bapu", 19);
        studentDataList.add(data);
        data = new studentData("chandra", 52);
        studentDataList.add(data);
        data = new studentData("deraj", 30);
        studentDataList.add(data);
        data = new studentData("eshanth", 28);
        studentDataList.add(data);
        Collections.sort(studentDataList, new Comparator() {
            @Override
            public int compare(studentData o1, studentData o2) {
                return o1.name.compareTo(o2.name);
            }
        });
    }
}

上記のコードでは、RecyclerViewとStudentAdapterをセットアップしています。アダプターには学生データ（名前と年齢）を格納したArrayListを渡しています。

スクロール処理のポイントは smoothScrollToPosition() メソッドです。引数に指定した位置へスムーズにスクロールでき、0番目（最上部）以外にも任意の位置を指定できます。今回の例では、黄色いボタンをタップすると最上部（位置0）へスクロールします。

moveTop.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        recyclerView.smoothScrollToPosition(0);
    }
});

ステップ5：StudentAdapter.javaの作成

src/StudentAdapter.java を以下のように作成します。

package com.example.andy.tutorialspoint;
import android.graphics.Color;
import android.support.annotation.NonNull;
import android.support.v7.widget.RecyclerView;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.LinearLayout;
import android.widget.TextView;

import java.util.List;
import java.util.Random;

class StudentAdapter extends RecyclerView.Adapter {
    List studentDataList;
    public StudentAdapter(List studentDataList) {
        this.studentDataList = studentDataList;
    }
    @NonNull
    @Override
    public MyViewHolder onCreateViewHolder(@NonNull ViewGroup viewGroup, int i) {
        View itemView = LayoutInflater.from(viewGroup.getContext())
        .inflate(R.layout.student_list_row, viewGroup, false);
        return new MyViewHolder(itemView);
    }
    @Override
    public void onBindViewHolder(MyViewHolder viewHolder, int i) {
        studentData data = studentDataList.get(i);
        Random rnd = new Random();
        int currentColor = Color.argb(255, rnd.nextInt(256), rnd.nextInt(256), rnd.nextInt(256));
        viewHolder.parent.setBackgroundColor(currentColor);
        viewHolder.name.setText(data.name);
        viewHolder.age.setText(String.valueOf(data.age));
    }
    @Override
    public int getItemCount() {
        return studentDataList.size();
    }
    class MyViewHolder extends RecyclerView.ViewHolder {
        TextView name,age;
        LinearLayout parent;
        public MyViewHolder(View itemView) {
            super(itemView);
            parent = itemView.findViewById(R.id.parent);
            name = itemView.findViewById(R.id.name);
            age = itemView.findViewById(R.id.age);
        }
    }
}

アダプタークラスには主に以下の4つの要素が含まれています。

• onCreateViewHolder()：ViewHolderを生成し、Viewを返すメソッドです。
• onBindViewHolder()：生成されたViewHolderにデータをバインド（紐付け）します。
• getItemCount()：リストのサイズ（表示件数）を返します。
• MyViewHolderクラス：RecyclerView.ViewHolderを継承した内部クラスで、各Viewへの参照を保持します。

また、RecyclerViewの各アイテムにランダムな背景色を設定するため、Randomクラス（Androidに標準搭載されているクラス）でランダムな色を生成し、アイテムの親ビューに適用しています。

Random rnd = new Random();
int currentColor = Color.argb(255, rnd.nextInt(256), rnd.nextInt(256), rnd.nextInt(256));
viewHolder.parent.setBackgroundColor(currentColor);

ステップ6：student_list_row.xmlの作成

res/layout/student_list_row.xml を以下のように作成します。

<?xml version = "1.0" encoding = "utf-8"?>
<android.support.v7.widget.CardView xmlns:android = "https://schemas.android.com/apk/res/android"
    xmlns:card_view = "https://schemas.android.com/apk/res-auto"
    android:layout_width = "match_parent"
    card_view:cardCornerRadius = "4dp"
    android:id = "@+id/card_view"
    android:layout_margin = "10dp"
    android:layout_height = "200dp">
    <LinearLayout
        android:id = "@+id/parent"
        android:layout_gravity = "center"
        android:layout_width = "match_parent"
        android:orientation = "vertical"
        android:gravity = "center"
        android:layout_height = "match_parent">
    <TextView
        android:id = "@+id/name"
        android:layout_width = "wrap_content"
        android:gravity = "center"
        android:textSize = "25sp"
        android:textColor = "#FFF"
        android:layout_height = "wrap_content" />
    <TextView
        android:id = "@+id/age"
        android:layout_width = "wrap_content"
        android:gravity = "center"
        android:textSize = "25sp"
        android:textColor = "#FFF"
        android:layout_height = "wrap_content" />
    </LinearLayout>
</android.support.v7.widget.CardView>

このリストアイテムのビューでは、CardViewの中に名前と年齢を表示する2つのTextViewを配置しています。CardViewには角丸や影などのプロパティが標準で用意されているため、ここでは角丸（cardCornerRadius）を活用しています。

ステップ7：studentData.javaの作成

src/studentData.java は以下の通りです。

class studentData {  
    String name;
    int age;
    public studentData(String name, int age) {
        this.name = name;
        this.age = age;
    }
}

このクラスは学生データ（名前・年齢）を保持するデータオブジェクトです。

アプリの実行と動作確認

それではアプリを実行してみましょう。実機のAndroidスマートフォンをPCに接続していることを前提に説明します。Android Studioでプロジェクト内の任意のアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックしてください。デバイスを選択して実行すると、端末に初期画面が表示されます。

次に、画面下部の黄色いボタンをタップしてみてください。RecyclerViewが滑らかに最上部までスクロールし、以下のような結果が得られます。

まとめ

このように、smoothScrollToPosition(0) を呼び出すだけで、LinearLayoutManagerを使用したRecyclerViewを簡単に最上部までスクロールできます。チャットアプリの「最新メッセージへ移動」ボタンや、長いリストの「先頭へ戻る」機能など、さまざまな場面で応用できるテクニックなので、ぜひ覚えておきましょう。