AndroidのPreferenceScreenにボタンを追加する方法をわかりやすく解説

はじめに

この記事では、Androidアプリの設定画面（PreferenceScreen）にボタンを追加する方法を、実際のコード例とともにステップごとに解説します。設定画面内のボタンは、通常のPreference要素としてXMLで定義し、Java側でクリックリスナーを設定することで、好きな動作を割り当てることができます。

ステップ1：新規プロジェクトの作成

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

ステップ2：レイアウトファイル（activity_main.xml）の編集

res/layout/activity_main.xml に以下のコードを記述します。設定画面（PreferenceFragment）を表示するための土台となる FrameLayout を配置しています。

<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <FrameLayout
        android:id="@+id/settings"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />
</LinearLayout>

ステップ3：MainActivity.java の実装

src/MainActivity.java に以下のコードを追加します。ここでのポイントは、PreferenceFragmentCompat を継承した SettingsFragment クラスを作成し、findPreference() メソッドでキー名「toastMsg」のボタンを取得して、クリックリスナーを設定している点です。ボタンがタップされると Toast メッセージが表示されます。

import android.os.Bundle;
import android.widget.Toast;
import androidx.appcompat.app.ActionBar;
import androidx.appcompat.app.AppCompatActivity;
import androidx.preference.Preference;
import androidx.preference.PreferenceFragmentCompat;

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main_activity);
        getSupportFragmentManager().beginTransaction().replace(R.id.settings, new SettingsFragment()).commit();
        ActionBar actionBar = getSupportActionBar();
        if (actionBar != null) {
            actionBar.setDisplayHomeAsUpEnabled(true);
        }
    }
    public static class SettingsFragment extends PreferenceFragmentCompat {
        @Override
        public void onCreatePreferences(Bundle savedInstanceState, String rootKey) {
            setPreferencesFromResource(R.xml.root_preferences, rootKey);
            Preference button = getPreferenceManager().findPreference("toastMsg");
            if (button != null) {
                button.setOnPreferenceClickListener(new Preference.OnPreferenceClickListener() {
                    @Override
                    public boolean onPreferenceClick(Preference arg0) {
                        Toast.makeText(getActivity(), "Preference button is clicked",
                             Toast.LENGTH_SHORT).show();
                        return true;
                    }
                });
            }
        }
    }
}

ステップ4：root_preferences.xml の編集

設定画面の構造を定義する root_preferences.xml に以下のコードを追加します。ボタンとして機能させるのは、app:key="toastMsg" を持つ Preference 要素です。EditTextPreference や ListPreference、SwitchPreferenceCompat など、他の設定項目と同じようにカテゴリ内に配置できます。

<PreferenceScreen xmlns:app="https://schemas.android.com/apk/res-auto">
    <PreferenceCategory app:title="@string/messages_header">
        <EditTextPreference
            app:key="signature"
            app:title="@string/signature_title"
            app:useSimpleSummaryProvider="true" />
        <ListPreference
            app:defaultValue="reply"
            app:entries="@array/reply_entries"
            app:entryValues="@array/reply_values"
            app:key="reply"
            app:title="@string/reply_title"
            app:useSimpleSummaryProvider="true" />
        <Preference
            app:key="toastMsg"
            app:title="Show me a Toast" />
    </PreferenceCategory>
    <PreferenceCategory app:title="@string/sync_header">
        <SwitchPreferenceCompat
            app:key="sync"
            app:title="@string/sync_title" />
        <SwitchPreferenceCompat
            app:dependency="sync"
            app:key="attachment"
            app:summaryOff="@string/attachment_summary_off"
            app:summaryOn="@string/attachment_summary_on"
            app:title="@string/attachment_title" />
    </PreferenceCategory>
</PreferenceScreen>

ステップ5：AndroidManifest.xml の確認

最後に、androidManifest.xml に以下のコードが含まれていることを確認してください。MainActivity がランチャーアクティビティとして登録されています。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android" package="app.com.sample">
    <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"
            android:label="@string/title_activity_settings">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

アプリを実行して動作を確認しよう

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