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

PreferenceGroup

public abstract class PreferenceGroup
extends Preference

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

Known Direct Subclasses

PreferenceCategory,PreferenceScreen

A container for multiple Preference objects. It is a base class for Preference objects that are parents, such as PreferenceCategory and PreferenceScreen.

Developer Guides

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

Summary

Nested classes
`interface`	`PreferenceGroup.PreferencePositionCallback` Interface for PreferenceGroup Adapters to implement so that `scrollToPreference(String)` and `scrollToPreference(Preference)` or `scrollToPreference(String)` and `scrollToPreference(Preference)` can determine the correct scroll position to request.

XML attributes
`PreferenceGroup_initialExpandedChildrenCount`

Inherited XML attributes

From class


  android.support.v7.preference.Preference

Inherited constants

From class


    android.support.v7.preference.Preference

Public constructors
`PreferenceGroup(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)`
`PreferenceGroup(Context context, AttributeSet attrs, int defStyleAttr)`
`PreferenceGroup(Context context, AttributeSet attrs)`

Public methods
`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.
`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 `Preference`s.
`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.
`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.

Protected methods
`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.
`boolean`	`isOnSameScreenAsChildren()` Whether this preference group should be shown on the same screen as its contained 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.

Inherited methods

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> 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).
`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`	`isIconSpaceReserved()` Returns whether the space of this preference icon view is reserved.
`boolean`	`isPersistent()` Checks whether this Preference is persistent.
`boolean`	`isSelectable()` Checks whether this Preference should be selectable in the list.
`boolean`	`isSingleLineTitle()` Gets whether the title of this preference is constrained to a single line.
`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.
`void`	`onDetached()` Called when the Preference hierarchy has been detached from the list of preferences.
`Object`	`onGetDefaultValue(TypedArray a, int index)` Called when a Preference is being inflated and the default value attribute needs to be read.
`void`	`onInitializeAccessibilityNodeInfo(AccessibilityNodeInfoCompat info)` Initializes an `AccessibilityNodeInfo` with information about the View for this Preference.
`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` if this Preference is persistent.
`boolean`	`persistFloat(float value)` Attempts to persist a `Float` if this Preference is persistent.
`boolean`	`persistInt(int value)` Attempts to persist an `Integer` if this Preference is persistent.
`boolean`	`persistLong(long value)` Attempts to persist a `Long` if this Preference is persistent.
`boolean`	`persistString(String value)` Attempts to persist a `String` if this Preference is persistent.
`boolean`	`persistStringSet(Set<String> values)` Attempts to persist a set of Strings if this Preference is persistent.
`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`	`setIconSpaceReserved(boolean iconSpaceReserved)` Sets whether to reserve the space of this Preference icon view when no icon is provided.
`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` or `PreferenceDataStore`.
`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`	`setPreferenceDataStore(PreferenceDataStore dataStore)` Sets a `PreferenceDataStore` to be used by this Preference instead of using `SharedPreferences`.
`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`	`setSingleLineTitle(boolean singleLineTitle)` Sets whether to constrain the title of this Preference to a single line instead of letting it wrap onto multiple lines.
`void`	`setSummary(CharSequence summary)` Sets the summary for this Preference with a CharSequence.
`void`	`setSummary(int summaryResId)` Sets the summary for this Preference with a resource ID.
`void`	`setTitle(CharSequence title)` Sets the title for this Preference with a CharSequence.
`void`	`setTitle(int titleResId)` Sets the title for this Preference with a resource ID.
`void`	`setViewId(int viewId)` Set the ID that will be assigned to the overall View representing this preference, once bound.
`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` or into `PreferenceDataStore` if assigned.
`String`	`toString()`

From class


  
    java.lang.Object

From interface


  
    java.lang.Comparable

XML attributes

PreferenceGroup_initialExpandedChildrenCount

Related methods:

setInitialExpandedChildrenCount(int)

Public constructors

PreferenceGroup

added in version 24.1.0

PreferenceGroup (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
`context`	`Context`
`attrs`	`AttributeSet`
`defStyleAttr`	`int`
`defStyleRes`	`int`

PreferenceGroup

added in version 24.1.0

PreferenceGroup (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
`context`	`Context`
`attrs`	`AttributeSet`
`defStyleAttr`	`int`

PreferenceGroup

added in version 24.1.0

PreferenceGroup (Context context, 
                AttributeSet attrs)

Parameters
`context`	`Context`
`attrs`	`AttributeSet`

Public methods

addItemFromInflater

added in version 24.1.0

void addItemFromInflater (Preference preference)

Called by the inflater to add an item to this group.

Parameters
`preference`	`Preference`

addPreference

added in version 24.1.0

boolean addPreference (Preference preference)

Adds a Preference at the correct position based on the preference's order.

Parameters
`preference`	`Preference`: The preference to add.

Returns
`boolean`	Whether the preference is now in this group.

findPreference

added in version 24.1.0

Preference findPreference (CharSequence key)

Finds a Preference based on its key. If two Preference share the same key (not recommended), the first to appear will be returned (to retrieve the other preference with the same key, call this method on the first preference). If this preference has the key, it will not be returned.

This will recursively search for the preference into children that are also PreferenceGroups.

Parameters
`key`	`CharSequence`: The key of the preference to retrieve.

Returns
`Preference`	The `Preference` with the key, or null.

getInitialExpandedChildrenCount

added in version 27.1.0

int getInitialExpandedChildrenCount ()

Gets the maximal number of children that is initially shown.

Related XML Attributes:

PreferenceGroup_initialExpandedChildrenCount

Returns
`int`	the maximal number of children that is initially shown.

getPreference

added in version 24.1.0

Preference getPreference (int index)

Returns the Preference at a particular index.

Parameters
`index`	`int`: The index of the `Preference` to retrieve.

Returns
`Preference`	The `Preference`.

getPreferenceCount

added in version 24.1.0

int getPreferenceCount ()

Returns the number of children Preferences.

Returns
`int`	The number of preference children in this group.

isOrderingAsAdded

added in version 24.1.0

boolean isOrderingAsAdded ()

Whether this group is ordering preferences in the order they are added.

Returns
`boolean`	Whether this group orders based on the order the children are added.

See also:

setOrderingAsAdded(boolean)

notifyDependencyChange

added in version 24.1.0

void notifyDependencyChange (boolean disableDependents)

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

Parameters
`disableDependents`	`boolean`: Whether this Preference should disable its dependents.

onAttached

added in version 24.1.0

void onAttached ()

Called when the Preference hierarchy has been attached to the list of preferences. This can also be called when this Preference has been attached to a group that was already attached to the list of preferences.

onDetached

added in version 24.1.0

void onDetached ()

Called when the Preference hierarchy has been detached from the list of preferences. This can also be called when this Preference has been removed from a group that was attached to the list of preferences.

removeAll

added in version 24.1.0

void removeAll ()

Removes all Preferences from this group.

removePreference

added in version 24.1.0

boolean removePreference (Preference preference)

Removes a Preference from this group.

Parameters
`preference`	`Preference`: The preference to remove.

Returns
`boolean`	Whether the preference was found and removed.

setInitialExpandedChildrenCount

added in version 27.1.0

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. If some children are hidden an expand button will be provided to show all the hidden children. Any child in any level of the hierarchy that is also a preference group (e.g. preference category) will not be counted towards the limit. But instead the children of such group will be counted. By default, all children will be shown, so the default value of this attribute is equal to Integer.MAX_VALUE.

Related XML Attributes:

PreferenceGroup_initialExpandedChildrenCount

Parameters
`expandedCount`	`int`: the number of children that is initially shown.

setOrderingAsAdded

added in version 24.1.0

void setOrderingAsAdded (boolean orderingAsAdded)

Whether to order the Preference children of this group as they are added. If this is false, the ordering will follow each Preference order and default to alphabetic for those without an order.

If this is called after preferences are added, they will not be re-ordered in the order they were added, hence call this method early on.

Parameters
`orderingAsAdded`	`boolean`: Whether to order according to the order added.

See also:

setOrder(int)

Protected methods

dispatchRestoreInstanceState

added in version 24.1.0

void dispatchRestoreInstanceState (Bundle container)

Called by restoreHierarchyState(Bundle) to retrieve the saved state for this Preference and its children. May be overridden to modify how restoring happens to the children of a Preference. For example, some Preference objects may not want to save state for their children.

Parameters
`container`	`Bundle`: The Bundle that holds the previously saved state.

dispatchSaveInstanceState

added in version 24.1.0

void dispatchSaveInstanceState (Bundle container)

Called by saveHierarchyState(Bundle) to store the instance for this Preference and its children. May be overridden to modify how the save happens for children. For example, some Preference objects may want to not store an instance for their children.

Parameters
`container`	`Bundle`: The Bundle in which to save the instance of this Preference.

isOnSameScreenAsChildren

added in version 24.1.0

boolean isOnSameScreenAsChildren ()

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.

onPrepareAddPreference

added in version 24.1.0

boolean onPrepareAddPreference (Preference preference)

Prepares a Preference to be added to the group.

Parameters
`preference`	`Preference`: The preference to add.

Returns
`boolean`	Whether to allow adding the preference (true), or not (false).

onRestoreInstanceState

added in version 24.1.0

void onRestoreInstanceState (Parcelable state)

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`	`Parcelable`: The saved state that had previously been returned by `onSaveInstanceState()`.

onSaveInstanceState

added in version 24.1.0

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

PreferenceGroup

Developer Guides

Summary

Nested classes

XML attributes

Inherited XML attributes

Inherited constants

Public constructors

Public methods

Protected methods

Inherited methods

XML attributes

PreferenceGroup_initialExpandedChildrenCount

Public constructors

PreferenceGroup

PreferenceGroup

PreferenceGroup

Public methods

addItemFromInflater

addPreference

findPreference

getInitialExpandedChildrenCount

getPreference

getPreferenceCount

isOrderingAsAdded

notifyDependencyChange

onAttached

onDetached

removeAll

removePreference

setInitialExpandedChildrenCount

setOrderingAsAdded

Protected methods

dispatchRestoreInstanceState

dispatchSaveInstanceState

isOnSameScreenAsChildren

onPrepareAddPreference

onRestoreInstanceState

onSaveInstanceState

Interfaces

Classes