PreferenceFragment - Android SDK

public abstract class

PreferenceFragment

extends Fragment
implements PreferenceManager.OnPreferenceTreeClickListener PreferenceManager.OnDisplayPreferenceDialogListener PreferenceManager.OnNavigateToScreenListener DialogPreference.TargetFragment

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

Known Direct Subclasses

BaseLeanbackPreferenceFragment

Known Indirect Subclasses

LeanbackPreferenceFragment

Class Overview

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 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 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 using PreferenceFragment, read the Settings guide.

Sample Code

The following sample code shows a simple preference fragment that is populated from a resource. The resource it loads is:

<PreferenceScreen
        xmlns:android="http://schemas.android.com/apk/res/android">

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

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

    </PreferenceCategory>

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

        <EditTextPreference
                android:key="edittext_preference"
                android:title="@string/title_edittext_preference"
                android:summary="@string/summary_edittext_preference"
                android:dialogTitle="@string/dialog_title_edittext_preference" />

        <ListPreference
                android:key="list_preference"
                android:title="@string/title_list_preference"
                android:summary="@string/summary_list_preference"
                android:entries="@array/entries_list_preference"
                android:entryValues="@array/entryvalues_list_preference"
                android:dialogTitle="@string/dialog_title_list_preference" />

    </PreferenceCategory>

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

        <!-- This PreferenceScreen tag serves as a screen break (similar to page break
             in word processing). Like for other preference types, we assign a key
             here so it is able to save and restore its instance state. -->
        <PreferenceScreen
                android:key="screen_preference"
                android:title="@string/title_screen_preference"
                android:summary="@string/summary_screen_preference">

            <!-- You can place more preferences here that will be shown on the next screen. -->

            <CheckBoxPreference
                    android:key="next_screen_checkbox_preference"
                    android:title="@string/title_next_screen_toggle_preference"
                    android:summary="@string/summary_next_screen_toggle_preference" />

        </PreferenceScreen>

        <PreferenceScreen
                android:title="@string/title_intent_preference"
                android:summary="@string/summary_intent_preference">

            <intent android:action="android.intent.action.VIEW"
                    android:data="http://www.android.com" />

        </PreferenceScreen>

    </PreferenceCategory>

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

        <CheckBoxPreference
                android:key="parent_checkbox_preference"
                android:title="@string/title_parent_preference"
                android:summary="@string/summary_parent_preference" />

        <!-- The visual style of a child is defined by this styled theme attribute. -->
        <CheckBoxPreference
                android:key="child_checkbox_preference"
                android:dependency="parent_checkbox_preference"
                android:layout="?android:attr/preferenceLayoutChild"
                android:title="@string/title_child_preference"
                android:summary="@string/summary_child_preference" />

    </PreferenceCategory>

</PreferenceScreen>

The fragment implementation itself simply populates the preferences when created. Note that the preferences framework takes care of loading the current values out of the app preferences and writing them when changed:

public static class PrefsFragment extends PreferenceFragment {

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Load the preferences from an XML resource
        addPreferencesFromResource(R.xml.preferences);
    }
}

Summary

Nested Classes
interface	PreferenceFragment.OnPreferenceDisplayDialogCallback
interface	PreferenceFragment.OnPreferenceStartFragmentCallback	Interface that PreferenceFragment'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 PreferenceFragment's containing activity should implement to be able to process preference items that wish to switch to a new screen of preferences.

[Expand]

Inherited XML Attributes

From class android.app.Fragment

Constants
String	ARG_PREFERENCE_ROOT	Fragment argument used to specify the tag of the desired root `PreferenceScreen` object.

[Expand]

Inherited Constants

From interface android.content.ComponentCallbacks2

Public Constructors
	PreferenceFragment()

Public Methods
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.
final RecyclerView	getListView()
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	onCreate(Bundle savedInstanceState) Called to do initial creation of a fragment.
RecyclerView.LayoutManager	onCreateLayoutManager() Called from `onCreateRecyclerView(LayoutInflater, ViewGroup, Bundle)` to create the `RecyclerView.LayoutManager` for the created `RecyclerView`.
abstract void	onCreatePreferences(Bundle savedInstanceState, String rootKey) Called during `onCreate(Bundle)` to supply the preferences for this fragment.
RecyclerView	onCreateRecyclerView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState) Creates the `RecyclerView` used to display the preferences.
View	onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) Called to have the fragment instantiate its user interface view.
void	onDestroyView() Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
void	onDisplayPreferenceDialog(Preference preference) Called when a preference in the tree requests to display a dialog.
void	onNavigateToScreen(PreferenceScreen preferenceScreen) Called by `onClick()` in order to navigate to a new screen of preferences.
boolean	onPreferenceTreeClick(Preference preference) Called when a preference in the tree rooted at this `PreferenceScreen` has been clicked.
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	setPreferenceScreen(PreferenceScreen preferenceScreen) Sets the root of the preference hierarchy that this fragment is showing.
void	setPreferencesFromResource(int preferencesResId, String key) Inflates the given XML resource and replaces the current preference hierarchy (if any) with the preference hierarchy rooted at `key`.

Protected Methods
Adapter	onCreateAdapter(PreferenceScreen preferenceScreen) Creates the root adapter.

[Expand]

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 the exit transition and enter transition overlap or not.
boolean	getAllowReturnTransitionOverlap() Returns whether the 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.
LoaderManager	getLoaderManager() Return the LoaderManager for this fragment, creating it if needed.
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 `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(Context, String, 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	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(Intent, int)`.
void	onAttach(Context context) Called when a fragment is first attached to its context.
void	onAttach(Activity activity) This method was deprecated in API level 23. Use `onAttach(Context)` instead.
void	onConfigurationChanged(Configuration newConfig) Called by the system when the device configuration changes while your component is running.
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.
void	onHiddenChanged(boolean hidden) Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
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	onInflate(AttributeSet attrs, Bundle savedInstanceState) This method was deprecated in API level 12. Use `onInflate(Context, AttributeSet, Bundle)` instead.
void	onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) This method was deprecated in API level 23. Use `onInflate(Context, AttributeSet, Bundle)` instead.
void	onLowMemory() This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
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	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.
void	onViewCreated(View view, Bundle savedInstanceState) Called immediately after `onCreateView(LayoutInflater, ViewGroup, 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	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 the exit transition and enter transition overlap or not.
void	setAllowReturnTransitionOverlap(boolean allow) Sets whether the 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 for requesting a permission.
void	startActivity(Intent intent) Call `startActivity(Intent)` from the fragment's containing Activity.
void	startActivity(Intent intent, Bundle options) Call `startActivity(Intent, Bundle)` from the fragment's containing Activity.
void	startActivityForResult(Intent intent, int requestCode) Call `startActivityForResult(Intent, int)` from the fragment's containing Activity.
void	startActivityForResult(Intent intent, int requestCode, Bundle options) Call `startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
String	toString() Returns a string containing a concise, human-readable description of this 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 o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.content.ComponentCallbacks2

From interface android.view.View.OnCreateContextMenuListener

From interface android.support.v7.preference.PreferenceManager.OnPreferenceTreeClickListener

From interface android.support.v7.preference.PreferenceManager.OnDisplayPreferenceDialogListener

From interface android.support.v7.preference.PreferenceManager.OnNavigateToScreenListener

From interface android.support.v7.preference.DialogPreference.TargetFragment

From interface android.content.ComponentCallbacks

Constants

public static final String ARG_PREFERENCE_ROOT

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

Constant Value: "android.support.v7.preference.PreferenceFragmentCompat.PREFERENCE_ROOT"

Public Constructors

public PreferenceFragment ()

Public Methods

public void addPreferencesFromResource (int preferencesResId)

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

Parameters

preferencesResId	The XML resource ID to inflate.

public Preference findPreference (CharSequence key)

Finds a Preference based on its key.

Parameters

key	The key of the preference to retrieve.

Returns

The Preference with the key, or null.

public final RecyclerView getListView ()

public PreferenceManager getPreferenceManager ()

Returns the PreferenceManager used by this fragment.

Returns

The PreferenceManager.

public PreferenceScreen getPreferenceScreen ()

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

Returns

The PreferenceScreen that is the root of the preference hierarchy.

public void onActivityCreated (Bundle savedInstanceState)

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(LayoutInflater, ViewGroup, Bundle) and before onViewStateRestored(Bundle).

Parameters

savedInstanceState	If the fragment is being re-created from a previous saved state, this is the state.

public void onCreate (Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach(Activity) and before onCreateView(LayoutInflater, ViewGroup, Bundle).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, see onActivityCreated(Bundle).

Parameters

savedInstanceState	If the fragment is being re-created from a previous saved state, this is the state.

public RecyclerView.LayoutManager onCreateLayoutManager ()

Called from onCreateRecyclerView(LayoutInflater, ViewGroup, Bundle) to create the RecyclerView.LayoutManager for the created RecyclerView.

Returns

A new RecyclerView.LayoutManager instance.

public abstract void onCreatePreferences (Bundle savedInstanceState, String rootKey)

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	If the fragment is being re-created from a previous saved state, this is the state.
rootKey	If non-null, this preference fragment should be rooted at the `PreferenceScreen` with this key.

public RecyclerView onCreateRecyclerView (LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState)

Creates the RecyclerView used to display the preferences. Subclasses may override this to return a customized RecyclerView.

Parameters

inflater	The LayoutInflater object that can be used to inflate the `RecyclerView`.
parent	The parent `View` that the RecyclerView will be attached to. This method should not add the view itself, but this can be used to generate the LayoutParams of the view.
savedInstanceState	If non-null, this view is being re-constructed from a previous saved state as given here

Returns

A new RecyclerView object to be placed into the view hierarchy

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

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null (which is the default implementation). This will be called between onCreate(Bundle) and onActivityCreated(Bundle).

If you return a View from here, you will later be called in onDestroyView() when the view is being released.

Parameters

inflater	The LayoutInflater object that can be used to inflate any views in the fragment,
container	If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
savedInstanceState	If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns

Return the View for the fragment's UI, or null.

public void onDestroyView ()

Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle) has been detached from the fragment. The next time the fragment needs to be displayed, a new view will be created. This is called after onStop() and before onDestroy(). It is called regardless of whether onCreateView(LayoutInflater, ViewGroup, Bundle) returned a non-null view. Internally it is called after the view's state has been saved but before it has been removed from its parent.

public void onDisplayPreferenceDialog (Preference preference)

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	The Preference object requesting the dialog.

public void onNavigateToScreen (PreferenceScreen preferenceScreen)

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

Parameters

preferenceScreen	The `PreferenceScreen` to navigate to.

public boolean onPreferenceTreeClick (Preference preference)

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

Parameters

preference	The preference that was clicked.

Returns

Whether the click was handled.

public 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. If a new instance of the fragment later needs to be created, the data you place in the Bundle here will be available in the Bundle given to onCreate(Bundle), onCreateView(LayoutInflater, ViewGroup, Bundle), and onActivityCreated(Bundle).

This corresponds to Activity.onSaveInstanceState(Bundle) and most of the discussion there applies here as well. Note however: this method may be called at any time before onDestroy(). There are many situations where a fragment may be mostly torn down (such as when placed on the back stack with no UI showing), but its state will not be saved until its owning activity actually needs to save its state.

Parameters

outState	Bundle in which to place your saved state.

public void onStart ()

Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle.

public void onStop ()

Called when the Fragment is no longer started. This is generally tied to Activity.onStop of the containing Activity's lifecycle.

public void setPreferenceScreen (PreferenceScreen preferenceScreen)

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

Parameters

preferenceScreen	The root `PreferenceScreen` of the preference hierarchy.

public void setPreferencesFromResource (int preferencesResId, String key)

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

Parameters

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

Protected Methods

protected Adapter onCreateAdapter (PreferenceScreen preferenceScreen)

Creates the root adapter.

Parameters

preferenceScreen	Preference screen object to create the adapter for.

Returns

An adapter that contains the preferences contained in this PreferenceScreen.

Results

Interfaces

Classes

PreferenceFragment

Class Overview

Developer Guides

Sample Code

See Also

Summary

Constants

public static final String ARG_PREFERENCE_ROOT

Public Constructors

public PreferenceFragment ()

Public Methods

public void addPreferencesFromResource (int preferencesResId)

Parameters

public Preference findPreference (CharSequence key)

Parameters

Returns

See Also

public final RecyclerView getListView ()

public PreferenceManager getPreferenceManager ()

Returns

public PreferenceScreen getPreferenceScreen ()

Returns

public void onActivityCreated (Bundle savedInstanceState)

Parameters

public void onCreate (Bundle savedInstanceState)

Parameters

public RecyclerView.LayoutManager onCreateLayoutManager ()

Returns

public abstract void onCreatePreferences (Bundle savedInstanceState, String rootKey)

Parameters

public RecyclerView onCreateRecyclerView (LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState)

Parameters

Returns

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

Parameters

Returns

public void onDestroyView ()

public void onDisplayPreferenceDialog (Preference preference)

Parameters

public void onNavigateToScreen (PreferenceScreen preferenceScreen)

Parameters

public boolean onPreferenceTreeClick (Preference preference)

Parameters

Returns

public void onSaveInstanceState (Bundle outState)

Parameters

public void onStart ()

public void onStop ()

public void setPreferenceScreen (PreferenceScreen preferenceScreen)

Parameters

public void setPreferencesFromResource (int preferencesResId, String key)

Parameters

Protected Methods

protected Adapter onCreateAdapter (PreferenceScreen preferenceScreen)

Parameters

Returns