BaseLeanbackPreferenceFragment

Artifact: androidx.leanback:leanback-preference

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

abstract class BaseLeanbackPreferenceFragment : PreferenceFragment

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

Known direct subclasses

LeanbackPreferenceFragment

LeanbackPreferenceFragment

This class is deprecated.

Use LeanbackPreferenceFragmentCompat

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

Summary

Public constructors
`BaseLeanbackPreferenceFragment()`

Public functions
`RecyclerView!`	`onCreateRecyclerView( inflater: LayoutInflater!, parent: ViewGroup!, savedInstanceState: Bundle! )` This function is deprecated. Use `PreferenceFragmentCompat` instead

Public functions

RecyclerView!

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

This function is deprecated.

Use PreferenceFragmentCompat instead

Inherited Constants

From android.content.ComponentCallbacks2

`const Int`	`TRIM_MEMORY_BACKGROUND = 40`
`const Int`	`TRIM_MEMORY_COMPLETE = 80` This property is deprecated.
`const Int`	`TRIM_MEMORY_MODERATE = 60` This property is deprecated.
`const Int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15` This property is deprecated.
`const Int`	`TRIM_MEMORY_RUNNING_LOW = 10` This property is deprecated.
`const Int`	`TRIM_MEMORY_RUNNING_MODERATE = 5` This property is deprecated.
`const Int`	`TRIM_MEMORY_UI_HIDDEN = 20`

From androidx.preference.PreferenceFragment

const String!

ARG_PREFERENCE_ROOT = "androidx.preference.PreferenceFragmentCompat.PREFERENCE_ROOT"

This property is deprecated.

Use PreferenceFragmentCompat instead

Inherited functions

From android.app.Fragment

`Unit`	`dump( prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>! )` This function is deprecated.
`Boolean`	`equals(o: Any!)` This function is deprecated.
`Activity!`	`getActivity()` This function is deprecated.
`Boolean`	`getAllowEnterTransitionOverlap()` This function is deprecated.
`Boolean`	`getAllowReturnTransitionOverlap()` This function is deprecated.
`Bundle!`	`getArguments()` This function is deprecated.
`FragmentManager!`	`getChildFragmentManager()` This function is deprecated.
`Context!`	`getContext()` This function is deprecated.
`Transition!`	`getEnterTransition()` This function is deprecated.
`Transition!`	`getExitTransition()` This function is deprecated.
`FragmentManager!`	`getFragmentManager()` This function is deprecated.
`Any!`	`getHost()` This function is deprecated.
`Int`	`getId()` This function is deprecated.
`LayoutInflater!`	`getLayoutInflater()` This function is deprecated.
`LoaderManager!`	`getLoaderManager()` This function is deprecated.
`Fragment!`	`getParentFragment()` This function is deprecated.
`Transition!`	`getReenterTransition()` This function is deprecated.
`Resources!`	`getResources()` This function is deprecated.
`Boolean`	`getRetainInstance()` This function is deprecated.
`Transition!`	`getReturnTransition()` This function is deprecated.
`Transition!`	`getSharedElementEnterTransition()` This function is deprecated.
`Transition!`	`getSharedElementReturnTransition()` This function is deprecated.
`String!`	`getString(resId: Int)` This function is deprecated.
`String!`	`getTag()` This function is deprecated.
`Fragment!`	`getTargetFragment()` This function is deprecated.
`Int`	`getTargetRequestCode()` This function is deprecated.
`CharSequence!`	`getText(resId: Int)` This function is deprecated.
`Boolean`	`getUserVisibleHint()` This function is deprecated.
`View!`	`getView()` This function is deprecated.
`Int`	`hashCode()` This function is deprecated.
`java-static Fragment!`	`instantiate(context: Context!, fname: String!)` This function is deprecated.
`Boolean`	`isAdded()` This function is deprecated.
`Boolean`	`isDetached()` This function is deprecated.
`Boolean`	`isHidden()` This function is deprecated.
`Boolean`	`isInLayout()` This function is deprecated.
`Boolean`	`isRemoving()` This function is deprecated.
`Boolean`	`isResumed()` This function is deprecated.
`Boolean`	`isStateSaved()` This function is deprecated.
`Boolean`	`isVisible()` This function is deprecated.
`Unit`	`onActivityCreated(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, data: Intent!)` This function is deprecated.
`Unit`	`onAttach(activity: Activity!)` This function is deprecated.
`Unit`	`onAttachFragment(childFragment: Fragment!)` This function is deprecated.
`Unit`	`onConfigurationChanged(newConfig: Configuration!)` This function is deprecated.
`Boolean`	`onContextItemSelected(item: MenuItem!)` This function is deprecated.
`Unit`	`onCreate(savedInstanceState: Bundle!)` This function is deprecated.
`Animator!`	`onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` This function is deprecated.
`Unit`	`onCreateContextMenu( menu: ContextMenu!, v: View!, menuInfo: ContextMenu.ContextMenuInfo! )` This function is deprecated.
`Unit`	`onCreateOptionsMenu(menu: Menu!, inflater: MenuInflater!)` This function is deprecated.
`View!`	`onCreateView( inflater: LayoutInflater!, container: ViewGroup!, savedInstanceState: Bundle! )` This function is deprecated.
`Unit`	`onDestroy()` This function is deprecated.
`Unit`	`onDestroyOptionsMenu()` This function is deprecated.
`Unit`	`onDestroyView()` This function is deprecated.
`Unit`	`onDetach()` This function is deprecated.
`LayoutInflater!`	`onGetLayoutInflater(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onHiddenChanged(hidden: Boolean)` This function is deprecated.
`Unit`	`onInflate( activity: Activity!, attrs: AttributeSet!, savedInstanceState: Bundle! )` This function is deprecated.
`Unit`	`onLowMemory()` This function is deprecated.
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` This function is deprecated.
`Boolean`	`onOptionsItemSelected(item: MenuItem!)` This function is deprecated.
`Unit`	`onOptionsMenuClosed(menu: Menu!)` This function is deprecated.
`Unit`	`onPause()` This function is deprecated.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` This function is deprecated.
`Unit`	`onPrepareOptionsMenu(menu: Menu!)` This function is deprecated.
`Unit`	`onRequestPermissionsResult( requestCode: Int, permissions: Array<String!>!, grantResults: IntArray! )` This function is deprecated.
`Unit`	`onResume()` This function is deprecated.
`Unit`	`onSaveInstanceState(outState: Bundle!)` This function is deprecated.
`Unit`	`onStart()` This function is deprecated.
`Unit`	`onStop()` This function is deprecated.
`Unit`	`onTrimMemory(level: Int)` This function is deprecated.
`Unit`	`onViewCreated(view: View!, savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onViewStateRestored(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`postponeEnterTransition()` This function is deprecated.
`Unit`	`registerForContextMenu(view: View!)` This function is deprecated.
`Unit`	`requestPermissions(permissions: Array<String!>!, requestCode: Int)` This function is deprecated.
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` This function is deprecated.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` This function is deprecated.
`Unit`	`setArguments(args: Bundle!)` This function is deprecated.
`Unit`	`setEnterSharedElementCallback(callback: SharedElementCallback!)` This function is deprecated.
`Unit`	`setEnterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setExitSharedElementCallback(callback: SharedElementCallback!)` This function is deprecated.
`Unit`	`setExitTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` This function is deprecated.
`Unit`	`setInitialSavedState(state: Fragment.SavedState!)` This function is deprecated.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` This function is deprecated.
`Unit`	`setReenterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setRetainInstance(retain: Boolean)` This function is deprecated.
`Unit`	`setReturnTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setSharedElementEnterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setSharedElementReturnTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setTargetFragment(fragment: Fragment!, requestCode: Int)` This function is deprecated.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` This function is deprecated.
`Boolean`	`shouldShowRequestPermissionRationale(permission: String!)` This function is deprecated.
`Unit`	`startActivity(intent: Intent!)` This function is deprecated.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int)` This function is deprecated.
`Unit`	`startIntentSenderForResult( intent: IntentSender!, requestCode: Int, fillInIntent: Intent!, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle! )` This function is deprecated.
`Unit`	`startPostponedEnterTransition()` This function is deprecated.
`String!`	`toString()` This function is deprecated.
`Unit`	`unregisterForContextMenu(view: View!)` This function is deprecated.

From androidx.preference.PreferenceFragment

`Unit`	`addPreferencesFromResource(preferencesResId: @XmlRes Int)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`T!`	`<T : Preference?> findPreference(key: CharSequence)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`RecyclerView!`	`getListView()` This function is deprecated. Use `PreferenceFragmentCompat` instead
`PreferenceManager!`	`getPreferenceManager()` This function is deprecated. Use `PreferenceFragmentCompat` instead
`PreferenceScreen!`	`getPreferenceScreen()` This function is deprecated. Use `PreferenceFragmentCompat` instead
`Unit`	`onCreate(savedInstanceState: Bundle?)` This function is deprecated.
`RecyclerView.Adapter`	`onCreateAdapter(preferenceScreen: PreferenceScreen)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`RecyclerView.LayoutManager`	`onCreateLayoutManager()` This function is deprecated. Use `PreferenceFragmentCompat` instead
`abstract Unit`	`onCreatePreferences(savedInstanceState: Bundle?, rootKey: String!)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`View`	`onCreateView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle? )` This function is deprecated.
`Unit`	`onDestroyView()` This function is deprecated.
`Unit`	`onDisplayPreferenceDialog(preference: Preference)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`Unit`	`onNavigateToScreen(preferenceScreen: PreferenceScreen)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`Boolean`	`onPreferenceTreeClick(preference: Preference)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`Unit`	`onSaveInstanceState(outState: Bundle)` This function is deprecated.
`Unit`	`onStart()` This function is deprecated.
`Unit`	`onStop()` This function is deprecated.
`Unit`	`onViewCreated(view: View, savedInstanceState: Bundle?)` This function is deprecated.
`Unit`	`scrollToPreference(key: String)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`Unit`	`scrollToPreference(preference: Preference)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`Unit`	`setDivider(divider: Drawable?)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`Unit`	`setDividerHeight(height: Int)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`Unit`	`setPreferenceScreen(preferenceScreen: PreferenceScreen!)` This function is deprecated. Use `PreferenceFragmentCompat` instead
`Unit`	`setPreferencesFromResource(preferencesResId: @XmlRes Int, key: String?)` This function is deprecated. Use `PreferenceFragmentCompat` instead

Public constructors

BaseLeanbackPreferenceFragment

Added in 1.1.0

Deprecated in 1.1.0

BaseLeanbackPreferenceFragment()

Public functions

onCreateRecyclerView

Added in 1.1.0

Deprecated in 1.1.0

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

Creates the RecyclerView used to display the preferences. Subclasses may override this to return a customized RecyclerView.

Parameters
`inflater: LayoutInflater!`	The LayoutInflater object that can be used to inflate the `RecyclerView`.
`parent: ViewGroup!`	The parent view that the RecyclerView will be attached to. This method should not add the view itself, but this can be used to generate the layout params of the view.
`savedInstanceState: Bundle!`	If non-null, this view is being re-constructed from a previous saved state as given here.

Returns
`RecyclerView!`	A new `RecyclerView` object to be placed into the view hierarchy