PreferenceFragmentCompat

Kotlin |Java

abstract class PreferenceFragmentCompat : Fragment, PreferenceManager.OnPreferenceTreeClickListener, PreferenceManager.OnDisplayPreferenceDialogListener, PreferenceManager.OnNavigateToScreenListener, DialogPreference.TargetFragment

kotlin.Any
↳	androidx.fragment.app.Fragment
	↳	androidx.preference.PreferenceFragmentCompat

Known Direct Subclasses

BaseLeanbackPreferenceFragmentCompat

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

Known Indirect Subclasses

LeanbackPreferenceFragmentCompat

This fragment provides a fully decorated leanback-style preference fragment, including a list background and header.

A PreferenceFragmentCompat is the entry point to using the Preference library. This Fragment displays a hierarchy of Preference objects to the user. It also handles persisting values to the device. To retrieve an instance of android.content.SharedPreferences that the preference hierarchy in this fragment will use by default, call PreferenceManager#getDefaultSharedPreferences(android.content.Context) with a context in the same package as this fragment.

You can define a preference hierarchy as an XML resource, or you can build a hierarchy in code. In both cases you need to use a PreferenceScreen as the root component in your hierarchy.

To inflate from XML, use the setPreferencesFromResource(int, String). An example example XML resource is shown further down.

To build a hierarchy from code, use PreferenceManager#createPreferenceScreen(Context) to create the root PreferenceScreen. Once you have added other Preferences to this root scree with PreferenceScreen#addPreference(Preference), you then need to set the screen as the root screen in your hierarchy with setPreferenceScreen(PreferenceScreen).

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

Sample Code

The following sample code shows a simple settings screen using an XML resource. The XML resource is as follows:

The fragment that loads the XML resource is as follows:

Summary

Nested classes
abstract	`OnPreferenceDisplayDialogCallback` Interface that the fragment's containing activity should implement to be able to process preference items that wish to display a dialog.
abstract	`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.
abstract	`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
static String	`ARG_PREFERENCE_ROOT` Fragment argument used to specify the tag of the desired root `PreferenceScreen` object.

Public constructors
`<init>()` A PreferenceFragmentCompat is the entry point to using the Preference library.

Public methods
open Unit	`addPreferencesFromResource(@XmlRes preferencesResId: Int)` Inflates the given XML resource and adds the preference hierarchy to the current preference hierarchy.
open T?	`findPreference(@NonNull key: CharSequence)`
RecyclerView!	`getListView()`
open PreferenceManager!	`getPreferenceManager()` Returns the `PreferenceManager` used by this fragment.
open PreferenceScreen!	`getPreferenceScreen()` Gets the root of the preference hierarchy that this fragment is showing.
open Unit	`onCreate(@Nullable savedInstanceState: Bundle?)`
open RecyclerView.LayoutManager!	`onCreateLayoutManager()` Called from `onCreateRecyclerView` to create the `RecyclerView.LayoutManager` for the created `RecyclerView`.
abstract Unit	`onCreatePreferences(savedInstanceState: Bundle!, rootKey: String!)` Called during `onCreate(Bundle)` to supply the preferences for this fragment.
open RecyclerView!	`onCreateRecyclerView(inflater: LayoutInflater!, parent: ViewGroup!, savedInstanceState: Bundle!)` Creates the `RecyclerView` used to display the preferences.
open View?	`onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup?, @Nullable savedInstanceState: Bundle?)`
open Unit	`onDestroyView()`
open Unit	`onDisplayPreferenceDialog(preference: Preference!)` Called when a preference in the tree requests to display a dialog.
open Unit	`onNavigateToScreen(preferenceScreen: PreferenceScreen!)` Called by `PreferenceScreen#onClick()` in order to navigate to a new screen of preferences.
open Boolean	`onPreferenceTreeClick(preference: Preference!)` Called when a preference in the tree rooted at this `PreferenceScreen` has been clicked.
open Unit	`onSaveInstanceState(@NonNull outState: Bundle)`
open Unit	`onStart()`
open Unit	`onStop()`
open Unit	`onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?)`
open Unit	`scrollToPreference(key: String!)`
open Unit	`scrollToPreference(preference: Preference!)`
open Unit	`setDivider(divider: Drawable!)` Sets the `Drawable` that will be drawn between each item in the list.
open Unit	`setDividerHeight(height: Int)` Sets the height of the divider that will be drawn between each item in the list.
open Unit	`setPreferenceScreen(preferenceScreen: PreferenceScreen!)` Sets the root of the preference hierarchy that this fragment is showing.
open Unit	`setPreferencesFromResource(@XmlRes preferencesResId: Int, @Nullable key: String?)` Inflates the given XML resource and replaces the current preference hierarchy (if any) with the preference hierarchy rooted at `key`.

Protected methods
open RecyclerView.Adapter<RecyclerView.ViewHolder!>!	`onCreateAdapter(preferenceScreen: PreferenceScreen!)` Creates the root adapter.

Inherited functions

From class Fragment

`Unit`	`dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<String!>?)` Print the Fragments's state into the given stream.
`Boolean`	`equals(@Nullable other: Any?)` Subclasses can not override equals().
`FragmentActivity?`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with. May return `null` if the fragment is associated with a `Context` instead.
`Boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting.
`Boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting.
`Bundle?`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`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.
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors. The `Fragment's arguments` when this is first called will be used as the defaults to any `androidx.lifecycle.SavedStateHandle` passed to a view model created using this factory.
`Any?`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View#INVISIBLE` to `View#VISIBLE`.
`Any?`	`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. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If transition is null, the views will remain unaffected.
`FragmentManager?`	`getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will be non-null slightly before `getActivity()`, during the time from when the fragment is placed in a `FragmentTransaction` until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's `getChildFragmentManager()`.
`Any?`	`getHost()` Return the host object of this fragment. May return `null` if the fragment isn't currently being hosted.
`Int`	`getId()` Return the identifier this fragment is known by. This is either the android:id value supplied in a layout or the container view ID supplied when adding the fragment.
`LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment. If `onGetLayoutInflater(Bundle)` has not been called `onGetLayoutInflater(Bundle)` will be called with a `null` argument and that value will be cached. The cached LayoutInflater will be replaced immediately prior to `onCreateView(LayoutInflater, ViewGroup, Bundle)` and cleared immediately after `onDetach()`.
`Lifecycle`	`getLifecycle()` Returns the Lifecycle of the provider. Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`LoaderManager`	`getLoaderManager()` Return the LoaderManager for this fragment.
`Fragment?`	`getParentFragment()` Returns the parent Fragment containing this Fragment. If this Fragment is attached directly to an Activity, returns null.
`FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will available slightly before `getActivity()`, during the time from when the fragment is placed in a `FragmentTransaction` until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's `getChildFragmentManager()`.
`Any?`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If nothing is set, the default will be to use the same transition as `getExitTransition()`.
`Resources`	`getResources()` Return `requireActivity().getResources()`.
`Boolean`	`getRetainInstance()` Returns `true` if this fragment instance's state will be retained across configuration changes, and `false` if it will not.
`Any?`	`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. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If nothing is set, the default will be to use the same transition as `getEnterTransition()`.
`SavedStateRegistry`	`getSavedStateRegistry()`
`Any?`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position.
`Any?`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as `setSharedElementEnterTransition(Object)`.
`String`	`getString(@StringRes resId: Int)` Return a localized string from the application's package's default string table.
`String`	`getString(@StringRes resId: Int, @Nullable vararg formatArgs: Any!)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `java.util.Formatter` and java.lang.String#format.
`String?`	`getTag()` Get the tag name of the fragment, if specified.
`Fragment?`	`getTargetFragment()` Return the target fragment set by `setTargetFragment`.
`Int`	`getTargetRequestCode()` Return the target request code set by `setTargetFragment`.
`CharSequence`	`getText(@StringRes resId: Int)` 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`), if provided.
`LifecycleOwner`	`getViewLifecycleOwner()` Get a `LifecycleOwner` that represents the `Fragment's View` lifecycle. In most cases, this mirrors the lifecycle of the Fragment itself, but in cases of `detached` Fragments, the lifecycle of the Fragment can be considerably longer than the lifecycle of the View itself. Namely, the lifecycle of the Fragment's View is: `created` after `onViewStateRestored(Bundle)` `started` after `onStart()` `resumed` after `onResume()` `paused` before `onPause()` `stopped` before `onStop()` `destroyed` before `onDestroyView()` The first method where it is safe to access the view lifecycle is `onCreateView(LayoutInflater, ViewGroup, Bundle)` under the condition that you must return a non-null view (an IllegalStateException will be thrown if you access the view lifecycle but don't return a non-null view). The view lifecycle remains valid through the call to `onDestroyView()`, after which `getView()` will return null, the view lifecycle will be destroyed, and this method will throw an IllegalStateException. Consider using `getViewLifecycleOwnerLiveData()` or `FragmentTransaction#runOnCommit(Runnable)` to receive a callback for when the Fragment's view lifecycle is available. This should only be called on the main thread. Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`LiveData<LifecycleOwner!>`	`getViewLifecycleOwnerLiveData()` Retrieve a `LiveData` which allows you to observe the `lifecycle of the Fragment's View`. This will be set to the new `LifecycleOwner` after `onCreateView` returns a non-null View and will set to null after `onDestroyView()`. Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`ViewModelStore`	`getViewModelStore()` Returns the `ViewModelStore` associated with this Fragment Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`Int`	`hashCode()` Subclasses can not override hashCode().
`Fragment`	`instantiate(@NonNull context: Context, @NonNull fname: String)` Like `instantiate(Context, String, Bundle)` but with a null argument Bundle.
`Fragment`	`instantiate(@NonNull context: Context, @NonNull fname: String, @Nullable args: Bundle?)` Create a new instance of a Fragment with the given class name. This is the same as calling its empty constructor, setting the `ClassLoader` on the supplied arguments, then calling `setArguments(Bundle)`.
`Boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`Boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI. That is, `FragmentTransaction.detach(Fragment)` has been used on it.
`Boolean`	`isHidden()` Return true if the fragment has been hidden. By default fragments are shown. You can find out about changes to this state with `onHiddenChanged`. Note that the hidden state is orthogonal to other states -- that is, to be visible to the user, a fragment must be both started and not hidden.
`Boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag. This will always be true when fragments are created through the <fragment> tag, except in the case where an old fragment is restored from a previous state and it does not appear in the layout of the current state.
`Boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity. This is not whether its activity is finishing, but rather whether it is in the process of being removed from its activity.
`Boolean`	`isResumed()` Return true if the fragment is in the resumed state. This is true for the duration of `onResume()` and `onPause()` as well.
`Boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host. Any operations that would change saved state should not be performed if this method returns true, and some operations such as `setArguments(Bundle)` will fail.
`Boolean`	`isVisible()` Return true if the fragment is currently visible to the user. This means it: (1) has been added, (2) has its view attached to the window, and (3) is not hidden.
`Unit`	`onActivityCreated(@Nullable savedInstanceState: Bundle?)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. It can be used to do final initialization once these pieces are in place, such as retrieving views or restoring state. It is also useful for fragments that use `setRetainInstance(boolean)` to retain their instance, as this callback tells the fragment when it is fully associated with the new activity instance. This is called after `onCreateView` and before `onViewStateRestored(Bundle)`.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, @Nullable data: Intent?)` Receive the result from a previous call to `startActivityForResult(Intent, int)`. This follows the related Activity API as described there in `Activity#onActivityResult(int, int, Intent)`.
`Unit`	`onAttach(@NonNull context: Context)` Called when a fragment is first attached to its context. `onCreate(Bundle)` will be called after this.
`Unit`	`onAttach(@NonNull activity: Activity)` Called when a fragment is first attached to its activity. `onCreate(Bundle)` will be called after this.
`Unit`	`onAttachFragment(@NonNull childFragment: Fragment)` Called when a fragment is attached as a child of this fragment. This is called after the attached fragment's `onAttach` and before the attached fragment's `onCreate` if the fragment has not yet had a previous call to `onCreate`.
`Unit`	`onConfigurationChanged(@NonNull newConfig: Configuration)`
`Boolean`	`onContextItemSelected(@NonNull item: MenuItem)` This hook is called whenever an item in a context menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities. Use `MenuItem#getMenuInfo()` to get extra information set by the View that added this menu item. Derived classes should call through to the base class for it to perform the default menu handling.
`Animation?`	`onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animation. Note that if `FragmentTransaction#setCustomAnimations(int, int)` was called with `Animator` resources instead of `Animation` resources, `nextAnim` will be an animator resource.
`Animator?`	`onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animator. This will be called when `onCreateAnimation(int, boolean, int)` returns null. Note that if `FragmentTransaction#setCustomAnimations(int, int)` was called with `Animation` resources instead of `Animator` resources, `nextAnim` will be an animation resource.
`Unit`	`onCreateContextMenu(@NonNull menu: ContextMenu, @NonNull v: View, @Nullable menuInfo: ContextMenuInfo?)` Called when a context menu for the `view` is about to be shown. Unlike `onCreateOptionsMenu`, this will be called every time the context menu is about to be shown and should be populated for the view (or item inside the view for `AdapterView` subclasses, this can be found in the `menuInfo`)). Use `onContextItemSelected(android.view.MenuItem)` to know when an item has been selected. The default implementation calls up to `Activity.onCreateContextMenu`, though you can not call this implementation if you don't want that behavior. It is not safe to hold onto the context menu after this method returns.
`Unit`	`onCreateOptionsMenu(@NonNull menu: Menu, @NonNull inflater: MenuInflater)` Initialize the contents of the Fragment host's standard options menu. You should place your menu items in to menu. For this method to be called, you must have first called `setHasOptionsMenu`. See `Activity.onCreateOptionsMenu` for more information.
`Unit`	`onDestroy()` Called when the fragment is no longer in use. This is called after `onStop()` and before `onDetach()`.
`Unit`	`onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu. Receiving this call means that the menu needed to be rebuilt, but this fragment's items were not included in the newly built menu (its `onCreateOptionsMenu(Menu, MenuInflater)` was not called).
`Unit`	`onDetach()` Called when the fragment is no longer attached to its activity. This is called after `onDestroy()`.
`LayoutInflater`	`onGetLayoutInflater(@Nullable savedInstanceState: Bundle?)` Returns the LayoutInflater used to inflate Views of this Fragment. The default implementation will throw an exception if the Fragment is not attached.
`Unit`	`onHiddenChanged(hidden: Boolean)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed. Fragments start out not hidden; this will be called whenever the fragment changes state from that.
`Unit`	`onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity. This may be called immediately after the fragment is created from a `FragmentContainerView` in a layout file. Note this is before the fragment's `onAttach(Context)` has been called; all you should do here is parse the attributes and save them away. This is called the first time the fragment is inflated. If it is being inflated into a new instance with saved state, this method will not be called a second time for the restored state fragment. Here is a typical implementation of a fragment that can take parameters both through attributes supplied here as well from `getArguments()`: Note that parsing the XML attributes uses a "styleable" resource. The declaration for the styleable used here is: The fragment can then be declared within its activity's content layout through a tag like this: This fragment can also be created dynamically from arguments given at runtime in the arguments Bundle; here is an example of doing so at creation of the containing activity:
`Unit`	`onInflate(@NonNull activity: Activity, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`Unit`	`onLowMemory()`
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. This is generally tied to Activity#onMultiWindowModeChanged of the containing Activity.
`Boolean`	`onOptionsItemSelected(@NonNull item: MenuItem)` This hook is called whenever an item in your options menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities. Derived classes should call through to the base class for it to perform the default menu handling.
`Unit`	`onOptionsMenuClosed(@NonNull 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).
`Unit`	`onPause()` Called when the Fragment is no longer resumed. This is generally tied to `Activity.onPause` of the containing Activity's lifecycle.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` Called by the system when the activity changes to and from picture-in-picture mode. This is generally tied to Activity#onPictureInPictureModeChanged of the containing Activity.
`Unit`	`onPrepareOptionsMenu(@NonNull menu: Menu)` Prepare the Fragment host's standard options menu to be displayed. This is called right before the menu is shown, every time it is shown. You can use this method to efficiently enable/disable items or otherwise dynamically modify the contents. See `Activity.onPrepareOptionsMenu` for more information.
`Unit`	`onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)` Callback for when the primary navigation state of this Fragment has changed. This can be the result of the `getParentFragmentManager()` containing FragmentManager} having its primary navigation fragment changed via `androidx.fragment.app.FragmentTransaction#setPrimaryNavigationFragment` or due to the primary navigation fragment changing in a parent FragmentManager.
`Unit`	`onRequestPermissionsResult(requestCode: Int, @NonNull permissions: Array<String!>, @NonNull grantResults: IntArray)` Callback for the result from requesting permissions. This method is invoked for every call on `requestPermissions(String[], int)`. Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation.
`Unit`	`onResume()` Called when the fragment is visible to the user and actively running. This is generally tied to `Activity.onResume` of the containing Activity's lifecycle.
`Unit`	`onViewStateRestored(@Nullable savedInstanceState: Bundle?)` Called when all saved state has been restored into the view hierarchy of the fragment. This can be used to do initialization based on saved state that you are letting the view hierarchy track itself, such as whether check box widgets are currently checked. This is called after `onViewCreated(View, Bundle)` and before `onStart()`.
`Unit`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition()` or `FragmentManager#executePendingTransactions()` has been called. This method gives the Fragment the ability to delay Fragment animations until all data is loaded. Until then, the added, shown, and attached Fragments will be INVISIBLE and removed, hidden, and detached Fragments won't be have their Views removed. The transaction runs when all postponed added Fragments in the transaction have called `startPostponedEnterTransition()`. This method should be called before being added to the FragmentTransaction or in `onCreate(Bundle)`, `onAttach(Context)`, or `onCreateView(LayoutInflater, ViewGroup, Bundle)`}. `startPostponedEnterTransition()` must be called to allow the Fragment to start the transitions. When a FragmentTransaction is started that may affect a postponed FragmentTransaction, based on which containers are in their operations, the postponed FragmentTransaction will have its start triggered. The early triggering may result in faulty or nonexistent animations in the postponed transaction. FragmentTransactions that operate only on independent containers will not interfere with each other's postponement. Calling postponeEnterTransition on Fragments with a null View will not postpone the transition. Likewise, postponement only works if `FragmentTransaction reordering` is enabled.
`Unit`	`postponeEnterTransition(duration: Long, @NonNull timeUnit: TimeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `startPostponedEnterTransition()`. This method gives the Fragment the ability to delay Fragment animations for a given amount of time. Until then, the added, shown, and attached Fragments will be INVISIBLE and removed, hidden, and detached Fragments won't be have their Views removed. The transaction runs when all postponed added Fragments in the transaction have called `startPostponedEnterTransition()`. This method should be called before being added to the FragmentTransaction or in `onCreate(Bundle)`, `onAttach(Context)`, or `onCreateView(LayoutInflater, ViewGroup, Bundle)`}. When a FragmentTransaction is started that may affect a postponed FragmentTransaction, based on which containers are in their operations, the postponed FragmentTransaction will have its start triggered. The early triggering may result in faulty or nonexistent animations in the postponed transaction. FragmentTransactions that operate only on independent containers will not interfere with each other's postponement. Calling postponeEnterTransition on Fragments with a null View will not postpone the transition. Likewise, postponement only works if `FragmentTransaction reordering` is enabled.
`ActivityResultLauncher<I>`	`registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull callback: ActivityResultCallback<O>)` Register a request to Activity#startActivityForResult, designated by the given `contract`. This creates a record in the `registry` associated wit this caller, managing request code, as well as conversions to/from `Intent` under the hood. This must be called unconditionally, as part of initialization path, typically as a field initializer of an Activity or Fragment. If the host of this fragment is an `ActivityResultRegistryOwner` the `ActivityResultRegistry` of the host will be used. Otherwise, this will use the registry of the Fragment's Activity.
`ActivityResultLauncher<I>`	`registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull registry: ActivityResultRegistry, @NonNull callback: ActivityResultCallback<O>)`
`Unit`	`registerForContextMenu(@NonNull view: View)` Registers a context menu to be shown for the given view (multiple views can show the context menu). This method will set the `OnCreateContextMenuListener` on the view to this fragment, so `onCreateContextMenu(ContextMenu, View, ContextMenuInfo)` will be called when it is time to show the context menu.
`Unit`	`requestPermissions(@NonNull permissions: Array<String!>, requestCode: Int)` Requests permissions to be granted to this application. These permissions must be requested in your manifest, they should not be granted to your app, and they should have protection level `#PROTECTION_DANGEROUS dangerous`, regardless whether they are declared by the platform or a third-party app. Normal permissions `android.content.pm.PermissionInfo#PROTECTION_NORMAL` are granted at install time if requested in the manifest. Signature permissions `android.content.pm.PermissionInfo#PROTECTION_SIGNATURE` are granted at install time if requested in the manifest and the signature of your app matches the signature of the app declaring the permissions. Call `shouldShowRequestPermissionRationale(String)` before calling this API to check if the system recommends to show a rationale dialog before asking for a permission. If your app does not have the requested permissions the user will be presented with UI for accepting them. After the user has accepted or rejected the requested permissions you will receive a callback on reporting whether the permissions were granted or not. Note that requesting a permission does not guarantee it will be granted and your app should be able to run without having this permission. This method may start an activity allowing the user to choose which permissions to grant and which to reject. Hence, you should be prepared that your activity may be paused and resumed. Further, granting some permissions may require a restart of you application. In such a case, the system will recreate the activity stack before delivering the result to . When checking whether you have a permission you should use . Calling this API for permissions already granted to your app would show UI to the user to decided whether the app can still hold these permissions. This can be useful if the way your app uses the data guarded by the permissions changes significantly.
`FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`Bundle`	`requireArguments()` Return the arguments supplied when the fragment was instantiated.
`Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`FragmentManager`	`requireFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will available slightly before `getActivity()`, during the time from when the fragment is placed in a `FragmentTransaction` until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's `getChildFragmentManager()`.
`Any`	`requireHost()` Return the host object of this fragment.
`Fragment`	`requireParentFragment()` Returns the parent Fragment containing this Fragment.
`View`	`requireView()` Get the root view for the fragment's layout (the one returned by `onCreateView`).
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` Sets whether the the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` Sets whether the the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting.
`Unit`	`setArguments(@Nullable args: Bundle?)` Supply the construction arguments for this fragment. The arguments supplied here will be retained across fragment destroy and creation. This method cannot be called if the fragment is added to a FragmentManager and if `isStateSaved()` would return true.
`Unit`	`setEnterSharedElementCallback(@Nullable callback: SharedElementCallback?)` 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.
`Unit`	`setEnterTransition(@Nullable transition: Any?)` Sets the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View#INVISIBLE` to `View#VISIBLE`. If `transition` is null, entering Views will remain unaffected.
`Unit`	`setExitSharedElementCallback(@Nullable callback: SharedElementCallback?)` 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.
`Unit`	`setExitTransition(@Nullable transition: Any?)` 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. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If transition is null, the views will remain unaffected.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu` and related methods.
`Unit`	`setInitialSavedState(@Nullable state: Fragment.SavedState?)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` Set a hint for whether this fragment's menu should be visible. This is useful if you know that a fragment has been placed in your view hierarchy so that the user can not currently seen it, so any menu items it has should also not be shown.
`Unit`	`setReenterTransition(@Nullable transition: Any?)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If transition is null, the views will remain unaffected. If nothing is set, the default will be to use the same transition as `getExitTransition()`.
`Unit`	`setRetainInstance(retain: Boolean)` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change). If set, the fragment lifecycle will be slightly different when an activity is recreated: `onDestroy()` will not be called (but `onDetach()` still will be, because the fragment is being detached from its current activity). `onCreate(Bundle)` will not be called since the fragment is not being re-created. `onAttach(Activity)` and `onActivityCreated(Bundle)` will still be called.
`Unit`	`setReturnTransition(@Nullable transition: Any?)` 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. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If `transition` is null, entering Views will remain unaffected. If nothing is set, the default will be to use the same value as set in `setEnterTransition(Object)`.
`Unit`	`setSharedElementEnterTransition(@Nullable transition: Any?)` Sets the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position.
`Unit`	`setSharedElementReturnTransition(@Nullable transition: Any?)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as `setSharedElementEnterTransition(Object)`.
`Unit`	`setTargetFragment(@Nullable fragment: Fragment?, requestCode: Int)` Optional target for this fragment. This may be used, for example, if this fragment is being started by another, and when done wants to give a result back to the first. The target set here is retained across instances via `FragmentManager.putFragment()`.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` Set a hint to the system about whether this fragment's UI is currently visible to the user. This hint defaults to true and is persistent across fragment instance state save and restore. An app may set this to false to indicate that the fragment's UI is scrolled out of visibility or is otherwise not directly visible to the user. This may be used by the system to prioritize operations such as fragment lifecycle updates or loader ordering behavior. Note: This method may be called outside of the fragment lifecycle. and thus has no ordering guarantees with regard to fragment lifecycle method calls.
`Boolean`	`shouldShowRequestPermissionRationale(@NonNull permission: String)` Gets whether you should show UI with rationale before requesting a permission.
`Unit`	`startActivity(intent: Intent!)` Call Activity#startActivity(Intent) from the fragment's containing Activity.
`Unit`	`startActivity(intent: Intent!, @Nullable options: Bundle?)` Call Activity#startActivity(Intent, Bundle) from the fragment's containing Activity.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int)` Call `Activity#startActivityForResult(Intent, int)` from the fragment's containing Activity.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int, @Nullable options: Bundle?)` Call `Activity#startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
`Unit`	`startIntentSenderForResult(intent: IntentSender!, requestCode: Int, @Nullable fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable options: Bundle?)` Call `Activity#startIntentSenderForResult(IntentSender, int, Intent, int, int, int, * Bundle)` from the fragment's containing Activity.
`Unit`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition()` was called. If postponeEnterTransition() was called, you must call startPostponedEnterTransition() or `FragmentManager#executePendingTransactions()` to complete the FragmentTransaction. If postponement was interrupted with `FragmentManager#executePendingTransactions()`, before `startPostponedEnterTransition()`, animations may not run or may execute improperly.
`String`	`toString()`
`Unit`	`unregisterForContextMenu(@NonNull view: View)` Prevents a context menu to be shown for the given view. This method will remove the `OnCreateContextMenuListener` on the view.

Constants

ARG_PREFERENCE_ROOT

static val ARG_PREFERENCE_ROOT: String

Fragment argument used to specify the tag of the desired root PreferenceScreen object.

Value: "androidx.preference.PreferenceFragmentCompat.PREFERENCE_ROOT"

Public constructors

<init>

PreferenceFragmentCompat()

You can define a preference hierarchy as an XML resource, or you can build a hierarchy in code. In both cases you need to use a PreferenceScreen as the root component in your hierarchy.

To inflate from XML, use the setPreferencesFromResource(int, String). An example example XML resource is shown further down.

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

Sample Code

The following sample code shows a simple settings screen using an XML resource. The XML resource is as follows:

The fragment that loads the XML resource is as follows:

See Also

Preference
PreferenceScreen

Public methods

addPreferencesFromResource

open fun addPreferencesFromResource(@XmlRes preferencesResId: Int): Unit

Inflates the given XML resource and adds the preference hierarchy to the current preference hierarchy.

Parameters
`preferencesResId`	Int: The XML resource ID to inflate

findPreference

@Nullable open fun <T : Preference!> findPreference(@NonNull key: CharSequence): T?

getListView

fun getListView(): RecyclerView!

getPreferenceManager

open fun getPreferenceManager(): PreferenceManager!

Returns the PreferenceManager used by this fragment.

Return
`PreferenceManager!`	The `PreferenceManager` used by this fragment

getPreferenceScreen

open fun getPreferenceScreen(): PreferenceScreen!

Gets the root of the preference hierarchy that this fragment is showing.

Return
`PreferenceScreen!`	The `PreferenceScreen` that is the root of the preference hierarchy

onCreate

open fun onCreate(@Nullable savedInstanceState: Bundle?): Unit

onCreateLayoutManager

open fun onCreateLayoutManager(): RecyclerView.LayoutManager!

Called from onCreateRecyclerView to create the RecyclerView.LayoutManager for the created RecyclerView.

Return
`RecyclerView.LayoutManager!`	A new `RecyclerView.LayoutManager` instance

onCreatePreferences

abstract fun onCreatePreferences(
    savedInstanceState: Bundle!, 
    rootKey: String!
): Unit

Called during onCreate(Bundle) to supply the preferences for this fragment. Subclasses are expected to call setPreferenceScreen(PreferenceScreen) either directly or via helper methods such as addPreferencesFromResource(int).

Parameters
`savedInstanceState`	Bundle!: If the fragment is being re-created from a previous saved state, this is the state.
`rootKey`	String!: If non-null, this preference fragment should be rooted at the `PreferenceScreen` with this key.

onCreateRecyclerView

open 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 `ViewGroup` 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.

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

onCreateView

open fun onCreateView(
    @NonNull inflater: LayoutInflater, 
    @Nullable container: ViewGroup?, 
    @Nullable savedInstanceState: Bundle?
): View?

onDestroyView

open fun onDestroyView(): Unit

onDisplayPreferenceDialog

open fun onDisplayPreferenceDialog(preference: Preference!): Unit

Called when a preference in the tree requests to display a dialog. Subclasses should override this method to display custom dialogs or to handle dialogs for custom preference classes.

Parameters
`preference`	Preference!: The `Preference` object requesting the dialog

onNavigateToScreen

open fun onNavigateToScreen(preferenceScreen: PreferenceScreen!): Unit

Called by PreferenceScreen#onClick() in order to navigate to a new screen of preferences. Calls PreferenceFragmentCompat.OnPreferenceStartScreenCallback#onPreferenceStartScreen if the target fragment or containing activity implements PreferenceFragmentCompat.OnPreferenceStartScreenCallback.

Parameters
`preferenceScreen`	PreferenceScreen!: The `PreferenceScreen` to navigate to

onPreferenceTreeClick

open fun onPreferenceTreeClick(preference: Preference!): Boolean

Called when a preference in the tree rooted at this PreferenceScreen has been clicked.

Parameters
`preference`	Preference!: The preference that was clicked

Return
`Boolean`	Whether the click was handled

onSaveInstanceState

open fun onSaveInstanceState(@NonNull outState: Bundle): Unit

onStart

open fun onStart(): Unit

onStop

open fun onStop(): Unit

onViewCreated

open fun onViewCreated(
    @NonNull view: View, 
    @Nullable savedInstanceState: Bundle?
): Unit

scrollToPreference

open fun scrollToPreference(key: String!): Unit

scrollToPreference

open fun scrollToPreference(preference: Preference!): Unit

setDivider

open fun setDivider(divider: Drawable!): Unit

Sets the Drawable that will be drawn between each item in the list.

Note: If the drawable does not have an intrinsic height, you should also call setDividerHeight(int).

Parameters
`divider`	Drawable!: The drawable to use `android.R.attr#divider`

setDividerHeight

open fun setDividerHeight(height: Int): Unit

Sets the height of the divider that will be drawn between each item in the list. Calling this will override the intrinsic height as set by setDivider(Drawable).

Parameters
`height`	Int: The new height of the divider in pixels `android.R.attr#dividerHeight`

setPreferenceScreen

open fun setPreferenceScreen(preferenceScreen: PreferenceScreen!): Unit

Sets the root of the preference hierarchy that this fragment is showing.

Parameters
`preferenceScreen`	PreferenceScreen!: The root `PreferenceScreen` of the preference hierarchy

setPreferencesFromResource

open fun setPreferencesFromResource(
    @XmlRes preferencesResId: Int, 
    @Nullable key: String?
): Unit

Inflates the given XML resource and replaces the current preference hierarchy (if any) with the preference hierarchy rooted at key.

Parameters
`preferencesResId`	Int: The XML resource ID to inflate
`key`	String?: The preference key of the `PreferenceScreen` to use as the root of the preference hierarchy, or `null` to use the root `PreferenceScreen`.

Protected methods

onCreateAdapter

protected open fun onCreateAdapter(preferenceScreen: PreferenceScreen!): RecyclerView.Adapter<RecyclerView.ViewHolder!>!

Creates the root adapter.

Parameters
`preferenceScreen`	PreferenceScreen!: The `PreferenceScreen` object to create the adapter for

Return
`RecyclerView.Adapter<RecyclerView.ViewHolder!>!`	An adapter that contains the preferences contained in this `PreferenceScreen`