Preference

bookmark_border Stay organized with collections Save and categorize content based on your preferences.

public static final int DEFAULT_ORDER = 2147483647

Specify for setOrder if a specific order is not required.

public Preference(@NonNull Context context)

Constructor to create a preference.

public Preference(@NonNull Context context, @Nullable AttributeSet attrs)

Constructor that is called when inflating a preference from XML. This is called when a preference is being constructed from an XML file, supplying attributes that were specified in the XML file. This version uses a default style of 0, so the only attribute values applied are those in the Context's Theme and the given AttributeSet.

public Preference(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr
)

Perform inflation from XML and apply a class-specific base style. This constructor allows subclasses to use their own base style when they are inflating. For example, a CheckBoxPreference constructor calls this version of the super class constructor and supplies android.R.attr.checkBoxPreferenceStyle for defStyleAttr. This allows the theme's checkbox preference style to modify all of the base preference attributes as well as the CheckBoxPreference class's attributes.

public Preference(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr,
    int defStyleRes
)

Perform inflation from XML and apply a class-specific base style. This constructor allows subclasses to use their own base style when they are inflating. For example, a CheckBoxPreference constructor calls this version of the super class constructor and supplies android.R.attr.checkBoxPreferenceStyle for defStyleAttr. This allows the theme's checkbox preference style to modify all of the base preference attributes as well as the CheckBoxPreference class's attributes.

public boolean callChangeListener(Object newValue)

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.

public int compareTo(@NonNull Preference another)

Compares preference objects based on order (if set), otherwise alphabetically on the titles.

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

public @Nullable String getDependency()

Returns the key of the dependency on this preference.

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

public @Nullable String getFragment()

Return the fragment class name associated with this preference.

public @Nullable Drawable getIcon()

Returns the icon of this preference.

public @Nullable Intent getIntent()

Return the Intent associated with this preference.

public String getKey()

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

public final int getLayoutResource()

Gets the layout resource that will be shown as the View for this preference.

public @Nullable 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).

public @Nullable Preference.OnPreferenceClickListener getOnPreferenceClickListener()

Returns the callback to be invoked when this preference is clicked.

public int getOrder()

Gets the order of this preference with respect to other preference objects on the same level.

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

public Set<String> getPersistedStringSet(Set<String> defaultReturnValue)

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

public @Nullable PreferenceDataStore getPreferenceDataStore()

Returns PreferenceDataStore used by this preference. Returns null if SharedPreferences is used instead.

By default preferences always use SharedPreferences. To make this preference to use the PreferenceDataStore you need to assign your implementation to the preference itself via setPreferenceDataStore or to its PreferenceManager via setPreferenceDataStore.

public PreferenceManager getPreferenceManager()

Gets the PreferenceManager that manages this preference object's tree.

public @Nullable SharedPreferences getSharedPreferences()

Returns the SharedPreferences where this preference can read its value(s). Usually, it's easier to use one of the helper read methods: getPersistedBoolean, getPersistedFloat, getPersistedInt, getPersistedLong, getPersistedString.

public boolean getShouldDisableView()

Checks whether this preference should disable its view when it's action is disabled.

public @Nullable CharSequence getSummary()

Returns the summary of this preference. If a SummaryProvider has been set for this preference, it will be used to provide the summary returned by this method.

public final @Nullable Preference.SummaryProvider getSummaryProvider()

Returns the SummaryProvider used to configure the summary of this preference.

public @Nullable CharSequence getTitle()

Returns the title of this preference.

public final int getWidgetLayoutResource()

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

public boolean hasKey()

Checks whether this preference has a valid key.

public boolean isCopyingEnabled()

Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference.

public boolean isEnabled()

Checks whether this preference should be enabled in the list.

public boolean isIconSpaceReserved()

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

public boolean isPersistent()

Checks whether this preference is persistent. If it is, it stores its value(s) into the persistent SharedPreferences storage by default or into PreferenceDataStore if assigned.

public boolean isSelectable()

Checks whether this preference should be selectable in the list.

public final boolean isShown()

Checks whether this preference is shown to the user in the hierarchy. For a preference to be shown in the hierarchy, it and all of its ancestors must be visible and attached to the root PreferenceScreen.

public boolean isSingleLineTitle()

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

public final boolean isVisible()

Checks whether this preference should be visible to the user. If this preference is visible, but one or more of its ancestors are not visible, then this preference will not be shown until its ancestors are all visible.

public void notifyDependencyChange(boolean disableDependents)

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

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.

public void onBindViewHolder(@NonNull PreferenceViewHolder holder)

Binds the created View to the data for this preference.

This is a good place to grab references to custom Views in the layout and set properties on them.

Make sure to call through to the superclass's implementation.

public void onDependencyChanged(
    @NonNull Preference dependency,
    boolean disableDependent
)

Called when the dependency changes.

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.

@CallSuper
public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfoCompat info)

Initializes an android.view.accessibility.AccessibilityNodeInfo with information about the View for this preference.

public void onParentChanged(@NonNull Preference parent, boolean disableChild)

Called when the implicit parent dependency changes.

public @Nullable Bundle peekExtras()

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

public boolean persistStringSet(Set<String> values)

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

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

public void restoreHierarchyState(@NonNull Bundle container)

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

public void saveHierarchyState(@NonNull Bundle container)

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

public void setCopyingEnabled(boolean enabled)

Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference.

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

public void setDependency(@Nullable String dependencyKey)

Sets the key of a preference that this preference will depend on. If that preference is not set or is off, this preference will be disabled.

public void setEnabled(boolean enabled)

Sets whether this preference is enabled. If disabled, it will not handle clicks.

public void setFragment(@Nullable String fragment)

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

public void setIcon(@Nullable Drawable icon)

Sets the icon for this preference with a Drawable. This icon will be placed into the ID icon within the View created by onBindViewHolder.

public void setIcon(int iconResId)

Sets the icon for this preference with a resource ID.

public void setIconSpaceReserved(boolean iconSpaceReserved)

Sets whether to reserve the space of this preference icon view when no icon is provided. If set to true, the preference will be offset as if it would have the icon and thus aligned with other preferences having icons.

public void setIntent(@Nullable Intent intent)

Sets an Intent to be used for startActivity when this preference is clicked.

public void setKey(String key)

Sets the key for this preference, which is used as a key to the SharedPreferences or PreferenceDataStore. This should be unique for the package.

public void setLayoutResource(int layoutResId)

Sets the layout resource that is inflated as the View to be shown for this preference. In most cases, the default layout is sufficient for custom preference objects and only the widget layout needs to be changed.

This layout should contain a ViewGroup with ID widget_frame to be the parent of the specific widget for this preference. It should similarly contain title and summary.

It is an error to change the layout after adding the preference to a PreferenceGroup.

public void setOnPreferenceChangeListener(
    @Nullable 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).

public void setOnPreferenceClickListener(
    @Nullable Preference.OnPreferenceClickListener onPreferenceClickListener
)

Sets the callback to be invoked when this preference is clicked.

public void setOrder(int order)

Sets the order of this preference with respect to other preference objects on the same level. If this is not specified, the default behavior is to sort alphabetically. The setOrderingAsAdded can be used to order preference objects based on the order they appear in the XML.

public void setPersistent(boolean persistent)

Sets whether this preference is persistent. When persistent, it stores its value(s) into the persistent SharedPreferences storage by default or into PreferenceDataStore if assigned.

public void setPreferenceDataStore(@Nullable PreferenceDataStore dataStore)

Sets a PreferenceDataStore to be used by this preference instead of using SharedPreferences.

The data store will remain assigned even if the preference is moved around the preference hierarchy. It will also override a data store propagated from the PreferenceManager that owns this preference.

public void setSelectable(boolean selectable)

Sets whether this preference is selectable.

public void setShouldDisableView(boolean shouldDisableView)

Sets whether this preference should disable its view when it gets disabled.

For example, set this and setEnabled to false for preferences that are only displaying information and 1) should not be clickable 2) should not have the view set to the disabled state.

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

public void setSummary(@Nullable CharSequence summary)

Sets the summary for this preference with a CharSequence.

You can also use a SummaryProvider to dynamically configure the summary of this preference.

public void setSummary(int summaryResId)

Sets the summary for this preference with a resource ID.

You can also use a SummaryProvider to dynamically configure the summary of this preference.

public final void setSummaryProvider(@Nullable Preference.SummaryProvider summaryProvider)

Set a SummaryProvider that will be invoked whenever the summary of this preference is requested. Set null to remove the existing SummaryProvider.

public void setTitle(@Nullable CharSequence title)

Sets the title for this preference with a CharSequence. This title will be placed into the ID title within the View bound by onBindViewHolder.

public void setTitle(int titleResId)

Sets the title for this preference with a resource ID.

public void setViewId(int viewId)

Set the ID that will be assigned to the overall View representing this preference, once bound.

public final void setVisible(boolean visible)

Sets whether this preference should be visible to the user. If false, it is excluded from the adapter, but can still be retrieved using findPreference.

To show this preference to the user, its ancestors must also all be visible. If you make a PreferenceGroup invisible, none of its children will be shown to the user until the group is visible.

public void setWidgetLayoutResource(int widgetLayoutResId)

Sets the layout for the controllable widget portion of this preference. This is inflated into the main layout. For example, a CheckBoxPreference would specify a custom layout (consisting of just the CheckBox) here, instead of creating its own main layout.

It is an error to change the layout after adding the preference to a PreferenceGroup.

public boolean shouldDisableDependents()

Checks whether this preference's dependents should currently be disabled.

protected @Nullable T <T extends Preference> findPreferenceInHierarchy(@NonNull String key)

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.

protected boolean getPersistedBoolean(boolean defaultReturnValue)

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

protected float getPersistedFloat(float defaultReturnValue)

Attempts to get a persisted Float if this preference is persistent.

protected int getPersistedInt(int defaultReturnValue)

Attempts to get a persisted Integer if this preference is persistent.

protected long getPersistedLong(long defaultReturnValue)

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

protected String getPersistedString(String defaultReturnValue)

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

protected void notifyChanged()

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

protected void notifyHierarchyChanged()

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

protected void onAttachedToHierarchy(@NonNull PreferenceManager preferenceManager)

Called when this preference has been attached to a preference hierarchy. Make sure to call the super implementation.

protected void onClick()

Processes a click on the preference. This includes saving the value to the SharedPreferences. However, the overridden method should call callChangeListener to make sure the client wants to update the preference's state with the new value.

protected @Nullable Object onGetDefaultValue(@NonNull TypedArray a, int index)

Called when a preference is being inflated and the default value attribute needs to be read. Since different preference types have different value types, the subclass should get and return the default value which will be its value type.

For example, if the value type is String, the body of the method would proxy to getString.

protected void onPrepareForRemoval()

Called when this preference is being removed from the hierarchy. You should remove any references to this preference that you know about. Make sure to call through to the superclass implementation.

protected void onRestoreInstanceState(@Nullable 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.

protected @Nullable 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.

protected void onSetInitialValue(@Nullable Object defaultValue)

Implement this to set the initial value of the preference.

If you are persisting values to SharedPreferences or a PreferenceDataStore you should restore the saved value for the preference.

If you are not persisting values, or there is no value saved for the preference, you should set the value of the preference to defaultValue.

protected void onSetInitialValue(boolean restorePersistedValue, Object defaultValue)

Implement this to set the initial value of the preference.

If restorePersistedValue is true, you should restore the preference value from the SharedPreferences. If restorePersistedValue is false, you should set the preference value to defaultValue that is given (and possibly store to SharedPreferences if shouldPersist is true).

In case of using PreferenceDataStore, the restorePersistedValue is always true but the default value (if provided) is set.

This may not always be called. One example is if it should not persist but there is no default value given.

protected boolean persistBoolean(boolean value)

Attempts to persist a Boolean if this preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

protected boolean persistFloat(float value)

Attempts to persist a Float if this preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

protected boolean persistInt(int value)

Attempts to persist an Integer if this preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

protected boolean persistLong(long value)

Attempts to persist a Long if this preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

protected boolean persistString(String value)

Attempts to persist a String if this preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

protected 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. This, at minimum, checks whether this preference is persistent and it currently has a key. Before you save/restore from the storage, check this first.