ダメ男のブログ: Android RecyclerViewの実装区切り線を表示する

公開日：2015年08月27日
最終更新日：2015年08月30日

記事概要

AndroidのRecyclerViewで区切り線を実装する方法を記載した記事です

環境

Android Studio 1.3.0
OS X Yosemite
android sdk 23(Android 6.0 Marshmallow(マシュマロ))
com.android.support:recyclerview-v7:23.0.0

はじめに

RecyclerViewを使ったリスト表示の仕方はこの記事を参考にしてください。
RecyclerViewでViewを切り替える実装方法はこの記事を参考にしてください。
今回は、RecyclerViewの区切り線の実装方法を説明します。

ListViewでの区切り線

ListViewで区切り線を表示する場合は、レイアウトxmlに


// 色
android:divider="#808080"

// 高さ
android:dividerHeight="2sp"

上記のように記載することで区切り線を表示していました。(昔の記事)

RecyclerViewで区切り線の実装

RecyclerViewの場合は、上記のようなxmlによる属性が用意されていないので、javaで実装する必要があります。
RecyclerView.ItemDecorationというクラスが用意されているので、このクラスを継承して作成します。
このクラスを使うことで、Adapterが保持しているデータセットに対して描画やレイアウトのようなエフェクトを付加することができます。


public class DividerItemDecoration extends RecyclerView.ItemDecoration {

    private static final int[] ATTRS = new int[]{
            android.R.attr.listDivider
    };

    public static final int HORIZONTAL_LIST = LinearLayoutManager.HORIZONTAL;

    public static final int VERTICAL_LIST = LinearLayoutManager.VERTICAL;

    private Drawable mDivider;

    private int mOrientation;

    public DividerItemDecoration(Context context, int orientation) {
        final TypedArray a = context.obtainStyledAttributes(ATTRS);
        mDivider = a.getDrawable(0);
        a.recycle();
        setOrientation(orientation);
    }

    public void setOrientation(int orientation) {
        if (orientation != HORIZONTAL_LIST && orientation != VERTICAL_LIST) {
            throw new IllegalArgumentException("invalid orientation");
        }
        mOrientation = orientation;
    }

    @Override
    public void onDraw(Canvas c, RecyclerView parent) {
        if (mOrientation == VERTICAL_LIST) {
            drawVertical(c, parent);
        } else {
            drawHorizontal(c, parent);
        }
    }

    public void drawVertical(Canvas c, RecyclerView parent) {
        final int left = parent.getPaddingLeft();
        final int right = parent.getWidth() - parent.getPaddingRight();

        final int childCount = parent.getChildCount();
        for (int i = 0; i < childCount; i++) {
            final View child = parent.getChildAt(i);
            final RecyclerView.LayoutParams params = (RecyclerView.LayoutParams) child
                    .getLayoutParams();
            final int top = child.getBottom() + params.bottomMargin;
            final int bottom = top + mDivider.getIntrinsicHeight();
            mDivider.setBounds(left, top, right, bottom);
            mDivider.draw(c);
        }
    }

    public void drawHorizontal(Canvas c, RecyclerView parent) {
        final int top = parent.getPaddingTop();
        final int bottom = parent.getHeight() - parent.getPaddingBottom();

        final int childCount = parent.getChildCount();
        for (int i = 0; i < childCount; i++) {
            final View child = parent.getChildAt(i);
            final RecyclerView.LayoutParams params = (RecyclerView.LayoutParams) child
                    .getLayoutParams();
            final int left = child.getRight() + params.rightMargin;
            final int right = left + mDivider.getIntrinsicHeight();
            mDivider.setBounds(left, top, right, bottom);
            mDivider.draw(c);
        }
    }

    @Override
    public void getItemOffsets(Rect outRect, int itemPosition, RecyclerView parent) {
        if (mOrientation == VERTICAL_LIST) {
            outRect.set(0, 0, 0, mDivider.getIntrinsicHeight());
        } else {
            outRect.set(0, 0, mDivider.getIntrinsicWidth(), 0);
        }
    }
}

上記で記述したコードをFragmentやActivityで利用しているRecyclerViewに設定します。


    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        // Inflate the layout for this fragment
        View view = inflater.inflate(R.layout.fragment_test, container, false);
        mRecyclerView = (RecyclerView)view.findViewById(R.id.recyclerView);

        // use this setting to improve performance if you know that changes
        // in content do not change the layout size of the RecyclerView
        mRecyclerView.setHasFixedSize(true);

        // use a linear layout manager
        mLayoutManager = new LinearLayoutManager(getActivity());
        mRecyclerView.setLayoutManager(mLayoutManager);

        // add ItemDecoration
        RecyclerView.ItemDecoration itemDecoration = new
                DividerItemDecoration(getActivity(), DividerItemDecoration.VERTICAL_LIST);
        mRecyclerView.addItemDecoration(itemDecoration);

        mAdapter = new TestAdapter(mDataset);
        // Set TestAdapter as the adapter for RecyclerView.
        mRecyclerView.setAdapter(mAdapter);
        // END_INCLUDE(initializeRecyclerView)

        return view;
    }

この時、addItemDecorationを呼び出す位置に注意してください。setAdapterの後にaddItemDecorationを記述すると、区切り線が表示されません。setAdapterを呼び出す前にaddItemDecorationを呼び出します。
きちんと実装できていれば以下のように表示されます。

まとめ

RecyclerViewは柔軟性が高い代わりに、必要な機能を自分で実装していく必要があります。
以前のListViewの機能のみで十分で、今後も拡張する予定がない場合はRecyclerViewは使わなくても良いでしょう。
ただ、個人的には最初からRecyclerViewで実装しておいたほうがあとあと拡張しやすく便利だとは思います。

以上

Androidアプリ開発にオススメの本

Effective Android

posted with ヨメレバ

TechBooster,小太刀御禄,出村成和,重田大助,西岡靖代,宮川大輔,柏本和俊,あんざいゆき,八木俊広,木村尭海,小林慎治,有山圭二,中西良明,わかめまさひろ,新井祐一,桝井草介,久郷達也,寺園聖文,shige0501,山下智樹,前田章博,秋葉ちひろ,末広尚義,中澤慧,日高正博,塚田翔也,井形圭介,中川幸哉,山崎誠,山下武志,なまそで,橋爪香織,さとうかずのり,l_b__ インプレスジャパン 2014-01-17

Amazon

Kindle