belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1
PreferenceManager
public
class
PreferenceManager
extends Object
java.lang.Object | |
↳ | android.support.v7.preference.PreferenceManager |
Used to help create Preference
hierarchies
from activities or XML.
In most cases, clients should use
addPreferencesFromResource(int)
, or
addPreferencesFromResource(int)
.
Summary
Nested classes | |
---|---|
interface |
PreferenceManager.OnDisplayPreferenceDialogListener
Interface definition for a class that will be called when a
|
interface |
PreferenceManager.OnNavigateToScreenListener
Interface definition for a class that will be called when a
|
interface |
PreferenceManager.OnPreferenceTreeClickListener
Interface definition for a callback to be invoked when a
|
class |
PreferenceManager.PreferenceComparisonCallback
Callback class to be used by the |
class |
PreferenceManager.SimplePreferenceComparisonCallback
A basic implementation of |
Constants | |
---|---|
String |
KEY_HAS_SET_DEFAULT_VALUES
|
Public methods | |
---|---|
PreferenceScreen
|
createPreferenceScreen(Context context)
|
Preference
|
findPreference(CharSequence key)
Finds a |
Context
|
getContext()
Returns the context. |
static
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. |
PreferenceManager.OnDisplayPreferenceDialogListener
|
getOnDisplayPreferenceDialogListener()
|
PreferenceManager.OnNavigateToScreenListener
|
getOnNavigateToScreenListener()
Returns the |
PreferenceManager.OnPreferenceTreeClickListener
|
getOnPreferenceTreeClickListener()
|
PreferenceManager.PreferenceComparisonCallback
|
getPreferenceComparisonCallback()
|
PreferenceDataStore
|
getPreferenceDataStore()
Returns the |
PreferenceScreen
|
getPreferenceScreen()
Returns the root of the preference hierarchy managed by this class. |
SharedPreferences
|
getSharedPreferences()
Gets a |
int
|
getSharedPreferencesMode()
Returns the current mode of the SharedPreferences file that preferences managed by this will use. |
String
|
getSharedPreferencesName()
Returns the current name of the |
boolean
|
isStorageDefault()
Indicates if the storage location used internally by this class is the
default provided by the hosting |
boolean
|
isStorageDeviceProtected()
Indicates if the storage location used internally by this class is backed by device-protected storage. |
static
void
|
setDefaultValues(Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain)
Similar to |
static
void
|
setDefaultValues(Context context, int resId, boolean readAgain)
Sets the default values from an XML preference file by reading the values defined
by each |
void
|
setOnDisplayPreferenceDialogListener(PreferenceManager.OnDisplayPreferenceDialogListener onDisplayPreferenceDialogListener)
|
void
|
setOnNavigateToScreenListener(PreferenceManager.OnNavigateToScreenListener listener)
Sets the callback to be invoked when a |
void
|
setOnPreferenceTreeClickListener(PreferenceManager.OnPreferenceTreeClickListener listener)
Sets the callback to be invoked when a |
void
|
setPreferenceComparisonCallback(PreferenceManager.PreferenceComparisonCallback preferenceComparisonCallback)
|
void
|
setPreferenceDataStore(PreferenceDataStore dataStore)
Sets a |
boolean
|
setPreferences(PreferenceScreen preferenceScreen)
Sets the root of the preference hierarchy. |
void
|
setSharedPreferencesMode(int sharedPreferencesMode)
Sets the mode of the SharedPreferences file that preferences managed by this will use. |
void
|
setSharedPreferencesName(String sharedPreferencesName)
Sets the name of the |
void
|
setStorageDefault()
Sets the storage location used internally by this class to be the default
provided by the hosting |
void
|
setStorageDeviceProtected()
Explicitly set the storage location used internally by this class to be device-protected storage. |
void
|
showDialog(Preference preference)
Called when a preference requests that a dialog be shown to complete a user interaction. |
Inherited methods | |
---|---|
![]()
java.lang.Object
|
Constants
KEY_HAS_SET_DEFAULT_VALUES
String KEY_HAS_SET_DEFAULT_VALUES
Constant Value: "_has_set_default_values"
Public methods
createPreferenceScreen
PreferenceScreen createPreferenceScreen (Context context)
Parameters | |
---|---|
context |
Context |
Returns | |
---|---|
PreferenceScreen |
findPreference
Preference findPreference (CharSequence key)
Finds a Preference
based on its key.
Parameters | |
---|---|
key |
CharSequence : The key of the preference to retrieve. |
Returns | |
---|---|
Preference |
The Preference with the key, or null. |
See also:
getContext
Context getContext ()
Returns the context.
Returns | |
---|---|
Context |
The context. |
getDefaultSharedPreferences
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 |
A SharedPreferences instance that can be used to retrieve and listen to values of the preferences. |
getOnDisplayPreferenceDialogListener
PreferenceManager.OnDisplayPreferenceDialogListener getOnDisplayPreferenceDialogListener ()
Returns | |
---|---|
PreferenceManager.OnDisplayPreferenceDialogListener |
getOnNavigateToScreenListener
PreferenceManager.OnNavigateToScreenListener getOnNavigateToScreenListener ()
Returns the PreferenceManager.OnNavigateToScreenListener
, if one has been set.
Returns | |
---|---|
PreferenceManager.OnNavigateToScreenListener |
getOnPreferenceTreeClickListener
PreferenceManager.OnPreferenceTreeClickListener getOnPreferenceTreeClickListener ()
Returns | |
---|---|
PreferenceManager.OnPreferenceTreeClickListener |