【问题标题】:What's the proper way to set up an Android PreferenceFragment?设置 Android PreferenceFragment 的正确方法是什么?
【发布时间】:2017-12-17 09:41:00
【问题描述】:

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

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 中生成的 Settings Activity 不会对它创建的三个 Fragment 中的任何一个进行此调用。它使用首选项标头。

所以这是我的问题:

  1. 如果您使用一个简单的preferences.xml 文件和一个PreferenceFragment 并且不需要API 19 之前的兼容性,那么SettingsActivity 应该扩展什么类? Activity、PreferenceActivity 或 AppCompatPreferenceActivity(对于它的所有支持方法和委托)?
  2. 是否需要在 SettingsActivity.onCreate() 中调用getFragmentManager().beginTransaction().replace(android.R.id.content, new SettingsFragment()).commit()
  3. 使用各种组合时,我要么得到一个没有操作栏的空白设置屏幕,要么出现崩溃。在显示应用操作栏的 Activity 中设置单个 PreferencesFragment 的正确方法是什么?

【问题讨论】:

    标签: android android-fragments android-actionbar settings preferences


    【解决方案1】:

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

    以下是有关如何构建设置活动的分步指南,您可以在其中添加一些首选项以切换或更改 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 类,它将承载PreferenceScreen。它应该扩展PreferenceFragmentCompat 类,如下所示:

      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. 现在是最后一部分,我们在应用程序中的活动和托管 PreferenceScreenSettingsFragment 类之间建立关联。添加一个名为SettingsActivity 的新活动,它继承自AppCompatActivity 类。 SettingsActivity 类将充当 PreferenceScreen 的容器。

    SettingsActivity 的 Java 文件:

    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 属性是症结所在。它将这个活动连接到整个项目中存在的任何类,这些类继承自PreferenceFragmentCompat 类。我只有一个名为SettingsFragment 的类。如果您的应用有多个设置屏幕,您可能有多个类继承自 PreferenceFragmentCompat 类。

    <?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"/>
    

    一切就绪!

    【讨论】:

    【解决方案2】:

    SettingsActivity 应该扩展什么类?

    对我有用的是扩展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();
        }
    }
    

    我踢掉了所有与偏好标头相关的生成代码,并为我的PreferenceFragment保留了一些模板方法/变量(Android Studio 在某些早期版本中生成)

    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 类中的静态方法(改编自模板)。您可能需要检查其他偏好类型:

     /**
     * 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;
        }
    };
    }
    

    【讨论】:

    • 这行得通——除了缺少操作栏。在 SettingsActivity.onCreate() 中,对 getSupportActionBar() 的调用会返回 null,即使该 Activity 在 AndroidManifest.xml 中设置为 MainActivity 的子级,它有一个操作栏。我还在 SettingsFragment.onCreate() 中调用 setHasOptionsMenu() ,但这可能没有实际意义。您如何显示 ActionBar?
    • @Phil - 我使用了一个 Activity 类型,它默认有一个 ActionBar。如果您必须设置 ActionBar,那么您应该从 MainActivity 复制该部分,并将 Fragment 不是在 R.id.content 中,而是在 Toolbar 下方的容器中,就像其他 Fragment 一样
    • 谢谢@0X0nosugar。我问这样一个基本的问题的原因是我正在使用 Android Studio 插入的 SettingsActivity,它不需要膨胀工具栏,甚至不需要定义 XML 片段,也不需要指定它的位置。它只是调用 getSupportActionBar() 并得到它。我的 SettingsActivity 基于它调用 getSupportActionBar() 并获得 null。要么我在某处遗漏了一段关键逻辑,要么标题样式首选项包含一些隐式的 ActionBar 处理。
    • 好的,我找到了阻止操作栏的原因。我的错。我在错误的地方有 android:theme="@style/AppTheme.NoActionBar" 。当我把它放在正确的标签中时,,以及 中的 android:theme=@style/AppTheme",操作栏出现了。再次感谢。
    • @Phil - 不客气 :) 抱歉,我没有时间早点回复,但我的猜测也是,是否有 ActionBar 取决于设置 Activity 样式。编码愉快!
    【解决方案3】:

    这是关于 Kotlin 和 android-x 的:

    分级:

    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>
    

    【讨论】:

      【解决方案4】:

      除了 RBT 给出的答案之外,还必须指定偏好主题,否则应用程序将崩溃并出现 IllegalStateException

      styles.xml文件中,在Activity的主题中添加如下一行

      <item name="preferenceTheme">@style/PreferenceThemeOverlay</item>
      

      【讨论】:

      • 需要片段吗?我只想要一个纯粹的活动,没有碎片。我看到 Google 自己的页面和示例虽然建议使用 Fragment
      • @Csaba Toth 这取决于您的需求和您想要实现的目标。如果您只是想存储一些数据并稍后恢复,您可能需要使用 SharedPreferences。
      • 我以前做过自定义首选项。好消息是PreferencesFragmentCompat 用极少的管道代码完成了这项工作,这正是我的目标。然而,添加一个不必要的片段本身就是一个管道代码。因此,如果有PreferencesActivityCompat 之类的,我们就快到了。目标:没有管道代码。
      猜你喜欢
      • 2014-01-20
      • 1970-01-01
      • 2021-12-06
      • 2013-12-26
      • 2014-03-16
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2023-04-02
      相关资源
      最近更新 更多