KotlinでAndroidの横スクロールListViewを作成する方法【RecyclerView活用】

このチュートリアルでは、Kotlinを使ってAndroidアプリに横方向にスクロールできるListViewを実装する方法を、サンプルコード付きで段階的に解説します。

現在のAndroid開発では、従来のListViewの代わりにRecyclerViewを使うのが主流です。LinearLayoutManagerの向きをHORIZONTALに設定するだけで、簡単に横スクロールのリストを実現できます。ここでは、映画のタイトル・ジャンル・公開年の一覧を横方向に表示するサンプルアプリを題材にします。

ステップ1：新規プロジェクトを作成する

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

ステップ2：activity_main.xml を編集する

res/layout/activity_main.xml に以下のコードを追加します。画面全体にRecyclerViewを配置するシンプルな縦方向のレイアウトです。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
   android:id="@+id/rlMain"
   android:layout_width="match_parent"
   android:layout_height="match_parent"
   android:layout_margin="16dp"
   android:orientation="vertical">
   <androidx.recyclerview.widget.RecyclerView
      android:id="@+id/recyclerView"
      android:layout_width="match_parent"
      android:layout_height="match_parent" />
</LinearLayout>

ステップ3：MainActivity.kt を実装する

src/MainActivity.kt に以下のコードを追加します。ポイントは mLayoutManager.orientation = LinearLayoutManager.HORIZONTAL の部分です。これにより、RecyclerViewの項目が縦ではなく横方向に並ぶようになります。

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import androidx.recyclerview.widget.DefaultItemAnimator
import androidx.recyclerview.widget.LinearLayoutManager
import androidx.recyclerview.widget.RecyclerView
import java.util.ArrayList
class MainActivity : AppCompatActivity() {
   private val movieList = ArrayList<MovieModel>()
   private lateinit var moviesAdapter: MoviesAdapter
   override fun onCreate(savedInstanceState: Bundle?) {
      super.onCreate(savedInstanceState)
      setContentView(R.layout.activity_main)
      title = "KotlinApp"
      val recyclerView = findViewById<RecyclerView>(R.id.recyclerView)
      moviesAdapter = MoviesAdapter(movieList)
      val mLayoutManager = LinearLayoutManager(applicationContext)
      mLayoutManager.orientation = LinearLayoutManager.HORIZONTAL
      recyclerView.layoutManager = mLayoutManager
      recyclerView.itemAnimator = DefaultItemAnimator()
      recyclerView.adapter = moviesAdapter
      prepareMovieData()
   }
   private fun prepareMovieData() {
      var movie = MovieModel("Mad Max: Fury Road", "Action & Adventure", "2015")
      movieList.add(movie)
      movie = MovieModel("Inside Out", "Animation, Kids & Family", "2015")
      movieList.add(movie)
      movie = MovieModel("Star Wars: Episode VII - The Force Awakens", "Action", "2015")
      movieList.add(movie)
      movie = MovieModel("Shaun the Sheep", "Animation", "2015")
      movieList.add(movie)
      movie = MovieModel("The Martian", "Science Fiction & Fantasy", "2015")
      movieList.add(movie)
      movie = MovieModel("Mission: Impossible Rogue Nation", "Action", "2015")
      movieList.add(movie)
      movie = MovieModel("Up", "Animation", "2009")
      movieList.add(movie)
      movie = MovieModel("Star Trek", "Science Fiction", "2009")
      movieList.add(movie)
      movie = MovieModel("The LEGO MovieModel", "Animation", "2014")
      movieList.add(movie)
      movie = MovieModel("Iron Man", "Action & Adventure", "2008")
      movieList.add(movie)
      movie = MovieModel("Aliens", "Science Fiction", "1986")
      movieList.add(movie)
      movie = MovieModel("Chicken Run", "Animation", "2000")
      movieList.add(movie)
      movie = MovieModel("Back to the Future", "Science Fiction", "1985")
      movieList.add(movie)
      movie = MovieModel("Raiders of the Lost Ark", "Action & Adventure", "1981")
      movieList.add(movie)
      movie = MovieModel("Goldfinger", "Action & Adventure", "1965")
      movieList.add(movie)
      movie = MovieModel("Guardians of the Galaxy", "Science Fiction & Fantasy", "2014")
      movieList.add(movie)
      moviesAdapter.notifyDataSetChanged()
   }
}

ステップ4：データモデルクラスを作成する

新しいクラス MovieModel.kt を作成し、以下のコードを追加します。映画のタイトル・ジャンル・公開年という3つの情報を保持する、シンプルなデータモデルクラスです。

class MovieModel(title: String?, genre: String?, year: String?) {
   private var title: String
   private var genre: String
   private var year: String
   init {
      this.title = title!!
      this.genre = genre!!
      this.year = year!!
   }
   fun getTitle(): String? {
      return title
   }
   fun setTitle(name: String?) {
      title = name!!
   }
   fun getYear(): String? {
      return year
   }
   fun setYear(year: String?) {
      this.year = year!!
   }
   fun getGenre(): String? {
      return genre
   }
   fun setGenre(genre: String?) {
      this.genre = genre!!
   }
}

ステップ5：アダプタークラスを作成する

新しいクラス MoviesAdapter.kt を作成し、以下のコードを追加します。RecyclerViewに対してデータをバインドするためのアダプターで、ViewHolderパターンを使って各項目のTextViewに値をセットしています。

import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import android.widget.TextView
import androidx.annotation.NonNull
import androidx.recyclerview.widget.RecyclerView
internal class MoviesAdapter(private var moviesList: List<MovieModel>) :
RecyclerView.Adapter<MoviesAdapter.MyViewHolder>() {
   internal inner class MyViewHolder(view: View) : RecyclerView.ViewHolder(view) {
      var title: TextView = view.findViewById(R.id.title)
      var year: TextView = view.findViewById(R.id.year)
      var genre: TextView = view.findViewById(R.id.genre)
   }
   @NonNull
   override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): MyViewHolder {
      val itemView = LayoutInflater.from(parent.context)
      .inflate(R.layout.movie_list, parent, false)
      return MyViewHolder(itemView)
   }
   override fun onBindViewHolder(holder: MyViewHolder, position: Int) {
      val movie = moviesList[position]
      holder.title.text = movie.getTitle()
      holder.genre.text = movie.getGenre()
      holder.year.text = movie.getYear()
   }
   override fun getItemCount(): Int {
      return moviesList.size
   }
}

ステップ6：アイテム用レイアウト movie_list.xml を作成する

新しいLayoutリソースファイル movie_list.xml を作成し、以下のコードを追加します。リストの各項目として表示される、タイトル・ジャンル・公開年の3つのTextViewを定義しています。アダプター内で参照している R.id.title・R.id.genre・R.id.year は、このレイアウトのIDに対応します。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:orientation="vertical"
   android:padding="12dp">
   <TextView
      android:id="@+id/title"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:textSize="16sp"
      android:textStyle="bold" />
   <TextView
      android:id="@+id/genre"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:textSize="14sp" />
   <TextView
      android:id="@+id/year"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:textSize="14sp" />
</LinearLayout>

ステップ7：AndroidManifest.xml を確認する

androidManifest.xml が以下のようになっていることを確認します。特別な権限は不要で、MainActivityがランチャーアクティビティとして登録されていればOKです。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android" package="com.example.q11">
   <application
      android:allowBackup="true"
      android:icon="@mipmap/ic_launcher"
      android:label="@string/app_name"
      android:roundIcon="@mipmap/ic_launcher_round"
      android:supportsRtl="true"
      android:theme="@style/AppTheme">
      <activity android:name=".MainActivity">
         <intent-filter>
            <action android:name="android.intent.action.MAIN" />
            <category android:name="android.intent.category.LAUNCHER" />
         </intent-filter>
      </activity>
   </application>
</manifest>

アプリを実行してみよう

それでは、アプリケーションを実行してみましょう。ここでは、実機のAndroidスマートフォンをPCに接続しているものとします。Android Studioからアプリを実行するには、プロジェクト内のアクティビティファイルを開き、ツールバーにある Run アイコン をクリックします。デバイス選択のダイアログで接続した端末を選択すると、端末の画面にアプリが起動し、横方向にスクロールできる映画リストが表示されます。

まとめ

このように、RecyclerViewとLinearLayoutManagerを組み合わせれば、orientationをHORIZONTALに変更するだけの手間で横スクロール型のListViewを実装できます。カルーセル表示やカテゴリ別コンテンツの一覧など、さまざまなUIに応用できるテクニックなので、ぜひ自分のアプリでも試してみてください。