Android 2.1 ～ 向け ActionBar : ActionBarActivity (Android Support Library r18)

Android 3.0 (API 11) から追加された ActionBar。
Android Design でも重要視されているユーザインターフェースで、従来のタイトルバーの代わりにアプリのアイコン、タイトル名、オプションメニューを配置できるウィジェットです。

従来のタイトル


ActionBar


ActionBar は Android 3.0 から追加されたため、それ以前の Andoroid 2.x では使うことができません。
そこで API Level 間の違いを解消するための Support Library を使います。
※ 2013/07/24 に公開された Android Support Library r18 より ActionBar に対応しました。
未対応時に ActionBarSherlock を使って ActionBar に対応していた方も簡単に移行することができます。

なお、ActionBar に対応した Support Library は android-support-v7 なので Android 2.1 (API 7) からしか使うことができません。

---

以下は、Eclipse (日本語パッチ) 環境にて行っています。
(Windows7 なのに C 直下に android フォルダあるのは気にしないでください…)

本家 (Android Developers | Support Library Setup)
http://developer.android.com/tools/support-library/setup.html

■ Android Support Library の取得／更新
[ウィンドウ] - [Android SDK マネージャー] を起動し、
[Extras] > [Android Support Library] にチェックを入れてインストールをします。



インストールが完了すると以下のフォルダが生成されます。
[ANDROID_SDK_HOME]\extras\android\support\v7


■ ライブラリプロジェクトのインポート
ActionBar はリソースファイルを扱うため jar ではなく、ライブラリプロジェクトになっています。

取得した [ANDROID_SDK_HOME]\extras\android\support\v7\appcompat をインポートします。
[ファイル] - [新規] - [プロジェクト] から [Android] > [既存コードからの Andorid プロジェクト]

インポートする際には 『プロジェクトをワークスペースにコピー』にチェックを入れてください。

インポートが完了すると android-support-v7-appcompat プロジェクトが作成されます。



■ ライブラリプロジェクトの参照
Android プロジェクトを作成しますが作成するプロジェクトは以下のバージョンを指定してください。
・Minumum Required SDK > API 7 : Android 2.1 (Eclair) 以上
・Target SDK > API 14 : Android 4.0 (IceCreamSandwich) 以上

プロジェクトが作成し終わったら、android-support-v7-appcompat を参照します。
作成したプロジェクトを右クリックし [プロパティー] を選択。
ライブラリーに android-support-v7-appcompat を追加します。


次に、作成したプロジェクトの libs フォルダに android-support-v7-appcompat プロジェクトの libs フォルダ内の jar ファイルをコピーします。
（ライブラリプロジェクト内にあればいいはずなのに参照元にも無いとエラーになりました…）


Found 2 versions of android-support-v4.jar in the dependency list, but not all the versions are identical (check is based on SHA-1 only at this time)
とエラーが出た場合、作成したプロジェクトと android-support-v7-appcompat の android-support-v4.jar ファイルのバージョンが異なっています。android-support-v4.jar をコピーするか、最新にしてクリーンしてください。

これでライブラリプロジェクトの参照が完了しました。


■ 実装
ライブラリプロジェクトを参照したことで後は実装するだけですが、ActionBar を使うには以下のルールを守る必要があります。
・ActionBarActivity を継承する
・AppCompat のテーマを設定する

ActionBarActivity を継承しているのにテーマが設定されない場合、コンパイルは通りますが実行時に以下のエラーが発生します。
java.lang.IllegalStateException: You need to use a Theme.AppCompat theme (or descendant) with this activity.

テーマは AndroidManifest.xml にある application で使用している theme を変更します。
ContextThemeWrapper#setTheme(int resid) で動的に設定してもエラーになります。

設定できるテーマは以下のとおり。
・Theme.AppCompat
・Theme.AppCompat.Light
・Theme.AppCompat.Light.DarkActionBar

/res/values/styles.xml

<!-- <style name="AppBaseTheme" parent="android:Theme.Light"> -->
<style name="AppBaseTheme" parent="Theme.AppCompat">

以上の設定が完了すれば準備完了です。
最初に表示した(↑にある) ActionBar は以下のソースコードによって形成されています。

package jp.inujirushi.android.sample;

import android.os.Bundle;
import android.support.v4.view.MenuItemCompat;
import android.support.v7.app.ActionBarActivity;
import android.view.Menu;
import android.view.MenuItem;

public class TestActivity extends ActionBarActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // レイアウトを設定する
        setContentView(R.layout.activity_layout);
    }

    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        MenuItem item = menu.add("HELP").setIcon(
                android.R.drawable.ic_menu_help);
        MenuItemCompat.setShowAsAction(item,
                MenuItemCompat.SHOW_AS_ACTION_IF_ROOM);
        return true;
    }
}

テーマを xml 側で定義する必要がありますが、それ以外では ActionBarActivity を継承するだけで特別な設定は必要ありません。
なお、ActionBarActivity は FragmentActivity を継承しているので Fragment を使うこともできます。


■ ActionBarSherlock からの移行
ActionBarSherlock から移行する場合 Menu/MenuItem を Andriod 標準のものに戻します。
MenuItem#setShowAsAction(int actionEnum) 等は ActionBar と同じ Android 3.0 (API 11) から追加されているため MenuItemCompat のメソッドを使います。

ActionBarSherlock

@Override
public boolean onCreateOptionsMenu(Menu menu) {
    menu.add("HELP").setIcon(android.R.drawable.ic_menu_help)
            .setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
    return true;
}

android-support-v7

@Override
public boolean onCreateOptionsMenu(Menu menu) {
    MenuItem item = menu.add("HELP").setIcon(android.R.drawable.ic_menu_help);
    MenuItemCompat.setShowAsAction(item, MenuItemCompat.SHOW_AS_ACTION_IF_ROOM);
    return true;
}

ActionBarSherlock の記事を書いた２日後に実装されるとかタイミングが悪かった…

---

■ 参考サイト
Android Developers - Support Library Setup
ソフトウェア技術ドキュメントを勝手に翻訳 - 6.3 アクションバーの使用
クラスメソッド開発者ブログ - [Android Tips] Support Library に追加された ActionBarActivity を使ってみた
EGG 開発ブログ - Support v7 の Action Barを使ったナビゲーションドロワー実装 （準備編）
EGG 開発ブログ - Support v7 の Action Barを使ったナビゲーションドロワー実装 （実装編）
Qiita|nagakenjs - ActionBarActivity移行メモ