Most visited

Recently visited

Results for

Added in API level 11

PreferenceFragment

public abstract class PreferenceFragment
extends Fragment

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

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

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

As a convenience, this fragment implements a click listener for any preference in the current hierarchy, see onPreferenceTreeClick(PreferenceScreen, 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);
    }
}

See also:

Preference
PreferenceScreen

Summary

Nested classes
`interface`	`PreferenceFragment.OnPreferenceStartFragmentCallback` Interface that PreferenceFragment's containing activity should implement to be able to process preference items that wish to switch to a new fragment.

Inherited XML attributes

From class


  android.app.Fragment

Inherited constants

From interface


    android.content.ComponentCallbacks2

Public constructors
`PreferenceFragment()`

Public methods
`void`	`addPreferencesFromIntent(Intent intent)` Adds preferences from activities that match the given `Intent`.
`void`	`addPreferencesFromResource(int preferencesResId)` Inflates the given XML resource and adds the preference hierarchy to the current preference hierarchy.
`Preference`	`findPreference(CharSequence key)` Finds a `Preference` based on its key.
`PreferenceManager`	`getPreferenceManager()` Returns the `PreferenceManager` used by this fragment.
`PreferenceScreen`	`getPreferenceScreen()` Gets the root of the preference hierarchy that this fragment is showing.
`void`	`onActivityCreated(Bundle savedInstanceState)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` Receive the result from a previous call to `startActivityForResult(Intent, int)`.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`boolean`	`onPreferenceTreeClick(PreferenceScreen preferenceScreen, Preference preference)`
`void`	`onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`setPreferenceScreen(PreferenceScreen preferenceScreen)` Sets the root of the preference hierarchy that this fragment is showing.

Inherited methods

From class


  
    android.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` Print the Fragments's state into the given stream.
`final boolean`	`equals(Object o)` Subclasses can not override equals().
`final Activity`	`getActivity()` Return the Activity this fragment is currently associated with.
`boolean`	`getAllowEnterTransitionOverlap()` Returns whether the 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, 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`	`getString(int resId)` Return a localized string from the application's package's default string table.
`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(Activity activity)` This method was deprecated in API level 23. Use `onAttach(Context)` instead.
`void`	`onAttach(Context context)` Called when a fragment is first attached to its context.
`void`	`onAttachFragment(Fragment childFragment)` Called when a fragment is attached as a child of this fragment.
`void`	`onConfigurationChanged(Configuration newConfig)` Called by the system when the device configuration changes while your component is running.
`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(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`	`onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`void`	`onLowMemory()` This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`onOptionsItemSelected(MenuItem item)` This hook is called whenever an item in your options menu is selected.
`void`	`onOptionsMenuClosed(Menu menu)` This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
`void`	`onPause()` Called when the Fragment is no longer resumed.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode.
`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.
`void`	`startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Call `startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)` from the fragment's containing Activity.
`String`	`toString()` Returns a string representation of the object.
`void`	`unregisterForContextMenu(View view)` Prevents a context menu to be shown for the given view.

From class


  
    java.lang.Object

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

From interface


  
    android.content.ComponentCallbacks2

From interface


  
    android.view.View.OnCreateContextMenuListener

From interface


  
    android.content.ComponentCallbacks

Parameters
`requestCode`	`int`: The integer request code originally supplied to startActivityForResult(), allowing you to identify who this result came from.
`resultCode`	`int`: The integer result code returned by the child activity through its setResult().
`data`	`Intent`: An Intent, which can return result data to the caller (various data can be attached to Intent "extras").

Parameters
`inflater`	`LayoutInflater`: The LayoutInflater object that can be used to inflate any views in the fragment,
`container`	`ViewGroup`: 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`	`Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.

Parameters
`view`	`View`: The View returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`.
`savedInstanceState`	`Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.

Most visited

Recently visited

Results for

PreferenceFragment

Developer Guides

Sample Code

Summary

Nested classes

Inherited XML attributes

Inherited constants

Public constructors

Public methods

Inherited methods

Public constructors

PreferenceFragment

Public methods

addPreferencesFromIntent

addPreferencesFromResource

findPreference

getPreferenceManager

getPreferenceScreen

onActivityCreated

onActivityResult

onCreate

onCreateView

onDestroy

onDestroyView

onPreferenceTreeClick

onSaveInstanceState

onStart

onStop

onViewCreated

setPreferenceScreen