Как открыть новый PreferenceFragment из текущего, используя новый Android-X API?

Фон

В предыдущих версиях библиотеки поддержки мы могли использовать заголовки, чтобы иметь экран настроек главного меню, чтобы каждый из них открывал новый экран настроек (фрагмент) .

Эта проблема

Теперь заголовки исчезли (как написано здесь) на некоторое время, и я думаю, что это стало хуже на Android-X:

Одна вещь, которую вы не заметите здесь - это заголовки настроек, и вы будете совершенно правы. Однако это не означает, что единый список предпочтений должен охватывать 10-дюймовый экран планшета. Вместо этого ваша активность может реализовать OnPreferenceStartFragmentCallback ( ссылка) для обработки предпочтений с помощью атрибута app: фрагмент или OnPreferenceStartScreenCallback ( ссылка) для обработки предпочтений PreferenceScreen. Это позволяет вам создать стиль PreferenceFragmentCompat в "заголовке" в одной панели и использовать эти обратные вызовы для замены второй панели, не работая в двух отдельных типах XML-файлов.

Дело в том, что я не могу использовать их на новом Android-X API.

Каждый фрагмент имеет свое собственное дерево настроек XML (используя setPreferencesFromResource в onCreatePreferences), но каждое решение, которое я придумал, либо ничего не делало, либо терпело крах.

Чтобы выразить это визуально, вот чего я пытаюсь достичь:

Поскольку имеется несколько экранов дополнительных настроек, было бы очень грязно, если бы все предпочтения всех них были помещены в один XML-файл главного экрана настроек.

Что я пробовал

Единственное, что мне удалось, это использовать PreferenceScreen для хранения настроек подэкрана, который должен быть показан.

Вот рабочий код (проект доступен здесь) такой вещи:

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. Установите "Android: фрагмент" для PreferenceScreen, чтобы указать на новые фрагменты классов, похожие на заголовки. Это ничего не сделало вообще.

  2. Используйте обычное предпочтение и используйте для этого прослушиватель кликов, который будет выполнять транзакцию фрагмента, как показано в исходном коде. Это вызвало сбой, который говорит что-то вроде "Объект предпочтения с ключом screen_preference не является PreferenceScreen" .

  3. Пытался избегать использования ARG_PREFERENCE_ROOT, но имел тот же сбой, что и на #2 .

  4. Как предложено здесь, я попытался вернуться this в функции getCallbackFragment, но это совсем не помогло.

Вопрос

Можно ли иметь фрагмент основных настроек, просто позволяя пользователю переходить к другим фрагментам, не имея при этом никаких других предпочтений, которые ему принадлежат (внутри preferences.xml)

Как?

Источник

1 ответ

Решение

Хорошо, я нашел 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>

Я передаю NULL для второго аргумента setPreferencesFromResource на новом фрагменте подэкрана.

Вот код (проект доступен здесь):

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и для каждого из них я выбираю добавить фрагмент по клику (проект доступен здесь):

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()
    }
}
Источник

К вашему сведению, если вы используете панель навигации + androidx.appcompat, вы можете:

1) Разделите каждый дочерний элемент PreferenceScreen на столько файлов, сколько файл preference.xml: т.е. "Pref_general.xml" будет основным предпочтением, а "pref_ServerSettings.xml" содержит дочерний элемент PreferenceScreen с настройками вашего сервера. 2) Создайте PreferenceFragmentCompat для каждого файла preference.xml:

"PrefFragmentGeneral"

В файле PrefFragmentGeneral.xml добавьте Preference вместо PreferenceScreen, как показано ниже, для любого суб-xml:

<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) Зарегистрируйте все свои фрагменты в панели навигации:

А теперь наслаждайтесь!

Плюсы: при переходе назад вы возвращаетесь к параметру "Общие", как если бы вы возвращались к дочерним элементам PreferenceActivity! И вы не получите исключения, сообщающего, что фрагмент не является частью FragmentManager.

Источник

То, что вы попробовали в 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
}

Для получения дополнительной информации вы можете ознакомиться с руководством по настройкам и примером предпочтений AndroidX.

РЕДАКТИРОВАТЬ: образец первого решения, после обновления, доступны здесь.

Вот как это может работать (образец доступен здесь):

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>

зависимости gradle:

implementation 'androidx.appcompat:appcompat:1.0.2'
implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
implementation 'androidx.preference:preference:1.0.0'
Источник
Другие вопросы по тегам