【Android】LinearLayoutManagerを使ってRecyclerViewを先頭までスクロールする方法

本記事では、Androidアプリ開発において、LinearLayoutManagerとFloatingActionButtonを組み合わせてRecyclerViewを先頭までスクロールさせる方法を、学生の名前と年齢を一覧表示するシンプルな学生名簿アプリの作成を通して解説します。

RecyclerViewとは

RecyclerViewは、AndroidのListViewをより高度に進化させたUIコンポーネントです。ViewHolderデザインパターンに基づいて動作し、大量のデータを効率的に描画できます。RecyclerViewを利用することで、リスト形式やグリッド形式のアイテムを柔軟に表示することが可能です。

手順1：新しいプロジェクトを作成する

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

手順2：ライブラリの依存関係を追加する

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：メインレイアウトを編集する

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との相性が良いため、親レイアウトにはCoordinatorLayoutを採用しました。FloatingActionButtonをタップすると、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を設定しています。アダプターには学生データのリスト（studentDataList）をArrayListとして渡しており、このリストには学生の名前と年齢が格納されています。

スクロールにはsmoothScrollToPosition()メソッドを使用しています。引数には任意のポジションを指定できるため、要件に応じて好きな位置にスクロールさせることが可能です。この例では、先頭（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<StudentAdapter.MyViewHolder> {
   List<studentData> studentDataList;
   public StudentAdapter(List<studentData> 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を継承した、ViewHolderのインナークラスです。

RecyclerViewの各アイテムにランダムな背景色を設定するため、Androidに標準で用意されているRandomクラスを使ってランダムな色を生成し、アイテムの親レイアウトに適用しています。該当するコードは以下の通りです。

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

手順6：リストアイテムのレイアウトを作成する

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の内容は以下の通りです。

package com.example.andy.tutorialspoint;
class studentData {
   String name;
   int age;
   public studentData(String name, int age) {
      this.name=name;
      this.age=age;
   }
}

上記のコードは、学生の名前と年齢を保持するデータオブジェクトクラスです。

アプリの実行

それでは、アプリを実行してみましょう。Androidの実機をPCに接続していることを前提とします。Android Studioからアプリを実行するには、プロジェクトのアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。実行する端末を選択すると、接続したモバイル端末に以下のような初期画面が表示されます。

黄色いボタンをタップすると、RecyclerViewが先頭までスムーズにスクロールし、以下のように結果が表示されます。