Most visited

Recently visited

Results for

Summary: Nested Classes | Constants | Methods | Inherited Methods | [Expand All]

PreferenceManager

public class PreferenceManager
extends Object

java.lang.Object
   ↳ android.support.v7.preference.PreferenceManager

用于帮助从活动或XML创建 Preference层次结构。

在大多数情况下，客户应该使用 addPreferencesFromResource(int)或 addPreferencesFromResource(int) 。

也可以看看：

Summary

Nested classes
interface PreferenceManager.OnDisplayPreferenceDialogListener

Preference请求显示对话框时将调用的类的接口定义。

interface PreferenceManager.OnNavigateToScreenListener

PreferenceScreen请求导航时将调用的类的接口定义。

interface PreferenceManager.OnPreferenceTreeClickListener

点击以PreferenceScreen为根的层次结构中的Preference时，将调用回调的接口定义。

Constants
String KEY_HAS_SET_DEFAULT_VALUES

Public methods
PreferenceScreen createPreferenceScreen(Context context)
Preference findPreference(CharSequence key)

根据其关键找到 Preference 。
Context getContext()

返回上下文。
static SharedPreferences getDefaultSharedPreferences(Context context)

获取一个SharedPreferences实例，该实例指向给定上下文中的首选项框架使用的默认文件。
PreferenceManager.OnDisplayPreferenceDialogListener getOnDisplayPreferenceDialogListener()
PreferenceManager.OnNavigateToScreenListener getOnNavigateToScreenListener()

如果已设置，则返回 PreferenceManager.OnNavigateToScreenListener 。
PreferenceManager.OnPreferenceTreeClickListener getOnPreferenceTreeClickListener()
PreferenceScreen getPreferenceScreen()

返回由此类管理的首选层次结构的根。
SharedPreferences getSharedPreferences()

获取由此管理的首选项将使用的SharedPreferences实例。
int getSharedPreferencesMode()

返回由此管理的首选项将使用的SharedPreferences文件的当前模式。
String getSharedPreferencesName()

返回由此管理的首选项将使用的SharedPreferences文件的当前名称。
boolean isStorageDefault()

指示此类内部使用的存储位置是托管 Context提供的默认 Context 。
boolean isStorageDeviceProtected()

指示此类内部使用的存储位置是否受设备保护存储支持。
static void setDefaultValues(Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain)

类似于 setDefaultValues(Context, int, boolean)但允许客户端提供共享首选项文件的文件名和模式。
static void setDefaultValues(Context context, int resId, boolean readAgain)

通过读取每个 Preference项目的 android:defaultValue属性定义的值来设置XML首选项文件的默认值。
void setOnDisplayPreferenceDialogListener(PreferenceManager.OnDisplayPreferenceDialogListener onDisplayPreferenceDialogListener)
void setOnNavigateToScreenListener(PreferenceManager.OnNavigateToScreenListener listener)

当单击位于此 PreferenceManager的层次结构中的 PreferenceScreen时，设置要调用的回调。
void setOnPreferenceTreeClickListener(PreferenceManager.OnPreferenceTreeClickListener listener)

当单击位于此 PreferenceManager处的层次结构中的 Preference时，设置要调用的回调。
boolean setPreferences(PreferenceScreen preferenceScreen)

设置偏好层次的根。
void setSharedPreferencesMode(int sharedPreferencesMode)

设置由此管理的首选项将使用的SharedPreferences文件的模式。
void setSharedPreferencesName(String sharedPreferencesName)

设置由此管理的首选项将使用的SharedPreferences文件的名称。
void setStorageDefault()

将此类内部使用的存储位置设置为主机 Context提供的默认 Context 。
void setStorageDeviceProtected()

将此类内部使用的存储位置明确设置为受设备保护的存储。
void showDialog(Preference preference)

当首选项请求显示对话框以完成用户交互时调用。

Inherited methods
From class java.lang.Object

Constants

KEY_HAS_SET_DEFAULT_VALUES

String KEY_HAS_SET_DEFAULT_VALUES

常量值：“_has_set_default_values”

Public methods

createPreferenceScreen

PreferenceScreen createPreferenceScreen (Context context)

Parameters
context Context
Returns
PreferenceScreen

findPreference

Preference findPreference (CharSequence key)

根据其关键找到 Preference 。

Parameters
key CharSequence: The key of the preference to retrieve.
Returns
Preference The Preference with the key, or null.

也可以看看：

getContext

Context getContext ()

返回上下文。

Returns
Context The context.

getDefaultSharedPreferences

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.

getOnDisplayPreferenceDialogListener

PreferenceManager.OnDisplayPreferenceDialogListener getOnDisplayPreferenceDialogListener ()

Returns
PreferenceManager.OnDisplayPreferenceDialogListener

getOnNavigateToScreenListener

PreferenceManager.OnNavigateToScreenListener getOnNavigateToScreenListener ()

如果已设置，则返回 PreferenceManager.OnNavigateToScreenListener 。

Returns
PreferenceManager.OnNavigateToScreenListener

getOnPreferenceTreeClickListener

PreferenceManager.OnPreferenceTreeClickListener getOnPreferenceTreeClickListener ()

Returns
PreferenceManager.OnPreferenceTreeClickListener

getPreferenceScreen

PreferenceScreen getPreferenceScreen ()

返回由此类管理的首选层次结构的根。

Returns
PreferenceScreen The PreferenceScreen object that is at the root of the hierarchy.

getSharedPreferences

SharedPreferences getSharedPreferences ()

获取由此管理的首选项将使用的SharedPreferences实例。

Returns
SharedPreferences A SharedPreferences instance pointing to the file that contains the values of preferences that are managed by this.

getSharedPreferencesMode

int getSharedPreferencesMode ()

返回由此管理的首选项将使用的SharedPreferences文件的当前模式。

Returns
int The mode that can be passed to getSharedPreferences(String, int).

也可以看看：

getSharedPreferencesName

String getSharedPreferencesName ()

返回由此管理的首选项将使用的SharedPreferences文件的当前名称。

Returns
String The name that can be passed to getSharedPreferences(String, int).

也可以看看：

isStorageDefault

boolean isStorageDefault ()

指示此类内部使用的存储位置是托管 Context提供的默认 Context 。

Returns
boolean

也可以看看：

isStorageDeviceProtected

boolean isStorageDeviceProtected ()

指示此类内部使用的存储位置是否受设备保护存储支持。

Returns
boolean

也可以看看：

setDefaultValues

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.

注意：这不会将首选项重置为其默认值。 对于该功能，使用getDefaultSharedPreferences(Context)并清除它，然后调用此方法，并将此参数设置为true。

也可以看看：

setDefaultValues

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.

注意：这不会将首选项重置为其默认值。 对于该功能，使用getDefaultSharedPreferences(Context)并清除它，然后调用此方法，并将此参数设置为true。

setOnDisplayPreferenceDialogListener

void setOnDisplayPreferenceDialogListener (PreferenceManager.OnDisplayPreferenceDialogListener onDisplayPreferenceDialogListener)

Parameters
onDisplayPreferenceDialogListener PreferenceManager.OnDisplayPreferenceDialogListener

setOnNavigateToScreenListener

void setOnNavigateToScreenListener (PreferenceManager.OnNavigateToScreenListener listener)

当单击位于此 PreferenceManager的层次结构中的 PreferenceScreen时，设置要调用的回调。

Parameters
listener PreferenceManager.OnNavigateToScreenListener: The callback to be invoked.

setOnPreferenceTreeClickListener

void setOnPreferenceTreeClickListener (PreferenceManager.OnPreferenceTreeClickListener listener)

当单击位于此 PreferenceManager的层次结构中的 Preference时，设置要调用的回调。

Parameters
listener PreferenceManager.OnPreferenceTreeClickListener: The callback to be invoked.

setPreferences

boolean setPreferences (PreferenceScreen preferenceScreen)

设置偏好层次的根。

Parameters
preferenceScreen PreferenceScreen: The root PreferenceScreen of the preference hierarchy.
Returns
boolean Whether the PreferenceScreen given is different than the previous.

setSharedPreferencesMode

void setSharedPreferencesMode (int sharedPreferencesMode)

设置由此管理的首选项将使用的SharedPreferences文件的模式。

Parameters
sharedPreferencesMode int: The mode of the SharedPreferences file.

也可以看看：

setSharedPreferencesName

void setSharedPreferencesName (String sharedPreferencesName)

设置由此管理的首选项将使用的SharedPreferences文件的名称。

Parameters
sharedPreferencesName String: The name of the SharedPreferences file.

也可以看看：

setStorageDefault

void setStorageDefault ()

将此类内部使用的存储位置设置为主机 Context提供的默认 Context 。

setStorageDeviceProtected

void setStorageDeviceProtected ()

将此类内部使用的存储位置明确设置为受设备保护的存储。

在直接引导的设备上，存储在此位置的数据使用绑定到物理设备的密钥进行加密，并且可以在设备成功引导后立即访问，无论是 在用户使用凭据进行身份验证 之前还是之后 （例如锁定模式或PIN）。

由于受到设备保护的数据在没有用户身份验证的情况下可用，因此应谨慎限制使用此上下文存储的数据。 例如，强烈建议不要在设备保护区域中存储敏感身份验证令牌或密码。

在 isAtLeastN()之前，此方法不起作用，因为设备保护的存储不可用。

也可以看看：

showDialog

void showDialog (Preference preference)

当首选项请求显示对话框以完成用户交互时调用。

Parameters
preference Preference: The preference requesting the dialog.
Android开发手册

Hooray!