PreferenceManager
open class PreferenceManager
kotlin.Any | |
↳ | androidx.preference.PreferenceManager |
Used to help create Preference
hierarchies from activities or XML.
In most cases, clients should use PreferenceFragmentCompat#addPreferencesFromResource(int)
.
Summary
Nested classes |
|
---|---|
abstract |
Interface definition for a class that will be called when a |
abstract |
Interface definition for a class that will be called when a |
abstract |
Interface definition for a callback to be invoked when a |
abstract |
Callback class to be used by the |
open |
A basic implementation of |
Constants |
|
---|---|
static String |
Public methods |
|
---|---|
open PreferenceScreen! |
createPreferenceScreen(context: Context!) |
open T? |
findPreference(@NonNull key: CharSequence) Finds a |
open Context! |
Returns the context. |
open static SharedPreferences! |
Gets a |
open PreferenceManager.OnDisplayPreferenceDialogListener! | |
open PreferenceManager.OnNavigateToScreenListener! |
Returns the |
open PreferenceManager.OnPreferenceTreeClickListener! | |
open PreferenceManager.PreferenceComparisonCallback! | |
open PreferenceDataStore? |
Returns the |
open PreferenceScreen! |
Returns the root of the preference hierarchy managed by this class. |
open SharedPreferences! |
Gets a |
open Int |
Returns the current mode of the |
open String! |
Returns the current name of the |
open Boolean |
Indicates if the storage location used internally by this class is the default provided by the hosting |
open Boolean |
Indicates if the storage location used internally by this class is backed by device-protected storage. |
open static Unit |
setDefaultValues(context: Context!, resId: Int, readAgain: Boolean) Sets the default values from an XML preference file by reading the values defined by each |
open static Unit |
Similar to |
open Unit |
setOnDisplayPreferenceDialogListener(onDisplayPreferenceDialogListener: PreferenceManager.OnDisplayPreferenceDialogListener!) |
open Unit |
Sets the callback to be invoked when a |
open Unit |
Sets the callback to be invoked when a |
open Unit |
setPreferenceComparisonCallback(preferenceComparisonCallback: PreferenceManager.PreferenceComparisonCallback!) |
open Unit |
setPreferenceDataStore(dataStore: PreferenceDataStore!) Sets a |
open Boolean |
setPreferences(preferenceScreen: PreferenceScreen!) Sets the root of the preference hierarchy. |
open Unit |
Sets the mode of the |
open Unit |
Sets the name of the |
open Unit |
Sets the storage location used internally by this class to be the default provided by the hosting |
open Unit |
Explicitly set the storage location used internally by this class to be device-protected storage. |
open Unit |
showDialog(preference: Preference!) Called when a preference requests that a dialog be shown to complete a user interaction. |
Constants
KEY_HAS_SET_DEFAULT_VALUES
static val KEY_HAS_SET_DEFAULT_VALUES: String
Value: "_has_set_default_values"
Public methods
createPreferenceScreen
open fun createPreferenceScreen(context: Context!): PreferenceScreen!
findPreference
@Nullable open fun <T : Preference!> findPreference(@NonNull key: CharSequence): T?
Finds a Preference
with the given key. Returns null
if no Preference
could be found with the given key.
Parameters | |
---|---|
key |
CharSequence: The key of the Preference to retrieve |
Return | |
---|---|
T?: The Preference with the key, or null |
getDefaultSharedPreferences
open static fun getDefaultSharedPreferences(: Context!): SharedPreferences!
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 |
Return | |
---|---|
SharedPreferences!: A SharedPreferences instance that can be used to retrieve and listen to values of the preferences |
getOnDisplayPreferenceDialogListener
open fun getOnDisplayPreferenceDialogListener(): PreferenceManager.OnDisplayPreferenceDialogListener!
getOnNavigateToScreenListener
open fun getOnNavigateToScreenListener(): PreferenceManager.OnNavigateToScreenListener!
Returns the PreferenceManager.OnNavigateToScreenListener
, if one has been set.
getOnPreferenceTreeClickListener
open fun getOnPreferenceTreeClickListener(): PreferenceManager.OnPreferenceTreeClickListener!
getPreferenceComparisonCallback
open fun getPreferenceComparisonCallback(): PreferenceManager.PreferenceComparisonCallback!
getPreferenceDataStore
@Nullable open fun getPreferenceDataStore(): PreferenceDataStore?
Returns the PreferenceDataStore
associated with this manager or null
if the default SharedPreferences
are used instead.
Return | |
---|---|
PreferenceDataStore?: The PreferenceDataStore associated with this manager or null if none |
getPreferenceScreen
open fun getPreferenceScreen(): PreferenceScreen!
Returns the root of the preference hierarchy managed by this class.
Return | |
---|---|
PreferenceScreen!: The PreferenceScreen object that is at the root of the hierarchy |
getSharedPreferences
open fun getSharedPreferences(): SharedPreferences!
Gets a SharedPreferences
instance that preferences managed by this will use.
Return | |
---|---|
SharedPreferences!: A SharedPreferences instance pointing to the file that contain the values of preferences that are managed by this PreferenceManager. If a PreferenceDataStore has been set, this method returns null . |
getSharedPreferencesMode
open fun getSharedPreferencesMode(): Int
Returns the current mode of the SharedPreferences
file that preferences managed by this will use.
Return | |
---|---|
Int: The mode that can be passed to Context#getSharedPreferences(String, int) |
getSharedPreferencesName
open fun getSharedPreferencesName(): String!
Returns the current name of the SharedPreferences
file that preferences managed by this will use.
Return | |
---|---|
String!: The name that can be passed to Context#getSharedPreferences(String, int) |
isStorageDefault
open fun isStorageDefault(): Boolean
Indicates if the storage location used internally by this class is the default provided by the hosting Context
.
isStorageDeviceProtected
open fun isStorageDeviceProtected(): Boolean
Indicates if the storage location used internally by this class is backed by device-protected storage.
setDefaultValues
open static fun setDefaultValues(context: Context!, resId: Int, readAgain: Boolean): Unit
Sets the default values from an XML preference file by reading the values defined by each 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 |
Context!: The resource ID of the preference XML file |
readAgain |
Context!: 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 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 |
setDefaultValues
open static fun setDefaultValues(context: Context!, : String!, : Int, resId: Int, readAgain: Boolean): Unit
Similar to setDefaultValues(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 |
Context!: A custom name for the shared preferences file |
sharedPreferencesMode |
Context!: The file creation mode for the shared preferences file, such as Context#MODE_PRIVATE or Context#MODE_PRIVATE . |
resId |
Context!: The resource ID of the preference XML file |
readAgain |
Context!: 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 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 |
setOnDisplayPreferenceDialogListener
open fun setOnDisplayPreferenceDialogListener(onDisplayPreferenceDialogListener: PreferenceManager.OnDisplayPreferenceDialogListener!): Unit
setOnNavigateToScreenListener
open fun setOnNavigateToScreenListener(: PreferenceManager.OnNavigateToScreenListener!): Unit
Sets the callback to be invoked when a PreferenceScreen
in the hierarchy rooted at this PreferenceManager
is clicked.
Parameters | |
---|---|
listener |
PreferenceManager.OnNavigateToScreenListener!: The callback to be invoked |
setOnPreferenceTreeClickListener
open fun setOnPreferenceTreeClickListener(listener: PreferenceManager.OnPreferenceTreeClickListener!): Unit
Sets the callback to be invoked when a Preference
in the hierarchy rooted at this PreferenceManager
is clicked.
Parameters | |
---|---|
listener |
PreferenceManager.OnPreferenceTreeClickListener!: The callback to be invoked |
setPreferenceComparisonCallback
open fun setPreferenceComparisonCallback(preferenceComparisonCallback: PreferenceManager.PreferenceComparisonCallback!): Unit
setPreferenceDataStore
open fun setPreferenceDataStore(dataStore: PreferenceDataStore!): Unit
Sets a PreferenceDataStore
to be used by all preferences associated with this manager that don't have a custom PreferenceDataStore
assigned via Preference#setPreferenceDataStore(PreferenceDataStore)
. Also if the data store is set, the child preferences won't use SharedPreferences
as long as they are assigned to this manager.
Parameters | |
---|---|
dataStore |
PreferenceDataStore!: The PreferenceDataStore to be used by this manager |
setPreferences
open fun setPreferences(preferenceScreen: PreferenceScreen!): Boolean
Sets the root of the preference hierarchy.
Parameters | |
---|---|
preferenceScreen |
PreferenceScreen!: The root PreferenceScreen of the preference hierarchy |
Return | |
---|---|
Boolean: Whether the PreferenceScreen given is different than the previous |
setSharedPreferencesMode
open fun setSharedPreferencesMode(: Int): Unit
Sets the mode of the SharedPreferences
file that preferences managed by this will use.
Parameters | |
---|---|
sharedPreferencesMode |
Int: The mode of the SharedPreferences file |
setSharedPreferencesName
open fun setSharedPreferencesName(: String!): Unit
Sets the name of the SharedPreferences
file that preferences managed by this will use.
If custom PreferenceDataStore
is set, this won't override its usage.
Parameters | |
---|---|
sharedPreferencesName |
String!: The name of the SharedPreferences file |
setStorageDefault
open fun setStorageDefault(): Unit
Sets the storage location used internally by this class to be the default provided by the hosting Context
.
setStorageDeviceProtected
open fun setStorageDeviceProtected(): Unit
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.
showDialog
open fun showDialog(preference: Preference!): Unit
Called when a preference requests that a dialog be shown to complete a user interaction.
Parameters | |
---|---|
preference |
Preference!: The preference requesting the dialog |