設定アクティビティのカスタマイズ

設定アクティビティを作成する方法を解説します。

前項「設定アクティビティの作成」で作成した設定アクティビティの設定項目は自動生成された設定項目でした。
本項では、設定項目を自前の設定項目に変更します。

解説

自動生成された設定項目を削除し、以下の５つの設定項目を追加します。

1. チェックボックスでOn/Offを切り替える設定項目
2. スイッチでOn/Offを切り替える設定項目
3. テキストを指定する設定項目
4. リストから１つの項目を選択する設定項目
5. リストから複数の項目を選択する設定項目

前項に対する処理の変更は以下です。

• プリファレンスファイルから、自動生成された設定項目を削除します。
• プリファレンスファイルに、自前の設定項目を追加します。
• 文字列配列リソースファイルに、自前の設定項目に関する文字列配列を追加します。
• メインアクティビティに設定値を表示するために、メインアクティビティのレイアウトを変更します。
• メインアクティビティに自前の設定項目の設定値を表示する処理を追加します。

実装

アプリの仕様

• アプリを起動すると、メインアクティビティが表示される。
• オプションメニューの「Settings」を選択すると、設定アクティビティに移行する。
• 設定アクティビティには、自前の設定項目が表示される。（本項で追加）
• メインアクティビティには、自前の設定項目の設定値が表示される。（本項で追加）

プロジェクトを開く

「設定アクティビティの作成」で作成したプロジェクトを開きます。

プリファレンスファイルの編集

プリファレンスファイル「root_preferences.xml」から、自動生成された設定項目を削除します。
プリファレンスファイル「root_preferences.xml」に、自前の設定項目を追加します。

プリファレンスファイル「root_preferences.xml」の内容を以下のようにします。
<PreferenceScreen xmlns:app="http://schemas.android.com/apk/res-auto"> <PreferenceCategory app:title="My settings"> <CheckBoxPreference app:key="foo_function" app:defaultValue="false" app:title="Foo function" app:summary="Whether to enable or disable Foo function." /> <SwitchPreference app:key="bar_function" app:defaultValue="true" app:title="Bar function" app:summary="Whether to enable or disable Bar function." /> <EditTextPreference app:key="baz_name" app:defaultValue="Baaaz" app:title="Baz name" app:summary="Set the name of Baz." /> <ListPreference app:key="qux_type" app:defaultValue="2" app:entries="@array/entries_qux_type" app:entryValues="@array/values_quex_type" app:title="Qux type" app:summary="Set the type of Baz." /> <MultiSelectListPreference app:key="corge_options" app:defaultValue="@array/default_corge_options" app:entries="@array/entries_corge_options" app:entryValues="@array/values_corge_options" app:title="Corge options" app:summary="Set the options of Corge." /> </PreferenceCategory> </PreferenceScreen>

文字列配列リソースファイルの編集

文字列配列リソースファイル「arrays.xml」に、自前の設定項目に関する文字列配列を追加します。

文字列配列リソースファイル「arrays.xml」の内容を以下のようにします。
<resources> <!-- Reply Preference --> <string-array name="reply_entries"> <item>Reply</item> <item>Reply to all</item> </string-array> <string-array name="reply_values"> <item>reply</item> <item>reply_all</item> </string-array> <!-- My Settings --> <string-array name="entries_qux_type"> <item>@string/entry_qux_1</item> <item>@string/entry_qux_2</item> <item>@string/entry_qux_3</item> </string-array> <string-array name="values_quex_type"> <item>@string/value_qux_1</item> <item>@string/value_qux_2</item> <item>@string/value_qux_3</item> </string-array> <string-array name="entries_corge_options"> <item>@string/entry_corge_a</item> <item>@string/entry_corge_b</item> <item>@string/entry_corge_c</item> </string-array> <string-array name="values_corge_options"> <item>@string/value_corge_a</item> <item>@string/value_corge_b</item> <item>@string/value_corge_c</item> </string-array> <string-array name="default_corge_options"> <item>@string/value_corge_a</item> <item>@string/value_corge_c</item> </string-array> </resources>

メインアクティビティのレイアウトファイルの編集

メインアクティビティに設定値を表示するために、メインアクティビティのレイアウトを変更します。

「Hello World!」と表示するためのTextViewを、設定値を表示するためのTextViewに変更します。

• 「android:id="@+id/textview_settings"」を追加します。
• 「android:text="Hello World!"」を削除します。

メインアクティビティのレイアウトファイル「activity_main.xml」の内容を以下のようにします。
<?xml version="1.0" encoding="utf-8"?> <androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:app="http://schemas.android.com/apk/res-auto" xmlns:tools="http://schemas.android.com/tools" android:layout_width="match_parent" android:layout_height="match_parent" tools:context=".MainActivity"> <TextView android:id="@+id/textview_settings" android:layout_width="wrap_content" android:layout_height="wrap_content" app:layout_constraintBottom_toBottomOf="parent" app:layout_constraintLeft_toLeftOf="parent" app:layout_constraintRight_toRightOf="parent" app:layout_constraintTop_toTopOf="parent" /> </androidx.constraintlayout.widget.ConstraintLayout>

メインアクティビティクラスの編集

メインアクティビティに設定値を表示するために、処理を追加します。

「MainActivity」クラスの末尾に、onResume関数を追加します。

• 設定値の読み込み処理を追加します。
• 設定値の表示処理を追加します。

「MainActivity」クラスの内容を以下のようにします。
package com.hiramine.settingsactivitytrial; import androidx.appcompat.app.AppCompatActivity; import androidx.preference.PreferenceManager; import android.content.Intent; import android.content.SharedPreferences; import android.os.Bundle; import android.view.Menu; import android.view.MenuItem; import android.widget.TextView; import java.util.Arrays; import java.util.HashSet; import java.util.Set; public class MainActivity extends AppCompatActivity { @Override protected void onCreate( Bundle savedInstanceState ) { （・・・略・・・） } // オプションメニュー作成時の処理 @Override public boolean onCreateOptionsMenu( Menu menu ) { （・・・略・・・） } // オプションメニューのアイテム選択時の処理 @Override public boolean onOptionsItemSelected( MenuItem item ) { （・・・略・・・） } // 初回表示時、および、ポーズからの復帰時 @Override protected void onResume() { super.onResume(); // 設定値の読み込み SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences( getApplicationContext() ); boolean bFooFunction = prefs.getBoolean( "foo_function", false ); boolean bBarFunction = prefs.getBoolean( "bar_function", true ); String strBazName = prefs.getString( "baz_name", "Baaaz" ); String strQuxType = prefs.getString( "qux_type", "2" ); String[] astrDefaultCorgeOptions = getResources().getStringArray( R.array.default_corge_options ); Set<String> setstrCorgeOptions = prefs.getStringSet( "corge_options", new HashSet<>( Arrays.asList( astrDefaultCorgeOptions ) ) ); // 設定値の表示 TextView textviewSettings = findViewById( R.id.textview_settings ); String strSettings = "Foo function : " + bFooFunction + "\n" + "Bar function : " + bBarFunction + "\n" + "Baz name : " + strBazName + "\n" + "Qux type : " + strQuxType + "\n" + "Corge options : " + setstrCorgeOptions + "\n"; textviewSettings.setText( strSettings ); } }

「Cannot resolve symbol」エラーは、「Alt + Enter」で、必要なクラスをimportします。

リビルドし、エラー、警告がないことを確認します。

実行

Android端末にて、動作確認。

アプリを起動すると、メインアクティビティが表示されます。
メインアクティビティには、設定項目の設定値が表示されます。


右上のオプションメニューの「Settings」を選択すると、「設定アクティビティ」に移行します。



テキストを指定する設定項目を選択すると、テキスト入力ダイアログが表示されます。
リストから選択する設定項目を選択すると、項目選択ダイアログが表示されます。


設定を変更し、メインアクティビティに戻ると、変更した設定値が画面に表示されます。



設定アクティビティで変更した設定は、アプリを終了しても、次回アプリを起動した際には、設定内容が復元されます。

関連ページ

• 設定アクティビティの作成 - 前項
• 設定アクティビティのカスタマイズ - 本項
• 設定アクティビティに設定値の表示 - 次項
• 色設定プリファレンス
• 設定アクティビティに設定色の表示