added in version 24.1.0
belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1

Summary: Inherited XML Attrs | Inherited Constants | Methods | Protected Methods | Inherited Methods | [Expand All]

PreferenceScreen

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public final class PreferenceScreen
extends PreferenceGroup

java.lang.Object
↳	android.support.v7.preference.Preference
	↳	android.support.v7.preference.PreferenceGroup
		↳	android.support.v7.preference.PreferenceScreen

---

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

This class can appear in two places:
• When a PreferenceFragmentCompat 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 PreferenceFragment or PreferenceFragmentCompat. 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:

• PreferenceCategory

Summary

Inherited XML attributes
From class android.support.v7.preference.PreferenceGroup PreferenceGroup_initialExpandedChildrenCount
From class android.support.v7.preference.Preference Preference_android_iconSpaceReserved   Preference_android_singleLineTitle

Inherited constants
From class android.support.v7.preference.Preference int DEFAULT_ORDER Specify for setOrder(int) if a specific order is not required.

Public methods
void	setShouldUseGeneratedIds(boolean shouldUseGeneratedIds) Set whether the adapter created for this screen should attempt to use the preference IDs generated by addPreference(Preference) as stable item IDs.
boolean	shouldUseGeneratedIds() See setShouldUseGeneratedIds(boolean)

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.

Inherited methods
From class android.support.v7.preference.PreferenceGroup void addItemFromInflater(Preference preference) Called by the inflater to add an item to this group. boolean addPreference(Preference preference) Adds a Preference at the correct position based on the preference's order. void dispatchRestoreInstanceState(Bundle container) Called by restoreHierarchyState(Bundle) to retrieve the saved state for this Preference and its children. void dispatchSaveInstanceState(Bundle container) Called by saveHierarchyState(Bundle) to store the instance for this Preference and its children. Preference findPreference(CharSequence key) Finds a Preference based on its key. int getInitialExpandedChildrenCount() Gets the maximal number of children that is initially shown. Preference getPreference(int index) Returns the Preference at a particular index. int getPreferenceCount() Returns the number of children Preferences. boolean isOnSameScreenAsChildren() Whether this preference group should be shown on the same screen as its contained preferences. boolean isOrderingAsAdded() Whether this group is ordering preferences in the order they are added. void notifyDependencyChange(boolean disableDependents) Notifies any listening dependents of a change that affects the dependency. void onAttached() Called when the Preference hierarchy has been attached to the list of preferences. void onDetached() Called when the Preference hierarchy has been detached from the list of preferences. boolean onPrepareAddPreference(Preference preference) Prepares a Preference to be added to the group. 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. void removeAll() Removes all Preferences from this group. boolean removePreference(Preference preference) Removes a Preference from this group. void setInitialExpandedChildrenCount(int expandedCount) Sets the maximal number of children that are shown when the preference group is launched where the rest of the children will be hidden. void setOrderingAsAdded(boolean orderingAsAdded) Whether to order the Preference children of this group as they are added.
From class android.support.v7.preference.Preference boolean callChangeListener(Object newValue) Call this method after the user changes the preference, but before the internal state is set. int compareTo(Preference another) Compares Preference objects based on order (if set), otherwise alphabetically on the titles. Preference findPreferenceInHierarchy(String key) Finds a Preference in this hierarchy (the whole thing, even above/below your PreferenceScreen screen break) with the given key. Context getContext() Returns the Context of this Preference. String getDependency() Returns the key of the dependency on this Preference. Bundle getExtras() Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one. String getFragment() Return the fragment class name associated with this Preference. Drawable getIcon() Returns the icon of this Preference. Intent getIntent() Return the Intent associated with this Preference. String getKey() Gets the key for this Preference, which is also the key used for storing values into SharedPreferences or PreferenceDataStore. final int getLayoutResource() Gets the layout resource that will be shown as the View for this Preference. Preference.OnPreferenceChangeListener getOnPreferenceChangeListener() Returns the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated). Preference.OnPreferenceClickListener getOnPreferenceClickListener() Returns the callback to be invoked when this Preference is clicked. int getOrder() Gets the order of this Preference with respect to other Preference objects on the same level. PreferenceGroup getParent() Returns the PreferenceGroup which is this Preference assigned to or null if this preference is not assigned to any group or is a root Preference. boolean getPersistedBoolean(boolean defaultReturnValue) Attempts to get a persisted Boolean if this Preference is persistent. float getPersistedFloat(float defaultReturnValue) Attempts to get a persisted Float if this Preference is persistent. int getPersistedInt(int defaultReturnValue) Attempts to get a persisted Integer if this Preference is persistent. long getPersistedLong(long defaultReturnValue) Attempts to get a persisted Long if this Preference is persistent. String getPersistedString(String defaultReturnValue) Attempts to get a persisted set of Strings if this Preference is persistent. Set<String> getPersistedStringSet(Set<String>