Apex 開発者ガイド
jStandardSetController クラス
StandardSetController オブジェクトを使用すると、Salesforce が提供する、プリビルドされた Visualforce リストコントローラと同様のリストコントローラ、またはその拡張としてリストコントローラを作成できます。
名前空間
使用方法
StandardSetController クラスには、プロトタイプオブジェクトも含まれます。これは、Visualforce の StandardSetController クラスに含まれる単一の sObject です。プロトタイプオブジェクトの項目が設定されている場合、それらの値は、保存操作中に使用されます。つまり、値は設定されたコントローラコレクションのすべてのレコードに適用されます。これは、一括更新 (オブジェクトのコレクション内の項目に同一の変更を適用) を実行するページを記述するときに役立ちます。
インスタンス化
次の��ずれかの方法で、StandardSetController をインスタンス化することができます。
- sObjects のリストを使用する場合:
- クエリロケータを使用する場合:
例
次の例では、StandardSetController オブジェクトのカスタムリストコントローラのコンストラクタでの使用方法を示します。
次の Visualforce マークアップは、上記のコントローラをページ内で使用する方法を示します。
StandardSetController コンストラクタ
StandardSetController のコンストラクタは次のとおりです。
StandardSetController(queryLocator)
クエリロケータによって返されるオブジェクトのリストの ApexPages.StandardSetController クラスのインスタンスを作成します。
署名
public StandardSetController(Database.QueryLocator queryLocator)
パラメータ
- queryLocator
- 型: Database.QueryLocator
- sObject のリストを表すクエリロケータ。
StandardSetController メソッド
StandardSetController のメソッドは次のとおりです。すべてインスタンスメソッドです。
cancel()
元のページ (わかっている場合)、またはホームページの PageReference を返します。
署名
public System.PageReference cancel()
戻り値
getCompleteResult()
セット内に存在するレコード数がレコード数の上限を超えているかどうかを示します。false の場合、レコード数がリストコントローラを使用して処理できる数を超えています。レコード数の上限は 10,000 レコードです。
署名
public Boolean getCompleteResult()
戻り値
型: Boolean
getListViewOptions()
現在のユーザが使用できるリストビューのリストを返します。
署名
public System.SelectOption getListViewOptions()
戻り値
型: System.SelectOption[]
getRecord()
選択したレコードへの変更を示す sObject を返します。クラス内に含まれるプロトタイプオブジェクトを取得し、一括更新の実行に使用されます。
署名
public sObject getRecord()
戻り値
型: sObject
getRecords()
現在のページセットにある sObject のリストを返します。このリストは不変であるため、clear() をコールできません。
署名
public sObject[] getRecords()
戻り値
型: sObject[]
save()
新しいレコードを挿入するか、変更された既存のレコードを更新します。この操作が完了した後、元のページ (わかっている場合)、またはホームページの PageReference を返します。
署名
public System.PageReference save()
戻り値
setFilterID(filterId)
コントローラの検索条件 ID を設定します。
署名
public Void setFilterID(String filterId)
パラメータ
- filterId
- 型: String
戻り値
型: Void
setpageNumber(pageNumber)
ページ番号を設定します。
署名
public Void setpageNumber(Integer pageNumber)
パラメータ
- pageNumber
- 型: Integer
戻り値
型: Void
setPageSize(pageSize)
各ページセット内のレコード数を設定します。
署名
public Void setPageSize(Integer pageSize)
パラメータ
- pageSize
- 型: Integer
戻り値
型: Void
setSelected(selectedRecords)
選択したレコードを設定します。
署名
public Void setSelected(sObject[] selectedRecords)
パラメータ
- selectedRecords
- 型: sObject[]
戻り値
型: Void