PreferenceScreen

Class Overview

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).

Summary

[Expand] Inherited XML Attributes
From class android.support.v7.preference.PreferenceGroup Attribute Name Related Method Description android:orderingFromXml Whether to order the Preference under this group as they appear in the XML file.
From class android.support.v7.preference.Preference Attribute Name Related Method Description android:defaultValue The default value for the preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.  android:dependency The key of another Preference that this Preference will depend on.  android:enabled Whether the Preference is enabled.  android:fragment When used inside of a modern PreferenceActivity, this declares a new PreferenceFragment to be shown when the user selects this item.  android:icon The optional icon for the preference Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".  android:key The key to store the Preference value.  android:layout The layout for the Preference in a PreferenceActivity screen.  android:order The order for the Preference (lower values are to be ordered first).  android:persistent Whether the Preference stores its value to the shared preferences.  android:selectable Whether the Preference is selectable.  android:shouldDisableView Whether the view of this Preference should be disabled when this Preference is disabled.  android:summary The summary for the Preference in a PreferenceActivity screen.  android:title The title for the Preference in a PreferenceActivity screen.  android:widgetLayout The layout for the controllable widget portion of a Preference.

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

[Expand] 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. 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. boolean onPrepareAddPreference(Preference preference) Prepares a Preference to be added to the group. void onPrepareForRemoval() Called when this Preference is being removed from the hierarchy. void removeAll() Removes all Preferences from this group. boolean removePreference(Preference preference) Removes a Preference from this group. 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. 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. boolean getPersistedBoolean(boolean defaultReturnValue) Attempts to get a persisted boolean from the SharedPreferences. float getPersistedFloat(float defaultReturnValue) Attempts to get a persisted float from the SharedPreferences. int getPersistedInt(int defaultReturnValue) Attempts to get a persisted int from the SharedPreferences. long getPersistedLong(long defaultReturnValue) Attempts to get a persisted long from the SharedPreferences. String getPersistedString(String defaultReturnValue) Attempts to get a persisted String from the SharedPreferences. PreferenceManager getPreferenceManager() Gets the PreferenceManager that manages this Preference object's tree. SharedPreferences getSharedPreferences() Returns the SharedPreferences where this Preference can read its value(s). boolean getShouldDisableView() Checks whether this Preference should disable its view when it's action is disabled. CharSequence getSummary() Returns the summary of this Preference. CharSequence getTitle() Returns the title of this Preference. final int getWidgetLayoutResource() Gets the layout resource for the controllable widget portion of this Preference. boolean hasKey() Checks whether this Preference has a valid key. boolean isEnabled() Checks whether this Preference should be enabled in the list. boolean isPersistent() Checks whether this Preference is persistent. boolean isSelectable() Checks whether this Preference should be selectable in the list. final boolean isVisible() Checks whether this preference should be visible to the user in the list. void notifyChanged() Should be called when the data of this Preference has changed. void notifyDependencyChange(boolean disableDependents) Notifies any listening dependents of a change that affects the dependency. void notifyHierarchyChanged() Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated. void onAttached() Called when the Preference hierarchy has been attached to the list of preferences. void onAttachedToHierarchy(PreferenceManager preferenceManager) Called when this Preference has been attached to a Preference hierarchy. void onBindViewHolder(PreferenceViewHolder holder) Binds the created View to the data for this Preference. void onClick() Processes a click on the preference. void onDependencyChanged(Preference dependency, boolean disableDependent) Called when the dependency changes. Object onGetDefaultValue(TypedArray a, int index) Called when a Preference is being inflated and the default value attribute needs to be read. void onParentChanged(Preference parent, boolean disableChild) Called when the implicit parent dependency changes. void onPrepareForRemoval() Called when this Preference is being removed from the hierarchy. 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 onSetInitialValue(boolean restorePersistedValue, Object defaultValue) Implement this to set the initial value of the Preference. Bundle peekExtras() Return the extras Bundle object associated with this preference, returning null if there is not currently one. boolean persistBoolean(boolean value) Attempts to persist a boolean to the SharedPreferences. boolean persistFloat(float value) Attempts to persist a float to the SharedPreferences. boolean persistInt(int value) Attempts to persist an int to the SharedPreferences. boolean persistLong(long value) Attempts to persist a long to the SharedPreferences. boolean persistString(String value) Attempts to persist a String to the SharedPreferences. void restoreHierarchyState(Bundle container) Restore this Preference hierarchy's previously saved state from the given container. void saveHierarchyState(Bundle container) Store this Preference hierarchy's frozen state into the given container. void setDefaultValue(Object defaultValue) Sets the default value for this Preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage. void setDependency(String dependencyKey) Sets the key of a Preference that this Preference will depend on. void setEnabled(boolean enabled) Sets whether this Preference is enabled. void setFragment(String fragment) Sets the class name of a fragment to be shown when this Preference is clicked. void setIcon(Drawable icon) Sets the icon for this Preference with a Drawable. void setIcon(int iconResId) Sets the icon for this Preference with a resource ID. void setIntent(Intent intent) Sets an Intent to be used for startActivity(Intent) when this Preference is clicked. void setKey(String key) Sets the key for this Preference, which is used as a key to the SharedPreferences. void setLayoutResource(int layoutResId) Sets the layout resource that is inflated as the View to be shown for this Preference. void setOnPreferenceChangeListener(Preference.OnPreferenceChangeListener onPreferenceChangeListener) Sets the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated). void setOnPreferenceClickListener(Preference.OnPreferenceClickListener onPreferenceClickListener) Sets the callback to be invoked when this Preference is clicked. void setOrder(int order) Sets the order of this Preference with respect to other Preference objects on the same level. void setPersistent(boolean persistent) Sets whether this Preference is persistent. void setSelectable(boolean selectable) Sets whether this Preference is selectable. void setShouldDisableView(boolean shouldDisableView) Sets whether this Preference should disable its view when it gets disabled. void setSummary(int summaryResId) Sets the summary for this Preference with a resource ID. void setSummary(CharSequence summary) Sets the summary for this Preference with a CharSequence. void setTitle(int titleResId) Sets the title for this Preference with a resource ID. void setTitle(CharSequence title) Sets the title for this Preference with a CharSequence. final void setVisible(boolean visible) Sets whether this preference should be visible in the list. void setWidgetLayoutResource(int widgetLayoutResId) Sets the layout for the controllable widget portion of this Preference. boolean shouldDisableDependents() Checks whether this preference's dependents should currently be disabled. boolean shouldPersist() Checks whether, at the given time this method is called, this Preference should store/restore its value(s) into the SharedPreferences. String toString() Returns a string containing a concise, human-readable description of this object.
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 java.lang.Comparable abstract int compareTo(Preference another) Compares this object to the specified object to determine their relative order.