Share via


Preference 类

定义

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

[Android.Runtime.Register("android/preference/Preference", DoNotGenerateAcw=true)]
public class Preference : Java.Lang.Object, IDisposable, Java.Interop.IJavaPeerable, Java.Lang.IComparable
[<Android.Runtime.Register("android/preference/Preference", DoNotGenerateAcw=true)>]
type Preference = class
    inherit Object
    interface IComparable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
继承
Preference
派生
属性
实现

注解

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。 此类提供 View 要显示在活动中的 ,并与 关联 SharedPreferences 以存储/检索首选项数据。

在 XML 中指定首选项层次结构时,每个元素都可以指向 的 Preference子类,类似于视图层次结构和布局。

此类包含 key 将用作 中的键的 SharedPreferences。 由子类决定如何存储值。

<div class=“special reference”><h3>开发人员指南</h3>

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

</Div>

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

android.preference.PreferenceJava 文档。

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

构造函数

Preference(Context)

用于创建首选项的构造函数。

Preference(Context, IAttributeSet)

从 XML 扩充首选项时调用的构造函数。

Preference(Context, IAttributeSet, Int32)

从 XML 执行膨胀并应用特定于类的基本样式。

Preference(Context, IAttributeSet, Int32, Int32)

从 XML 执行膨胀并应用特定于类的基本样式。

Preference(IntPtr, JniHandleOwnership)

创建 JNI 对象的托管表示形式时使用的构造函数;由运行时调用。

字段

DefaultOrder

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

属性

Class

返回此 Object的运行时类。

(继承自 Object)
Context

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

Dependency

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

Editor

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

Enabled

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

Extras

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

Fragment

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

Handle

基础 Android 实例的句柄。

(继承自 Object)
HasKey

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

Icon

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

IconSpaceReserved

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

Intent

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

JniIdentityHashCode

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 Object)
JniPeerMembers

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

Key

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

LayoutResource

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

OnPreferenceChangeListener

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

OnPreferenceClickListener

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

Order

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

Parent

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

PeerReference

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 Object)
Persistent

检查此首选项是否是永久性的。 - 或 - 设置此首选项是否是永久性的。

PreferenceDataStore

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

PreferenceManager

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

RecycleEnabled

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

Selectable

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

SharedPreferences

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

ShouldDisableView

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

SingleLineTitle

获取此首选项的标题是否限制为单行。 - 或 - 设置是否将此首选项的标题限制为单行,而不是让它环绕到多行。

Summary

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

SummaryFormatted

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

ThresholdClass

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

ThresholdType

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

Title

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

TitleFormatted

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

TitleRes

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

WidgetLayoutResource

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

方法

CallChangeListener(Object)

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

Clone()

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

(继承自 Object)
CompareTo(Preference)

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

Dispose()

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 Object)
Dispose(Boolean)

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 Object)
Equals(Object)

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

(继承自 Object)
FindPreferenceInHierarchy(String)

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

GetHashCode()

返回对象的哈希代码值。

(继承自 Object)
GetPersistedBoolean(Boolean)

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

GetPersistedFloat(Single)

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

GetPersistedInt(Int32)

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

GetPersistedLong(Int64)

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

GetPersistedString(String)

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

GetPersistedStringSet(ICollection<String>)

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

GetView(View, ViewGroup)

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

JavaFinalize()

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

(继承自 Object)
Notify()

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

(继承自 Object)
NotifyAll()

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

(继承自 Object)
NotifyChanged()

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

NotifyDependencyChange(Boolean)

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

NotifyHierarchyChanged()

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

OnAttachedToActivity()

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

OnAttachedToHierarchy(PreferenceManager)

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

OnBindView(View)

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

OnClick()

单击首选项进行处理。

OnCreateView(ViewGroup)

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

OnDependencyChanged(Preference, Boolean)

在依赖项更改时调用。

OnGetDefaultValue(TypedArray, Int32)

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

OnParentChanged(Preference, Boolean)

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

OnPrepareForRemoval()

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

OnRestoreInstanceState(IParcelable)

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

OnSaveInstanceState()

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

OnSetInitialValue(Boolean, Object)

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

PeekExtras()

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

PersistBoolean(Boolean)

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

PersistFloat(Single)

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

PersistInt(Int32)

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

PersistLong(Int64)

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

PersistString(String)

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

PersistStringSet(ICollection<String>)

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

RestoreHierarchyState(Bundle)

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

SaveHierarchyState(Bundle)

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

SetDefaultValue(Object)

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

SetHandle(IntPtr, JniHandleOwnership)

设置 Handle 属性。

(继承自 Object)
SetIcon(Int32)

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

SetSummary(Int32)

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

SetTitle(Int32)

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

ShouldCommit()

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

ShouldDisableDependents()

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

ShouldPersist()

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

ToArray<T>()

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 Object)
ToString()

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

(继承自 Object)
UnregisterFromRuntime()

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 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

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

PreferenceClick

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

显式接口实现

IComparable.CompareTo(Object)

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

IJavaPeerable.Disposed()

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 Object)
IJavaPeerable.DisposeUnlessReferenced()

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 Object)
IJavaPeerable.Finalized()

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 Object)
IJavaPeerable.JniManagedPeerState

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

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

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

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

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

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

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

(继承自 Object)

扩展方法

JavaCast<TResult>(IJavaObject)

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

JavaCast<TResult>(IJavaObject)

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

GetJniTypeName(IJavaPeerable)

表示以 PreferenceActivity 的形式 ListView由 显示的基本首选项 UI 构建基块。

适用于