Android RecyclerView GridLayoutManagerで列間隔（アイテム間の余白）を設定する方法

この記事では、AndroidのRecyclerViewでGridLayoutManagerを使用する際に、列間隔（アイテム同士のスペース）を設定する方法を解説します。SpacesItemDecorationクラスを活用することで、グリッド表示の各アイテムに均等な余白を持たせることができます。

手順1：新規プロジェクトの作成

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

手順2：activity_main.xmlの編集

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

<?xml version = "1.0" encoding = "utf-8"?>
<android.support.design.widget.CoordinatorLayout android:layout_width = "match_parent"
   android:layout_height = "match_parent"
   xmlns:android = "https://schemas.android.com/apk/res/android"
   xmlns:app = "https://schemas.android.com/apk/res-auto">
   <android.support.design.widget.AppBarLayout
      android:layout_width = "match_parent"
      android:layout_height = "wrap_content">
      <android.support.v7.widget.Toolbar
         android:id = "@+id/appbarlayout_tool_bar"
         android:background = "@color/colorPrimary"
         android:layout_width = "match_parent"
         android:layout_height = "?attr/actionBarSize"
         app:layout_scrollFlags = "scroll|snap|enterAlways"
         app:theme = "@style/ThemeOverlay.AppCompat.Dark.ActionBar"
         app:popupTheme = "@style/ThemeOverlay.AppCompat.Light" />
   </android.support.design.widget.AppBarLayout>
   <android.support.v7.widget.RecyclerView
      android:id = "@+id/recycler_view"
      android:layout_width = "match_parent"
      android:layout_height = "match_parent"
      app:layout_behavior = "@string/appbar_scrolling_view_behavior"/>
</android.support.design.widget.CoordinatorLayout>

上記のコードでは、画面にRecyclerViewを配置しています。あわせてAppBarLayoutとToolbarも定義しており、スクロールに連動してツールバーが動作する構成になっています。

手順3：MainActivity.javaの編集

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

package com.example.myapplication;
import android.annotation.TargetApi;
import android.os.Build;
import android.os.Bundle;
import android.support.v4.content.ContextCompat;
import android.support.v7.app.AppCompatActivity;
import android.support.v7.widget.DefaultItemAnimator;
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.support.v7.widget.Toolbar;
import android.widget.TextView;
import android.widget.Toast;
import java.util.ArrayList;
public class MainActivity extends AppCompatActivity {
   TextView text;
   ArrayList<String> list = new ArrayList<>();
   private RecyclerView recyclerView;
   private customAdapter mAdapter;
   private onClickInterface onclickInterface;
   @TargetApi(Build.VERSION_CODES.LOLLIPOP)
   @Override
   public void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      Toolbar toolbar = (android.support.v7.widget.Toolbar) findViewById(R.id.appbarlayout_tool_bar);
      toolbar.setTitle("This is toolbar.");
      setSupportActionBar(toolbar);
      onclickInterface = new onClickInterface() {
         @Override
         public void setClick(int abc) {
            list.remove(abc);
            Toast.makeText(MainActivity.this,"Position is"+abc,Toast.LENGTH_LONG).show();
            mAdapter.notifyDataSetChanged();
         }
      };
      recyclerView = (RecyclerView) findViewById(R.id.recycler_view);
      GridLayoutManager mLayoutManager = new GridLayoutManager(getApplicationContext(),2);
      recyclerView.setLayoutManager(mLayoutManager);
      recyclerView.setItemAnimator(new DefaultItemAnimator());
      mAdapter = new customAdapter(this, list, onclickInterface);
      recyclerView.setAdapter(mAdapter);
      recyclerView.addItemDecoration(new SpacesItemDecoration(10));
      list.add("sairamm");
      list.add("Krishna");
      list.add("prasad");
      list.add("sairamm");
      list.add("Krishna");
      list.add("prasad");
      list.add("sairamm");
      list.add("Krishna");
      list.add("prasad");
      list.add("sairamm");
      list.add("Krishna");
      list.add("prasad");
      list.add("Krishna");
      list.add("prasad");
      list.add("sairamm");
      list.add("Krishna");
      list.add("prasad");
      list.add("sairamm");
      list.add("Krishna");
      list.add("prasad");
   }
}

ポイントはrecyclerView.addItemDecoration(new SpacesItemDecoration(10));の行です。ここで自作のItemDecorationをRecyclerViewに登録し、各アイテムに10dpの間隔を適用しています。また、GridLayoutManager(getApplicationContext(), 2)により2列のグリッド表示を指定しています。

手順4：customAdapter.javaの作成

src/customAdapter.javaに以下のコードを追加します。

package com.example.myapplication;
import android.content.Context;
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.TextView;
import java.util.ArrayList;
public class customAdapter extends RecyclerView.Adapter<customAdapter.MyViewHolder> {
   Context context;
   ArrayList<String> list;
   onClickInterface onClickInterface;
   public class MyViewHolder extends RecyclerView.ViewHolder {
      public TextView title;
      public MyViewHolder(View view) {
         super(view);
         title = (TextView) view.findViewById(R.id.title);
      }
   }
   public customAdapter(Context context, ArrayList<String> list, onClickInterface onClickInterface) {
      this.context = context;
      this.list = list;
      this.onClickInterface = onClickInterface;
   }
   @NonNull
   @Override
   public MyViewHolder onCreateViewHolder(@NonNull ViewGroup viewGroup, int i) {
      View itemView = LayoutInflater.from(viewGroup.getContext()).inflate(R.layout.list_row, viewGroup, false);
      return new MyViewHolder(itemView);
   }
   @Override
   public void onBindViewHolder(@NonNull MyViewHolder myViewHolder, final int i) {
      myViewHolder.title.setText(list.get(i));
      myViewHolder.title.setOnClickListener(new View.OnClickListener() {
         @Override
         public void onClick(View v) {
            onClickInterface.setClick(i);
         }
      });
   }
   @Override
   public int getItemCount() {
      return list.size();
   }
}

このアダプターでは、リストの各要素をViewHolderにバインドし、タイトルがタップされたときにインターフェース経由でクリック位置を通知する仕組みを実装しています。

手順5：list_row.xmlの編集

res/layout/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:app = "https://schemas.android.com/apk/res-auto"
   xmlns:tools = "https://schemas.android.com/tools"
   android:layout_width = "match_parent"
   android:layout_height = "wrap_content"
   app:cardElevation = "10dp"
   app:cardCornerRadius = "20dp"
   tools:context = ".MainActivity">
   <LinearLayout
      android:layout_width = "match_parent"
      android:layout_height = "wrap_content"
      android:gravity = "center"
      android:orientation = "vertical">
      <ImageView
         android:id = "@+id/imageView2"
         android:layout_width = "wrap_content"
         android:layout_height = "wrap_content"
         android:src = "@drawable/logo" />
      <TextView
         android:id = "@+id/title"
         android:layout_width = "match_parent"
         android:layout_height = "wrap_content"
         android:gravity = "center"
         android:textSize = "30sp" />
      <TextView
         android:id = "@+id/textview2"
         android:layout_width = "match_parent"
         android:layout_height = "wrap_content"
         android:gravity = "center"
         android:text = "Sairamkrishan"
         android:textSize = "30sp" />
   </LinearLayout>
</android.support.v7.widget.CardView>

各行はCardViewで構成されており、角丸と影（Elevation）を設定したカード型のアイテムが表示されます。

手順6：onClickInterfaceの作成

src/onClickInterface.javaに以下のコードを追加します。

package com.example.myapplication;
public interface onClickInterface {
   void setClick(int abc);
}

手順7：SpacesItemDecoration.javaの作成

ここが列間隔設定の核心となる部分です。src/SpacesItemDecoration.javaに以下のコードを追加します。

package com.example.myapplication;
import android.graphics.Rect;
import android.support.v7.widget.RecyclerView;
import android.view.View;
public class SpacesItemDecoration extends RecyclerView.ItemDecoration {
   private int space;
   public SpacesItemDecoration(int space) {
      this.space = space;
   }
   @Override
   public void getItemOffsets(Rect outRect, View view, RecyclerView parent, RecyclerView.State state) {
      outRect.left = space;
      outRect.right = space;
      outRect.bottom = space;
      // Add top margin only for the first item to avoid double space between items
      if (parent.getChildLayoutPosition(view) == 0) {
         outRect.top = space;
      } else {
         outRect.top = 0;
      }
   }
}

getItemOffsets()メソッドをオーバーライドし、各アイテムの左右と下にスペースを設定しています。先頭のアイテムにのみ上部マージンを追加することで、アイテム間に余分な二重スペースが生じるのを防いでいます。コンストラクタで渡す数値を変更すれば、間隔の幅を自由に調整できます。

アプリの実行

それでは、アプリケーションを実行してみましょう。実際のAndroid端末をパソコンに接続しているものとします。Android Studioからアプリを実行するには、プロジェクト内のアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。表示された選択肢から接続したモバイルデバイスを選択すると、端末に以下のような画面が表示されます。