2014.10.11

【Android】ヘッダー/フッタービューつきのAndroid GridViewをオープンソースとして公開します

平野雄一

この記事の概要

AndroidのGridViewに対し、ヘッダービューとフッタービューの追加をサポートしたものをオープンソースとして公開しました。

We published HeaderFooterGridView by open source.
HeaderFooterGridView supports adding header rows and footer rows to GridView for Android.

簡単な自己紹介

本ブログでの初めての記事になりますので、簡単な自己紹介を。
リクルートマーケティングパートナーズのiOS/Androidエンジニアの平野と申します。2014年7月にジョインし、現在は主に料理サプリのAndroidアプリに携わっています。
家電メーカーで民生向けや業務向けの機器のソフトウェア開発や、ベンチャーでiOS/AndroidアプリのほかUnity/AR/Kinect2/位置情報系のアプリ開発などをしてきました。

AndroidのGridViewにはヘッダービュー・フッタービューがない

さて、ここから本題。

AndroidのListViewには上下に固定のViewを追加することができます。
この機能はたとえば、ListViewの上部に広告を載せたいとか、下部にボタンを置きたいときなどにとても便利です。
ListViewの上部に追加するViewのことをヘッダー、下部に追加するViewのことをフッターと呼びます。

しかし、AndroidのGridViewには残念ながらヘッダーやフッダーを追加する機能がありません。
ヘッダー付きのGridViewならばオープンソースのものがいくつか見つかるのですが、フッターまで付いたものは見つかりませんでした。
料理サプリAndroidアプリでフッターの付いたGridViewが必要だったため、今回はGoogleが公開しているヘッダー付きのGridViewのコード¹⁾Androidのギャラリーアプリのためのコードのようですをフッターもつけられるように改造しました。

ソースコードはこちらです。

使い方

HeaderFooterGridView.javaをプロジェクトにコピーします。
HeaderFooterGridView.javaは他のクラスには依存しないため、このファイルだけをコピーすればOKです。

【追記 2014/11/1】
Mavenからダウンロードできるようになりました。

【追記ここまで】

ヘッターの追加は HeaderFooterGridView#addHeaderView(View) 、フッターの追加は HeaderFooterGridView#addFooterView(View) ですることができます。

final HeaderFooterGridView headerFooterGridView = (HeaderFooterGridView) findViewById(R.id.HeaderFooterGridView);
HeaderView headerView = new HeaderView(context);
// ヘッダービューを追加します。
// setAdapterでAdapterを設定するよりも前にヘッダーを追加する必要があります。
headerFooterGridView.addHeaderView(headerView);
FooterView footerView = new FooterView(context);
// フッタービューを追加します。
// setAdapterでAdapterを設定するよりも前にフッターを追加する必要があります。
headerFooterGridView.addFooterView(footerView);
// Adapterはヘッダーとフッターを追加した後にセットしてください。
mAdapter = new HeaderFooterGridViewAdapter(this);
headerFooterGridView.setAdapter(mAdapter);

公開したソースコードの中に、デモアプリのコードを含めていますのでそちらも確認してみてください。

ライセンス

Apache License, Version 2.0のライセンスになります。

Copyright (C) 2013 The Android Open Source Project
Copyright (C) 2014 Recruit Marketing Partners Co.,Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.