Android APIs
public final class

PreferenceScreen

extends PreferenceGroup
implements AdapterView.OnItemClickListener DialogInterface.OnDismissListener
java.lang.Object
   ↳ android.preference.Preference
     ↳ android.preference.PreferenceGroup
       ↳ android.preference.PreferenceScreen

Class Overview

Represents a top-level Preference that is the root of a Preference hierarchy. A PreferenceActivity points to an instance of this class to show the preferences. To instantiate this class, use createPreferenceScreen(Context).

    This class can appear in two places:
  • When a PreferenceActivity points to this, it is used as the root and is not shown (only the contained preferences are shown).
  • When it appears inside another preference hierarchy, it is shown and serves as the gateway to another screen of preferences (either by showing another screen of preferences as a Dialog or via a startActivity(android.content.Intent) from the getIntent()). The children of this PreferenceScreen are NOT shown in the screen that this PreferenceScreen is shown in. Instead, a separate screen will be shown when this preference is clicked.

Here's an example XML layout of a PreferenceScreen:

<PreferenceScreen
        xmlns:android="http://schemas.android.com/apk/res/android"
        android:key="first_preferencescreen">
    <CheckBoxPreference
            android:key="wifi enabled"
            android:title="WiFi" />
    <PreferenceScreen
            android:key="second_preferencescreen"
            android:title="WiFi settings">
        <CheckBoxPreference
                android:key="prefer wifi"
                android:title="Prefer WiFi" />
        ... other preferences here ...
    </PreferenceScreen>
</PreferenceScreen> 

In this example, the "first_preferencescreen" will be used as the root of the hierarchy and given to a PreferenceActivity. The first screen will show preferences "WiFi" (which can be used to quickly enable/disable WiFi) and "WiFi settings". The "WiFi settings" is the "second_preferencescreen" and when clicked will show another screen of preferences such as "Prefer WiFi" (and the other preferences that are children of the "second_preferencescreen" tag).

Developer Guides

For information about building a settings UI with Preferences, read the Settings guide.

See also:

Summary

[Expand]
Inherited XML Attributes
From class android.preference.PreferenceGroup
From class android.preference.Preference
[Expand]
Inherited Constants
From class android.preference.Preference
Public Methods
void bind(ListView listView)
Binds a ListView to the preferences contained in this PreferenceScreen via getRootAdapter().
Dialog getDialog()
Used to get a handle to the dialog.
ListAdapter getRootAdapter()
Returns an adapter that can be attached to a PreferenceActivity or PreferenceFragment to show the preferences contained in this PreferenceScreen.
void onDismiss(DialogInterface dialog)
This method will be invoked when the dialog is dismissed.
void onItemClick(AdapterView parent, View view, int position, long id)
Protected Methods
boolean isOnSameScreenAsChildren()
Whether this preference group should be shown on the same screen as its contained preferences.
void onClick()
Processes a click on the preference.
ListAdapter onCreateRootAdapter()
Creates the root adapter.
void onRestoreInstanceState(Parcelable state)
Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().
Parcelable onSaveInstanceState()
Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state.
[Expand]
Inherited Methods
From class android.preference.PreferenceGroup
From class android.preference.Preference
From class java.lang.Object
From interface java.lang.Comparable
From interface android.widget.AdapterView.OnItemClickListener
From interface android.content.DialogInterface.OnDismissListener

Public Methods

public void bind (ListView listView)

Added in API level 1

Binds a ListView to the preferences contained in this PreferenceScreen via getRootAdapter(). It also handles passing list item clicks to the corresponding Preference contained by this PreferenceScreen.

Parameters
listView The list view to attach to.

public Dialog getDialog ()

Added in API level 1

Used to get a handle to the dialog. This is useful for cases where we want to manipulate the dialog as we would with any other activity or view.

Returns
Dialog

public ListAdapter getRootAdapter ()

Added in API level 1

Returns an adapter that can be attached to a PreferenceActivity or PreferenceFragment to show the preferences contained in this PreferenceScreen.

This PreferenceScreen will NOT appear in the returned adapter, instead it appears in the hierarchy above this PreferenceScreen.

This adapter's getItem(int) should always return a subclass of Preference.

Returns
ListAdapter An adapter that provides the Preference contained in this PreferenceScreen.

public void onDismiss (DialogInterface dialog)

Added in API level 1

This method will be invoked when the dialog is dismissed.

Parameters
dialog The dialog that was dismissed will be passed into the method.

public void onItemClick (AdapterView parent, View view, int position, long id)

Added in API level 1

Parameters
parent
view
position
id

Protected Methods

protected boolean isOnSameScreenAsChildren ()

Added in API level 1

Whether this preference group should be shown on the same screen as its contained preferences.

Returns
boolean True if the contained preferences should be shown on the same screen as this preference.

protected void onClick ()

Added in API level 1

Processes a click on the preference. This includes saving the value to the SharedPreferences. However, the overridden method should call callChangeListener(Object) to make sure the client wants to update the preference's state with the new value.

protected ListAdapter onCreateRootAdapter ()

Added in API level 1

Creates the root adapter.

Returns
ListAdapter An adapter that contains the preferences contained in this PreferenceScreen.

See also:

protected void onRestoreInstanceState (Parcelable state)

Added in API level 1

Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters
state The saved state that had previously been returned by onSaveInstanceState().

protected Parcelable onSaveInstanceState ()

Added in API level 1

Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can be reconstructed later.

Returns
Parcelable A Parcelable object containing the current dynamic state of this Preference, or null if there is nothing interesting to save. The default implementation returns null.