PreferenceScreen

Kotlin |Java

class PreferenceScreen : PreferenceGroup

kotlin.Any
↳	androidx.preference.Preference
	↳	androidx.preference.PreferenceGroup
		↳	androidx.preference.PreferenceScreen

A top-level container that represents a settings screen. This is the root component of your Preference hierarchy. A PreferenceFragmentCompat points to an instance of this class to show the preferences. To instantiate this class, use PreferenceManager#createPreferenceScreen(Context).

Summary

Inherited constants

From class Preference

Int

DEFAULT_ORDER

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

Public methods
Unit	`setShouldUseGeneratedIds(shouldUseGeneratedIds: Boolean)` Set whether the adapter created for this screen should attempt to use the preference IDs generated by `PreferenceGroup#addPreference(Preference)` as stable item IDs.
Boolean	`shouldUseGeneratedIds()` See `setShouldUseGeneratedIds(boolean)`

Protected methods
Boolean	`isOnSameScreenAsChildren()`
Unit	`onClick()`

Inherited functions

From class PreferenceGroup

`Unit`	`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.
`Unit`	`dispatchRestoreInstanceState(container: Bundle!)`
`Unit`	`dispatchSaveInstanceState(container: Bundle!)`
`T?`	`findPreference(@NonNull key: CharSequence)` Finds a `Preference` based on its key. If two `Preference`s 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 `PreferenceGroup`s.
`Int`	`getInitialExpandedChildrenCount()` Gets the maximal number of children that are initially shown.
`Preference!`	`getPreference(index: Int)` 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.
`Unit`	`notifyDependencyChange(disableDependents: Boolean)`
`Unit`	`onAttached()`
`Unit`	`onDetached()`
`Boolean`	`onPrepareAddPreference(preference: Preference!)` Prepares a `Preference` to be added to the group.
`Unit`	`onRestoreInstanceState(state: Parcelable!)`
`Parcelable!`	`onSaveInstanceState()`
`Unit`	`removeAll()` Removes all `Preference`s from this group.
`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.
`Boolean`	`removePreferenceRecursively(@NonNull key: CharSequence)` Recursively finds and removes a `Preference` from this group or a nested group lower down in the hierarchy. If two `Preference`s share the same key (not recommended), the first to appear will be removed.
`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. 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.
`Unit`	`setOrderingAsAdded(orderingAsAdded: Boolean)` 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.

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`