如何使用新的Android-X API从当前的PreferenceFragment中打开一个新的PreferenceFragment?

时间:2018-10-09 14:39:28

标签: android android-fragments android-preferences preferencefragment androidx

背景

在早期版本的支持库中,我们可以使用标题以使设置具有主菜单屏幕,每个主屏幕都将打开一个新的设置屏幕(片段)。

问题

现在标题消失了(写为here)一段时间了,我认为在android-x上它变得更糟了:

  

您要注意的一件事不是首选项标题,您将   完全正确。但是,这并不意味着一个偏好列表   需要跨越10英寸平板电脑屏幕。相反,您的活动可以实现   OnPreferenceStartFragmentCallback(link)来处理   具有app:fragment属性的首选项或   OnPreferenceStartScreenCallback(link)来处理   PreferenceScreen首选项。这使您可以构造一个“标题”   在一个窗格中设置PreferenceFragmentCompat样式,并使用这些回调来   替换第二个窗格,而无需使用两种单独的XML类型   文件。

问题是,我无法在新的android-x API上使用它们。

每个片段都有自己的首选项XML树(在setPreferencesFromResource中使用onCreatePreferences),但是我想出的每个解决方案要么什么都不做,要么崩溃了。

以可视化的方式表达,这就是我要实现的目标:

enter image description here

由于存在多个子设置屏幕,因此将所有它们的所有首选项都放在主设置屏幕的一个XML文件中会非常混乱。

我尝试过的

我成功的唯一方法是使用PreferenceScreen保留应该显示的子屏幕的首选项。

这是这种事情的工作代码(可用于项目here):

preferences.xml

<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android" android:title="Demo">

    <PreferenceScreen
        android:key="screen_preference" android:summary="Shows another screen of preferences"
        android:title="Screen preferenc">

        <CheckBoxPreference
            android:key="next_screen_checkbox_preference"
            android:summary="Preference that is on the next screen but same hierarchy"
            android:title="Toggle preference"/>

    </PreferenceScreen>

</PreferenceScreen>

MainActivity.kt

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

    override fun onPreferenceStartScreen(caller: PreferenceFragmentCompat, pref: PreferenceScreen): Boolean {
        val f = PrefsFragment()
        val args = Bundle(1)
        args.putString(PreferenceFragmentCompat.ARG_PREFERENCE_ROOT, pref.key)
        f.arguments = args
        supportFragmentManager.beginTransaction().replace(android.R.id.content, f).addToBackStack(null).commit()
        return true
    }

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

但是,正如我所写的,这不是我要尝试做的。我想拥有多个扩展PreferenceFragmentCompat的类,每个类都有其自己的XML文件,该文件将从主类中打开。

这是我尝试过(失败)的事情:

  1. PreferenceScreen设置一个“ android:fragment”,以指向新的片段类,类似于标头。这根本什么也没做。

  2. 使用常规首选项并为其单击监听器,这将执行片段处理,如原始代码所示。这导致崩溃,并显示类似“具有key screen_preference键的Preference对象不是PreferenceScreen”之类的信息。

  3. 试图避免使用ARG_PREFERENCE_ROOT,但是崩溃与#2相同。

  4. 根据建议here,我尝试在函数this中返回getCallbackFragment,但这根本没有帮助。

问题

是否可以让主要设置片段仅让用户导航到其他片段,而没有属于它们的其他任何首选项(在preferences.xml内部)?

如何?

3 个答案:

答案 0 :(得分:2)

好的,我发现了两种可能的解决方案,但很奇怪。

我仍然想知道是否有正式的方法来做,因为这两种解决方案都很奇怪。

解决方案1 ​​

在主设置首选项XML文件中,对于每个子PreferenceScreen,我放置一个空的Preference标签。

preferences.xml

<PreferenceScreen
    android:key="screen_preference" android:summary="Shows another screen of preferences"
    android:title="Screen preference">
    <Preference/>
</PreferenceScreen>

我在新的子屏幕片段上为setPreferencesFromResource的第二个参数传递了null。

这是代码(可用于项目here):

MainActivity.kt

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

    override fun onPreferenceStartScreen(caller: PreferenceFragmentCompat, pref: PreferenceScreen): Boolean {
        supportFragmentManager.beginTransaction().replace(android.R.id.content, PrefsFragment2()).addToBackStack(null).commit()
        return true
    }

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

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

当然,需要对此进行修改,以便您知道要创建和添加哪个片段...

解决方案2

我使用普通的Preference而不是每个PreferenceScreen,对于每个它们,我都选择单击以添加片段(项目可用的here):

preferences.xml

<Preference
    android:key="screen_preference" android:summary="Shows another screen of preferences"
    android:title="Screen preference"/>

MainActivity.kt

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

    class PrefsFragment : PreferenceFragmentCompat() {
        override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
            setPreferencesFromResource(R.xml.preferences, rootKey)
            setPreferenceToOpenFragmentAsNewPage(findPreference("screen_preference"), PrefsFragment2::class.java)
        }

        private fun setPreferenceToOpenFragmentAsNewPage(pref: Preference, java: Class<out PreferenceFragmentCompat>) {
            pref.onPreferenceClickListener = Preference.OnPreferenceClickListener {
                val fragment = java.newInstance()
                val args = Bundle(1)
                args.putString(PreferenceFragmentCompat.ARG_PREFERENCE_ROOT, pref.key)
                fragment.arguments = args
                activity!!.supportFragmentManager.beginTransaction().replace(android.R.id.content, fragment).addToBackStack(null).commit()
                true
            }
        }
    }

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

编辑:对第二个解决方案进行微小的修改可以使其更好:

preferences.xml

<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android" android:title="Demo">

    <Preference
        android:fragment="com.example.user.myapplication.MainActivity$PrefsFragment2" android:key="screen_preference"
        android:summary="Shows another screen of preferences" android:title="Screen preference"/>

</PreferenceScreen>

MainActivity.kt

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

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

        private fun setPreferenceToOpenFragmentAsNewPage(pref: Preference) {
            pref.onPreferenceClickListener = Preference.OnPreferenceClickListener {
                val clazz = Class.forName(pref.fragment)
                val fragment: PreferenceFragmentCompat = clazz.newInstance() as PreferenceFragmentCompat
                val args = Bundle(1)
                args.putString(PreferenceFragmentCompat.ARG_PREFERENCE_ROOT, pref.key)
                fragment.arguments = args
                activity!!.supportFragmentManager.beginTransaction().replace(android.R.id.content, fragment).addToBackStack(null).commit()
                true
            }
        }
    }

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

}

请注意,您需要将其添加到Proguard规则中:

-keepnames public class * extends androidx.preference.PreferenceFragmentCompat

解决方案2的另一项改进是,它可以自己遍历所有首选项:

class PrefsFragment : BasePreferenceFragment() {
    override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
        setPreferencesFromResource(R.xml.preferences_headers, rootKey)
        val preferenceScreen = preferenceScreen
        val preferenceCount = preferenceScreen.preferenceCount
        for (i in 0 until preferenceCount) {
            val pref = preferenceScreen.getPreference(i)
            val fragmentClassName = pref.fragment
            if (fragmentClassName.isNullOrEmpty())
                continue
            pref.setOnPreferenceClickListener {
                showPreferenceFragment(activity!!, fragmentClassName)
                true
            }
        }
    }
}

companion object {
    @JvmStatic
    private fun showPreferenceFragment(activity: FragmentActivity, fragmentClassName: String) {
        val clazz = Class.forName(fragmentClassName)
        val fragment: PreferenceFragmentCompat = clazz.newInstance() as PreferenceFragmentCompat
        val fragmentsCount = activity.supportFragmentManager.fragments.size
        val transaction = activity.supportFragmentManager.beginTransaction().replace(android.R.id.content, fragment)
        if (fragmentsCount > 0)
            transaction.addToBackStack(null)
        transaction.commit()
    }
}

编辑:似乎第一个解决方案是正确的,但是需要更改。检查答案here。完整的示例可用here

答案 1 :(得分:2)

仅供参考,如果您使用的是导航抽屉+ androidx.appcompat,则可以:

1)将每个PreferenceScreen子级拆分为与preference.xml文件一样多的子级: 即“ Pref_general.xml”将是主要首选项,“ pref_ServerSettings.xml”包含具有服务器设置的PreferenceScreen子级。 2)为每个preference.xml创建一个PreferenceFragmentCompat:

“ PrefFragmentGeneral”

在您的PrefFragmentGeneral.xml文件中,为任何子xml添加一个首选项,而不是像下面这样的PreferenceScreen:

<Preference
    android:key="pref_serverPref"
    android:summary="@string/settings_serverPrefSum"
    android:title="@string/settings_serverPrefTitle"
    />

“ PrefFragmentServer”

2)确保覆盖“ onCreatePreferences”以从您想要的XML文件中设置首选项:

public class PrefFragmentGeneral extends PreferenceFragmentCompat {
    @Override
    public void onCreatePreferences(Bundle savedInstanceState, String rootKey) {
        setPreferencesFromResource(R.xml.Pref_general, rootKey);
        //find your preference(s) using the same key
        Preference serverPref=findPreference("pref_serverPref");
        if(serverPref!=null){
            //Assign the click listener to navigate to the fragment using the navigation controller
            serverPref.setOnPreferenceClickListener(preference -> {
                NavController navController = Navigation.findNavController(getActivity(), R.id.nav_host_fragment);
                navController.navigate(R.id.nav_PrefFragmentServer);
                return true;
            });
        }
    }
//and the PrefFragmentServer 
public class PrefFragmentServer extends PreferenceFragmentCompat {
    @Override
    public void onCreatePreferences(Bundle savedInstanceState, String rootKey) {
        setPreferencesFromResource(R.xml.pref_ServerSettings,rootKey);
     }
}

3)在导航抽屉中注册所有片段:

Navigation drawer

现在享受吧!

优点:当您向后导航时,您将返回“常规”首选项,就像您回到PreferenceActivity子级一样! 并且您不会得到任何异常信息,告诉您该片段不是FragmentManager的一部分。

答案 2 :(得分:0)

您在1)中尝试过的方法是正确的-但您不应为此使用<PreferenceScreen>标签。

您的XML资源应该看起来像这样:

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

    <Preference
        app:key="screen_preference" 
        app:summary="Shows another screen of preferences"
        app:title="Screen preference"
        app:fragment="com.example.user.myapplication.MainActivity$PrefsFragment2"/>

</PreferenceScreen>

此外,如果您使用的Preference版本早于androidx.preference:preference:1.1.0-alpha01,则需要实现onPreferenceStartFragment来处理片段事务。 (在1.1.0 alpha01中,此方法具有默认实现,但仍建议您使用自己的实现来自定义任何动画/过渡)

这应该类似于:

override fun onPreferenceStartFragment(
        caller: PreferenceFragmentCompat,
        pref: Preference
): Boolean {
    // Instantiate the new Fragment
    val args = pref.extras
    val fragment = supportFragmentManager.fragmentFactory.instantiate(
            classLoader,
            pref.fragment,
            args
    ).apply {
        arguments = args
        setTargetFragment(caller, 0)
    }
    // Replace the existing Fragment with the new Fragment
    supportFragmentManager.beginTransaction()
            .replace(R.id.settings, fragment)
            .addToBackStack(null)
            .commit()
    return true
}

有关更多信息,请查看Settings指南 和AndroidX Preference Sample


编辑:第一个解决方案的示例在更新后可用here

这是它的工作方式(示例here):

MainActivity.kt

class MainActivity : AppCompatActivity(), PreferenceFragmentCompat.OnPreferenceStartFragmentCallback {
    override fun onPreferenceStartFragment(caller: PreferenceFragmentCompat, pref: Preference): Boolean {
        //Note: this whole function won't be needed when using new version of fragment dependency (1.1.0 and above)
        val fragment = Fragment.instantiate(this, pref.fragment, pref.extras)
        fragment.setTargetFragment(caller, 0)
        supportFragmentManager.beginTransaction().replace(android.R.id.content, fragment).addToBackStack(null).commit()
        return true
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        supportActionBar!!.setDisplayHomeAsUpEnabled(true)
        if (savedInstanceState == null)
            supportFragmentManager.beginTransaction().replace(android.R.id.content, PrefsFragment()).commit()
    }

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

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

preferences.xml

  <PreferenceScreen xmlns:app="http://schemas.android.com/apk/res-auto">

    <Preference
      app:fragment="com.example.user.myapplication.MainActivity$PrefsFragment2" app:key="screen_preference" app:summary="Shows another screen of preferences"
      app:title="Screen preference"/>

  </PreferenceScreen>

preferences2.xml

<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android" android:title="Demo">

  <PreferenceCategory android:title="Category">
    <CheckBoxPreference
      android:key="next_screen_checkbox_preference" android:summary="AAAA" android:title="Toggle preference"/>
  </PreferenceCategory>

</PreferenceScreen>

渐变依赖项:

implementation 'androidx.appcompat:appcompat:1.0.2'
implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
implementation 'androidx.preference:preference:1.0.0'