# PreferenceManager added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1 Summary:[Nested Classes](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#nestedclasses)\|[Constants](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#constants)\|[Methods](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#) # PreferenceManager | This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings). ` public class PreferenceManager ` ` extends Object `` ` |---|-------------------------------------------------| | java.lang.Object || | ↳ | android.support.v7.preference.PreferenceManager |
*** ** * ** *** Used to help create[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)hierarchies from activities or XML. In most cases, clients should use[addPreferencesFromResource(int)](https://developer.android.com/reference/android/support/v14/preference/PreferenceFragment#addPreferencesFromResource(int)), or[addPreferencesFromResource(int)](https://developer.android.com/reference/android/support/v7/preference/PreferenceFragmentCompat#addPreferencesFromResource(int)). **See also:** - [PreferenceFragment](https://developer.android.com/reference/android/support/v14/preference/PreferenceFragment) - [PreferenceFragmentCompat](https://developer.android.com/reference/android/support/v7/preference/PreferenceFragmentCompat) ## Summary | ### Nested classes || |--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` interface` | [PreferenceManager.OnDisplayPreferenceDialogListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnDisplayPreferenceDialogListener) Interface definition for a class that will be called when a[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)requests to display a dialog. | | ` interface` | [PreferenceManager.OnNavigateToScreenListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnNavigateToScreenListener) Interface definition for a class that will be called when a[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen)requests navigation. | | ` interface` | [PreferenceManager.OnPreferenceTreeClickListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnPreferenceTreeClickListener) Interface definition for a callback to be invoked when a[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)in the hierarchy rooted at this[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen)is clicked. | | ` class` | [PreferenceManager.PreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.PreferenceComparisonCallback) Callback class to be used by the[RecyclerView.Adapter](https://developer.android.com/reference/android/support/v7/widget/RecyclerView.Adapter)associated with the[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen), used to determine when two[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)objects are semantically and visually the same. | | ` class` | [PreferenceManager.SimplePreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.SimplePreferenceComparisonCallback) A basic implementation of[PreferenceManager.PreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.PreferenceComparisonCallback)suitable for use with the default[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)classes. | | ### Constants || |----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | `String` | [KEY_HAS_SET_DEFAULT_VALUES](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#KEY_HAS_SET_DEFAULT_VALUES)
| | ### Public methods || |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen) | ` `[createPreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#createPreferenceScreen(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context) ` | | ` `[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference) | ` `[findPreference](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#findPreference(java.lang.CharSequence))`(CharSequence key) ` Finds a[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)based on its key. | | ` `[Context](https://developer.android.com/reference/android/content/Context.html) | ` `[getContext](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getContext())`() ` Returns the context. | | ` static `[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html) | ` `[getDefaultSharedPreferences](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getDefaultSharedPreferences(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context) ` Gets a SharedPreferences instance that points to the default file that is used by the preference framework in the given context. | | ` `[PreferenceManager.OnDisplayPreferenceDialogListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnDisplayPreferenceDialogListener) | ` `[getOnDisplayPreferenceDialogListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getOnDisplayPreferenceDialogListener())`() ` | | ` `[PreferenceManager.OnNavigateToScreenListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnNavigateToScreenListener) | ` `[getOnNavigateToScreenListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getOnNavigateToScreenListener())`() ` Returns the[PreferenceManager.OnNavigateToScreenListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnNavigateToScreenListener), if one has been set. | | ` `[PreferenceManager.OnPreferenceTreeClickListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnPreferenceTreeClickListener) | ` `[getOnPreferenceTreeClickListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getOnPreferenceTreeClickListener())`() ` | | ` `[PreferenceManager.PreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.PreferenceComparisonCallback) | ` `[getPreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getPreferenceComparisonCallback())`() ` | | ` `[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore) | ` `[getPreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getPreferenceDataStore())`() ` Returns the[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)associated with this manager or`null`if the default[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)are used instead. | | ` `[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen) | ` `[getPreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getPreferenceScreen())`() ` Returns the root of the preference hierarchy managed by this class. | | ` `[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html) | ` `[getSharedPreferences](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getSharedPreferences())`() ` Gets a[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)instance that preferences managed by this will use. | | ` int` | ` `[getSharedPreferencesMode](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getSharedPreferencesMode())`() ` Returns the current mode of the SharedPreferences file that preferences managed by this will use. | | ` String` | ` `[getSharedPreferencesName](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getSharedPreferencesName())`() ` Returns the current name of the[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)file that preferences managed by this will use. | | ` boolean` | ` `[isStorageDefault](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#isStorageDefault())`() ` Indicates if the storage location used internally by this class is the default provided by the hosting[Context](https://developer.android.com/reference/android/content/Context.html). | | ` boolean` | ` `[isStorageDeviceProtected](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#isStorageDeviceProtected())`() ` Indicates if the storage location used internally by this class is backed by device-protected storage. | | ` static void` | ` `[setDefaultValues](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setDefaultValues(android.content.Context, java.lang.String, int, int, boolean))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain) ` Similar to[setDefaultValues(Context, int, boolean)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setDefaultValues(android.content.Context, int, boolean))but allows the client to provide the filename and mode of the shared preferences file. | | ` static void` | ` `[setDefaultValues](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setDefaultValues(android.content.Context, int, boolean))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context, int resId, boolean readAgain) ` Sets the default values from an XML preference file by reading the values defined by each[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)item's`android:defaultValue`attribute. | | ` void` | ` `[setOnDisplayPreferenceDialogListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setOnDisplayPreferenceDialogListener(android.support.v7.preference.PreferenceManager.OnDisplayPreferenceDialogListener))`(`[PreferenceManager.OnDisplayPreferenceDialogListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnDisplayPreferenceDialogListener)` onDisplayPreferenceDialogListener) ` | | ` void` | ` `[setOnNavigateToScreenListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setOnNavigateToScreenListener(android.support.v7.preference.PreferenceManager.OnNavigateToScreenListener))`(`[PreferenceManager.OnNavigateToScreenListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnNavigateToScreenListener)` listener) ` Sets the callback to be invoked when a[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen)in the hierarchy rooted at this[PreferenceManager](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager)is clicked. | | ` void` | ` `[setOnPreferenceTreeClickListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setOnPreferenceTreeClickListener(android.support.v7.preference.PreferenceManager.OnPreferenceTreeClickListener))`(`[PreferenceManager.OnPreferenceTreeClickListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnPreferenceTreeClickListener)` listener) ` Sets the callback to be invoked when a[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)in the hierarchy rooted at this[PreferenceManager](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager)is clicked. | | ` void` | ` `[setPreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setPreferenceComparisonCallback(android.support.v7.preference.PreferenceManager.PreferenceComparisonCallback))`(`[PreferenceManager.PreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.PreferenceComparisonCallback)` preferenceComparisonCallback) ` | | ` void` | ` `[setPreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setPreferenceDataStore(android.support.v7.preference.PreferenceDataStore))`(`[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)` dataStore) ` Sets a[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)to be used by all Preferences associated with this manager that don't have a custom[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)assigned via[setPreferenceDataStore(PreferenceDataStore)](https://developer.android.com/reference/android/support/v7/preference/Preference#setPreferenceDataStore(android.support.v7.preference.PreferenceDataStore)). | | ` boolean` | ` `[setPreferences](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setPreferences(android.support.v7.preference.PreferenceScreen))`(`[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen)` preferenceScreen) ` Sets the root of the preference hierarchy. | | ` void` | ` `[setSharedPreferencesMode](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setSharedPreferencesMode(int))`(int sharedPreferencesMode) ` Sets the mode of the SharedPreferences file that preferences managed by this will use. | | ` void` | ` `[setSharedPreferencesName](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setSharedPreferencesName(java.lang.String))`(String sharedPreferencesName) ` Sets the name of the[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)file that preferences managed by this will use. | | ` void` | ` `[setStorageDefault](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setStorageDefault())`() ` Sets the storage location used internally by this class to be the default provided by the hosting[Context](https://developer.android.com/reference/android/content/Context.html). | | ` void` | ` `[setStorageDeviceProtected](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setStorageDeviceProtected())`() ` Explicitly set the storage location used internally by this class to be device-protected storage. | | ` void` | ` `[showDialog](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#showDialog(android.support.v7.preference.Preference))`(`[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)` preference) ` Called when a preference requests that a dialog be shown to complete a user interaction. | | ### Inherited methods | |-----------------------|---| | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#)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() ` | || ## Constants ### KEY_HAS_SET_DEFAULT_VALUES added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` String KEY_HAS_SET_DEFAULT_VALUES ```

Constant Value: "_has_set_default_values" ## Public methods ### createPreferenceScreen added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` PreferenceScreen createPreferenceScreen (Context context) ```

| Parameters || |-----------|------------------| | `context` | `Context`
| | Returns || |------------------------------------------------------------------------------------------------------------|--------| | [PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen) |
| ### findPreference added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` Preference findPreference (CharSequence key) ``` Finds a[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)based on its key.
| Parameters || |-------|---------------------------------------------------------------| | `key` | `CharSequence`: The key of the preference to retrieve.
| | Returns || |------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| | [Preference](https://developer.android.com/reference/android/support/v7/preference/Preference) | The[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)with the key, or null.
| **See also:** - [findPreference(CharSequence)](https://developer.android.com/reference/android/support/v7/preference/PreferenceGroup#findPreference(java.lang.CharSequence)) ### getContext added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` Context getContext () ``` Returns the context.
| Returns || |---------------------------------------------------------------------------------|---------------------| | [Context](https://developer.android.com/reference/android/content/Context.html) | The context.
| ### getDefaultSharedPreferences added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` SharedPreferences getDefaultSharedPreferences (Context context) ``` Gets a SharedPreferences instance that points to the default file that is used by the preference framework in the given context.
| Parameters || |-----------|---------------------------------------------------------------------------| | `context` | `Context`: The context of the preferences whose values are wanted.
| | Returns || |-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| | [SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html) | A SharedPreferences instance that can be used to retrieve and listen to values of the preferences.
| ### getOnDisplayPreferenceDialogListener added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` PreferenceManager.OnDisplayPreferenceDialogListener getOnDisplayPreferenceDialogListener () ```

| Returns || |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| | [PreferenceManager.OnDisplayPreferenceDialogListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnDisplayPreferenceDialogListener) |
| ### getOnNavigateToScreenListener added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` PreferenceManager.OnNavigateToScreenListener getOnNavigateToScreenListener () ``` Returns the[PreferenceManager.OnNavigateToScreenListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnNavigateToScreenListener), if one has been set.
| Returns || |--------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| | [PreferenceManager.OnNavigateToScreenListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnNavigateToScreenListener) |
| ### getOnPreferenceTreeClickListener added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` PreferenceManager.OnPreferenceTreeClickListener getOnPreferenceTreeClickListener () ```

| Returns || |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| | [PreferenceManager.OnPreferenceTreeClickListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnPreferenceTreeClickListener) |
| ### getPreferenceComparisonCallback added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` PreferenceManager.PreferenceComparisonCallback getPreferenceComparisonCallback () ```

| Returns || |------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| | [PreferenceManager.PreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.PreferenceComparisonCallback) |
| ### getPreferenceDataStore added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` PreferenceDataStore getPreferenceDataStore () ``` Returns the[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)associated with this manager or`null`if the default[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)are used instead.
| Returns || |------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore) | The[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)associated with this manager or`null`if none.
| **See also:** - [setPreferenceDataStore(PreferenceDataStore)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setPreferenceDataStore(android.support.v7.preference.PreferenceDataStore)) ### getPreferenceScreen added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` PreferenceScreen getPreferenceScreen () ``` Returns the root of the preference hierarchy managed by this class.
| Returns || |------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen) | The[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen)object that is at the root of the hierarchy.
| ### getSharedPreferences added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` SharedPreferences getSharedPreferences () ``` Gets a[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)instance that preferences managed by this will use.
| Returns || |-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html) | a[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)instance pointing to the file that contain the values of preferences that are managed by this PreferenceManager. If a[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)has been set, this method returns`null`.
| ### getSharedPreferencesMode added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` int getSharedPreferencesMode () ``` Returns the current mode of the SharedPreferences file that preferences managed by this will use.
| Returns || |-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | The mode that can be passed to[getSharedPreferences(String, int)](https://developer.android.com/reference/android/content/Context.html#getSharedPreferences(java.lang.String, int)).
| **See also:** - [getSharedPreferences(String, int)](https://developer.android.com/https://developer.android.com/reference/android/content/Context#getSharedPreferences(java.lang.String, int)) ### getSharedPreferencesName added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` String getSharedPreferencesName () ``` Returns the current name of the[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)file that preferences managed by this will use.
| Returns || |----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `String` | The name that can be passed to[getSharedPreferences(String, int)](https://developer.android.com/reference/android/content/Context.html#getSharedPreferences(java.lang.String, int)).
| **See also:** - [getSharedPreferences(String, int)](https://developer.android.com/https://developer.android.com/reference/android/content/Context#getSharedPreferences(java.lang.String, int)) ### isStorageDefault added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean isStorageDefault () ``` Indicates if the storage location used internally by this class is the default provided by the hosting[Context](https://developer.android.com/reference/android/content/Context.html).
| Returns || |-----------|--------| | `boolean` |
| **See also:** - [setStorageDefault()](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setStorageDefault()) - [setStorageDeviceProtected()](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setStorageDeviceProtected()) ### isStorageDeviceProtected added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean isStorageDeviceProtected () ``` Indicates if the storage location used internally by this class is backed by device-protected storage.
| Returns || |-----------|--------| | `boolean` |
| **See also:** - [setStorageDefault()](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setStorageDefault()) - [setStorageDeviceProtected()](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setStorageDeviceProtected()) ### setDefaultValues added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setDefaultValues (Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain) ``` Similar to[setDefaultValues(Context, int, boolean)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setDefaultValues(android.content.Context, int, boolean))but allows the client to provide the filename and mode of the shared preferences file.
| Parameters || |-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `context` | `Context`: The context of the shared preferences.
| | `sharedPreferencesName` | `String`: A custom name for the shared preferences file.
| | `sharedPreferencesMode` | `int`: The file creation mode for the shared preferences file, such as[MODE_PRIVATE](https://developer.android.com/reference/android/content/Context.html#MODE_PRIVATE)or[MODE_PRIVATE](https://developer.android.com/reference/android/content/Context.html#MODE_PRIVATE)
| | `resId` | `int`: The resource ID of the preference XML file.
| | `readAgain` | `boolean`: Whether to re-read the default values. If false, this method will set the default values only if this method has never been called in the past (or if the[KEY_HAS_SET_DEFAULT_VALUES](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#KEY_HAS_SET_DEFAULT_VALUES)in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set`readAgain`to true. Note: this will NOT reset preferences back to their default values. For that functionality, use[getDefaultSharedPreferences(Context)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getDefaultSharedPreferences(android.content.Context))and clear it followed by a call to this method with this parameter set to true. | **See also:** - [setDefaultValues(Context, int, boolean)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setDefaultValues(android.content.Context, int, boolean)) - [setSharedPreferencesName(String)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setSharedPreferencesName(java.lang.String)) - [setSharedPreferencesMode(int)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setSharedPreferencesMode(int)) ### setDefaultValues added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setDefaultValues (Context context, int resId, boolean readAgain) ``` Sets the default values from an XML preference file by reading the values defined by each[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)item's`android:defaultValue`attribute. This should be called by the application's main activity.

| Parameters || |-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `context` | `Context`: The context of the shared preferences.
| | `resId` | `int`: The resource ID of the preference XML file.
| | `readAgain` | `boolean`: Whether to re-read the default values. If false, this method sets the default values only if this method has never been called in the past (or if the[KEY_HAS_SET_DEFAULT_VALUES](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#KEY_HAS_SET_DEFAULT_VALUES)in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set`readAgain`to true. Note: this will NOT reset preferences back to their default values. For that functionality, use[getDefaultSharedPreferences(Context)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#getDefaultSharedPreferences(android.content.Context))and clear it followed by a call to this method with this parameter set to true. | ### setOnDisplayPreferenceDialogListener added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setOnDisplayPreferenceDialogListener (PreferenceManager.OnDisplayPreferenceDialogListener onDisplayPreferenceDialogListener) ```

| Parameters || |-------------------------------------|--------------------------------------------------------------| | `onDisplayPreferenceDialogListener` | `PreferenceManager.OnDisplayPreferenceDialogListener`
| ### setOnNavigateToScreenListener added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setOnNavigateToScreenListener (PreferenceManager.OnNavigateToScreenListener listener) ``` Sets the callback to be invoked when a[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen)in the hierarchy rooted at this[PreferenceManager](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager)is clicked.
| Parameters || |------------|------------------------------------------------------------------------------------| | `listener` | `PreferenceManager.OnNavigateToScreenListener`: The callback to be invoked.
| ### setOnPreferenceTreeClickListener added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setOnPreferenceTreeClickListener (PreferenceManager.OnPreferenceTreeClickListener listener) ``` Sets the callback to be invoked when a[Preference](https://developer.android.com/reference/android/support/v7/preference/Preference)in the hierarchy rooted at this[PreferenceManager](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager)is clicked.
| Parameters || |------------|---------------------------------------------------------------------------------------| | `listener` | `PreferenceManager.OnPreferenceTreeClickListener`: The callback to be invoked.
| ### setPreferenceComparisonCallback added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setPreferenceComparisonCallback (PreferenceManager.PreferenceComparisonCallback preferenceComparisonCallback) ```

| Parameters || |--------------------------------|---------------------------------------------------------| | `preferenceComparisonCallback` | `PreferenceManager.PreferenceComparisonCallback`
| ### setPreferenceDataStore added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setPreferenceDataStore (PreferenceDataStore dataStore) ``` Sets a[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)to be used by all Preferences associated with this manager that don't have a custom[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)assigned via[setPreferenceDataStore(PreferenceDataStore)](https://developer.android.com/reference/android/support/v7/preference/Preference#setPreferenceDataStore(android.support.v7.preference.PreferenceDataStore)). Also if the data store is set, the child preferences won't use[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)as long as they are assigned to this manager.
| Parameters || |-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `dataStore` | `PreferenceDataStore`: the[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)to be used by this manager
| **See also:** - [setPreferenceDataStore(PreferenceDataStore)](https://developer.android.com/reference/android/support/v7/preference/Preference#setPreferenceDataStore(android.support.v7.preference.PreferenceDataStore)) ### setPreferences added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean setPreferences (PreferenceScreen preferenceScreen) ``` Sets the root of the preference hierarchy.
| Parameters || |--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `preferenceScreen` | `PreferenceScreen`: The root[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen)of the preference hierarchy.
| | Returns || |-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `boolean` | Whether the[PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen)given is different than the previous.
| ### setSharedPreferencesMode added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setSharedPreferencesMode (int sharedPreferencesMode) ``` Sets the mode of the SharedPreferences file that preferences managed by this will use.
| Parameters || |-------------------------|-------------------------------------------------------| | `sharedPreferencesMode` | `int`: The mode of the SharedPreferences file.
| **See also:** - [getSharedPreferences(String, int)](https://developer.android.com/https://developer.android.com/reference/android/content/Context#getSharedPreferences(java.lang.String, int)) ### setSharedPreferencesName added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setSharedPreferencesName (String sharedPreferencesName) ``` Sets the name of the[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html)file that preferences managed by this will use. If custom[PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore)is set, this won't override its usage.
| Parameters || |-------------------------|----------------------------------------------------------| | `sharedPreferencesName` | `String`: The name of the SharedPreferences file.
| **See also:** - [getSharedPreferences(String, int)](https://developer.android.com/https://developer.android.com/reference/android/content/Context#getSharedPreferences(java.lang.String, int)) - [setPreferenceDataStore(PreferenceDataStore)](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager#setPreferenceDataStore(android.support.v7.preference.PreferenceDataStore)) ### setStorageDefault added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setStorageDefault () ``` Sets the storage location used internally by this class to be the default provided by the hosting[Context](https://developer.android.com/reference/android/content/Context.html).
### setStorageDeviceProtected added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setStorageDeviceProtected () ``` Explicitly set the storage location used internally by this class to be device-protected storage. On devices with direct boot, data stored in this location is encrypted with a key tied to the physical device, and it can be accessed immediately after the device has booted successfully, both*before and after*the user has authenticated with their credentials (such as a lock pattern or PIN). Because device-protected data is available without user authentication, you should carefully limit the data you store using this Context. For example, storing sensitive authentication tokens or passwords in the device-protected area is strongly discouraged. Prior to API 24 this method has no effect, since device-protected storage is not available.
**See also:** - [createDeviceProtectedStorageContext()](https://developer.android.com/https://developer.android.com/reference/android/content/Context#createDeviceProtectedStorageContext()) ### showDialog added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void showDialog (Preference preference) ``` Called when a preference requests that a dialog be shown to complete a user interaction.
| Parameters || |--------------|------------------------------------------------------------| | `preference` | `Preference`: The preference requesting the dialog.
| - ## Interfaces - [DialogPreference.TargetFragment](https://developer.android.com/reference/android/support/v7/preference/DialogPreference.TargetFragment) - [Preference.OnPreferenceChangeListener](https://developer.android.com/reference/android/support/v7/preference/Preference.OnPreferenceChangeListener) - [Preference.OnPreferenceClickListener](https://developer.android.com/reference/android/support/v7/preference/Preference.OnPreferenceClickListener) - [PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback) - [PreferenceFragmentCompat.OnPreferenceStartFragmentCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceFragmentCompat.OnPreferenceStartFragmentCallback) - [PreferenceFragmentCompat.OnPreferenceStartScreenCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceFragmentCompat.OnPreferenceStartScreenCallback) - [PreferenceGroup.PreferencePositionCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceGroup.PreferencePositionCallback) - [PreferenceManager.OnDisplayPreferenceDialogListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnDisplayPreferenceDialogListener) - [PreferenceManager.OnNavigateToScreenListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnNavigateToScreenListener) - [PreferenceManager.OnPreferenceTreeClickListener](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.OnPreferenceTreeClickListener) - ## Classes - [CheckBoxPreference](https://developer.android.com/reference/android/support/v7/preference/CheckBoxPreference) - [DialogPreference](https://developer.android.com/reference/android/support/v7/preference/DialogPreference) - [DropDownPreference](https://developer.android.com/reference/android/support/v7/preference/DropDownPreference) - [EditTextPreference](https://developer.android.com/reference/android/support/v7/preference/EditTextPreference) - [EditTextPreferenceDialogFragmentCompat](https://developer.android.com/reference/android/support/v7/preference/EditTextPreferenceDialogFragmentCompat) - [ListPreference](https://developer.android.com/reference/android/support/v7/preference/ListPreference) - [ListPreferenceDialogFragmentCompat](https://developer.android.com/reference/android/support/v7/preference/ListPreferenceDialogFragmentCompat) - [MultiSelectListPreferenceDialogFragmentCompat](https://developer.android.com/reference/android/support/v7/preference/MultiSelectListPreferenceDialogFragmentCompat) - [Preference](https://developer.android.com/reference/android/support/v7/preference/Preference) - [Preference.BaseSavedState](https://developer.android.com/reference/android/support/v7/preference/Preference.BaseSavedState) - [PreferenceCategory](https://developer.android.com/reference/android/support/v7/preference/PreferenceCategory) - [PreferenceDataStore](https://developer.android.com/reference/android/support/v7/preference/PreferenceDataStore) - [PreferenceDialogFragmentCompat](https://developer.android.com/reference/android/support/v7/preference/PreferenceDialogFragmentCompat) - [PreferenceFragmentCompat](https://developer.android.com/reference/android/support/v7/preference/PreferenceFragmentCompat) - [PreferenceGroup](https://developer.android.com/reference/android/support/v7/preference/PreferenceGroup) - [PreferenceManager](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager) - [PreferenceManager.PreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.PreferenceComparisonCallback) - [PreferenceManager.SimplePreferenceComparisonCallback](https://developer.android.com/reference/android/support/v7/preference/PreferenceManager.SimplePreferenceComparisonCallback) - [PreferenceScreen](https://developer.android.com/reference/android/support/v7/preference/PreferenceScreen) - [PreferenceViewHolder](https://developer.android.com/reference/android/support/v7/preference/PreferenceViewHolder) - [R](https://developer.android.com/reference/android/support/v7/preference/R) - [R.anim](https://developer.android.com/reference/android/support/v7/preference/R.anim) - [R.attr](https://developer.android.com/reference/android/support/v7/preference/R.attr) - [R.bool](https://developer.android.com/reference/android/support/v7/preference/R.bool) - [R.color](https://developer.android.com/reference/android/support/v7/preference/R.color) - [R.dimen](https://developer.android.com/reference/android/support/v7/preference/R.dimen) - [R.drawable](https://developer.android.com/reference/android/support/v7/preference/R.drawable) - [R.id](https://developer.android.com/reference/android/support/v7/preference/R.id) - [R.integer](https://developer.android.com/reference/android/support/v7/preference/R.integer) - [R.layout](https://developer.android.com/reference/android/support/v7/preference/R.layout) - [R.string](https://developer.android.com/reference/android/support/v7/preference/R.string) - [R.style](https://developer.android.com/reference/android/support/v7/preference/R.style) - [R.styleable](https://developer.android.com/reference/android/support/v7/preference/R.styleable) - [SeekBarPreference](https://developer.android.com/reference/android/support/v7/preference/SeekBarPreference) - [SwitchPreferenceCompat](https://developer.android.com/reference/android/support/v7/preference/SwitchPreferenceCompat) - [TwoStatePreference](https://developer.android.com/reference/android/support/v7/preference/TwoStatePreference)