PreferenceFragmentの詳しい解説

PreferenceFragmentはアプリケーションの設定画面を表示するための特別なFragmentで、さまざまな種類のプリファレンス項目の設定画面を簡単に作成できる。

PreferenceFragmentはAPIレベル11（Android 3.0）で導入されたが、APIレベル28で非推奨となり、PreferenceFragmentCompatへの移行が推奨された。

プリファレンスフラグメントを使用すると、プリファレンス 項目を異なる プリファレンス画面にグループ分けし、異なるプリファレンスタイプを使用して異なる設定項目を表すことができます。プリファレンス項目の変更を処理し、変更内容を SharedPreferences に保存するためのメソッドもいくつか提供されています。

PreferenceFragmentを使用するには、Activityのレイアウトファイルかコード内でそれを追加する必要があります。その後、PreferenceFragment内でユーザー設定項目を定義し、それらの変更を処理できます。

PreferenceFragmentを使用するための基本的な手順を以下に示します.

1. PreferenceFragmentを継承したクラスを作成する

public class MyPreferenceFragment extends PreferenceFragment {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// 加载偏好设置项布局文件
addPreferencesFromResource(R.xml.preferences);
}
}

1. PreferenceFragmentをレイアウトファイルまたはコードでアクティビティに追加します。

public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// 将PreferenceFragment添加到Activity
getFragmentManager().beginTransaction()
.replace(R.id.fragment_container, new MyPreferenceFragment())
.commit();
}
}

1. preferences.xmlファイルを作成してres / xmlフォルダーに定義する

<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
<PreferenceCategory android:title="General">
<CheckBoxPreference
android:key="example_checkbox"
android:title="Example Checkbox"
android:summary="This is an example checkbox preference"
android:defaultValue="true" />
<EditTextPreference
android:key="example_edittext"
android:title="Example EditText"
android:summary="This is an example EditText preference"
android:defaultValue="Default value" />
</PreferenceCategory>
<PreferenceCategory android:title="Advanced">
<ListPreference
android:key="example_list"
android:title="Example List"
android:summary="This is an example List preference"
android:entries="@array/example_list_entries"
android:entryValues="@array/example_list_values"
android:defaultValue="value1" />
<RingtonePreference
android:key="example_ringtone"
android:title="Example Ringtone"
android:summary="This is an example Ringtone preference"
android:ringtoneType="all"
android:defaultValue="content://settings/system/ringtone" />
</PreferenceCategory>
</PreferenceScreen>

1. Preference設定の変更処理

public class MyPreferenceFragment extends PreferenceFragment implements SharedPreferences.OnSharedPreferenceChangeListener {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
addPreferencesFromResource(R.xml.preferences);
}
@Override
public void onResume() {
super.onResume();
// 注册SharedPreferences的监听器
getPreferenceScreen().getSharedPreferences().registerOnSharedPreferenceChangeListener(this);
}
@Override
public void onPause() {
super.onPause();
// 取消注册SharedPreferences的监听器
getPreferenceScreen().getSharedPreferences().unregisterOnSharedPreferenceChangeListener(this);
}
@Override
public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
// 处理偏好设置项的更改
if (key.equals("example_checkbox")) {
boolean isChecked = sharedPreferences.getBoolean(key, false);
// 处理Example Checkbox的更改
} else if (key.equals("example_edittext")) {
String text = sharedPreferences.getString(key, "");
// 处理Example EditText的更改
} else if (key.equals("example_list")) {
String value = sharedPreferences.getString(key, "");
// 处理Example List的更改
}
}
}

以上、PreferenceFragmentを使用する基本的なステップ。必要に応じて、より多くの設定項目を定義し、onSharedPreferenceChanged()メソッドで変更を処理してください。

PreferenceFragment の代わりに PreferenceFragmentCompat を使うことを推奨します。PreferenceFragmentCompat は互換性ライブラリで、端末のバージョンに関係なく利用できます。