PreferenceManager
class PreferenceManager
Used to help create Preference hierarchies from activities or XML.
In most cases, clients should use addPreferencesFromResource.
| See also | |
|---|---|
PreferenceFragmentCompat |
Summary
Nested types |
|---|
|
Interface definition for a class that will be called when a |
|
Interface definition for a class that will be called when a |
|
Interface definition for a callback to be invoked when a |
abstract class PreferenceManager.PreferenceComparisonCallbackCallback class to be used by the |
class PreferenceManager.SimplePreferenceComparisonCallback : PreferenceManager.PreferenceComparisonCallbackA basic implementation of |
Constants |
|
|---|---|
const String! |
KEY_HAS_SET_DEFAULT_VALUES = "_has_set_default_values" |
Public functions |
|
|---|---|
PreferenceScreen |
createPreferenceScreen(context: Context) |
T? |
<T : Preference?> findPreference(key: CharSequence)Finds a |
Context |
Returns the context. |
java-static SharedPreferences! |
getDefaultSharedPreferences(context: Context)Gets a |
PreferenceManager.OnDisplayPreferenceDialogListener? |
|
PreferenceManager.OnNavigateToScreenListener? |
Returns the |
PreferenceManager.OnPreferenceTreeClickListener? |
|
PreferenceManager.PreferenceComparisonCallback? |
|
PreferenceDataStore? |
Returns the |
PreferenceScreen! |
Returns the root of the preference hierarchy managed by this class. |
SharedPreferences? |
Gets a |
Int |
Returns the current mode of the |
String! |
Returns the current name of the |
Boolean |
Indicates if the storage location used internally by this class is the default provided by the hosting |
Boolean |
Indicates if the storage location used internally by this class is backed by device-protected storage. |
java-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 |
java-static Unit |
setDefaultValues(Similar to |
Unit |
setOnDisplayPreferenceDialogListener( |
Unit |
Sets the callback to be invoked when a |
Unit |
Sets the callback to be invoked when a |
Unit |
setPreferenceComparisonCallback( |
Unit |
setPreferenceDataStore(dataStore: PreferenceDataStore?)Sets a |
Boolean |
setPreferences(preferenceScreen: PreferenceScreen!)Sets the root of the preference hierarchy. |
Unit |
setSharedPreferencesMode(sharedPreferencesMode: Int)Sets the mode of the |
Unit |
setSharedPreferencesName(sharedPreferencesName: String!)Sets the name of the |
Unit |
Sets the storage location used internally by this class to be the default provided by the hosting |
Unit |
Explicitly set the storage location used internally by this class to be device-protected storage. |
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
const val KEY_HAS_SET_DEFAULT_VALUES = "_has_set_default_values": String!
Public functions
createPreferenceScreen
fun createPreferenceScreen(context: Context): PreferenceScreen
findPreference
fun <T : Preference?> findPreference(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 |
| Returns | |
|---|---|
T? |
The |
| See also | |
|---|---|
findPreference |
getDefaultSharedPreferences
java-static fun getDefaultSharedPreferences(context: 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 |
| Returns | |
|---|---|
SharedPreferences! |
A |
getOnDisplayPreferenceDialogListener
fun getOnDisplayPreferenceDialogListener(): PreferenceManager.OnDisplayPreferenceDialogListener?
getOnNavigateToScreenListener
fun getOnNavigateToScreenListener(): PreferenceManager.OnNavigateToScreenListener?
Returns the PreferenceManager.OnNavigateToScreenListener, if one has been set.
getOnPreferenceTreeClickListener
fun getOnPreferenceTreeClickListener(): PreferenceManager.OnPreferenceTreeClickListener?
getPreferenceComparisonCallback
fun getPreferenceComparisonCallback(): PreferenceManager.PreferenceComparisonCallback?
getPreferenceDataStore
fun getPreferenceDataStore(): PreferenceDataStore?
Returns the PreferenceDataStore associated with this manager or null if the default SharedPreferences are used instead.
| Returns | |
|---|---|
PreferenceDataStore? |
The |
| See also | |
|---|---|
setPreferenceDataStore |
getPreferenceScreen
fun getPreferenceScreen(): PreferenceScreen!
Returns the root of the preference hierarchy managed by this class.
| Returns | |
|---|---|
PreferenceScreen! |
The |
getSharedPreferences
fun getSharedPreferences(): SharedPreferences?
Gets a SharedPreferences instance that preferences managed by this will use.
| Returns | |
|---|---|
SharedPreferences? |
A |
getSharedPreferencesMode
fun getSharedPreferencesMode(): Int
Returns the current mode of the SharedPreferences file that preferences managed by this will use.
| Returns | |
|---|---|
Int |
The mode that can be passed to |
| See also | |
|---|---|
getSharedPreferences |
getSharedPreferencesName
fun getSharedPreferencesName(): String!
Returns the current name of the SharedPreferences file that preferences managed by this will use.
| Returns | |
|---|---|
String! |
The name that can be passed to |
| See also | |
|---|---|
getSharedPreferences |
isStorageDefault
fun isStorageDefault(): Boolean
Indicates if the storage location used internally by this class is the default provided by the hosting Context.
isStorageDeviceProtected
fun isStorageDeviceProtected(): Boolean
Indicates if the storage location used internally by this class is backed by device-protected storage.
setDefaultValues
java-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: 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 Note: this will NOT reset preferences back to their default values. For that functionality, use |
setDefaultValues
java-static fun setDefaultValues(
context: Context,
sharedPreferencesName: String!,
sharedPreferencesMode: Int,
resId: Int,
readAgain: Boolean
): Unit
Similar to setDefaultValues 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 |
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 Note: this will NOT reset preferences back to their default values. For that functionality, use |
setOnDisplayPreferenceDialogListener
fun setOnDisplayPreferenceDialogListener(
onDisplayPreferenceDialogListener: PreferenceManager.OnDisplayPreferenceDialogListener?
): Unit
setOnNavigateToScreenListener
fun setOnNavigateToScreenListener(
listener: 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
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
fun setPreferenceComparisonCallback(
preferenceComparisonCallback: PreferenceManager.PreferenceComparisonCallback?
): Unit
setPreferenceDataStore
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 setPreferenceDataStore. 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 |
| See also | |
|---|---|
setPreferenceDataStore |
setPreferences
fun setPreferences(preferenceScreen: PreferenceScreen!): Boolean
Sets the root of the preference hierarchy.
| Parameters | |
|---|---|
preferenceScreen: PreferenceScreen! |
The root |
| Returns | |
|---|---|
Boolean |
Whether the |
setSharedPreferencesMode
fun setSharedPreferencesMode(sharedPreferencesMode: 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 |
| See also | |
|---|---|
getSharedPreferences |
setSharedPreferencesName
fun setSharedPreferencesName(sharedPreferencesName: 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
fun setStorageDefault(): Unit
Sets the storage location used internally by this class to be the default provided by the hosting Context.
setStorageDeviceProtected
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.
| See also | |
|---|---|
createDeviceProtectedStorageContext |
showDialog
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 |