added in version 24.1.0
belongs to Maven artifact com.android.support:preference-leanback-v17:28.0.0-alpha1

Summary: Inherited XML Attrs | Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

LeanbackPreferenceFragment

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public abstract class LeanbackPreferenceFragment
extends BaseLeanbackPreferenceFragment

java.lang.Object
↳	android.app.Fragment
	↳	android.support.v14.preference.PreferenceFragment
		↳	android.support.v17.preference.BaseLeanbackPreferenceFragment
			↳	android.support.v17.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:

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

    <Preference
        android:key="basic_preference"
        android:title="@string/title_basic_preference"
        android:summary="@string/summary_basic_preference" />

    <Preference
        android:key="stylish_preference"
        android:title="@string/title_stylish_preference"
        android:summary="@string/summary_stylish_preference" />

    <Preference
        android:key="preference_with_icon"
        android:title="Preference with icon"
        android:summary="This preference has an icon"
        android:icon="@android:drawable/ic_menu_camera" />

    <PreferenceCategory
        android:title="@string/inline_preferences">

        <CheckBoxPreference
            android:key="checkbox_preference"
            android:title="@string/title_checkbox_preference"
            android:summary="@string/summary_checkbox_preference" />

        <SwitchPreference
            android:key="switch_preference"
            android:title="Switch preference"
            android:summary="This is a switch" />

        <DropDownPreference
            android:key="dropdown_preference"
            android:title="@string/title_dropdown_preference"
            android:summary="@string/summary_dropdown_preference"
            android:entries="@array/entries_list_preference"
            android:entryValues="@array/entryvalues_list_preference" />

    </PreferenceCategory>

    <PreferenceCategory
        android:title="@string/dialog_based_preferences">

        <EditTextPreference
            android:key="edittext_preference"
            android:title="@string/title_edittext_preference"
            android:summary="@string/summary_edittext_preference"
            android:dialogTitle="@string/dialog_title_edittext_preference" />

        <ListPreference
            android:key="list_preference"
            android:title="@string/title_list_preference"
            android:summary="@string/summary_list_preference"
            android:entries="@array/entries_list_preference"
            android:entryValues="@array/entryvalues_list_preference"
            android:dialogTitle="@string/dialog_title_list_preference" />

        <MultiSelectListPreference
            android:key="multi_select_list_preference"
            android:title="@string/title_multi_list_preference"
            android:summary="@string/summary_multi_list_preference"
            android:entries="@array/entries_list_preference"
            android:entryValues="@array/entryvalues_list_preference"
            android:dialogTitle="@string/dialog_title_multi_list_preference" />

    </PreferenceCategory>

    <PreferenceCategory
        android:title="@string/launch_preferences">

        <!-- This PreferenceScreen tag serves as a screen break (similar to page break
             in word processing). Like for other preference types, we assign a key
             here so it is able to save and restore its instance state. -->
        <PreferenceScreen
            android:key="screen_preference"
            android:title="@string/title_screen_preference"
            android:summary="@string/summary_screen_preference">

            <!-- You can place more preferences here that will be shown on the next screen. -->

            <CheckBoxPreference
                android:key="next_screen_checkbox_preference"
                android:title="@string/title_next_screen_toggle_preference"
                android:summary="@string/summary_next_screen_toggle_preference" />

        </PreferenceScreen>

        <PreferenceScreen
            android:title="@string/title_intent_preference"
            android:summary="@string/summary_intent_preference">

            <intent android:action="android.intent.action.VIEW"
                android:data="http://www.android.com" />

        </PreferenceScreen>

    </PreferenceCategory>

    <PreferenceCategory
        android:title="@string/preference_attributes">

        <CheckBoxPreference
            android:key="parent_checkbox_preference"
            android:title="@string/title_parent_preference"
            android:summary="@string/summary_parent_preference" />

        <!-- The visual style of a child is defined by this styled theme attribute. -->
        <CheckBoxPreference
            android:key="child_checkbox_preference"
            android:dependency="parent_checkbox_preference"
            android:layout="?android:attr/preferenceLayoutChild"
            android:title="@string/title_child_preference"
            android:summary="@string/summary_child_preference" />

    </PreferenceCategory>

</PreferenceScreen>

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

public static class SettingsFragment extends LeanbackSettingsFragment {
    @Override
    public void onPreferenceStartInitialScreen() {
        startPreferenceFragment(new PrefsFragment());
    }

    @Override
    public boolean onPreferenceStartFragment(PreferenceFragment caller, Preference pref) {
        final Fragment f =
                Fragment.instantiate(getActivity(), pref.getFragment(), pref.getExtras());
        f.setTargetFragment(caller, 0);
        if (f instanceof PreferenceFragment || f instanceof PreferenceDialogFragment) {
            startPreferenceFragment(f);
        } else {
            startImmersiveFragment(f);
        }
        return true;
    }

    @Override
    public boolean onPreferenceStartScreen(PreferenceFragment caller, PreferenceScreen pref) {
        final Fragment f = new PrefsFragment();
        final Bundle args = new Bundle(1);
        args.putString(PreferenceFragment.ARG_PREFERENCE_ROOT, pref.getKey());
        f.setArguments(args);
        startPreferenceFragment(f);
        return true;
    }
}

public static class PrefsFragment extends LeanbackPreferenceFragment {

    @Override
    public void onCreatePreferences(Bundle savedInstanceState, String rootKey) {
        // Load the preferences from an XML resource
        setPreferencesFromResource(R.xml.preferences, rootKey);
    }
}

Summary

Inherited XML attributes
From class android.support.v14.preference.PreferenceFragment PreferenceFragment_android_divider   PreferenceFragment_android_dividerHeight

Inherited constants
From class android.support.v14.preference.PreferenceFragment String ARG_PREFERENCE_ROOT Fragment argument used to specify the tag of the desired root PreferenceScreen object.
From interface android.content.ComponentCallbacks2 int TRIM_MEMORY_BACKGROUND int TRIM_MEMORY_COMPLETE int TRIM_MEMORY_MODERATE int TRIM_MEMORY_RUNNING_CRITICAL int TRIM_MEMORY_RUNNING_LOW int TRIM_MEMORY_RUNNING_MODERATE int TRIM_MEMORY_UI_HIDDEN

Public constructors
LeanbackPreferenceFragment()

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

Inherited methods
From class android.support.v17.preference.BaseLeanbackPreferenceFragment RecyclerView onCreateRecyclerView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState) Creates the RecyclerView used to display the preferences.
From class android.support.v14.preference.PreferenceFragment void addPreferencesFromResource(int preferencesResId) Inflates the given XML resource and adds the preference hierarchy to the current preference hierarchy. Preference findPreference(CharSequence key) Finds a Preference based on its key. final 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. void onActivityCreated(Bundle savedInstanceState) void onCreate(Bundle savedInstanceState) Adapter onCreateAdapter(PreferenceScreen preferenceScreen) Creates the root adapter. RecyclerView.LayoutManager onCreateLayoutManager() Called from onCreateRecyclerView(LayoutInflater, ViewGroup, Bundle) to create the RecyclerView.LayoutManager for the created RecyclerView. abstract void onCreatePreferences(Bundle savedInstanceState, String rootKey) Called during onCreate(Bundle) to supply the preferences for this fragment. RecyclerView onCreateRecyclerView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState) Creates the RecyclerView used to display the preferences. View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) void onDestroyView() void onDisplayPreferenceDialog(Preference preference) Called when a preference in the tree requests to display a dialog. void onNavigateToScreen(PreferenceScreen preferenceScreen) Called by onClick() in order to navigate to a new screen of preferences. boolean onPreferenceTreeClick(Preference preference) Called when a preference in the tree rooted at this PreferenceScreen has been clicked. void onSaveInstanceState(Bundle outState) void onStart() void onStop() void onViewCreated(View view, Bundle savedInstanceState) void scrollToPreference(Preference preference) void scrollToPreference(String key) void setDivider(Drawable divider) Sets the drawable that will be drawn between each item in the list. void setDividerHeight(int height) Sets the height of the divider that will be drawn between each item in the list. void setPreferenceScreen(PreferenceScreen preferenceScreen) Sets the root of the preference hierarchy that this fragment is showing. void setPreferencesFromResource(int preferencesResId, String key) Inflates the given XML resource and replaces the current preference hierarchy (if any) with the preference hierarchy rooted at key.
From class android.app.Fragment void dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3) final boolean equals(Object arg0) final Activity getActivity() boolean getAllowEnterTransitionOverlap() boolean getAllowReturnTransitionOverlap() final Bundle getArguments() final FragmentManager getChildFragmentManager() Context getContext() Transition getEnterTransition() Transition getExitTransition() final FragmentManager getFragmentManager() final Object getHost() final int getId() final LayoutInflater getLayoutInflater() LoaderManager getLoaderManager() final Fragment getParentFragment() Transition getReenterTransition() final Resources getResources() final boolean getRetainInstance() Transition getReturnTransition() Transition getSharedElementEnterTransition() Transition getSharedElementReturnTransition() final String getString(int arg0, Object... arg1) final String getString(int arg0) final String getTag() final Fragment getTargetFragment() final int getTargetRequestCode() final CharSequence getText(int arg0) boolean getUserVisibleHint() View getView() final int hashCode() static Fragment instantiate(Context arg0, String arg1) static Fragment instantiate(Context arg0, String arg1, Bundle arg2) final boolean isAdded() final boolean isDetached() final boolean isHidden() final boolean isInLayout() final boolean isRemoving() final boolean isResumed() final boolean isStateSaved() final boolean isVisible() void onActivityCreated(Bundle arg0) void onActivityResult(int arg0, int arg1, Intent arg2) void onAttach(Activity arg0) void onAttach(Context arg0) void onAttachFragment(Fragment arg0) void onConfigurationChanged(Configuration arg0) boolean onContextItemSelected(MenuItem arg0) void onCreate(Bundle arg0) Animator onCreateAnimator(int arg0, boolean arg1, int arg2) void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2) void onCreateOptionsMenu(Menu arg0, MenuInflater arg1) View onCreateView(LayoutInflater arg0, ViewGroup arg1, Bundle arg2) void onDestroy() void onDestroyOptionsMenu() void onDestroyView() void onDetach() LayoutInflater onGetLayoutInflater(Bundle arg0) void onHiddenChanged(boolean arg0) void onInflate(AttributeSet arg0, Bundle arg1) void onInflate(Activity arg0, AttributeSet arg1, Bundle arg2) void onInflate(Context arg0, AttributeSet arg1, Bundle arg2) void onLowMemory() void onMultiWindowModeChanged(boolean arg0) void onMultiWindowModeChanged(boolean arg0, Configuration arg1) boolean onOptionsItemSelected(MenuItem arg0) void onOptionsMenuClosed(Menu arg0) void onPause() void onPictureInPictureModeChanged(boolean arg0, Configuration arg1) void onPictureInPictureModeChanged(boolean arg0) void onPrepareOptionsMenu(Menu arg0) void onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2) void onResume() void onSaveInstanceState(Bundle arg0) void onStart() void onStop() void onTrimMemory(int arg0) void onViewCreated(View arg0, Bundle arg1) void onViewStateRestored(Bundle arg0) void postponeEnterTransition() void registerForContextMenu(View arg0) final void requestPermissions(String[] arg0, int arg1) void setAllowEnterTransitionOverlap(boolean arg0) void setAllowReturnTransitionOverlap(boolean arg0) void setArguments(Bundle arg0) void setEnterSharedElementCallback(SharedElementCallback arg0) void setEnterTransition(Transition arg0) void setExitSharedElementCallback(SharedElementCallback arg0) void setExitTransition(Transition arg0) void setHasOptionsMenu(boolean arg0) void setInitialSavedState(Fragment.SavedState arg0) void setMenuVisibility(boolean arg0) void setReenterTransition(Transition arg0) void setRetainInstance(boolean arg0) void setReturnTransition(Transition arg0) void setSharedElementEnterTransition(Transition arg0) void setSharedElementReturnTransition(Transition arg0) void setTargetFragment(Fragment arg0, int arg1) void setUserVisibleHint(boolean arg0) boolean shouldShowRequestPermissionRationale(String arg0) void startActivity(Intent arg0) void startActivity(Intent arg0, Bundle arg1) void startActivityForResult(Intent arg0, int arg1) void startActivityForResult(Intent arg0, int arg1, Bundle arg2) void startIntentSenderForResult(IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6) void startPostponedEnterTransition() String toString() void unregisterForContextMenu(View arg0)
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface android.support.v7.preference.PreferenceManager.OnPreferenceTreeClickListener abstract boolean onPreferenceTreeClick(Preference preference) Called when a preference in the tree rooted at this PreferenceScreen has been clicked.
From interface android.support.v7.preference.PreferenceManager.OnDisplayPreferenceDialogListener abstract void onDisplayPreferenceDialog(Preference preference) Called when a preference in the tree requests to display a dialog.
From interface android.support.v7.preference.PreferenceManager.OnNavigateToScreenListener abstract void onNavigateToScreen(PreferenceScreen preferenceScreen) Called when a PreferenceScreen in the tree requests to navigate to its contents.
From interface android.support.v7.preference.DialogPreference.TargetFragment abstract Preference findPreference(CharSequence key)
From interface android.content.ComponentCallbacks2 abstract void onTrimMemory(int arg0)
From interface android.view.View.OnCreateContextMenuListener abstract void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)
From interface android.content.ComponentCallbacks abstract void onConfigurationChanged(Configuration arg0) abstract void onLowMemory()

Public constructors

LeanbackPreferenceFragment

added in version 24.1.0

LeanbackPreferenceFragment ()

Public methods

onCreateView

View onCreateView (LayoutInflater inflater, 
                ViewGroup container, 
                Bundle savedInstanceState)

Parameters
inflater	LayoutInflater
container	ViewGroup
savedInstanceState	Bundle

Returns
View

onViewCreated

void onViewCreated (View view, 
                Bundle savedInstanceState)

Parameters
view	View
savedInstanceState	Bundle

setTitle

added in version 25.1.0

void setTitle (CharSequence title)

Set the title to be shown above the preference list

Parameters
title	CharSequence: Title text to be shown

• Interfaces

  • LeanbackListPreferenceDialogFragment.ViewHolder.OnItemClickListener

• Classes

  • BaseLeanbackPreferenceFragment
  • LeanbackListPreferenceDialogFragment
  • LeanbackListPreferenceDialogFragment.AdapterMulti
  • LeanbackListPreferenceDialogFragment.AdapterSingle
  • LeanbackListPreferenceDialogFragment.ViewHolder
  • LeanbackPreferenceDialogFragment
  • LeanbackPreferenceFragment
  • LeanbackSettingsFragment
  • R
  • R.anim
  • R.animator
  • R.attr
  • R.bool
  • R.color
  • R.dimen
  • R.drawable
  • R.fraction
  • R.id
  • R.integer
  • R.layout
  • R.raw
  • R.string
  • R.style
  • R.styleable
  • R.transition