Most visited

Recently visited

Results for

Summary: Inherited Constants | Methods | Protected Methods | Inherited Methods | [Expand All]

PreferenceScreen

public final class PreferenceScreen
extends PreferenceGroup

java.lang.Object
↳	android.support.v7.preference.Preference
	↳	android.support.v7.preference.PreferenceGroup
		↳	android.support.v7.preference.PreferenceScreen

表示顶层Preference ，它是首选层次结构的根。一个PreferenceFragmentCompat指向这个类的一个实例来显示首选项。要实例化这个类，请使用createPreferenceScreen(android.content.Context) 。

When a PreferenceFragmentCompat points to this, it is used as the root and is not shown (only the contained preferences are shown).
When it appears inside another preference hierarchy, it is shown and serves as the gateway to another screen of preferences (either by showing another screen of preferences as a Dialog or via a startActivity(android.content.Intent) from the getIntent()). The children of this PreferenceScreen are NOT shown in the screen that this PreferenceScreen is shown in. Instead, a separate screen will be shown when this preference is clicked.

以下是一个PreferenceScreen的示例XML布局：

 <PreferenceScreen
 xmlns:android="http://schemas.android.com/apk/res/android"
 android:key="first_preferencescreen">
 <CheckBoxPreference
 android:key="wifi enabled"
 android:title="WiFi" />
 <PreferenceScreen
 android:key="second_preferencescreen"
 android:title="WiFi settings">
 <CheckBoxPreference
 android:key="prefer wifi"
 android:title="Prefer WiFi" />
 ... other preferences here ...
 </PreferenceScreen>
 </PreferenceScreen>

在此示例中，“first_preferencescreen”将用作层次结构的根目录，并将其提供给PreferenceFragment或PreferenceFragmentCompat 。第一个屏幕将显示首选项“WiFi”（可用于快速启用/禁用WiFi）和“WiFi设置”。 “WiFi设置”是“second_preferencescreen”，点击后会显示另一个首选项屏幕，如“首选WiFi”（以及其他首选项，即“second_preferencescreen”标签的子选项）。

Developer Guides

有关使用首选项构建设置UI的信息，请阅读 Settings指南。

也可以看看：

PreferenceCategory

Summary

Inherited constants

From class android.support.v7.preference.Preference

Public methods
`void`	`setShouldUseGeneratedIds(boolean shouldUseGeneratedIds)` 设置为此屏幕创建的适配器是否应尝试使用由 `addPreference(Preference)`生成的首选项ID作为稳定的项目ID。
`boolean`	`shouldUseGeneratedIds()` 见 `setShouldUseGeneratedIds(boolean)`

Protected methods
`boolean`	`isOnSameScreenAsChildren()` 此偏好组是否应该与其包含的偏好一起显示在同一屏幕上。
`void`	`onClick()` 处理点击偏好。

Inherited methods

From class android.support.v7.preference.PreferenceGroup

From class android.support.v7.preference.Preference

`boolean`	`callChangeListener(Object newValue)` 在用户更改首选项之后但在内部状态设置之前调用此方法。
`int`	`compareTo(Preference another)` 根据订单（如果设置）比较偏好对象，否则按标题按字母顺序排列。
`Preference`	`findPreferenceInHierarchy(String key)` 使用给定的键在此层次结构中找到偏好（整个事件，甚至高于/低于 `PreferenceScreen`屏幕中断）。
`Context`	`getContext()` 返回此首选项的 `Context` 。
`String`	`getDependency()` 返回此首选项的依赖项的关键。
`Bundle`	`getExtras()` 返回与此首选项关联的额外Bundle对象，如果当前不存在Bundle对象，则创建一个新Bundle。
`String`	`getFragment()` 返回与此首选项关联的片段类名称。
`Drawable`	`getIcon()` 返回此首选项的图标。
`Intent`	`getIntent()` 返回与此首选项关联的 `Intent` 。
`String`	`getKey()` 获取此首选项的关键字，这也是用于将值存储到SharedPreferences中的关键。
`final int`	`getLayoutResource()` 获取此首选项将显示为 `View`的布局资源。
`Preference.OnPreferenceChangeListener`	`getOnPreferenceChangeListener()` 当用户更改此首选项时（但内部状态已更新之前），返回要调用的回调。
`Preference.OnPreferenceClickListener`	`getOnPreferenceClickListener()` 返回单击此首选项时要调用的回调。
`int`	`getOrder()` 获取此Preference相对于同一级别上的其他Preference对象的顺序。
`boolean`	`getPersistedBoolean(boolean defaultReturnValue)` 尝试从 `SharedPreferences`获取持久布尔值。
`float`	`getPersistedFloat(float defaultReturnValue)` 尝试从 `SharedPreferences`获得持续浮动。
`int`	`getPersistedInt(int defaultReturnValue)` 尝试从 `SharedPreferences`获取持久化int。
`long`	`getPersistedLong(long defaultReturnValue)` 尝试从 `SharedPreferences`获得持续很长的 `SharedPreferences` 。
`String`	`getPersistedString(String defaultReturnValue)` 尝试从 `SharedPreferences`获取持久字符串。
`PreferenceManager`	`getPreferenceManager()` 获取管理此首选项对象树的 `PreferenceManager` 。
`SharedPreferences`	`getSharedPreferences()` 返回 `SharedPreferences` ，其中此首选项可以读取其值（s）。
`boolean`	`getShouldDisableView()` 检查此首选项是否应在其操作处于禁用状态时禁用其视图。
`CharSequence`	`getSummary()` 返回此首选项的摘要。
`CharSequence`	`getTitle()` 返回此首选项的标题。
`final int`	`getWidgetLayoutResource()` 获取此首选项的可控小部件的布局资源。
`boolean`	`hasKey()` 检查此首选项是否有有效的密钥。
`boolean`	`isEnabled()` 检查此首选项是否应在列表中启用。
`boolean`	`isPersistent()` 检查此首选项是否持久。
`boolean`	`isSelectable()` 检查此首选项是否应该在列表中可选。
`final boolean`	`isVisible()` 检查此首选项是否对列表中的用户可见。
`void`	`notifyChanged()` 当这个 `Preference`的数据改变时应该被调用。
`void`	`notifyDependencyChange(boolean disableDependents)` 通知任何监听依赖者影响依赖性的更改。
`void`	`notifyHierarchyChanged()` 应该在从此组添加/移除偏好时调用，或者应该重新评估顺序。
`void`	`onAttached()` 当首选项层次已被附加到首选项列表时调用。
`void`	`onAttachedToHierarchy(PreferenceManager preferenceManager)` 当此首选项已附加到首选项层次结构时调用。
`void`	`onBindViewHolder(PreferenceViewHolder holder)` 将创建的视图绑定到此首选项的数据。
`void`	`onClick()` 处理点击偏好。
`void`	`onDependencyChanged(Preference dependency, boolean disableDependent)` 当依赖关系发生变化时调用。
`void`	`onDetached()` 当首选项层次已从首选项列表中分离时调用。
`Object`	`onGetDefaultValue(TypedArray a, int index)` 当首选项被夸大并且需要读取默认值属性时调用。
`void`	`onInitializeAccessibilityNodeInfo(AccessibilityNodeInfoCompat info)` 使用有关此首选项的视图的信息初始化 `AccessibilityNodeInfo` 。
`void`	`onParentChanged(Preference parent, boolean disableChild)` 当隐式父依赖性发生变化时调用。
`void`	`onPrepareForRemoval()` 当此首选项从层次结构中删除时调用。
`void`	`onRestoreInstanceState(Parcelable state)` 挂钩允许偏好重新应用先前由 `onSaveInstanceState()`生成的其内部状态的表示。
`Parcelable`	`onSaveInstanceState()` 钩子允许首选项生成其内部状态的表示，稍后可用于创建具有相同状态的新实例。
`void`	`onSetInitialValue(boolean restorePersistedValue, Object defaultValue)` 执行此操作来设置首选项的初始值。
`Bundle`	`peekExtras()` 返回与此首选项关联的额外Bundle对象，如果当前不存在返回null。
`boolean`	`persistBoolean(boolean value)` 尝试将布尔值保存到 `SharedPreferences` 。
`boolean`	`persistFloat(float value)` 尝试持续浮动到 `SharedPreferences` 。
`boolean`	`persistInt(int value)` 尝试持续int到 `SharedPreferences` 。
`boolean`	`persistLong(long value)` 尝试持续很长的时间到 `SharedPreferences` 。
`boolean`	`persistString(String value)` 尝试将字符串保存到 `SharedPreferences` 。
`void`	`restoreHierarchyState(Bundle container)` 从给定的容器中恢复此首选项层次结构的先前保存的状态。
`void`	`saveHierarchyState(Bundle container)` 将此首选项层次结构的冻结状态存储到给定的容器中。
`void`	`setDefaultValue(Object defaultValue)` 设置此首选项的默认值，如果持久性处于关闭状态或持久性处于打开状态并且在持久性存储器中未找到首选项，则会设置该首选项。
`void`	`setDependency(String dependencyKey)` 设置此首选项将依赖的首选项的关键。
`void`	`setEnabled(boolean enabled)` 设置是否启用此首选项。
`void`	`setFragment(String fragment)` 设置单击此首选项时要显示的片段的类名称。
`void`	`setIcon(Drawable icon)` 使用Drawable设置此首选项的图标。
`void`	`setIcon(int iconResId)` 使用资源ID设置此首选项的图标。
`void`	`setIntent(Intent intent)` 套 `Intent`用于 `startActivity(Intent)`单击此偏好时。
`void`	`setKey(String key)` 设置此首选项的密钥，该密钥用作 `SharedPreferences`的密钥。
`void`	`setLayoutResource(int layoutResId)` 设置为此偏好显示的 `View`充气布局资源。
`void`	`setOnPreferenceChangeListener(Preference.OnPreferenceChangeListener onPreferenceChangeListener)` 当用户更改此首选项时（但在内部状态更新之前）设置要调用的回调。
`void`	`setOnPreferenceClickListener(Preference.OnPreferenceClickListener onPreferenceClickListener)` 设置单击此首选项时要调用的回调。
`void`	`setOrder(int order)` 设置此首选项相对于同一级别上的其他首选项对象的顺序。
`void`	`setPersistent(boolean persistent)` 设置此首选项是否持久。
`void`	`setSelectable(boolean selectable)` 设置此首选项是否可选。
`void`	`setShouldDisableView(boolean shouldDisableView)` 设置此首选项是否应禁用其视图。
`void`	`setSummary(CharSequence summary)` 使用CharSequence设置此首选项的摘要。
`void`	`setSummary(int summaryResId)` 使用资源ID设置此首选项的摘要。
`void`	`setTitle(CharSequence title)` 使用CharSequence设置此首选项的标题。
`void`	`setTitle(int titleResId)` 使用资源ID设置此首选项的标题。
`void`	`setViewId(int viewId)` 设置绑定后将分配给代表此首选项的整体视图的标识。
`final void`	`setVisible(boolean visible)` 设置此首选项是否应在列表中可见。
`void`	`setWidgetLayoutResource(int widgetLayoutResId)` 设置此首选项的可控件部分的布局。
`boolean`	`shouldDisableDependents()` 检查当前是否应该禁用此首选项的依赖项。
`boolean`	`shouldPersist()` 检查在给定时间调用此方法时，此首选项是否应将其值存储/恢复到 `SharedPreferences` 。
`String`	`toString()` 返回对象的字符串表示形式。

From class java.lang.Object

From interface java.lang.Comparable

Public methods

setShouldUseGeneratedIds

void setShouldUseGeneratedIds (boolean shouldUseGeneratedIds)

设置为此屏幕创建的适配器是否应尝试使用由addPreference(Preference)生成的首选项ID作为稳定的项目ID。如果将Preference对象频繁地从Preference中删除并重新添加到其包含的PreferenceGroup将其设置为false可以抑制不需要的动画。

只有在首选项屏幕未附加到层次结构时才可以调用此方法。

默认值是 true 。

Parameters
`shouldUseGeneratedIds`	`boolean`: `true` if the adapter should use the preference ID as a stable ID, or `false` to disable the use of stable IDs

shouldUseGeneratedIds

boolean shouldUseGeneratedIds ()

见 setShouldUseGeneratedIds(boolean)

Returns
`boolean`	`true` if the adapter should use the preference IDs generated by `addPreference(Preference)` as stable item IDs

Protected methods

isOnSameScreenAsChildren

boolean isOnSameScreenAsChildren ()

此偏好组是否应该与其包含的偏好一起显示在同一屏幕上。

Returns
`boolean`	True if the contained preferences should be shown on the same screen as this preference.

onClick

void onClick ()

处理点击偏好。这包括将值保存到SharedPreferences 。但是，重写的方法应该调用callChangeListener(Object)以确保客户端想要用新值更新首选项的状态。

Interfaces

Classes

Most visited

Recently visited

Results for

PreferenceScreen

Developer Guides

Summary

Inherited constants

Public methods

Protected methods

Inherited methods

Public methods

setShouldUseGeneratedIds

shouldUseGeneratedIds

Protected methods

isOnSameScreenAsChildren

onClick