PreferenceScreen

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.


      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.


      findPreferenceInHierarchy(String key)

Finds a Preference in this hierarchy (the whole thing, even above/below your PreferenceScreen screen break) with the given key.


      getContext()

Returns the Context of this Preference.


      getDependency()

Returns the key of the dependency on this Preference.


      getExtras()

Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.


      getFragment()

Return the fragment class name associated with this Preference.


      getIcon()

Returns the icon of this Preference.


      getIntent()

Return the Intent associated with this Preference.


      getKey()

Gets the key for this Preference, which is also the key used for storing values into SharedPreferences or PreferenceDataStore.


      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.


      getPersistedBoolean(boolean defaultReturnValue)

Attempts to get a persisted Boolean if this Preference is persistent.


      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.


      getPersistedLong(long defaultReturnValue)

Attempts to get a persisted Long if this Preference is persistent.


      getPersistedString(String defaultReturnValue)

Attempts to get a persisted set of Strings if this Preference is persistent.


        
        
        
        
        
        Set<String>


      getPersistedStringSet(Set<String> defaultReturnValue)

Attempts to get a persisted set of Strings if this Preference is persistent.


        
        
        
        
        
        PreferenceDataStore


      getPreferenceDataStore()

Returns PreferenceDataStore used by this Preference.


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


      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.


      getWidgetLayoutResource()

Gets the layout resource for the controllable widget portion of this Preference.


      hasKey()

Checks whether this Preference has a valid key.


      isEnabled()

Checks whether this Preference should be enabled in the list.


      isIconSpaceReserved()

Returns whether the space of this preference icon view is reserved.


      isPersistent()

Checks whether this Preference is persistent.


      isSelectable()

Checks whether this Preference should be selectable in the list.


      isSingleLineTitle()

Gets whether the title of this preference is constrained to a single line.


      isVisible()

Checks whether this preference should be visible to the user in the list.


      notifyChanged()

Should be called when the data of this Preference has changed.


      notifyDependencyChange(boolean disableDependents)

Notifies any listening dependents of a change that affects the dependency.


      notifyHierarchyChanged()

Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated.


      onAttached()

Called when the Preference hierarchy has been attached to the list of preferences.


      onAttachedToHierarchy(PreferenceManager preferenceManager)

Called when this Preference has been attached to a Preference hierarchy.


      onBindViewHolder(PreferenceViewHolder holder)

Binds the created View to the data for this Preference.


      onClick()

Processes a click on the preference.


      onDependencyChanged(Preference dependency, boolean disableDependent)

Called when the dependency changes.


      onDetached()

Called when the Preference hierarchy has been detached from the list of preferences.


      onGetDefaultValue(TypedArray a, int index)

Called when a Preference is being inflated and the default value attribute needs to be read.


      onInitializeAccessibilityNodeInfo(AccessibilityNodeInfoCompat info)

Initializes an AccessibilityNodeInfo with information about the View for this Preference.


      onParentChanged(Preference parent, boolean disableChild)

Called when the implicit parent dependency changes.


      onPrepareForRemoval()

Called when this Preference is being removed from the hierarchy.


      onRestoreInstanceState(Parcelable state)

Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().


      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.


      onSetInitialValue(boolean restorePersistedValue, Object defaultValue)

Implement this to set the initial value of the Preference.


      peekExtras()

Return the extras Bundle object associated with this preference, returning null if there is not currently one.


      persistBoolean(boolean value)

Attempts to persist a Boolean if this Preference is persistent.


      persistFloat(float value)

Attempts to persist a Float if this Preference is persistent.


      persistInt(int value)

Attempts to persist an Integer if this Preference is persistent.


      persistLong(long value)

Attempts to persist a Long if this Preference is persistent.


      persistString(String value)

Attempts to persist a String if this Preference is persistent.


      persistStringSet(Set<String> values)

Attempts to persist a set of Strings if this Preference is persistent.


      restoreHierarchyState(Bundle container)

Restore this Preference hierarchy's previously saved state from the given container.


      saveHierarchyState(Bundle container)

Store this Preference hierarchy's frozen state into the given container.


      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.


      setDependency(String dependencyKey)

Sets the key of a Preference that this Preference will depend on.


      setEnabled(boolean enabled)

Sets whether this Preference is enabled.


      setFragment(String fragment)

Sets the class name of a fragment to be shown when this Preference is clicked.


      setIcon(Drawable icon)

Sets the icon for this Preference with a Drawable.


      setIcon(int iconResId)

Sets the icon for this Preference with a resource ID.


      setIconSpaceReserved(boolean iconSpaceReserved)

Sets whether to reserve the space of this Preference icon view when no icon is provided.


      setIntent(Intent intent)

Sets an Intent to be used for startActivity(Intent) when this Preference is clicked.


      setKey(String key)

Sets the key for this Preference, which is used as a key to the SharedPreferences or PreferenceDataStore.

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

Developer Guides

Summary

Inherited XML attributes

Inherited constants

Public methods

Protected methods

Inherited methods