LeanbackPreferenceFragment

Kotlin |Java

abstract class LeanbackPreferenceFragment : BaseLeanbackPreferenceFragment

kotlin.Any
↳	android.app.Fragment
	↳	androidx.preference.PreferenceFragment
		↳	androidx.leanback.preference.BaseLeanbackPreferenceFragment
			↳	androidx.leanback.preference.LeanbackPreferenceFragment

This fragment provides a fully decorated leanback-style preference fragment, including a list background and header.

The following sample code shows a simple leanback preference fragment that is populated from a resource. The resource it loads is:

The fragment needs only to implement onCreatePreferences(Bundle, String) to populate the list of preference objects:

Summary

Inherited constants

From class PreferenceFragment

String

ARG_PREFERENCE_ROOT

Fragment argument used to specify the tag of the desired root PreferenceScreen object.

Public constructors
`<init>()`

Public methods
open View!	`onCreateView(inflater: LayoutInflater!, container: ViewGroup!, savedInstanceState: Bundle!)`
open Unit	`onViewCreated(view: View!, savedInstanceState: Bundle!)`
open Unit	`setTitle(title: CharSequence!)` Set the title to be shown above the preference list

Inherited functions

From class PreferenceFragment

`Unit`	`addPreferencesFromResource(@XmlRes preferencesResId: Int)` Inflates the given XML resource and adds the preference hierarchy to the current preference hierarchy.
`T?`	`findPreference(key: CharSequence)` Finds a `Preference` based on its key.
`RecyclerView!`	`getListView()`
`PreferenceManager!`	`getPreferenceManager()` Returns the `PreferenceManager` used by this fragment.
`PreferenceScreen!`	`getPreferenceScreen()` Gets the root of the preference hierarchy that this fragment is showing.
`Unit`	`onCreate(savedInstanceState: Bundle!)`
`RecyclerView.Adapter<RecyclerView.ViewHolder!>!`	`onCreateAdapter(preferenceScreen: PreferenceScreen!)` Creates the root adapter.
`RecyclerView.LayoutManager!`	`onCreateLayoutManager()` Called from `onCreateRecyclerView` to create the `RecyclerView.LayoutManager` for the created `RecyclerView`.
`Unit`	`onCreatePreferences(savedInstanceState: Bundle!, rootKey: String!)` Called during `onCreate(Bundle)` to supply the preferences for this fragment. Subclasses are expected to call `setPreferenceScreen(PreferenceScreen)` either directly or via helper methods such as `addPreferencesFromResource(int)`.
`View!`	`onCreateView(inflater: LayoutInflater!, container: ViewGroup!, savedInstanceState: Bundle!)`
`Unit`	`onDestroyView()`
`Unit`	`onDisplayPreferenceDialog(preference: Preference!)` Called when a preference in the tree requests to display a dialog. Subclasses should override this method to display custom dialogs or to handle dialogs for custom preference classes.
`Unit`	`onNavigateToScreen(preferenceScreen: PreferenceScreen!)` Called by `PreferenceScreen#onClick()` in order to navigate to a new screen of preferences. Calls `PreferenceFragment.OnPreferenceStartScreenCallback#onPreferenceStartScreen` if the target fragment or containing activity implements `PreferenceFragment.OnPreferenceStartScreenCallback`.
`Boolean`	`onPreferenceTreeClick(preference: Preference!)` Called when a preference in the tree rooted at this `PreferenceScreen` has been clicked.
`Unit`	`onSaveInstanceState(outState: Bundle!)`
`Unit`	`onStart()`
`Unit`	`onStop()`
`Unit`	`onViewCreated(view: View!, savedInstanceState: Bundle!)`
`Unit`	`scrollToPreference(key: String!)`
`Unit`	`scrollToPreference(preference: Preference!)`
`Unit`	`setDivider(divider: Drawable!)` Sets the `Drawable` that will be drawn between each item in the list. Note: If the drawable does not have an intrinsic height, you should also call `setDividerHeight(int)`.
`Unit`	`setDividerHeight(height: Int)` Sets the height of the divider that will be drawn between each item in the list. Calling this will override the intrinsic height as set by `setDivider(Drawable)`.
`Unit`	`setPreferenceScreen(preferenceScreen: PreferenceScreen!)` Sets the root of the preference hierarchy that this fragment is showing.
`Unit`	`setPreferencesFromResource(@XmlRes preferencesResId: Int, @Nullable key: String?)` Inflates the given XML resource and replaces the current preference hierarchy (if any) with the preference hierarchy rooted at `key`.

From class BaseLeanbackPreferenceFragment

RecyclerView!

onCreateRecyclerView(inflater: LayoutInflater!, parent: ViewGroup!, savedInstanceState: Bundle!)

Public constructors

<init>

LeanbackPreferenceFragment()

Public methods

onCreateView

open fun onCreateView(
    inflater: LayoutInflater!, 
    container: ViewGroup!, 
    savedInstanceState: Bundle!
): View!

onViewCreated

open fun onViewCreated(
    view: View!, 
    savedInstanceState: Bundle!
): Unit

setTitle

open fun setTitle(title: CharSequence!): Unit

Set the title to be shown above the preference list

Parameters
`title`	CharSequence!: Title text to be shown