Added in API level 11
Deprecated in API level 28

PreferenceFragment

public abstract class PreferenceFragment
extends Fragment

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

This class was deprecated in API level 28.
Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

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 showing these other screens from the preference hierarchy.

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 Intent to query Activities that each have preferences, use addPreferencesFromIntent(Intent). Each Activity can specify meta-data in the manifest (via the key PreferenceManager.METADATA_KEY_PREFERENCES) that points to an XML resource. These XML resources will be inflated into a single preference hierarchy and shown by this fragment.

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

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

Developer Guides

For information about using PreferenceFragment, read the Settings guide.

See also:

Preference
PreferenceScreen

Summary

Nested classes
`interface`	`PreferenceFragment.OnPreferenceStartFragmentCallback` This interface was deprecated in API level 28. Use `PreferenceFragmentCompat.OnPreferenceStartFragmentCallback`

Inherited XML attributes

From class android.app.Fragment

`android:fragmentAllowEnterTransitionOverlap`	Sets whether the enter and exit transitions should overlap when transitioning forward.
`android:fragmentAllowReturnTransitionOverlap`	Sets whether the enter and exit transitions should overlap when transitioning because of popping the back stack.
`android:fragmentEnterTransition`	The Transition that will be used to move Views into the initial scene.
`android:fragmentExitTransition`	The Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`android:fragmentReenterTransition`	The Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`android:fragmentSharedElementEnterTransition`	The Transition that will be used for shared elements transferred into the content Scene.
`android:fragmentSharedElementReturnTransition`	The Transition that will be used for shared elements transferred back during a pop of the back stack.

Inherited constants

From interface android.content.ComponentCallbacks2

`int`	`TRIM_MEMORY_BACKGROUND` Level for `onTrimMemory(int)`: the process has gone on to the LRU list.
`int`	`TRIM_MEMORY_COMPLETE` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_MODERATE` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_RUNNING_CRITICAL` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_RUNNING_LOW` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_RUNNING_MODERATE` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_UI_HIDDEN` Level for `onTrimMemory(int)`: the process had been showing a user interface, and is no longer doing so.

Public constructors
`PreferenceFragment()`

Public methods
`void`	`addPreferencesFromIntent(Intent intent)` Adds preferences from activities that match the given `Intent`.
`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.
`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)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` Receive the result from a previous call to `startActivityForResult(android.content.Intent, int)`.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`boolean`	`onPreferenceTreeClick(PreferenceScreen preferenceScreen, Preference preference)`
`void`	`onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`setPreferenceScreen(PreferenceScreen preferenceScreen)` Sets the root of the preference hierarchy that this fragment is showing.

Inherited methods

From class android.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` Print the Fragments's state into the given stream.
`final boolean`	`equals(Object o)` Subclasses can not override equals().
`final Activity`	`getActivity()` Return the Activity this fragment is currently associated with.
`boolean`	`getAllowEnterTransitionOverlap()` Returns whether the exit transition and enter transition overlap or not.
`boolean`	`getAllowReturnTransitionOverlap()` Returns whether the return transition and reenter transition overlap or not.
`final Bundle`	`getArguments()` Return the arguments supplied to `setArguments(Bundle)`, if any.
`final FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context`	`getContext()` Return the `Context` this fragment is currently associated with.
`Transition`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`Transition`	`getExitTransition()` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`final FragmentManager`	`getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`final Object`	`getHost()` Return the host object of this fragment.
`final int`	`getId()` Return the identifier this fragment is known by.
`final LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`LoaderManager`	`getLoaderManager()` This method is deprecated. Use `Fragment.getLoaderManager()`
`final Fragment`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`Transition`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`final Resources`	`getResources()` Return `getActivity().getResources()`.
`final boolean`	`getRetainInstance()`
`Transition`	`getReturnTransition()` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`Transition`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Transition`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`final String`	`getString(int resId)` Return a localized string from the application's package's default string table.
`final String`	`getString(int resId, Object... formatArgs)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `String.format(String, Object)`.
`final String`	`getTag()` Get the tag name of the fragment, if specified.
`final Fragment`	`getTargetFragment()` Return the target fragment set by `setTargetFragment(Fragment, int)`.
`final int`	`getTargetRequestCode()` Return the target request code set by `setTargetFragment(Fragment, int)`.
`final CharSequence`	`getText(int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`boolean`	`getUserVisibleHint()`
`View`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`), if provided.
`final int`	`hashCode()` Subclasses can not override hashCode().
`static Fragment`	`instantiate(Context context, String fname)` Like `instantiate(android.content.Context, java.lang.String, android.os.Bundle)` but with a null argument Bundle.
`static Fragment`	`instantiate(Context context, String fname, Bundle args)` Create a new instance of a Fragment with the given class name.
`final boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`final boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`final boolean`	`isHidden()` Return true if the fragment has been hidden.
`final boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.
`final boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`final boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`final boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`final boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`void`	`onActivityCreated(Bundle savedInstanceState)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` Receive the result from a previous call to `startActivityForResult(android.content.Intent, int)`.
`void`	`onAttach(Activity activity)` This method was deprecated in API level 23. Use `onAttach(android.content.Context)` instead.
`void`	`onAttach(Context context)` Called when a fragment is first attached to its context.
`void`	`onAttachFragment(Fragment childFragment)` Called when a fragment is attached as a child of this fragment.
`void`	`onConfigurationChanged(Configuration newConfig)` Called by the system when the device configuration changes while your component is running. If you override this method you must call through to the superclass implementation.
`boolean`	`onContextItemSelected(MenuItem item)` This hook is called whenever an item in a context menu is selected.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`void`	`onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)` Called when a context menu for the `view` is about to be shown.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` Initialize the contents of the Activity's standard options menu.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void`	`onDetach()` Called when the fragment is no longer attached to its activity.
`LayoutInflater`	`onGetLayoutInflater(Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void`	`onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
`void`	`onInflate(AttributeSet attrs, Bundle savedInstanceState)` This method was deprecated in API level 15. Use `onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle)` instead.
`void`	`onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState)` This method was deprecated in API level 23. Use `onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle)` instead.
`void`	`onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`void`	`onLowMemory()` This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. If you override this method you must call through to the superclass implementation.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` This method was deprecated in API level 26. Use `onMultiWindowModeChanged(boolean, android.content.res.Configuration)` instead.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode, Configuration newConfig)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`onOptionsItemSelected(MenuItem item)` This hook is called whenever an item in your options menu is selected.
`void`	`onOptionsMenuClosed(Menu menu)` This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
`void`	`onPause()` Called when the Fragment is no longer resumed.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode, Configuration newConfig)` Called by the system when the activity changes to and from picture-in-picture mode.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` This method was deprecated in API level 26. Use `onPictureInPictureModeChanged(boolean, android.content.res.Configuration)` instead.
`void`	`onPrepareOptionsMenu(Menu menu)` Prepare the Screen's standard options menu to be displayed.
`void`	`onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)` Callback for the result from requesting permissions.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`void`	`onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`void`	`onTrimMemory(int level)` Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process. If you override this method you must call through to the superclass implementation.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`onViewStateRestored(Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.
`void`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition()` or `FragmentManager.executePendingTransactions()` has been called.
`void`	`registerForContextMenu(View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void`	`requestPermissions(String[] permissions, int requestCode)` Requests permissions to be granted to this application.
`void`	`setAllowEnterTransitionOverlap(boolean allow)` Sets whether the exit transition and enter transition overlap or not.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` Sets whether the return transition and reenter transition overlap or not.
`void`	`setArguments(Bundle args)` Supply the construction arguments for this fragment.
`void`	`setEnterSharedElementCallback(SharedElementCallback callback)` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
`void`	`setEnterTransition(Transition transition)` Sets the Transition that will be used to move Views into the initial scene.
`void`	`setExitSharedElementCallback(SharedElementCallback callback)` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
`void`	`setExitTransition(Transition transition)` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`void`	`setHasOptionsMenu(boolean hasMenu)` Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.
`void`	`setInitialSavedState(Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`void`	`setMenuVisibility(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible.
`void`	`setReenterTransition(Transition transition)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`void`	`setRetainInstance(boolean retain)` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
`void`	`setReturnTransition(Transition transition)` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`void`	`setSharedElementEnterTransition(Transition transition)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`void`	`setSharedElementReturnTransition(Transition transition)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`void`	`setTargetFragment(Fragment fragment, int requestCode)` Optional target for this fragment.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` Set a hint to the system about whether this fragment's UI is currently visible to the user.
`boolean`	`shouldShowRequestPermissionRationale(String permission)` Gets whether you should show UI with rationale before requesting a permission.
`void`	`startActivity(Intent intent)` Call `Activity.startActivity(Intent)` from the fragment's containing Activity.
`void`	`startActivity(Intent intent, Bundle options)` Call `Activity.startActivity(Intent, Bundle)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode)` Call `Activity.startActivityForResult(Intent, int)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode, Bundle options)` Call `Activity.startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
`void`	`startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Call `Activity.startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)` from the fragment's containing Activity.
`void`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition()` was called.
`String`	`toString()` Returns a string representation of the object.
`void`	`unregisterForContextMenu(View view)` Prevents a context menu to be shown for the given view.

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface android.content.ComponentCallbacks2

abstract void

onTrimMemory(int level)

Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.

From interface android.view.View.OnCreateContextMenuListener

abstract void

onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)

Called when the context menu for this view is being built.

From interface android.content.ComponentCallbacks

`abstract void`	`onConfigurationChanged(Configuration newConfig)` Called by the system when the device configuration changes while your component is running.
`abstract void`	`onLowMemory()` This method was deprecated in API level 35. Since API level 14 this is superseded by `ComponentCallbacks2.onTrimMemory`. Since API level 34 this is never called. If you're overriding ComponentCallbacks2#onTrimMemory and your minSdkVersion is greater than API 14, you can provide an empty implementation for this method.

Public constructors