apex:pageBlockTable
標準の Salesforce ページの関連リストまたはリストビューに類似した、<apex:pageBlock> コンポーネントまたは <apex:pageBlockSection> コンポーネントのいずれかにテーブルとして表示されるデータのリストです。<apex:dataTable> と同様に、<apex:pageBlockTable> は一連のデータを反復することによって定義され、1 行あたり 1 つのデータ項目に関する情報を表示します。一連のデータには最大 1,000 個または 10,000 個 (参照のみモードでページを実行する場合) の項目を含めることができます。
<apex:pageBlockTable> の本文には、テーブルに似た、データの各項目に関して表示する情報を指定する 1 つ以上の列コンポーネントが含まれます。<apex:dataTable> コンポーネントとは異なり、<apex:pageBlockTable> のデフォルトのスタイルは、標準の Salesforce スタイルに一致します。<apex:pageBlockTable> 属性で指定されたその他のスタイルは、標準の Salesforce スタイルに追加されます。
列の value 属性として sObject 項目を指定した場合、デフォルトで、その項目の関連する表示ラベルが列ヘッダーとして使用されます。この動作を上書きするには、列の headerValue 属性か、または列の header ファセットを使用します。
Salesforce.com API バージョン 20.0 以降が稼動している Visualforce ページでは、このコンポーネントに <apex:repeat> タグを含めて列を生成できます。
このコンポーネントでは、「html-」プレフィックスを使用した HTML パススルー属性がサポートされています。パススルー属性は、生成されたテーブルの <tbody> タグに適用されます。
例
属性
| 属性名 | 属性型 | 説明 | 必須かどうか | API バージョン | 通用範囲 |
|---|---|---|---|---|---|
| align | String | 表示される HTML テーブルのページに対する位置。使用できる値には、「left」、「center」、または「right」があります。指定されていない状態にすると、この値はデフォルトの「left」に設定されます。 | 12.0 | グローバル | |
| bgcolor | String | この属性は Salesforce API バージョン 18.0 では使用できなくなりました。ページへの影響はありません。 | 12.0 | グローバル | |
| border | String | 表示される HTML テーブルの周囲のフレームの幅 (ピクセル単位)。 | 12.0 | グローバル | |
| captionClass | String | caption ファセットが指定されている場合、表示される HTML テーブルのキャプションの表示に使用されるスタイルクラス。この属性は、主に、外部 CSS スタイルシートを使用するときに適用される CSS スタイルを指定するために使用されます。 | 12.0 | グローバル | |
| captionStyle | String | caption ファセットが指定されている場合、表示される HTML テーブルのキャプションの表示に使用されるスタイル。この属性は、主に、インライン CSS スタイルを追加するために使用されます。 | 12.0 | グローバル | |
| cellpadding | String | 各リストのセルの境界線とセルのコンテンツの間のスペース。この属性の値がピクセル単位の長さである場合、4 辺の余白のすべてでコンテンツからの距離がこの値に設定されます。属性の値がパーセント単位の長さである場合は、上下の余白は利用可能な縦方向のスペースのパーセントに基づいてコンテンツからの距離が上下均等の長さに分割され、左右の余白は利用可能な横方向のスペースのパーセントに基づいてコンテンツからの距離が左右均等の長さに分割されます。 | 12.0 | グローバル | |
| cellspacing | String | 各リストのセルの境界線とそのセルを取り囲む他のセルの境界線および/またはリストの端の間のスペース。この値はピクセルまたはパーセント単位で指定する必要があります。 | 12.0 | グローバル | |
| columnClasses | String | リストの列に関連付けられた 1 つ以上のクラスのカンマ区切りのリスト。主に、外部 CSS スタイルシートを使用するときに適用される CSS スタイルを指定するために使用されます。 複数のクラスが指定されている場合、クラスはすべての列に繰り返し適用されます。たとえば、columnClasses="classA, classB" と指定すると、最初の列は classA でスタイル設定され、2 番目の列は classB でスタイル設定され、3 番目の列は classA でスタイル設定され、4 番目の列は classB でスタイル設定されます (以下同様)。 |
12.0 | グローバル | |
| columns | Integer | このページブロックテーブルの列の数。 | 12.0 | グローバル | |
| columnsWidth | String | 各リストの列に適用される幅のカンマ区切りのリスト。値はピクセルで表すことができます (columnsWidth="100px, 100px" など)。 | 12.0 | グローバル | |
| dir | String | 生成された HTML コンポーネントの読み取り方向。使用可能な値には「RTL」(右から左) または「LTR」(左から右) があります。 | 12.0 | グローバル | |
| first | Integer | ページブロックテーブルに視覚的に表示される反復処理の最初の要素。ここで、0 は value 属性で指定されている一連のデータの最初の要素のインデックスです。たとえば、value 属性で指定されている一連のレコードの最初の 2 つの要素を表示しない場合は、first="2" と設定します。 | 12.0 | グローバル | |
| footerClass | String | footer ファセットが指定されている場合、表示される HTML テーブルのフッター (一番下の行) を表示するために使用されるスタイルクラス。この属性は、主に、外部 CSS スタイルシートを使用するときに適用される CSS スタイルを指定するために使用されます。 | 12.0 | グローバル | |
| frame | String | このページブロックテーブルに引かれる境界線。使用できる値には、「none」、「above」、「below」、「hsides」、「vsides」、「lhs」、「rhs」、「box」、および「border」があります。指定されていない場合、この値はデフォルトの「border」に設定されます。 | 12.0 | グローバル | |
| headerClass | String | header ファセットが指定されている場合、表示される HTML テーブルのヘッダーの表示に使用されるスタイルクラス。この属性は、主に、外部 CSS スタイルシートを使用するときに適用される CSS スタイルを指定するために使用されます。 | 12.0 | グローバル | |
| id | String | ページの他のコンポーネントが pageBlockTable コンポーネントを参照できるようにする識別子。 | 12.0 | グローバル | |
| lang | String | 「en」または「en-US」など、生成された HTML 出力の基本言語。この属性についての詳細は、W3C 仕様を参照してください。 | 12.0 | グローバル | |
| onclick | String | onclick イベントが発生した場合 (ユーザがページブロックテーブルをクリックした場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| ondblclick | String | ondblclick イベントが発生した場合 (ユーザがページブロックテーブルをダブルクリックした場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onkeydown | String | onkeydown イベントが発生した場合 (ユーザがキーボードのキーを押した場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onkeypress | String | onkeypress イベントが発生した場合 (ユーザがキーボードのキーを押したか、押したままにした場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onkeyup | String | onkeyup イベントが発生した場合 (ユーザがキーボードのキーを放した場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onmousedown | String | onmousedown イベントが発生した場合 (ユーザがマウスボタンをクリックした場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onmousemove | String | onmousemove イベントが発生した場合 (ユーザがマウスポインタを移動した場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onmouseout | String | onmouseout イベントが発生した場合 (ユーザがページブロックテーブルからマウスポインタを移動した場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onmouseover | String | onmouseover イベントが発生した場合 (ユーザがページブロックテーブルにマウスポインタを重ねた場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onmouseup | String | onmouseup イベントが発生した場合 (ユーザがマウスボタンを放した場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onRowClick | String | onRowClick イベントが発生した場合 (ユーザがページブロックテーブルの行をクリックした場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onRowDblClick | String | onRowDblClick イベントが発生した場合 (ユーザがページブロックリストテーブルの行をクリックした場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onRowMouseDown | String | onRowMouseDown イベントが発生した場合 (ユーザがページブロックテーブルの行でマウスボタンをクリックした場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onRowMouseMove | String | onRowMouseMove イベントが発生した場合 (ユーザがマウスポインタをページブロックテーブルの行に重ねた場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onRowMouseOut | String | onRowMouseOut イベントが発生した場合 (ユーザがページブロックテーブルの行からマウスポインタを移動した場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onRowMouseOver | String | onRowMouseOver イベントが発生した場合 (ユーザがページブロックテーブルの行にマウスポインタを重ねた場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| onRowMouseUp | String | onRowMouseUp イベントが発生した場合 (ユーザがページブロックテーブルの行の上でマウスボタンを放した場合) に呼び出される JavaScript。 | 12.0 | グローバル | |
| rendered | Boolean | コンポーネントをページに表示するかどうかを指定する boolean 値。指定されていない場合、この値はデフォルトの true に設定されます。 | 12.0 | グローバル | |
| rowClasses | String | ページブロックテーブルの行に関連付けられた 1 つ以上のクラスのカンマ区切りのリスト。主に、外部 CSS スタイルシートを使用するときに適用される CSS スタイルを指定するために使用されます。 複数のクラスが指定されている場合、それらのクラスがすべての行に繰り返し適用されます。たとえば、columnRows="classA, classB" と指定すると、最初の行は classA でスタイル設定され、2 番目の行は classB でスタイル設定され、3 番目の行は classA でスタイル設定され、4 番目の行は classB でスタイル設定されます (以下同様)。 |
12.0 | グローバル | |
| rows | Integer | このページブロックテーブルの行の数。 | 12.0 | グローバル | |
| rules | String | ページブロックテーブルのセルの間に引かれる境界線。使用できる値には、「none」、「groups」、「rows」、「cols」、および「all」があります。指定されていない場合、この値はデフォルトの「none」に設定されます。 | 12.0 | グローバル | |
| style | String | pageBlockTable コンポーネントの表示に使用されるスタイル。主に、インライン CSS スタイルを追加するために使用されます。 | 12.0 | グローバル | |
| styleClass | String | pageBlockTable コンポーネントの表示に使用されるスタイルクラス。主に、外部 CSS スタイルシートを使用するときに適用される CSS スタイルを指定するために使用されます。 | 12.0 | グローバル | |
| summary | String | セクション 508 の準拠に関するページブロックテーブルの目的と構造の概要。 | 12.0 | グローバル | |
| title | String | ユーザがコンポーネントにマウスポインタを重ねたときにツールチップとして表示されるテキスト。 | 12.0 | グローバル | |
| value | Object | ページブロックテーブルに表示されるデータのコレクション。 | はい | 12.0 | グローバル |
| var | String | value 属性で指定するデータのコレクションの 1 つの要素を表す変数の名前。この変数を使用して、pageBlockTable コンポーネントタグの本文に要素自体を表示することができます。 | はい | 12.0 | グローバル |
| width | String | pageBlockTable 全体の幅。利用可能な横方向の合計スペースに対する相対パーセント (width="80%" など)、またはピクセル数 (width="800px" など) のいずれかで表されます。 | 12.0 | グローバル |
ファセット
| ファセット名 | 説明 | API バージョン |
|---|---|---|
| caption | ページブロックテーブルのキャプションに表示されるコンポーネント。テーブルのキャプションの表示は、name="caption" を含むファセットによって制御されるため、caption ファセットが pageBlockTable コンポーネントの本文に表示される順序は重要ではありません。 | 12.0 |
| footer | ページブロックテーブルのフッター行に表示されるコンポーネント。テーブルの最終行の表示は、name="footer" を含むファセットによって制御されるため、footer ファセットが pageBlockTable コンポーネントの本文に表示される順序は重要ではありません。 | 12.0 |
| header | ページブロックテーブルのヘッダー行に表示されるコンポーネント。テーブルの冒頭行の表示は、name="header" を含むファセットによって制御されるため、header ファセットが pageBlockTable コンポーネントの本文に表示される順序は重要ではありません。 | 12.0 |