public class PreferenceManager
extends Object
java.lang.Object | |
↳ | android.preference.PreferenceManager |
用于帮助从活动或XML创建 Preference
层次结构。
在大多数情况下,客户应使用 addPreferencesFromIntent(Intent)
或 addPreferencesFromResource(int)
。
也可以看看:
Nested classes |
|
---|---|
interface |
PreferenceManager.OnActivityDestroyListener 当容器的活动被销毁时将被调用的类的接口定义。 |
interface |
PreferenceManager.OnActivityResultListener 当容器的活动收到活动结果时将调用的类的接口定义。 |
interface |
PreferenceManager.OnActivityStopListener 当容器的活动停止时将被调用的类的接口定义。 |
Constants |
|
---|---|
String |
KEY_HAS_SET_DEFAULT_VALUES |
String |
METADATA_KEY_PREFERENCES 它的XML偏好层次结构的活动元数据键。 |
Public methods |
|
---|---|
PreferenceScreen |
createPreferenceScreen(Context context) |
Preference |
findPreference(CharSequence key) 根据密钥找到 |
static SharedPreferences |
getDefaultSharedPreferences(Context context) 获取一个SharedPreferences实例,该实例指向给定上下文中的首选项框架使用的默认文件。 |
static String |
getDefaultSharedPreferencesName(Context context) 返回用于存储默认共享首选项的名称。 |
SharedPreferences |
getSharedPreferences() 获取由此管理的首选项将使用的SharedPreferences实例。 |
int |
getSharedPreferencesMode() 返回由此管理的首选项将使用的SharedPreferences文件的当前模式。 |
String |
getSharedPreferencesName() 返回由此管理的首选项将使用的SharedPreferences文件的当前名称。 |
boolean |
isStorageDefault() |
boolean |
isStorageDeviceProtected() 指示此类内部使用的存储位置是否受设备保护存储支持。 |
static void |
setDefaultValues(Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain) 类似于 |
static void |
setDefaultValues(Context context, int resId, boolean readAgain) 通过读取每个 |
void |
setSharedPreferencesMode(int sharedPreferencesMode) 设置由此管理的首选项将使用的SharedPreferences文件的模式。 |
void |
setSharedPreferencesName(String sharedPreferencesName) 设置由此管理的首选项将使用的SharedPreferences文件的名称。 |
void |
setStorageDefault() |
void |
setStorageDeviceProtected() 将此类内部使用的存储位置明确设置为受设备保护的存储。 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
String KEY_HAS_SET_DEFAULT_VALUES
常量值:“_has_set_default_values”
String METADATA_KEY_PREFERENCES
它的XML偏好层次结构的活动元数据键。
常量值:“android.preference”
PreferenceScreen createPreferenceScreen (Context context)
Parameters | |
---|---|
context |
Context
|
Returns | |
---|---|
PreferenceScreen |
Preference findPreference (CharSequence key)
根据其密钥找到 Preference
。
Parameters | |
---|---|
key |
CharSequence : The key of the preference to retrieve. |
Returns | |
---|---|
Preference |
The Preference with the key, or null. |
也可以看看:
SharedPreferences getDefaultSharedPreferences (Context context)
获取一个SharedPreferences实例,该实例指向给定上下文中的首选项框架使用的默认文件。
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. |
String getDefaultSharedPreferencesName (Context context)
返回用于存储默认共享首选项的名称。
Parameters | |
---|---|
context |
Context
|
Returns | |
---|---|
String |
SharedPreferences getSharedPreferences ()
获取由此管理的首选项将使用的SharedPreferences实例。
Returns | |
---|---|
SharedPreferences |
A SharedPreferences instance pointing to the file that contains the values of preferences that are managed by this. |
int getSharedPreferencesMode ()
返回由此管理的首选项将使用的SharedPreferences文件的当前模式。
Returns | |
---|---|
int |
The mode that can be passed to getSharedPreferences(String, int) . |
String getSharedPreferencesName ()
返回由此管理的首选项将使用的SharedPreferences文件的当前名称。
Returns | |
---|---|
String |
The name that can be passed to getSharedPreferences(String, int) . |
boolean isStorageDefault ()
指示此类内部使用的存储位置是由主机 Context
提供的默认 Context
。
Returns | |
---|---|
boolean |
boolean isStorageDeviceProtected ()
指示此类内部使用的存储位置是否受设备保护存储支持。
Returns | |
---|---|
boolean |
void setDefaultValues (Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain)
类似于 setDefaultValues(Context, int, boolean)
但允许客户端提供共享首选项文件的文件名和模式。
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 or 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 in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set readAgain to true. 注意:这不会将首选项重置为其默认值。 对于该功能,使用 |
void setDefaultValues (Context context, int resId, boolean readAgain)
通过读取每个Preference
项目的android:defaultValue
属性定义的值来设置XML首选项文件的默认值。 这应该由应用程序的主要活动调用。
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 in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set readAgain to true. 注意:这不会将首选项重置为其默认值。 对于该功能,使用 |
void setSharedPreferencesMode (int sharedPreferencesMode)
设置由此管理的首选项将使用的SharedPreferences文件的模式。
Parameters | |
---|---|
sharedPreferencesMode |
int : The mode of the SharedPreferences file. |
void setSharedPreferencesName (String sharedPreferencesName)
设置由此管理的首选项将使用的SharedPreferences文件的名称。
Parameters | |
---|---|
sharedPreferencesName |
String : The name of the SharedPreferences file. |
void setStorageDeviceProtected ()
将此类内部使用的存储位置明确设置为受设备保护的存储。
在直接引导的设备上,存储在此位置的数据使用绑定到物理设备的密钥进行加密,并且可以在设备成功引导后立即访问,无论是 在用户使用凭据进行身份验证 之前还是之后 (例如锁定模式或PIN)。
由于受到设备保护的数据在没有用户身份验证的情况下可用,因此应谨慎限制使用此上下文存储的数据。 例如,强烈建议不要在设备保护区域中存储敏感身份验证令牌或密码。