PreferenceFragment

Artifact: androidx.preference:preference

Added in 1.0.0

Deprecated in 1.1.0

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

Shows a hierarchy of Preference objects as lists. These preferences will automatically save to android.content.SharedPreferences as the user interacts with them. To retrieve an instance of android.content.SharedPreferences that the preference hierarchy in this fragment will use, call getDefaultSharedPreferences 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.

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 android.app.Activity meta-data
From an object hierarchy rooted with PreferenceScreen

To inflate from XML, use the addPreferencesFromResource. 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.

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

See also
`Preference`
`PreferenceScreen`

Summary

Nested types
`public 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.
`public 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.
`public 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
`static final String`	`ARG_PREFERENCE_ROOT = "androidx.preference.PreferenceFragmentCompat.PREFERENCE_ROOT"` This field is deprecated. Use `PreferenceFragmentCompat` instead

Constants

static final String

ARG_PREFERENCE_ROOT = "androidx.preference.PreferenceFragmentCompat.PREFERENCE_ROOT"

This field is deprecated.

Use PreferenceFragmentCompat instead

Public constructors
`PreferenceFragment()`

Public methods
`void`	`addPreferencesFromResource(@XmlRes int preferencesResId)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`T`	`<T extends Preference> findPreference(@NonNull 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(@Nullable Bundle savedInstanceState)` This method is deprecated.
`@NonNull RecyclerView.LayoutManager`	`onCreateLayoutManager()` This method is deprecated. Use `PreferenceFragmentCompat` instead
`abstract void`	`onCreatePreferences(@Nullable Bundle savedInstanceState, String rootKey)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`@NonNull RecyclerView`	`onCreateRecyclerView( @NonNull LayoutInflater inflater, @NonNull ViewGroup parent, @Nullable Bundle savedInstanceState )` This method is deprecated. Use `PreferenceFragmentCompat` instead
`@NonNull View`	`onCreateView( @NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState )` This method is deprecated.
`void`	`onDestroyView()` This method is deprecated.
`void`	`onDisplayPreferenceDialog(@NonNull Preference preference)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`onNavigateToScreen(@NonNull PreferenceScreen preferenceScreen)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`boolean`	`onPreferenceTreeClick(@NonNull Preference preference)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`onSaveInstanceState(@NonNull Bundle outState)` This method is deprecated.
`void`	`onStart()` This method is deprecated.
`void`	`onStop()` This method is deprecated.
`void`	`onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)` This method is deprecated.
`void`	`scrollToPreference(@NonNull String key)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`scrollToPreference(@NonNull Preference preference)` This method is deprecated. Use `PreferenceFragmentCompat` instead
`void`	`setDivider(@Nullable 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( @XmlRes int preferencesResId, @Nullable String key )` This method is deprecated. Use `PreferenceFragmentCompat` instead

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

Protected methods

@NonNull RecyclerView.Adapter

onCreateAdapter(@NonNull PreferenceScreen preferenceScreen)

This method is deprecated.

Use PreferenceFragmentCompat instead

Inherited Constants

From android.content.ComponentCallbacks2

`static final int`	`TRIM_MEMORY_BACKGROUND = 40`
`static final int`	`TRIM_MEMORY_COMPLETE = 80` This field is deprecated.
`static final int`	`TRIM_MEMORY_MODERATE = 60` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_LOW = 10` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_MODERATE = 5` This field is deprecated.
`static final int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited methods

From android.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` This method is deprecated.
`final boolean`	`equals(Object o)` This method is deprecated.
`final Activity`	`getActivity()` This method is deprecated.
`boolean`	`getAllowEnterTransitionOverlap()` This method is deprecated.
`boolean`	`getAllowReturnTransitionOverlap()` This method is deprecated.
`final Bundle`	`getArguments()` This method is deprecated.
`final FragmentManager`	`getChildFragmentManager()` This method is deprecated.
`Context`	`getContext()` This method is deprecated.
`Transition`	`getEnterTransition()` This method is deprecated.
`Transition`	`getExitTransition()` This method is deprecated.
`final FragmentManager`	`getFragmentManager()` This method is deprecated.
`final Object`	`getHost()` This method is deprecated.
`final int`	`getId()` This method is deprecated.
`final LayoutInflater`	`getLayoutInflater()` This method is deprecated.
`LoaderManager`	`getLoaderManager()` This method is deprecated.
`final Fragment`	`getParentFragment()` This method is deprecated.
`Transition`	`getReenterTransition()` This method is deprecated.
`final Resources`	`getResources()` This method is deprecated.
`final boolean`	`getRetainInstance()` This method is deprecated.
`Transition`	`getReturnTransition()` This method is deprecated.
`Transition`	`getSharedElementEnterTransition()` This method is deprecated.
`Transition`	`getSharedElementReturnTransition()` This method is deprecated.
`final String`	`getString(int resId)` This method is deprecated.
`final String`	`getTag()` This method is deprecated.
`final Fragment`	`getTargetFragment()` This method is deprecated.
`final int`	`getTargetRequestCode()` This method is deprecated.
`final CharSequence`	`getText(int resId)` This method is deprecated.
`boolean`	`getUserVisibleHint()` This method is deprecated.
`View`	`getView()` This method is deprecated.
`final int`	`hashCode()` This method is deprecated.
`static Fragment`	`instantiate(Context context, String fname)` This method is deprecated.
`final boolean`	`isAdded()` This method is deprecated.
`final boolean`	`isDetached()` This method is deprecated.
`final boolean`	`isHidden()` This method is deprecated.
`final boolean`	`isInLayout()` This method is deprecated.
`final boolean`	`isRemoving()` This method is deprecated.
`final boolean`	`isResumed()` This method is deprecated.
`final boolean`	`isStateSaved()` This method is deprecated.
`final boolean`	`isVisible()` This method is deprecated.
`void`	`onActivityCreated(Bundle savedInstanceState)` This method is deprecated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` This method is deprecated.
`void`	`onAttach(Activity activity)` This method is deprecated.
`void`	`onAttachFragment(Fragment childFragment)` This method is deprecated.
`void`	`onConfigurationChanged(Configuration newConfig)` This method is deprecated.
`boolean`	`onContextItemSelected(MenuItem item)` This method is deprecated.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` This method is deprecated.
`void`	`onCreateContextMenu( ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo )` This method is deprecated.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` This method is deprecated.
`void`	`onDestroy()` This method is deprecated.
`void`	`onDestroyOptionsMenu()` This method is deprecated.
`void`	`onDetach()` This method is deprecated.
`LayoutInflater`	`onGetLayoutInflater(Bundle savedInstanceState)` This method is deprecated.
`void`	`onHiddenChanged(boolean hidden)` This method is deprecated.
`void`	`onInflate( Activity activity, AttributeSet attrs, Bundle savedInstanceState )` This method is deprecated.
`void`	`onLowMemory()` This method is deprecated.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` This method is deprecated.
`boolean`	`onOptionsItemSelected(MenuItem item)` This method is deprecated.
`void`	`onOptionsMenuClosed(Menu menu)` This method is deprecated.
`void`	`onPause()` This method is deprecated.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` This method is deprecated.
`void`	`onPrepareOptionsMenu(Menu menu)` This method is deprecated.
`void`	`onRequestPermissionsResult( int requestCode, String[] permissions, int[] grantResults )`