BaseLeanbackPreferenceFragmentCompat

Kotlin |Java

abstract class BaseLeanbackPreferenceFragmentCompat : PreferenceFragmentCompat

kotlin.Any
↳	androidx.fragment.app.Fragment
	↳	androidx.preference.PreferenceFragmentCompat
		↳	androidx.leanback.preference.BaseLeanbackPreferenceFragmentCompat

Known Direct Subclasses

LeanbackPreferenceFragmentCompat

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

This fragment provides a preference fragment with leanback-style behavior, suitable for embedding into broader UI elements.

Summary

Inherited constants

From class PreferenceFragmentCompat

String

ARG_PREFERENCE_ROOT

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

Public constructors
`<init>()` This fragment provides a preference fragment with leanback-style behavior, suitable for embedding into broader UI elements.

Public methods
open Context?	`getContext()`
open RecyclerView!	`onCreateRecyclerView(inflater: LayoutInflater!, parent: ViewGroup!, savedInstanceState: Bundle!)`

Inherited functions

From class PreferenceFragmentCompat

`Unit`	`addPreferencesFromResource(@XmlRes preferencesResId: Int)` Inflates the given XML resource and adds the preference hierarchy to the current preference hierarchy.
`T?`	`findPreference(@NonNull key: CharSequence)`
`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(@Nullable 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(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup?, @Nullable 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 `PreferenceFragmentCompat.OnPreferenceStartScreenCallback#onPreferenceStartScreen` if the target fragment or containing activity implements `PreferenceFragmentCompat.OnPreferenceStartScreenCallback`.
`Boolean`	`onPreferenceTreeClick(preference: Preference!)` Called when a preference in the tree rooted at this `PreferenceScreen` has been clicked.
`Unit`	`onSaveInstanceState(@NonNull outState: Bundle)`
`Unit`	`onStart()`
`Unit`	`onStop()`
`Unit`	`onViewCreated(@NonNull view: View, @Nullable 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 Fragment

Unit

dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<String!>?)

Print the Fragments's state into the given stream.

Boolean

equals(@Nullable other: Any?)

Subclasses can not override equals().

FragmentActivity?

getActivity()

Return the FragmentActivity this fragment is currentl