PreferenceGroup

Kotlin |Java

abstract class PreferenceGroup : Preference

kotlin.Any
↳	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.

Summary

Nested classes
abstract	`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 Preference

Int

DEFAULT_ORDER

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

Public constructors
`<init>(context: Context!, attrs: AttributeSet!, defStyleAttr: Int, defStyleRes: Int)`
`<init>(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)`
`<init>(context: Context!, attrs: AttributeSet!)`

Public methods
open Unit	`addItemFromInflater(preference: Preference!)` Called by the inflater to add an item to this group.
open Boolean	`addPreference(preference: Preference!)` Adds a `Preference` at the correct position based on the preference's order.
open T?	`findPreference(@NonNull key: CharSequence)` Finds a `Preference` based on its key.
open Int	`getInitialExpandedChildrenCount()` Gets the maximal number of children that are initially shown.
open Preference!	`getPreference(index: Int)` Returns the `Preference` at a particular index.
open Int	`getPreferenceCount()` Returns the number of children `Preference`s.
open Boolean	`isOrderingAsAdded()` Whether this group is ordering preferences in the order they are added.
open Unit	`notifyDependencyChange(disableDependents: Boolean)`
open Unit	`onAttached()`
open Unit	`onDetached()`
open Unit	`removeAll()` Removes all `Preference`s from this group.
open Boolean	`removePreference(preference: Preference!)` Removes a `Preference` from this group.
open Boolean	`removePreferenceRecursively(@NonNull key: CharSequence)` Recursively finds and removes a `Preference` from this group or a nested group lower down in the hierarchy.
open Unit	`setInitialExpandedChildrenCount(expandedCount: Int)` Sets the maximal number of children that are shown when the preference group is launched where the rest of the children will be hidden.
open Unit	`setOrderingAsAdded(orderingAsAdded: Boolean)` Whether to order the `Preference` children of this group as they are added.

Protected methods
open Unit	`dispatchRestoreInstanceState(container: Bundle!)`
open Unit	`dispatchSaveInstanceState(container: Bundle!)`
open Boolean	`isOnSameScreenAsChildren()` Whether this preference group should be shown on the same screen as its contained preferences.
open Boolean	`onPrepareAddPreference(preference: Preference!)` Prepares a `Preference` to be added to the group.
open Unit	`onRestoreInstanceState(state: Parcelable!)`
open Parcelable!	`onSaveInstanceState()`

Inherited functions

From class Preference

`Boolean`	`callChangeListener(newValue: Any!)` Call this method after the user changes the preference, but before the internal state is set. This allows the client to ignore the user value.
`Int`	`compareTo(@NonNull other: Preference)` Compares preference objects based on order (if set), otherwise alphabetically on the titles.
`T?`	`findPreferenceInHierarchy(@NonNull key: String)` Finds a preference in the entire hierarchy (above or below this preference) with the given key. Returns `null` if no preference could be found with the given key. This only works after this preference has been attached to a hierarchy.
`Context!`	`getContext()` Returns the `Context` of this preference. Each preference in a preference hierarchy can be from different Context (for example, if multiple activities provide preferences into a single `PreferenceFragmentCompat`). This Context will be used to save the preference values.
`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. You can use this to get and set individual extra key/value pairs.
`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`.
`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(defaultReturnValue: Boolean)` Attempts to get a persisted `Boolean` if this preference is persistent.
`Float`	`getPersistedFloat(defaultReturnValue: Float)` Attempts to get a persisted `Float` if this preference is persistent.
`Int`	`getPersistedInt(defaultReturnValue: Int)` Attempts to get a persisted `Integer` if this preference is persistent.
`Long`	`getPersistedLong(defaultReturnValue: Long)` Attempts to get a persisted