Summary: Inherited Constants | Ctors | Methods | Inherited Methods

LeanbackSettingsFragment

Kotlin |Java

public abstract class LeanbackSettingsFragment
extends Fragment implements PreferenceFragment.OnPreferenceStartFragmentCallback, PreferenceFragment.OnPreferenceStartScreenCallback, PreferenceFragment.OnPreferenceDisplayDialogCallback

java.lang.Object
↳	android.app.Fragment
	↳	androidx.leanback.preference.LeanbackSettingsFragment

---

This class is deprecated.
Use LeanbackSettingsFragmentCompat

This fragment provides a container for displaying a LeanbackPreferenceFragment

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"
        xmlns:app="http://schemas.android.com/apk/res-auto">

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

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

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

        <Preference
                android:key="icon"
                android:title="@string/title_icon_preference"
                android:summary="@string/summary_icon_preference"
                android:icon="@android:drawable/ic_menu_camera"/>

        <Preference
                android:key="single_line_title"
                android:title="@string/title_single_line_title_preference"
                android:summary="@string/summary_single_line_title_preference"
                app:singleLineTitle="true"/>
    </PreferenceCategory>

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

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

        <SwitchPreferenceCompat
                android:key="switch"
                android:title="@string/title_switch_preference"
                android:summary="@string/summary_switch_preference"/>

        <DropDownPreference
                android:key="dropdown"
                android:title="@string/title_dropdown_preference"
                android:entries="@array/entries"
                app:useSimpleSummaryProvider="true"
                android:entryValues="@array/entry_values"/>

        <SeekBarPreference
                android:key="seekbar"
                android:title="@string/title_seekbar_preference"
                android:max="10"
                android:defaultValue="5"/>
    </PreferenceCategory>

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

        <EditTextPreference
                android:key="edittext"
                android:title="@string/title_edittext_preference"
                app:useSimpleSummaryProvider="true"
                android:dialogTitle="@string/dialog_title_edittext_preference"/>

        <ListPreference
                android:key="list"
                android:title="@string/title_list_preference"
                app:useSimpleSummaryProvider="true"
                android:entries="@array/entries"
                android:entryValues="@array/entry_values"
                android:dialogTitle="@string/dialog_title_list_preference"/>

        <MultiSelectListPreference
                android:key="multi_select_list"
                android:title="@string/title_multi_list_preference"
                android:summary="@string/summary_multi_list_preference"
                android:entries="@array/entries"
                android:entryValues="@array/entry_values"
                android:dialogTitle="@string/dialog_title_multi_list_preference"/>
    </PreferenceCategory>

    <PreferenceCategory
            android:key="advanced"
            android:title="@string/advanced_attributes"
            app:initialExpandedChildrenCount="1">

        <Preference
                android:key="expandable"
                android:title="@string/title_expandable_preference"
                android:summary="@string/summary_expandable_preference"/>

        <Preference
                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"/>

        </Preference>

        <SwitchPreferenceCompat
                android:key="parent"
                android:title="@string/title_parent_preference"
                android:summary="@string/summary_parent_preference"/>

        <SwitchPreferenceCompat
                android:key="child"
                android:dependency="parent"
                android:title="@string/title_child_preference"
                android:summary="@string/summary_child_preference"/>

        <SwitchPreferenceCompat
                android:key="toggle_summary"
                android:title="@string/title_toggle_summary_preference"
                android:summaryOn="@string/summary_on_toggle_summary_preference"
                android:summaryOff="@string/summary_off_toggle_summary_preference"/>

        <Preference
                android:key="copyable"
                android:title="@string/title_copyable_preference"
                android:summary="@string/summary_copyable_preference"
                android:selectable="false"
                app:enableCopying="true"/>
    </PreferenceCategory>

</PreferenceScreen>

The sample implements PreferenceFragment.OnPreferenceStartFragmentCallback.onPreferenceStartFragment(PreferenceFragment, Preference), PreferenceFragment.OnPreferenceStartScreenCallback.onPreferenceStartScreen(PreferenceFragment, PreferenceScreen), and onPreferenceStartInitialScreen():

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

    @Override
    public boolean onPreferenceStartFragment(PreferenceFragmentCompat caller, Preference pref) {
        final Bundle args = pref.getExtras();
        final Fragment f = getChildFragmentManager().getFragmentFactory().instantiate(
                requireActivity().getClassLoader(), pref.getFragment());
        f.setArguments(args);
        f.setTargetFragment(caller, 0);
        if (f instanceof PreferenceFragmentCompat
                || f instanceof PreferenceDialogFragmentCompat) {
            startPreferenceFragment(f);
        } else {
            startImmersiveFragment(f);
        }
        return true;
    }

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

/**
 * The fragment that is embedded in SettingsFragment
 */
public static class DemoFragment extends LeanbackPreferenceFragmentCompat {

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

Summary

Inherited constants
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
LeanbackSettingsFragment()

Public methods
View	onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
void	onPause()
boolean	onPreferenceDisplayDialog(PreferenceFragment caller, Preference pref)
abstract void	onPreferenceStartInitialScreen() Called to instantiate the initial PreferenceFragment to be shown in this fragment.
void	onResume()
void	onViewCreated(View view, Bundle savedInstanceState)
void	startImmersiveFragment(Fragment fragment) Displays a fragment to the user, temporarily replacing the contents of this fragment.
void	startPreferenceFragment(Fragment fragment) Displays a preference fragment to the user.

Inherited methods
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.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 androidx.preference.PreferenceFragment.OnPreferenceStartFragmentCallback abstract boolean onPreferenceStartFragment(PreferenceFragment caller, Preference pref) Called when the user has clicked on a Preference that has a fragment class name associated with it.
From interface androidx.preference.PreferenceFragment.OnPreferenceStartScreenCallback abstract boolean onPreferenceStartScreen(PreferenceFragment caller, PreferenceScreen pref) Called when the user has clicked on a PreferenceScreen in order to navigate to a new screen of preferences.
From interface androidx.preference.PreferenceFragment.OnPreferenceDisplayDialogCallback abstract boolean onPreferenceDisplayDialog(PreferenceFragment caller, Preference pref)
From interface android.content.ComponentCallbacks abstract void onConfigurationChanged(Configuration arg0) abstract void onLowMemory()

Public constructors

LeanbackSettingsFragment

public LeanbackSettingsFragment ()

Public methods

onCreateView

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

Parameters
inflater	LayoutInflater
container	ViewGroup
savedInstanceState	Bundle

Returns
View

onPause

public void onPause ()

onPreferenceDisplayDialog

public boolean onPreferenceDisplayDialog (PreferenceFragment caller, 
                Preference pref)

Parameters
caller	PreferenceFragment
pref	Preference

Returns
boolean

onPreferenceStartInitialScreen

public abstract void onPreferenceStartInitialScreen ()

Called to instantiate the initial PreferenceFragment to be shown in this fragment. Implementations are expected to call startPreferenceFragment(android.app.Fragment).

onResume

public void onResume ()

onViewCreated

public void onViewCreated (View view, 
                Bundle savedInstanceState)

Parameters
view	View
savedInstanceState	Bundle

startImmersiveFragment

public void startImmersiveFragment (Fragment fragment)

Displays a fragment to the user, temporarily replacing the contents of this fragment.

Parameters
fragment	Fragment: Fragment instance to be added.

startPreferenceFragment

public void startPreferenceFragment (Fragment fragment)

Displays a preference fragment to the user. This method can also be used to display list-style fragments on top of the stack of preference fragments.

Parameters
fragment	Fragment: Fragment instance to be added.