PreferenceScreen クラス

定義

名前空間:: Android.Preferences

アセンブリ:: Mono.Android.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

基本設定階層のルートである最上位レベルの 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

継承: Object

Object

Preference

PreferenceGroup
PreferenceScreen

属性: RegisterAttribute

実装: IDialogInterfaceOnDismissListener IJavaObject AdapterView.IOnItemClickListener IJavaPeerable IDisposable

注釈

基本設定階層のルートである最上位レベルの Preference を表します。 PreferenceActivityは、このクラスのインスタンスを指して基本設定を表示します。このクラスをインスタンス化するには、 PreferenceManager#createPreferenceScreen(Context)を使用します。 <ul> このクラスは、 <li>PreferenceActivity がこれを指している場合、ルートとして使用され、表示されません (含まれている基本設定のみが表示されます)。 <li> 別の基本設定階層内に表示されると、その画面が表示され、別の基本設定画面へのゲートウェイとして機能します (基本設定の別の画面をDialogとして表示するか、Preference#getIntent()のContext#startActivity(android.content.Intent)を介して表示されます)。この 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" であり、クリックすると、"Prefer WiFi" (および "second_preferencescreen" タグの子であるその他の設定) などの環境設定の別の画面が表示されます。

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

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

</部>

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

Javaドキュメント。

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

フィールド

名前	説明
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 に関連付けられているフラグメントクラス名を返します。または、この基本設定をクリックしたときに表示されるフラグメントのクラス名を設定します。 (継承元 Preference)
Handle	基になる Android インスタンスへのハンドル。 (継承元 Object)
HasKey	この基本設定に有効なキーがあるかどうかを確認します。 (継承元 Preference)
Icon	この基本設定のアイコンを返します。または、Drawable を使用してこの基本設定のアイコンを設定します。 (継承元 Preference)
IconSpaceReserved	この基本設定アイコンビューの領域が予約されているかどうかを取得します。または、アイコンが指定されていないときに、この基本設定アイコンビューの領域を予約するかどうかを設定します。 (継承元 Preference)
Intent	この基本設定に関連付けられている `Intent` を返します。または、この環境設定をクリックしたときに`Context#startActivity(Intent)`に使用する`Intent`を設定します。 (継承元 Preference)
IsOnSameScreenAsChildren	この基本設定グループを、含まれている基本設定と同じ画面に表示するかどうかを指定します。 (継承元 PreferenceGroup)
JniIdentityHashCode	基本設定階層のルートである最上位レベルの `Preference` を表します。 (継承元 Object)
JniPeerMembers	基本設定階層のルートである最上位レベルの `Preference` を表します。
Key	この基本設定のキーを取得します。これは、値を `SharedPreferences` または `PreferenceDataStore`に格納するために使用されるキーでもあります。または、 `SharedPreferences` または `PreferenceDataStore`のキーとして使用される、この基本設定のキーを設定します。 (継承元 Preference)
LayoutResource	この基本設定の `View` として表示されるレイアウトリソースを取得します。または、この基本設定に表示する `View` として拡張されるレイアウトリソースを設定します。 (継承元 Preference)
OnPreferenceChangeListener	この基本設定がユーザーによって変更されたときに呼び出されるコールバックを返します (ただし、内部状態が更新される前)。または、この基本設定がユーザーによって変更されたときに呼び出されるコールバックを設定します (ただし、内部状態が更新される前)。 (継承元 Preference)
OnPreferenceClickListener	この基本設定がクリックされたときに呼び出されるコールバックを返します。または、この基本設定がクリックされたときに呼び出されるコールバックを設定します。 (継承元 Preference)
Order	同じレベルの他の Preference オブジェクトに関するこの基本設定の順序を取得します。または、同じレベルの他の基本設定オブジェクトに対して、この基本設定の順序を設定します。 (継承元 Preference)
OrderingAsAdded	このグループが追加された順序の優先順位であるかどうか。または、このグループの `Preference` 子を追加時に並べ替えるかどうか。 (継承元 PreferenceGroup)
Parent	この基本設定がグループに割り当てられないか、ルート基本設定の場合は、この基本設定が割り当てられている `PreferenceGroup` または `null` を返します。 (継承元 Preference)
PeerReference	基本設定階層のルートである最上位レベルの `Preference` を表します。 (継承元 Object)
Persistent	この基本設定が永続的かどうかを確認します。または、この基本設定が永続的かどうかを設定します。 (継承元 Preference)
PreferenceCount	子 `Preference`の数を返します。 (継承元 PreferenceGroup)
PreferenceDataStore	この基本設定で使用 `PreferenceDataStore` を返します。または、`android.content.SharedPreferences`を使用するのではなく、この基本設定で使用する`PreferenceDataStore`を設定します。 (継承元 Preference)
PreferenceManager	この Preference オブジェクトのツリーを管理する `PreferenceManager` を取得します。 (継承元 Preference)
RecycleEnabled	リストビューで使用するときに、このユーザー設定でビューのリサイクルが有効になっているかどうかを確認します。または、リストビューで使用する場合に、この基本設定でビューのリサイクルを有効にするかどうかを設定します。 (継承元 Preference)
RootAdapter	`PreferenceActivity`または`PreferenceFragment`に接続して、この`PreferenceScreen`に含まれる基本設定を表示できるアダプターを返します。
Selectable	この基本設定を一覧で選択できるかどうかを確認します。または、この基本設定を選択可能にするかどうかを設定します。 (継承元 Preference)
SharedPreferences	このユーザー設定が値を読み取ることができる `SharedPreferences` を返します。 (継承元 Preference)
ShouldDisableView	アクションが無効になっているときに、このユーザー設定でビューを無効にするかどうかを確認します。または、このユーザー設定が無効になったときにビューを無効にするかどうかを設定します。 (継承元 Preference)
SingleLineTitle	この基本設定のタイトルが 1 行に制限されているかどうかを取得します。または、この基本設定のタイトルを複数の行に折り返すのではなく、1 行に制限するかどうかを設定します。 (継承元 Preference)
Summary	基本設定階層のルートである最上位レベルの `Preference` を表します。 (継承元 Preference)
SummaryFormatted	この基本設定の概要を返します。または、CharSequence を使用してこの基本設定の概要を設定します。 (継承元 Preference)
ThresholdClass	この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。 (継承元 PreferenceGroup)
ThresholdType	この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。 (継承元 PreferenceGroup)
Title	基本設定階層のルートである最上位レベルの `Preference` を表します。 (継承元 Preference)
TitleFormatted	この基本設定のタイトルを返します。または、CharSequence を使用してこの基本設定のタイトルを設定します。 (継承元 Preference)
TitleRes	この基本設定のタイトルリソース ID を返します。 (継承元 Preference)
WidgetLayoutResource	この基本設定の制御可能なウィジェット部分のレイアウトリソースを取得します。または、この基本設定の制御可能なウィジェット部分のレイアウトを設定します。 (継承元 Preference)

メソッド

名前	説明
AddItemFromInflater(Preference)	このグループに項目を追加するために、インフレータによって呼び出されます。 (継承元 PreferenceGroup)
AddPreference(Preference)	ユーザー設定の順序に基づいて、正しい位置に `Preference` を追加します。 (継承元 PreferenceGroup)
Bind(ListView)	`#getRootAdapter()`を介して、この`PreferenceScreen`に含まれる基本設定に`ListView`をバインドします。
CallChangeListener(Object)	ユーザーが基本設定を変更した後、内部状態が設定される前に、このメソッドを呼び出します。 (継承元 Preference)
Clone()	このオブジェクトのコピーを作成して返します。 (継承元 Object)
CompareTo(Preference)	順序 (設定されている場合) に基づいて基本設定オブジェクトを比較します。それ以外の場合はタイトルのアルファベット順に比較します。 (継承元 Preference)
DispatchRestoreInstanceState(Bundle)	この Preference とその子の保存された状態を取得するために、 RestoreHierarchyState(Bundle) によって呼び出されます。 (継承元 PreferenceGroup)
DispatchSaveInstanceState(Bundle)	この Preference とその子のインスタンスを格納するために、 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)	この基本設定が永続的な場合は、永続化された float の取得を試みます。 (継承元 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()	このオブジェクトのモニターで待機している 1 つのスレッドを起動します。 (継承元 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 が拡張され、既定値の属性を読み取る必要がある場合に呼び出されます。 (継承元 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()	このメソッドが呼び出された時点で、この Preference の値を `SharedPreferences` に格納するか、割り当てられている場合は `PreferenceDataStore` に復元するかを確認します。 (継承元 Preference)
ToArray<T>()	基本設定階層のルートである最上位レベルの `Preference` を表します。 (継承元 Object)
ToString()	オブジェクトの文字列形式を返します。 (継承元 Object)
UnregisterFromRuntime()	基本設定階層のルートである最上位レベルの `Preference` を表します。 (継承元 Object)
Wait()	現在のスレッドが起動するまで待機します。通常は、 <em>notified</em> または <em>interrupted</em>。 (継承元 Object)
Wait(Int64, Int32)	現在のスレッドは、通常、 <em>notified</em> または <em>interrupted</em>、または一定のリアルタイムが経過するまで、起動されるまで待機します。 (継承元 Object)
Wait(Int64)	現在のスレッドは、通常、 <em>notified</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)

拡張メソッド

名前	説明
GetJniTypeName(IJavaPeerable)	インスタンス `self`の型の JNI 名を取得します。
JavaAs<TResult>(IJavaPeerable)	`self`を強制的に`TResult`入力し、強制型がJava側で有効であることを確認します。
JavaCast<TResult>(IJavaObject)	Android ランタイムチェック型変換を実行します。
JavaCast<TResult>(IJavaObject)	基本設定階層のルートである最上位レベルの `Preference` を表します。
TryJavaCast<TResult>(IJavaPeerable, TResult)	`self`を強制的に`TResult`入力し、強制型がJava側で有効であることを確認します。

適用対象