設定アクティビティの作成

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

本項では、Android Studio の 設定アクティビティのひな形を利用して、最低限の設定アクティビティを作成します。

解説

Android Studio の 「New > Activity > Settings Activity」を利用して設定アクティビティを作成すると、設定アクティビティに必要なファイルを自動生成します。また生成したファイルに関して必要なコードを自動追記します。

実装

アプリの仕様

• アプリを起動すると、メインアクティビティが表示される。
• オプションメニューの「Settings」を選択すると、設定アクティビティに移行する。

プロジェクトの作成

（開発環境としては、Android Studio 2020.3.1 を使用しています）

（この設定でプロジェクトを作成しなければいけない、というわけではありません。）

「Welcome to Android Studio」画面の「Create New Project」をクリックします。


「Empty Activity」を選択し、「Next」ボタンを押します。


Nameに、「SettingsActivityTrial」と入力します。
Package nameのドメイン部分に、会社のドメイン名を指定します。
Save locationに、プロジェクトを保存するフォルダパスを指定します。
Minimum SDKを選択します（たとえば、「API 21: Android 5.0 (Lollipop)」）。
「Finish」ボタンを押します。

しばらく待ちます。
Android Studio のステータスバーに「Gradle sync finished in ・・・」や「*daemon started successfully ・・・」と出るまで待ちます。

以上で、プロジェクトができました。

設定アクティビティの作成

設定アクティビティを作成します。

「Project」ペインの「app > java > ドメイン.パッケージ名」を右クリックします。
右クリックメニュー「New > Activity > Settings Activity」を選択します。


Activity Name欄に「MySettingsActivity」と入力します。
「Finish」ボタンを押します。

「MySettingsActivity」クラスファイルが生成されます。
参考）生成された「MySettingsActivity」クラスファイルの内容は以下。
package com.hiramine.settingsactivitytrial; import android.os.Bundle; import androidx.appcompat.app.ActionBar; import androidx.appcompat.app.AppCompatActivity; import androidx.preference.PreferenceFragmentCompat; public class MySettingsActivity extends AppCompatActivity { @Override protected void onCreate( Bundle savedInstanceState ) { super.onCreate( savedInstanceState ); setContentView( R.layout.settings_activity ); if( savedInstanceState == null ) { 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 ); } } }

レイアウトファイル「settings_activity.xml」が生成されます。
参考）生成されたレイアウトファイル「settings_activity.xml」の内容は以下。
<LinearLayout xmlns:android="http://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>

プリファレンスファイル「root_preferences.xml」が生成されます。
参考）生成されたプリファレンスファイル「root_preferences.xml」の内容は以下。
<PreferenceScreen xmlns:app="http://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" /> </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>

文字列配列リソースファイル「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> </resources>

文字列リソースファイル「strings.xml」に、「MySettingsActivity」で使用される文字列に関する記述が追加されます。
参考）「MySettingsActivity」で使用される文字列に関する記述が追加された文字列リソースファイル「strings.xml」の内容は以下。
<resources> <string name="app_name">SettingsActivityTrial</string> <string name="title_activity_my_settings">MySettingsActivity</string> <!-- Preference Titles --> <string name="messages_header">Messages</string> <string name="sync_header">Sync</string> <!-- Messages Preferences --> <string name="signature_title">Your signature</string> <string name="reply_title">Default reply action</string> <!-- Sync Preferences --> <string name="sync_title">Sync email periodically</string> <string name="attachment_title">Download incoming attachments</string> <string name="attachment_summary_on">Automatically download attachments for incoming emails</string> <string name="attachment_summary_off">Only download attachments when manually requested</string> </resources>

マニフェストファイル「AndroidManifest.xml」に、「MySettingsActivity」に関する記述が追加されます。
参考）「MySettingsActivity」に関する記述が追加されたマニフェストファイル「AndroidManifest.xml」の内容は以下。
<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.hiramine.settingsactivitytrial"> <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/Theme.SettingsActivityTrial"> <activity android:name=".MySettingsActivity" android:exported="false" android:label="@string/title_activity_my_settings" /> <activity android:name=".MainActivity" android:exported="true"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> </application> </manifest>

メニューリソースファイルの作成

メインアクティビティのメニューリソースファイルを作成します。

「Project」ペインの「app > res」を右クリックします。
右クリックメニュー「New > Android Resource File」を選択します。


File name欄に「activity_main」と入力します。
Resource type欄を「menu」にします。
「OK」ボタンを押します。

activity_main.xml が作成されます。

「設定アクティビティを呼び出すためのメニュー項目」を定義します。

activity_main.xmlの内容を以下のようにします。
<?xml version="1.0" encoding="utf-8"?> <menu xmlns:android="http://schemas.android.com/apk/res/android"> <item android:id="@+id/menuitem_settings" android:title="Settings"/> </menu>

メインアクティビティのメニューリソースファイルができました。

メインアクティビティクラスへのメニュー関連関数の追加

メインアクティビティクラスに、メニュー関連関数を追加します。

「MainActivity」クラスの末尾に、以下を追加します。
// オプションメニュー作成時の処理 @Override public boolean onCreateOptionsMenu( Menu menu ) { getMenuInflater().inflate( R.menu.activity_main, menu ); return true; } // オプションメニューのアイテム選択時の処理 @Override public boolean onOptionsItemSelected( MenuItem item ) { if( R.id.menuitem_settings == item.getItemId() ) { Intent intent = new Intent( this, MySettingsActivity.class ); startActivity( intent ); return true; } return false; }

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

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

実行

Android端末にて、動作確認。

アプリを起動すると、メインアクティビティが表示されます。


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



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

関連ページ

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