PreferenceScreen 类

定义

表示一个顶级 Preference ,它是首选项层次结构的根。

[Android.Runtime.Register("android/preference/PreferenceScreen", DoNotGenerateAcw=true)]
public sealed class PreferenceScreen : Android.Preferences.PreferenceGroup, Android.Content.IDialogInterfaceOnDismissListener, Android.Widget.AdapterView.IOnItemClickListener, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/preference/PreferenceScreen", DoNotGenerateAcw=true)>]
type PreferenceScreen = class
    inherit PreferenceGroup
    interface IDialogInterfaceOnDismissListener
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
    interface AdapterView.IOnItemClickListener
继承
属性
实现

注解

表示一个顶级 Preference ,它是首选项层次结构的根。 指向 PreferenceActivity 此类的实例以显示首选项。 若要实例化此类,请使用 PreferenceManager#createPreferenceScreen(Context)。 <ul> 此类可以出现在两个PreferenceActivity位置:<li> 当 指向此时,它将用作根,不显示 (仅显示包含的首选项) 。 <li> 当它出现在另一个首选项层次结构中时,它会显示,并作为另一个首选项屏幕的网关, (通过将另一个首选项屏幕显示为 Dialog 或从 Context#startActivity(android.content.Intent)Preference#getIntent()) 显示。 此 PreferenceScreen 的子级不会显示在显示此 PreferenceScreen 的屏幕中。 相反,单击此首选项时,将显示单独的屏幕。 </ul>

下面是 PreferenceScreen 的示例 XML 布局:

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

在此示例中,“first_preferencescreen”将用作层次结构的根,并提供给 PreferenceActivity。 第一个屏幕将显示首选项“WiFi” (可用于快速启用/禁用 WiFi) 和“WiFi 设置”。 “WiFi 设置”是“second_preferencescreen”,单击时将显示另一个首选项屏幕,例如“首选 WiFi” (以及作为“second_preferencescreen”标记) 子级的其他首选项。

<div class=“special reference”><h3>Developer Guides</h3>

有关使用首选项生成设置 UI 的信息,请阅读 设置 指南。

</Div>

此成员已弃用。 使用 AndroidX 首选项库 在所有设备上实现一致的行为。 有关使用 AndroidX 首选项库的详细信息,请参阅 设置

android.preference.PreferenceScreenJava 文档。

此页面的某些部分是基于 创建和共享的工作进行的修改,并根据 署名许可中所述的条款使用。

字段

DefaultOrder

如果不需要特定顺序,请指定 。#setOrder(int)

(继承自 Preference)

属性

Class

返回此 Object的运行时类。

(继承自 Object)
Context

返回 android.content.Context 此首选项的 。

(继承自 Preference)
Dependency

返回此首选项的依赖项的键。 - 或 - 设置此首选项将依赖的首选项的键。

(继承自 Preference)
Dialog

用于获取对话框的句柄。

Editor

返回一个 , SharedPreferences.Editor 其中此首选项可以保存其值 () 。

(继承自 Preference)
Enabled

检查是否应在列表中启用此首选项。 - 或 - 设置是否启用此首选项。

(继承自 Preference)
Extras

返回与此首选项关联的 extras Bundle 对象,如果当前没有捆绑包,则创建一个新的捆绑包。

(继承自 Preference)
Fragment

返回与此首选项关联的片段类名称。 - 或 - 设置单击此首选项时要显示的片段的类名。

(继承自 Preference)
Handle

基础 Android 实例的句柄。

(继承自 Object)
HasKey

检查此首选项是否具有有效的密钥。

(继承自 Preference)
Icon

返回此首选项的图标。 - 或 - 使用 Drawable 设置此首选项的图标。

(继承自 Preference)
IconSpaceReserved

获取此首选项图标视图是否保留的空间。 - 或 - 设置在未提供图标时是否保留此首选项图标视图的空间。

(继承自 Preference)
Intent

Intent返回与此首选项关联的 。 - 或 - 设置 Intent 在单击此首选项时要使用的 Context#startActivity(Intent)

(继承自 Preference)
IsOnSameScreenAsChildren

此首选项组是否应与其包含的首选项在同一屏幕上显示。

(继承自 PreferenceGroup)
JniIdentityHashCode

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
JniPeerMembers

表示一个顶级 Preference ,它是首选项层次结构的根。

Key

获取此首选项的键,该键也是用于将值存储到 或 PreferenceDataStore中的SharedPreferences键。 - 或 - 设置此首选项的键,该首选项用作 或 PreferenceDataStoreSharedPreferences键。

(继承自 Preference)
LayoutResource

获取将显示为此首选项的 View 的布局资源。 - 或 - 设置膨胀为 View 要为此首选项显示的布局资源。

(继承自 Preference)
OnPreferenceChangeListener

返回当用户 (更改此首选项时,但在内部状态更新) 之前调用的回调。 - 或 - 设置当用户 (更改此首选项时,但在) 更新内部状态之前调用的回调。

(继承自 Preference)
OnPreferenceClickListener

返回单击此首选项时要调用的回调。 - 或 - 设置在单击此首选项时要调用的回调。

(继承自 Preference)
Order

获取此首选项相对于同一级别上其他 Preference 对象的顺序。 - 或 - 设置此首选项相对于同一级别上其他 Preference 对象的顺序。

(继承自 Preference)
OrderingAsAdded

此组是否按添加顺序对首选项进行排序。 - 或 - 是否在添加此组的 Preference 子级时对它们进行排序。

(继承自 PreferenceGroup)
Parent

如果 PreferenceGroup 此首选项未分配给任何组或 null 为根首选项,则返回此首选项分配给任何组的 。

(继承自 Preference)
PeerReference

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
Persistent

检查此首选项是否持久。 - 或 - 设置此首选项是否持久。

(继承自 Preference)
PreferenceCount

返回子 Preference级 的数目。

(继承自 PreferenceGroup)
PreferenceDataStore

返回 PreferenceDataStore 此首选项使用的 。 - 或 - 设置 PreferenceDataStore 要由此首选项而不是使用 android.content.SharedPreferences的 。

(继承自 Preference)
PreferenceManager

获取 PreferenceManager 管理此 Preference 对象的树的 。

(继承自 Preference)
RecycleEnabled

检查此首选项是否允许在列表视图中使用时回收其视图。 - 或 - 设置此首选项是否允许在列表视图中使用时回收其视图。

(继承自 Preference)
RootAdapter

返回可附加到 PreferenceActivityPreferenceFragment 以显示此 PreferenceScreen中包含的首选项的适配器。

Selectable

检查此首选项是否应在列表中选择。 - 或 - 设置此首选项是否可选。

(继承自 Preference)
SharedPreferences

返回可在其中 SharedPreferences 读取其值的 () 。

(继承自 Preference)
ShouldDisableView

检查禁用操作时,此首选项是否应禁用其视图。 - 或 - 设置禁用此首选项时是否应禁用其视图。

(继承自 Preference)
SingleLineTitle

获取此首选项的标题是否限制为单行。 - 或 - 设置是否将此首选项的标题限制为一行,而不是使其换行到多行。

(继承自 Preference)
Summary

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Preference)
SummaryFormatted

返回此首选项的摘要。 - 或 - 使用 CharSequence 设置此首选项的摘要。

(继承自 Preference)
ThresholdClass

此 API 支持 Mono for Android 基础结构,不应直接从代码中使用。

(继承自 PreferenceGroup)
ThresholdType

此 API 支持 Mono for Android 基础结构,不应直接从代码中使用。

(继承自 PreferenceGroup)
Title

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Preference)
TitleFormatted

返回此首选项的标题。 - 或 - 使用 CharSequence 设置此首选项的标题。

(继承自 Preference)
TitleRes

返回此首选项的游戏资源 ID。

(继承自 Preference)
WidgetLayoutResource

获取此首选项的可控制小组件部分的布局资源。 - 或 - 设置此首选项的可控制小组件部分的布局。

(继承自 Preference)

方法

AddItemFromInflater(Preference)

由膨胀器调用以将项添加到此组。

(继承自 PreferenceGroup)
AddPreference(Preference)

Preference根据首选项的顺序在正确位置添加 。

(继承自 PreferenceGroup)
Bind(ListView)

ListView通过 #getRootAdapter()将 绑定到此 PreferenceScreen 中包含的首选项。

CallChangeListener(Object)

在用户更改首选项之后,但在设置内部状态之前调用此方法。

(继承自 Preference)
Clone()

创建并返回此对象的副本。

(继承自 Object)
CompareTo(Preference)

如果设置) ,则根据顺序 (比较 Preference 对象,否则按字母顺序对标题进行比较。

(继承自 Preference)
DispatchRestoreInstanceState(Bundle)

调用 以 RestoreHierarchyState(Bundle) 检索此首选项及其子项的保存状态。

(继承自 PreferenceGroup)
DispatchSaveInstanceState(Bundle)

SaveHierarchyState(Bundle)由 调用以存储此首选项及其子级的 实例。

(继承自 PreferenceGroup)
Dispose()

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
Dispose(Boolean)

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
Equals(Object)

指示某个其他对象是否“等于”此对象。

(继承自 Object)
FindPreference(ICharSequence)

Preference基于其键查找 。

(继承自 PreferenceGroup)
FindPreference(String)

Preference基于其键查找 。

(继承自 PreferenceGroup)
FindPreferenceInHierarchy(String)

在此层次结构中查找首选项, (整个内容,甚至在屏幕中断) 的上方/下方 PreferenceScreen 使用给定键。

(继承自 Preference)
GetHashCode()

返回对象的哈希代码值。

(继承自 Object)
GetPersistedBoolean(Boolean)

如果此首选项是永久性的,则尝试获取持久化布尔值。

(继承自 Preference)
GetPersistedFloat(Single)

如果此首选项是永久性的,则尝试获取持久浮点数。

(继承自 Preference)
GetPersistedInt(Int32)

如果此首选项是永久性的,则尝试获取持久化 int。

(继承自 Preference)
GetPersistedLong(Int64)

如果此首选项是永久性的,则尝试获取持久化时间。

(继承自 Preference)
GetPersistedString(String)

如果此首选项是永久性的,则尝试获取持久字符串。

(继承自 Preference)
GetPersistedStringSet(ICollection<String>)

如果此首选项是永久性的,则尝试获取一组持久字符串。

(继承自 Preference)
GetPreference(Int32)

返回 Preference 特定索引处的 。

(继承自 PreferenceGroup)
GetView(View, ViewGroup)

获取将在 中显示的 PreferenceActivity视图。

(继承自 Preference)
JavaFinalize()

当垃圾回收确定不再引用对象时,由垃圾回收器对对象调用。

(继承自 Object)
Notify()

唤醒正在等待此对象的监视器的单个线程。

(继承自 Object)
NotifyAll()

唤醒正在等待此对象的监视器的所有线程。

(继承自 Object)
NotifyChanged()

当此 Preference 的数据发生更改时,应调用 。

(继承自 Preference)
NotifyDependencyChange(Boolean)

通知任何侦听依赖项影响依赖项的更改。

(继承自 Preference)
NotifyHierarchyChanged()

应在从此组中添加/删除首选项时调用,或者应重新评估排序。

(继承自 Preference)
OnAttachedToActivity()

在首选项层次结构已附加到 时调用 PreferenceActivity

(继承自 Preference)
OnAttachedToHierarchy(PreferenceManager)

当此首选项已附加到首选项层次结构时调用。

(继承自 Preference)
OnBindView(View)

将创建的视图绑定到此首选项的数据。

(继承自 Preference)
OnClick()

处理单击首选项。

(继承自 Preference)
OnCreateView(ViewGroup)

在 中 PreferenceActivity为此首选项创建要显示的视图。

(继承自 Preference)
OnDependencyChanged(Preference, Boolean)

在依赖项更改时调用。

(继承自 Preference)
OnDismiss(IDialogInterface)

关闭对话框时,将调用此方法。

OnGetDefaultValue(TypedArray, Int32)

当首选项被膨胀并且需要读取默认值属性时调用。

(继承自 Preference)
OnItemClick(AdapterView, View, Int32, Int64)
OnParentChanged(Preference, Boolean)

在隐式父依赖项更改时调用。

(继承自 Preference)
OnPrepareAddPreference(Preference)

Preference准备要添加到组中的 。

(继承自 PreferenceGroup)
OnPrepareForRemoval()

从层次结构中删除此首选项时调用。

(继承自 Preference)
OnRestoreInstanceState(IParcelable)

挂钩允许首选项重新应用其内部状态的表示形式,该表示形式以前由 #onSaveInstanceState生成。

(继承自 Preference)
OnSaveInstanceState()

挂钩允许首选项生成其内部状态的表示形式,该状态稍后可用于创建具有相同状态的新实例。

(继承自 Preference)
OnSetInitialValue(Boolean, Object)

实现此以设置首选项的初始值。

(继承自 Preference)
PeekExtras()

返回与此首选项关联的 extras Bundle 对象,如果当前没有,则返回 null

(继承自 Preference)
PersistBoolean(Boolean)

如果此首选项是永久性的,则尝试保留布尔值。

(继承自 Preference)
PersistFloat(Single)

如果此首选项是永久性的,则尝试保留一个长。

(继承自 Preference)
PersistInt(Int32)

如果此首选项是永久性的,则尝试保留 int。

(继承自 Preference)
PersistLong(Int64)

如果此首选项是永久性的,则尝试保留一个长。

(继承自 Preference)
PersistString(String)

如果此首选项是永久性的,则尝试保留字符串。

(继承自 Preference)
PersistStringSet(ICollection<String>)

如果此首选项是永久性的,则尝试保留一组字符串。

(继承自 Preference)
RemoveAll()

从此组中删除所有 Preference Preferences 内容。

(继承自 PreferenceGroup)
RemovePreference(Preference)

Preference从此组中删除 。

(继承自 PreferenceGroup)
RestoreHierarchyState(Bundle)

从给定容器还原此首选项层次结构以前保存的状态。

(继承自 Preference)
SaveHierarchyState(Bundle)

将此首选项层次结构的冻结状态存储到给定容器中。

(继承自 Preference)
SetDefaultValue(Object)

设置此首选项的默认值,如果持久性处于关闭状态或持久性处于打开状态,且在持久性存储中找不到首选项,则将设置该默认值。

(继承自 Preference)
SetHandle(IntPtr, JniHandleOwnership)

设置 Handle 属性。

(继承自 Object)
SetIcon(Int32)

使用资源 ID 设置此首选项的图标。

(继承自 Preference)
SetSummary(Int32)

使用资源 ID 设置此首选项的摘要。

(继承自 Preference)
SetTitle(Int32)

使用资源 ID 设置此首选项的标题。

(继承自 Preference)
ShouldCommit()

返回 是否 Preference 应提交其保存的值 (中的 #getEditor()) 。

(继承自 Preference)
ShouldDisableDependents()

检查当前是否应禁用此首选项的依赖项。

(继承自 Preference)
ShouldPersist()

检查在调用此方法的给定时间,此首选项是否应将其值存储/还原 () 到 SharedPreferencesPreferenceDataStore (如果分配) 中。

(继承自 Preference)
ToArray<T>()

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
ToString()

返回对象的字符串表示形式。

(继承自 Object)
UnregisterFromRuntime()

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
Wait()

导致当前线程等待,直到它被唤醒,通常是通过 em <通知/em> 或 <em>interrupted</em>。<>

(继承自 Object)
Wait(Int64)

导致当前线程等待,直到它被唤醒,通常是通过 em <通知/em> 或 <em>interrupted</em>,或直到经过一定数量的实时。<>

(继承自 Object)
Wait(Int64, Int32)

导致当前线程等待,直到它被唤醒,通常是通过 em <通知/em> 或 <em>interrupted</em>,或直到经过一定数量的实时。<>

(继承自 Object)

事件

PreferenceChange

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Preference)
PreferenceClick

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Preference)

显式接口实现

IComparable.CompareTo(Object)

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Preference)
IJavaPeerable.Disposed()

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
IJavaPeerable.DisposeUnlessReferenced()

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
IJavaPeerable.Finalized()

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
IJavaPeerable.JniManagedPeerState

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)
IJavaPeerable.SetPeerReference(JniObjectReference)

表示一个顶级 Preference ,它是首选项层次结构的根。

(继承自 Object)

扩展方法

JavaCast<TResult>(IJavaObject)

执行 Android 运行时检查的类型转换。

JavaCast<TResult>(IJavaObject)

表示一个顶级 Preference ,它是首选项层次结构的根。

GetJniTypeName(IJavaPeerable)

表示一个顶级 Preference ,它是首选项层次结构的根。

适用于