设置 Android PreferenceFragment 的正确方法是什么?

What's the proper way to set up an Android PreferenceFragment?

我正在尝试在 Android 应用程序中实施基本设置 activity,然后出现空白屏幕或崩溃。我看到的文档和示例没有帮助,因为它们要么陈旧,要么不一致。例如,根据您查看的位置,设置 activity 应该扩展 Activity, 或 AppCompatPreferenceActivity(文件>新建>Activity>设置的一部分 Activity).

developer.android.com 表示您应该执行以下操作:

public class SettingsActivity extends Activity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Display the fragment as the main content.
        getFragmentManager().beginTransaction()
            .replace(android.R.id.content, new SettingsFragment())
            .commit();
    }
}

然而,在 Android Studio 中使用的设置 Activity 不会对其创建的三个片段中的任何一个进行此调用。它使用首选项 headers.

所以这是我的问题:

  1. 如果您使用的是一个简单的单一 preferences.xml 文件和一个 PreferenceFragment 并且 pre-API 19 兼容性不是必需的,class 应该设置 Activity延长? Activity、PreferenceActivity 或 AppCompatPreferenceActivity(对于其所有支持方法和委派)?
  2. 是否需要在 SettingsActivity.onCreate() 中调用 getFragmentManager().beginTransaction().replace(android.R.id.content, new SettingsFragment()).commit()
  3. 通过各种组合,我得到一个空白的白色设置屏幕,没有操作栏或崩溃。在显示应用程序操作栏的 activity 中设置单个 PreferencesFragment 的正确方法是什么?

what class should SettingsActivity extend?

对我有用的是扩展 AppCompatActivity

static final String ANIMATION = "animation" ;
static final String COUNTDOWN_ON_OFF = "countdown_on_off";

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

    if (getFragmentManager().findFragmentById(android.R.id.content) == null)
    {
        getFragmentManager().beginTransaction().add(android.R.id.content, new Prefs()).commit();
    }
}

我删除了所有与首选项相关的生成代码 headers 并为我的 PreferenceFragment[= 保留了一些模板方法/变量(Android Studio 在某些早期版本中生成的) 20=]

public static class Prefs extends PreferenceFragment
{
    @Override
    public void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
        addPreferencesFromResource(R.xml.preferences);

        // Bind the summaries of EditText/List/Dialog/Ringtone preferences
        // to their values. When their values change, their summaries are
        // updated to reflect the new value, per the Android Design
        // guidelines.

        // findPreference() uses android:key like in preferences.xml !

        bindPreferenceSummaryToValue(findPreference(ANIMATION));

    }
}

我的 Activity class 中的静态方法(改编自模板)。您可能需要检查其他偏好类型:

 /**
 * Binds a preference's summary to its value. More specifically, when the
 * preference's value is changed, its summary (line of text below the
 * preference title) is updated to reflect the value. The summary is also
 * immediately updated upon calling this method. The exact display format is
 * dependent on the type of preference.
 *
 * @see #sBindPreferenceSummaryToValueListener
 */
private static void bindPreferenceSummaryToValue(Preference preference)
{
    // Set the listener to watch for value changes.
    preference.setOnPreferenceChangeListener(sBindPreferenceSummaryToValueListener);

    // Trigger the listener immediately with the preference's
    // current value.

    if (preference instanceof CheckBoxPreference)
    {
        sBindPreferenceSummaryToValueListener.onPreferenceChange(preference,
                                                                 PreferenceManager
                                                                         .getDefaultSharedPreferences(preference.getContext())
                                                                        .getBoolean(preference.getKey(), true));
    }
    else
    {
        sBindPreferenceSummaryToValueListener.onPreferenceChange(preference,
                                                                 PreferenceManager
                                                                         .getDefaultSharedPreferences(preference.getContext())
                                                                         .getString(preference.getKey(), ""));
    }
}

最后,Preference.OnPreferenceChangeListener 作为 Activity 中的静态变量(也改编自模板):

   /**
 * A preference value change listener that updates the preference's summary
 * to reflect its new value.<br>
 * template by Android Studio minus Ringtone Preference
 */
private static Preference.OnPreferenceChangeListener sBindPreferenceSummaryToValueListener = new Preference.OnPreferenceChangeListener()
{
    @Override
    public boolean onPreferenceChange(Preference preference, Object value)
    {
        String stringValue = value.toString();

        if (preference instanceof ListPreference)
        {
            // For list preferences, look up the correct display value in
            // the preference's 'entries' list.
            ListPreference listPreference = (ListPreference) preference;
            int index = listPreference.findIndexOfValue(stringValue);

            // Set the summary to reflect the new value.
            preference.setSummary(
                    index >= 0
                            ? listPreference.getEntries()[index]
                            : null);

        }
        else if (preference instanceof RingtonePreference)
        {
            // my app didn't need that
            return true;
        }
        else if (preference instanceof CheckBoxPreference)
        {
            Context ctx = preference.getContext();
            boolean isChecked = (Boolean) value;

            if (preference.getKey().equals(ANIMATION))
            {
                preference.setSummary(isChecked ? ctx.getString(R.string.sOn) : ctx.getString(R.string.sOff));
            }
            else if (preference.getKey().equals(COUNTDOWN_ON_OFF))
            {
                preference.setSummary(isChecked ? ctx.getString(R.string.sWhenPaused) : ctx.getString(R.string.sNever) );
            }
        }
        else
        {
            // For all other preferences, set the summary to the value's
            // simple string representation.
            preference.setSummary(stringValue);
        }
        return true;
    }
};
}

假设我们想要一个带有一个复选框首选项片段的设置屏幕,如下所示:

这是有关如何构建设置的分步指南 activity,您可以在其中添加一些首选项来切换或更改 Android 应用的配置:

  1. build.gradle 文件中为 app 模块添加支持首选项片段的依赖项:

    dependencies {
        compile 'com.android.support:preference-v7:25.1.0'
    }
    
  2. res目录中添加xmlAndroid资源目录。

  3. xml 目录中,添加一个名为 pref_visualizer.xml 的新 XML resource file,如下所示。我们将在其中添加一个复选框首选项片段。

    <?xml version="1.0" encoding="utf-8"?>
    <PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
        <CheckBoxPreference
            android:defaultValue="true"
            android:key="show_base"
            android:summaryOff="Bass will not be shown currently."
            android:summaryOn="Bass will be shown currently."
            android:title="Show Bass"
            />
    </PreferenceScreen>
    

    PreferenceScreen 是根标签,可以容纳任意多的偏好片段。如果您想添加更多类型列表或文本框的配置,那么您需要将其添加为 PreferenceScreen 标签的子标签。

  4. 添加一个名为 SettingsFragment 的新 Java class,它将托管 PreferenceScreen。它应该扩展 PreferenceFragmentCompat class 如下所示:

    import android.content.SharedPreferences;
    import android.content.SharedPreferences.OnSharedPreferenceChangeListener;
    import android.os.Bundle;
    import android.support.v7.preference.CheckBoxPreference;
    import android.support.v7.preference.EditTextPreference;
    import android.support.v7.preference.ListPreference;
    import android.support.v7.preference.Preference;
    import android.support.v7.preference.PreferenceFragmentCompat;
    import android.support.v7.preference.PreferenceScreen;
    import android.widget.Toast;
    
    
    public class SettingsFragment extends PreferenceFragmentCompat {
    
    
    @Override
    public void onCreatePreferences(Bundle bundle, String s) {
            addPreferencesFromResource(R.xml.pref_visualizer);
        }
    }
    
  5. 现在是最后一部分,我们在应用程序中的 activity 和托管 PreferenceScreenSettingsFragment class 之间建立关联。添加一个名为 SettingsActivity 的新 activity,它继承自 AppCompatActivity class。 SettingsActivity class 将充当 PreferenceScreen.

  6. 的容器

Java 文件 SettingsActivity:

import android.support.v4.app.NavUtils;
import android.support.v7.app.ActionBar;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.MenuItem;

public class SettingsActivity extends AppCompatActivity {

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_settings);
}

}

SettingsActivity 的布局文件如下所示 (activity_settings.xml)。这里android.name属性是症结所在。它将此 activity 连接到整个项目中存在的任何 classes,这些 classes 继承自 PreferenceFragmentCompat class。我只有一个这样的 class,名为 SettingsFragment。如果您的应用有多个设置屏幕,您可能有多个 class 从 PreferenceFragmentCompat class 继承。

<?xml version="1.0" encoding="utf-8"?>
<fragment xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/activity_settings"
    android:name="android.example.com.visualizerpreferences.SettingsFragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>

大功告成!

除了彩铃给出的答案外,还必须指定首选项主题,否则应用程序将崩溃并出现 IllegalStateException

styles.xml文件中,只需在Activity的主题

中添加以下行
<item name="preferenceTheme">@style/PreferenceThemeOverlay</item>

这是关于 Kotlin 和 android-x :

gradle:

implementation 'androidx.appcompat:appcompat:1.1.0-rc01'
implementation 'androidx.core:core-ktx:1.2.0-alpha02'
implementation 'androidx.constraintlayout:constraintlayout:2.0.0-beta2'
implementation 'com.google.android.material:material:1.1.0-alpha08'
implementation "androidx.preference:preference-ktx:1.1.0-rc01"
implementation 'androidx.core:core-ktx:1.2.0-alpha02'
implementation 'androidx.collection:collection-ktx:1.1.0'
implementation 'androidx.fragment:fragment-ktx:1.2.0-alpha01'

MainActivity.kt

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        if (savedInstanceState == null)
            supportFragmentManager.commit { replace(android.R.id.content, PrefsFragment()) }
    }

    class PrefsFragment : PreferenceFragmentCompat() {
        override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
            setPreferencesFromResource(R.xml.preferences, rootKey)
        }
    }
}

preferences.xml

<androidx.preference.PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">

  <androidx.preference.Preference android:title="hello"/>
</androidx.preference.PreferenceScreen>