Interface definition for a callback to be invoked when the value of this
Preference has been changed by the user and is
about to be set and/or persisted. This gives the client a chance
to prevent setting and/or persisting the value.
Called when a Preference has been changed by the user. This is
called before the state of the Preference is about to be updated and
before the state is persisted.
Parameters
preference
Preference: The changed Preference.
newValue
Object: The new value of the Preference.
Returns
boolean
True to update the state of the Preference with the new value.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# Preference.OnPreferenceChangeListener\n\nadded in [version 24.1.0](/topic/libraries/support-library/revisions) \nbelongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1 \n\nPreference.OnPreferenceChangeListener\n=====================================\n\n| This package is part of the Android [support library](/topic/libraries/support-library) which is no longer maintained. The support library has been superseded by [AndroidX](/jetpack/androidx) which is part of [Jetpack](/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider [migrating](/jetpack/androidx/migrate) existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library [class\n| mappings](/jetpack/androidx/migrate/class-mappings).\n\n\n`\npublic\nstatic\n\n\ninterface\nPreference.OnPreferenceChangeListener\n`\n\n\n`\n\n\n`\n\n|---------------------------------------------------------------------|\n| android.support.v7.preference.Preference.OnPreferenceChangeListener |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nInterface definition for a callback to be invoked when the value of this\n[Preference](/reference/android/support/v7/preference/Preference) has been changed by the user and is\nabout to be set and/or persisted. This gives the client a chance\nto prevent setting and/or persisting the value.\n\nSummary\n-------\n\n| ### Public methods ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract boolean` | ` `[onPreferenceChange](/reference/android/support/v7/preference/Preference.OnPreferenceChangeListener#onPreferenceChange(android.support.v7.preference.Preference, java.lang.Object))`(`[Preference](/reference/android/support/v7/preference/Preference)` preference, Object newValue) ` Called when a Preference has been changed by the user. |\n\nPublic methods\n--------------\n\n### onPreferenceChange\n\nadded in [version 24.1.0](/topic/libraries/support-library/revisions) \n\n```\nboolean onPreferenceChange (Preference preference, \n Object newValue)\n```\n\nCalled when a Preference has been changed by the user. This is\ncalled before the state of the Preference is about to be updated and\nbefore the state is persisted.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|---------------------------------------------------|\n| `preference` | `Preference`: The changed Preference. \u003cbr /\u003e |\n| `newValue` | `Object`: The new value of the Preference. \u003cbr /\u003e |\n\n| Returns ||\n|-----------|-----------------------------------------------------------------------|\n| `boolean` | True to update the state of the Preference with the new value. \u003cbr /\u003e |\n\n-\n\n Interfaces\n ----------\n\n - [DialogPreference.TargetFragment](/reference/android/support/v7/preference/DialogPreference.TargetFragment)\n - [Preference.OnPreferenceChangeListener](/reference/android/support/v7/preference/Preference.OnPreferenceChangeListener)\n - [Preference.OnPreferenceClickListener](/reference/android/support/v7/preference/Preference.OnPreferenceClickListener)\n - [PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback](/reference/android/support/v7/preference/PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback)\n - [PreferenceFragmentCompat.OnPreferenceStartFragmentCallback](/reference/android/support/v7/preference/PreferenceFragmentCompat.OnPreferenceStartFragmentCallback)\n - [PreferenceFragmentCompat.OnPreferenceStartScreenCallback](/reference/android/support/v7/preference/PreferenceFragmentCompat.OnPreferenceStartScreenCallback)\n - [PreferenceGroup.PreferencePositionCallback](/reference/android/support/v7/preference/PreferenceGroup.PreferencePositionCallback)\n - [PreferenceManager.OnDisplayPreferenceDialogListener](/reference/android/support/v7/preference/PreferenceManager.OnDisplayPreferenceDialogListener)\n - [PreferenceManager.OnNavigateToScreenListener](/reference/android/support/v7/preference/PreferenceManager.OnNavigateToScreenListener)\n - [PreferenceManager.OnPreferenceTreeClickListener](/reference/android/support/v7/preference/PreferenceManager.OnPreferenceTreeClickListener)\n-\n\n Classes\n -------\n\n - [CheckBoxPreference](/reference/android/support/v7/preference/CheckBoxPreference)\n - [DialogPreference](/reference/android/support/v7/preference/DialogPreference)\n - [DropDownPreference](/reference/android/support/v7/preference/DropDownPreference)\n - [EditTextPreference](/reference/android/support/v7/preference/EditTextPreference)\n - [EditTextPreferenceDialogFragmentCompat](/reference/android/support/v7/preference/EditTextPreferenceDialogFragmentCompat)\n - [ListPreference](/reference/android/support/v7/preference/ListPreference)\n - [ListPreferenceDialogFragmentCompat](/reference/android/support/v7/preference/ListPreferenceDialogFragmentCompat)\n - [MultiSelectListPreferenceDialogFragmentCompat](/reference/android/support/v7/preference/MultiSelectListPreferenceDialogFragmentCompat)\n - [Preference](/reference/android/support/v7/preference/Preference)\n - [Preference.BaseSavedState](/reference/android/support/v7/preference/Preference.BaseSavedState)\n - [PreferenceCategory](/reference/android/support/v7/preference/PreferenceCategory)\n - [PreferenceDataStore](/reference/android/support/v7/preference/PreferenceDataStore)\n - [PreferenceDialogFragmentCompat](/reference/android/support/v7/preference/PreferenceDialogFragmentCompat)\n - [PreferenceFragmentCompat](/reference/android/support/v7/preference/PreferenceFragmentCompat)\n - [PreferenceGroup](/reference/android/support/v7/preference/PreferenceGroup)\n - [PreferenceManager](/reference/android/support/v7/preference/PreferenceManager)\n - [PreferenceManager.PreferenceComparisonCallback](/reference/android/support/v7/preference/PreferenceManager.PreferenceComparisonCallback)\n - [PreferenceManager.SimplePreferenceComparisonCallback](/reference/android/support/v7/preference/PreferenceManager.SimplePreferenceComparisonCallback)\n - [PreferenceScreen](/reference/android/support/v7/preference/PreferenceScreen)\n - [PreferenceViewHolder](/reference/android/support/v7/preference/PreferenceViewHolder)\n - [R](/reference/android/support/v7/preference/R)\n - [R.anim](/reference/android/support/v7/preference/R.anim)\n - [R.attr](/reference/android/support/v7/preference/R.attr)\n - [R.bool](/reference/android/support/v7/preference/R.bool)\n - [R.color](/reference/android/support/v7/preference/R.color)\n - [R.dimen](/reference/android/support/v7/preference/R.dimen)\n - [R.drawable](/reference/android/support/v7/preference/R.drawable)\n - [R.id](/reference/android/support/v7/preference/R.id)\n - [R.integer](/reference/android/support/v7/preference/R.integer)\n - [R.layout](/reference/android/support/v7/preference/R.layout)\n - [R.string](/reference/android/support/v7/preference/R.string)\n - [R.style](/reference/android/support/v7/preference/R.style)\n - [R.styleable](/reference/android/support/v7/preference/R.styleable)\n - [SeekBarPreference](/reference/android/support/v7/preference/SeekBarPreference)\n - [SwitchPreferenceCompat](/reference/android/support/v7/preference/SwitchPreferenceCompat)\n - [TwoStatePreference](/reference/android/support/v7/preference/TwoStatePreference)"]]