PreferenceFragment

Kotlin |Java

public abstract class PreferenceFragment
extends Fragment implements PreferenceManager.OnPreferenceTreeClickListener, PreferenceManager.OnDisplayPreferenceDialogListener, PreferenceManager.OnNavigateToScreenListener, DialogPreference.TargetFragment

java.lang.Object
↳	android.app.Fragment
	↳	androidx.preference.PreferenceFragment

Known direct subclasses

BaseLeanbackPreferenceFragment

BaseLeanbackPreferenceFragment This class is deprecated. Use BaseLeanbackPreferenceFragmentCompat

Known indirect subclasses

LeanbackPreferenceFragment

LeanbackPreferenceFragment This class is deprecated. Use LeanbackPreferenceFragmentCompat

This class is deprecated.
Use PreferenceFragmentCompat instead

Shows a hierarchy of Preference objects as lists. These preferences will automatically save to SharedPreferences as the user interacts with them. To retrieve an instance of SharedPreferences that the preference hierarchy in this fragment will use, call PreferenceManager.getDefaultSharedPreferences(android.content.Context) with a context in the same package as this fragment.

Furthermore, the preferences shown will follow the visual style of system preferences. It is easy to create a hierarchy of preferences (that can be shown on multiple screens) via XML. For these reasons, it is recommended to use this fragment (as a superclass) to deal with preferences in applications.

A PreferenceScreen object should be at the top of the preference hierarchy. Furthermore, subsequent PreferenceScreen in the hierarchy denote a screen break--that is the preferences contained within subsequent PreferenceScreen should be shown on another screen. The preference framework handles this by calling onNavigateToScreen(PreferenceScreen).

The preference hierarchy can be formed in multiple ways:

From an XML file specifying the hierarchy
From different Activities that each specify its own preferences in an XML file via Activity meta-data
From an object hierarchy rooted with PreferenceScreen

To inflate from XML, use the addPreferencesFromResource(int). The root element should be a PreferenceScreen. Subsequent elements can point to actual Preference subclasses. As mentioned above, subsequent PreferenceScreen in the hierarchy will result in the screen break.

To specify an object hierarchy rooted with PreferenceScreen, use setPreferenceScreen(PreferenceScreen).

As a convenience, this fragment implements a click listener for any preference in the current hierarchy, see onPreferenceTreeClick(Preference).

Developer Guides

For information about building a settings screen using the AndroidX Preference library, see Settings.

See also:

Preference
PreferenceScreen

Summary

Nested classes
`interface`	`PreferenceFragment.OnPreferenceDisplayDialogCallback` Interface that the fragment's containing activity should implement to be able to process preference items that wish to display a dialog.
`interface`	`PreferenceFragment.OnPreferenceStartFragmentCallback` Interface that the fragment's containing activity should implement to be able to process preference items that wish to switch to a specified fragment.
`interface`	`PreferenceFragment.OnPreferenceStartScreenCallback` Interface that the fragment's containing activity should implement to be able to process preference items that wish to switch to a new screen of preferences.

Constants
`String`	`ARG_PREFERENCE_ROOT` This constant is deprecated. Use `PreferenceFragmentCompat` instead

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
`PreferenceFragment()`

Public methods
`void`	`addPreferencesFromResource(int preferencesResId)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`<T extends Preference> T`	`findPreference(CharSequence key)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`final RecyclerView`	`getListView()` This method is deprecated. Use `PreferenceFragmentCompat` instead
`PreferenceManager`	`getPreferenceManager()` This method is deprecated. Use `PreferenceFragmentCompat` instead
`PreferenceScreen`	`getPreferenceScreen()` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`onCreate(Bundle savedInstanceState)`
`RecyclerView.LayoutManager`	`onCreateLayoutManager()` This method is deprecated. Use `PreferenceFragmentCompat` instead
`abstract void`	`onCreatePreferences(Bundle savedInstanceState, String rootKey)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`RecyclerView`	`onCreateRecyclerView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)`
`void`	`onDestroyView()`
`void`	`onDisplayPreferenceDialog(Preference preference)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`onNavigateToScreen(PreferenceScreen preferenceScreen)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`boolean`	`onPreferenceTreeClick(Preference preference)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`onSaveInstanceState(Bundle outState)`
`void`	`onStart()`
`void`	`onStop()`
`void`	`onViewCreated(View view, Bundle savedInstanceState)`
`void`	`scrollToPreference(Preference preference)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`scrollToPreference(String key)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`setDivider(Drawable divider)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`setDividerHeight(int height)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`setPreferenceScreen(PreferenceScreen preferenceScreen)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`setPreferencesFromResource(int preferencesResId, String key)` This method is deprecated. Use `PreferenceFragmentCompat` instead

Protected methods
`Adapter`	`onCreateAdapter(PreferenceScreen preferenceScreen)` This method is deprecated. Use `PreferenceFragmentCompat` instead

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)`

PreferenceFragment

Developer Guides

Summary

Nested classes

Constants

Inherited constants

Public constructors

Public methods

Protected methods

Inherited methods