Preference クラス

定義

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

[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 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。 このクラスは、アクティビティに表示される を提供 View し、 に関連付けて SharedPreferences 基本設定データを格納または取得します。

XML でユーザー設定階層を指定する場合、各要素は、ビュー階層やレイアウトと同様に、 の Preferenceサブクラスを指すことができます。

このクラスには、 への key キー SharedPreferencesとして使用される が含まれています。 値の格納方法を決定するのはサブクラス次第です。

<div class="special reference"><h3>Developer Guides</h3>

基本設定を使用して設定 UI を構築する方法については、 設定 ガイドを参照してください。

</部>

このメンバーは非推奨とされます。 すべてのデバイスで一貫した動作を行う場合は、 AndroidX 基本設定ライブラリ を使用します。 AndroidX 環境設定ライブラリの使用方法の詳細については、「 設定」を参照してください。

の Java ドキュメント android.preference.Preference

このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。

コンストラクター

Preference(Context)

ユーザー設定を作成するコンストラクター。

Preference(Context, IAttributeSet)

XML から Preference を拡張するときに呼び出されるコンストラクター。

Preference(Context, IAttributeSet, Int32)

XML からインフレーションを実行し、クラス固有の基本スタイルを適用します。

Preference(Context, IAttributeSet, Int32, Int32)

XML からインフレーションを実行し、クラス固有の基本スタイルを適用します。

Preference(IntPtr, JniHandleOwnership)

JNI オブジェクトのマネージド表現を作成するときに使用されるコンストラクター。ランタイムによって呼び出されます。

フィールド

DefaultOrder

特定の注文が不要な場合は、 に を #setOrder(int) 指定します。

プロパティ

Class

この Objectのランタイム クラスを返します。

(継承元 Object)
Context

この Preference の を android.content.Context 返します。

Dependency

この Preference に対する依存関係のキーを返します。 または、この環境設定が依存する環境設定のキーを設定します。

Editor

SharedPreferences.Editorこの Preference で値を保存できる を返します。

Enabled

この基本設定を一覧で有効にする必要があるかどうかを確認します。 または、この環境設定を有効にするかどうかを設定します。

Extras

この基本設定に関連付けられている extras Bundle オブジェクトを返し、現在存在しない場合は新しい Bundle を作成します。

Fragment

この Preference に関連付けられているフラグメント クラス名を返します。 または、この基本設定をクリックしたときに表示されるフラグメントのクラス名を設定します。

Handle

基になる Android インスタンスへのハンドル。

(継承元 Object)
HasKey

この基本設定に有効なキーがあるかどうかを確認します。

Icon

この基本設定のアイコンを返します。 または、 [描画可能] を使用して、この基本設定のアイコンを設定します。

IconSpaceReserved

この基本設定アイコン ビューの領域が予約されているかどうかを取得します。 または、 アイコンが指定されていないときに、この基本設定アイコン ビューの領域を予約するかどうかを設定します。

Intent

この Preference に関連付けられている を Intent 返します。 または、この基本設定をクリックしたときに使用Context#startActivity(Intent)する を設定Intentします。

JniIdentityHashCode

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
JniPeerMembers

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

Key

この Preference のキーを取得します。これは、 または PreferenceDataStoreSharedPreferences値を格納するために使用されるキーでもあります。 または、 または のキーとして使用される、この Preference のキーをSharedPreferencesPreferenceDataStore設定します。

LayoutResource

この Preference の として表示されるレイアウト リソースを View 取得します。 または、この基本設定で表示される として View 拡張されるレイアウト リソースを設定します。

OnPreferenceChangeListener

このユーザー設定がユーザーによって変更されたときに呼び出されるコールバックを返します (ただし、内部状態が更新される前)。 または、 ユーザーによってこの基本設定が変更されたときに (ただし、内部状態が更新される前に) コールバックを呼び出されるように設定します。

OnPreferenceClickListener

この Preference がクリックされたときに呼び出されるコールバックを返します。 または、この基本設定がクリックされたときに呼び出されるコールバックを設定します。

Order

同じレベルの他の Preference オブジェクトに関するこの Preference の順序を取得します。 または、同じレベルの他の Preference オブジェクトに対して、この Preference の順序を設定します。

Parent

このユーザー設定が PreferenceGroup 割り当てられている か、この基本設定がグループに null 割り当てられないか、ルートの Preference である 場合は を返します。

PeerReference

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
Persistent

この基本設定が永続的であるかどうかを確認します。 または、この基本設定が永続的かどうかを設定します。

PreferenceDataStore

PreferenceDataStoreこの Preference で使用される を返します。 または、 を使用する代わりに、この Preference で使用android.content.SharedPreferencesする を設定PreferenceDataStoreします。

PreferenceManager

この Preference オブジェクトの PreferenceManager ツリーを管理する を取得します。

RecycleEnabled

リスト ビューで使用するときに、このユーザー設定でビューのリサイクルが有効になっているかどうかを確認します。 または、 リスト ビューで使用するときに、このユーザー設定でビューのリサイクルを有効にするかどうかを設定します。

Selectable

この基本設定を一覧で選択できるかどうかを確認します。 または、この環境設定を選択可能にするかどうかを設定します。

SharedPreferences

この Preference が値を SharedPreferences 読み取ることができる 場所を返します。

ShouldDisableView

アクションが無効になっているときに、このユーザー設定でビューを無効にする必要があるかどうかを確認します。 または、このユーザー設定が無効になったときにビューを無効にするかどうかを設定します。

SingleLineTitle

この基本設定のタイトルが 1 行に制限されているかどうかを取得します。 または、複数の行に折り返すのではなく、この Preference のタイトルを 1 行に制限するかどうかを設定します。

Summary

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

SummaryFormatted

この基本設定の概要を返します。 または、CharSequence を使用してこの基本設定の概要を設定します。

ThresholdClass

この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用することを意図したものではありません。

ThresholdType

この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用することを意図したものではありません。

Title

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

TitleFormatted

この Preference のタイトルを返します。 または、CharSequence を使用してこの基本設定のタイトルを設定します。

TitleRes

この Preference のタイトル リソース ID を返します。

WidgetLayoutResource

この Preference の制御可能なウィジェット部分のレイアウト リソースを取得します。 または、この基本設定の制御可能なウィジェット部分のレイアウトを設定します。

メソッド

CallChangeListener(Object)

ユーザーが基本設定を変更した後、内部状態が設定される前に、このメソッドを呼び出します。

Clone()

このオブジェクトのコピーを作成して返します。

(継承元 Object)
CompareTo(Preference)

順序 (設定されている場合) に基づいて Preference オブジェクトを比較します。それ以外の場合はタイトルのアルファベット順に比較します。

Dispose()

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
Dispose(Boolean)

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
Equals(Object)

他のオブジェクトがこのオブジェクトと "等しい" かどうかを示します。

(継承元 Object)
FindPreferenceInHierarchy(String)

指定されたキーを使用して、この階層内のユーザー設定 (画面の中断の上/下 PreferenceScreen でも、全体) を検索します。

GetHashCode()

オブジェクトのハッシュ コード値を返します。

(継承元 Object)
GetPersistedBoolean(Boolean)

この Preference が永続的な場合に、永続化されたブール値の取得を試みます。

GetPersistedFloat(Single)

この Preference が永続的な場合に、永続化された float の取得を試みます。

GetPersistedInt(Int32)

この基本設定が永続的な場合は、永続化された int の取得を試みます。

GetPersistedLong(Int64)

この基本設定が永続的な場合に、永続化された長いを取得しようとします。

GetPersistedString(String)

この設定が永続的な場合は、永続化された文字列の取得を試みます。

GetPersistedStringSet(ICollection<String>)

この基本設定が永続的な場合は、永続化された文字列のセットを取得しようとします。

GetView(View, ViewGroup)

に表示されるビューを取得します PreferenceActivity

JavaFinalize()

ガベージ コレクションがオブジェクトへの参照がなくなったと判断したときに、オブジェクトのガベージ コレクターによって呼び出されます。

(継承元 Object)
Notify()

このオブジェクトのモニターで待機している 1 つのスレッドをウェイクアップします。

(継承元 Object)
NotifyAll()

このオブジェクトのモニターで待機しているすべてのスレッドをウェイクアップします。

(継承元 Object)
NotifyChanged()

この Preference データが変更されたときに呼び出す必要があります。

NotifyDependencyChange(Boolean)

依存関係に影響を与える変更をリッスンしている依存ユーザーに通知します。

NotifyHierarchyChanged()

このグループにユーザー設定が追加または削除されたとき、または順序を再評価する必要がある場合に呼び出す必要があります。

OnAttachedToActivity()

ユーザー設定階層が にアタッチされている場合に PreferenceActivity呼び出されます。

OnAttachedToHierarchy(PreferenceManager)

このユーザー設定がユーザー設定階層にアタッチされている場合に呼び出されます。

OnBindView(View)

作成したビューをこの Preference のデータにバインドします。

OnClick()

ユーザー設定のクリックを処理します。

OnCreateView(ViewGroup)

この基本設定に表示するビューを に作成します PreferenceActivity

OnDependencyChanged(Preference, Boolean)

依存関係が変更されたときに呼び出されます。

OnGetDefaultValue(TypedArray, Int32)

Preference が拡張され、既定値属性を読み取る必要がある場合に呼び出されます。

OnParentChanged(Preference, Boolean)

暗黙的な親依存関係が変更されたときに呼び出されます。

OnPrepareForRemoval()

この基本設定が階層から削除されるときに呼び出されます。

OnRestoreInstanceState(IParcelable)

フックを使用すると、 によって以前に生成された内部状態の表現をユーザー設定で #onSaveInstanceState再適用できます。

OnSaveInstanceState()

フックを使用すると、後で同じ状態の新しいインスタンスを作成するために使用できる内部状態の表現を生成できます。

OnSetInitialValue(Boolean, Object)

これを実装して、Preference の初期値を設定します。

PeekExtras()

この基本設定に関連付けられている extras Bundle オブジェクトを返し、現在存在しない場合は を null 返します。

PersistBoolean(Boolean)

この Preference が永続的な場合にブール値の永続化を試みます。

PersistFloat(Single)

この設定が永続的な場合は、長いを保持しようとします。

PersistInt(Int32)

この基本設定が永続的な場合は、int の永続化を試みます。

PersistLong(Int64)

この設定が永続的な場合は、長いを保持しようとします。

PersistString(String)

この基本設定が永続的な場合は、文字列の永続化を試みます。

PersistStringSet(ICollection<String>)

この設定が永続的な場合は、文字列のセットを保持しようとします。

RestoreHierarchyState(Bundle)

この Preference 階層の以前に保存された状態を、指定されたコンテナーから復元します。

SaveHierarchyState(Bundle)

この Preference 階層の固定状態を、指定されたコンテナーに格納します。

SetDefaultValue(Object)

この Preference の既定値を設定します。これは、永続化がオフの場合、または永続化がオンで、永続ストレージに優先順位が見つからない場合に設定されます。

SetHandle(IntPtr, JniHandleOwnership)

Handle プロパティを設定します。

(継承元 Object)
SetIcon(Int32)

リソース ID を使用して、この Preference のアイコンを設定します。

SetSummary(Int32)

リソース ID を使用して、この基本設定の概要を設定します。

SetTitle(Int32)

リソース ID を使用して、この Preference のタイトルを設定します。

ShouldCommit()

Preference 保存された値 #getEditor()を コミットするかどうかを返します。

ShouldDisableDependents()

この基本設定の依存が現在無効になっているかどうかを確認します。

ShouldPersist()

このメソッドが呼び出された時点で、この Preference が割り当てられている場合、その値を または にSharedPreferencesPreferenceDataStore格納または復元する必要があるかどうかを確認します。

ToArray<T>()

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
ToString()

オブジェクトの文字列形式を返します。

(継承元 Object)
UnregisterFromRuntime()

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
Wait()

現在のスレッドが起動するまで待機します。通常<>は、通知</em> または <em>割り込み</em によって待機します>。

(継承元 Object)
Wait(Int64)

現在のスレッドが起動するまで待機します。通常<>は、通知</em> または>< em 割り込み</em>、または一定のリアルタイムが経過するまで待機します。

(継承元 Object)
Wait(Int64, Int32)

現在のスレッドが起動するまで待機します。通常<>は、通知</em> または>< em 割り込み</em>、または一定のリアルタイムが経過するまで待機します。

(継承元 Object)

イベント

PreferenceChange

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

PreferenceClick

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

明示的なインターフェイスの実装

IComparable.CompareTo(Object)

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

IJavaPeerable.Disposed()

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
IJavaPeerable.DisposeUnlessReferenced()

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
IJavaPeerable.Finalized()

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
IJavaPeerable.JniManagedPeerState

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)
IJavaPeerable.SetPeerReference(JniObjectReference)

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

(継承元 Object)

拡張メソッド

JavaCast<TResult>(IJavaObject)

Android ランタイムチェック型変換を実行します。

JavaCast<TResult>(IJavaObject)

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

GetJniTypeName(IJavaPeerable)

によって PreferenceActivity 表示される基本的なユーザー設定 UI 構成要素を の ListView形式で表します。

適用対象