PreferenceGroup

Kotlin |Java

public abstract class PreferenceGroup
extends Preference

java.lang.Object
↳	androidx.preference.Preference
	↳	androidx.preference.PreferenceGroup

Known direct subclasses

PreferenceCategory, PreferenceScreen

PreferenceCategory	A container that is used to group similar `Preference`s.
PreferenceScreen	A top-level container that represents a settings screen.

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

Developer Guides

For information about building a settings screen using the AndroidX Preference library, see Settings.

Summary

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

Inherited constants

From class androidx.preference.Preference

int

DEFAULT_ORDER

Specify for setOrder(int) if a specific order is not required.

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.
`<T extends Preference> T`	`findPreference(CharSequence key)` Finds a `Preference` based on its key.
`int`	`getInitialExpandedChildrenCount()` Gets the maximal number of children that are 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 `Preference`s from this group.
`boolean`	`removePreference(Preference preference)` Removes a `Preference` from this group.
`boolean`	`removePreferenceRecursively(CharSequence key)` Recursively finds and removes a `Preference` from this group or a nested group lower down in the hierarchy.
`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


        
          androidx.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.
`<T extends Preference> T`	`findPreferenceInHierarchy(String key)` Finds a preference in the entire hierarchy (above or below this preference) 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.
`final SummaryProvider`	`getSummaryProvider()` Returns the `Preference.SummaryProvider` used to configure 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`	`isCopyingEnabled()` Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference.
`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.
`final boolean`	`isShown()` Checks whether this preference is shown to the user in the hierarchy.
`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.
`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)` This method is deprecated. Preferences aren't views. They should not need any accessibility changes, unless the view hierarchy is customized. In this situation, please add Accessibility information in `onBindViewHolder(PreferenceViewHolder)`.
`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(Object defaultValue)` Implement this to set the initial value of the preference.
`void`	`onSetInitialValue(boolean restorePersistedValue, Object defaultValue)` This method is deprecated. Use `onSetInitialValue(Object)` instead.
`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`	`setCopyingEnabled(boolean enabled)` Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference.
`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 `Context.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.
`final void`	`setSummaryProvider(SummaryProvider summaryProvider)` Set a `Preference.SummaryProvider` that will be invoked whenever the summary of this preference is requested.
`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 to the user.
`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

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          java.lang.Comparable

abstract int compareTo(Preference arg0)

Public constructors

PreferenceGroup

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

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

PreferenceGroup

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

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

PreferenceGroup

public PreferenceGroup (Context context, 
                AttributeSet attrs)

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

Public methods

addItemFromInflater

public void addItemFromInflater (Preference preference)

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

Parameters
`preference`	`Preference`

addPreference

public 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

public T findPreference (CharSequence key)

Finds a Preference based on its key. If two Preferences share the same key (not recommended), the first to appear will be returned.

This will recursively search for the Preference in any children that are also PreferenceGroups.

Parameters
`key`	`CharSequence`: The key of the `Preference` to retrieve

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

getInitialExpandedChildrenCount

public int getInitialExpandedChildrenCount ()

Gets the maximal number of children that are initially shown.

Returns
`int`	The maximal number of children that are initially shown `R.attr.initialExpandedChildrenCount`

getPreference

public 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

public int getPreferenceCount ()

Returns the number of children Preferences.

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

isOrderingAsAdded

public 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

public 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

public 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

public 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

public void removeAll ()

Removes all Preferences from this group.

removePreference

public boolean removePreference (Preference preference)

Removes a Preference from this group.

Note: This action is not recursive, and will only remove a preference if it exists in this group, ignoring preferences found in nested groups. Use removePreferenceRecursively(CharSequence) to recursively find and remove a preference.

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

Returns
`boolean`	Whether the preference was found and removed

See also:

removePreferenceRecursively(CharSequence)

removePreferenceRecursively

public boolean removePreferenceRecursively (CharSequence key)

Recursively finds and removes a Preference from this group or a nested group lower down in the hierarchy. If two Preferences share the same key (not recommended), the first to appear will be removed.

Parameters
`key`	`CharSequence`: The key of the preference to remove

Returns
`boolean`	Whether the preference was found and removed

See also:

findPreference(CharSequence)

setInitialExpandedChildrenCount

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

Note: The group should have a key defined if an expandable preference is present to correctly persist state.

Parameters
`expandedCount`	`int`: The number of children that is initially shown `R.attr.initialExpandedChildrenCount`

setOrderingAsAdded

public 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:

Preference.setOrder(int)

Protected methods

dispatchRestoreInstanceState

protected 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

protected 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

protected 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

protected 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

protected 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

protected 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

Inherited constants

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

PreferenceGroup

PreferenceGroup

PreferenceGroup

Public methods

addItemFromInflater

addPreference

findPreference

getInitialExpandedChildrenCount

getPreference

getPreferenceCount

isOrderingAsAdded

notifyDependencyChange

onAttached

onDetached

removeAll

removePreference

removePreferenceRecursively

setInitialExpandedChildrenCount

setOrderingAsAdded

Protected methods

dispatchRestoreInstanceState

dispatchSaveInstanceState

isOnSameScreenAsChildren

onPrepareAddPreference

onRestoreInstanceState

onSaveInstanceState