apex:actionSupport
他のコンポーネントに AJAX サポートを追加するコンポーネントです。このコンポーネントでは、ボタンのクリック、マウスを重ねるなどの特定のイベントの発生時にサーバーが非同期にコンポーネントを更新できます。
このコンポーネントを使用して、sObject の項目に対応しないコントローラーメソッドのユーザー入力を取得します。sObject 項目で使用できるのは、<apex:inputField> と <apex:outputField> のみです。
<apex:actionFunction> も参照してください。
例
1<!-- Page: -->
2<apex:page controller="exampleCon">
3 <apex:form>
4 <apex:outputpanel id="counter">
5 <apex:outputText value="Click Me!: {!count}"/>
6 <apex:actionSupport event="onclick"
7 action="{!incrementCounter}"
8 rerender="counter" status="counterStatus"/>
9 </apex:outputpanel>
10 <apex:actionStatus id="counterStatus"
11 startText=" (incrementing...)"
12 stopText=" (done)"/>
13 </apex:form>
14</apex:page>
15
16/*** Controller: ***/
17public class exampleCon {
18 Integer count = 0;
19
20 public PageReference incrementCounter() {
21 count++;
22 return null;
23 }
24
25 public Integer getCount() {
26 return count;
27 }
28}属性
| 属性名 | 属性型 | 説明 | 必須かどうか | API バージョン | 通用範囲 |
|---|---|---|---|---|---|
| action | ApexPages.Action | サーバーに対する AJAX 要求によって呼び出される action メソッド。このメソッドを参照するには、差し込み項目の構文を使用します。たとえば、action="{!incrementCounter}" ではコントローラーの incrementCounter() メソッドを参照します。アクションが指定されていない場合、ページは単に更新されます。 | 10.0 | グローバル | |
| disabled | Boolean | ユーザーがコンポーネントを無効にできる boolean 値。「true」に設定すると、イベントの実行時にアクションが呼び出されません。 | 16.0 | ||
| disableDefault | Boolean | 関連付けられているイベントのデフォルトのブラウザー処理をスキップするかどうかを指定する boolean 値。true に設定すると、この処理はスキップされます。指定されていない場合、この値はデフォルトの true に設定されます。 | 10.0 | グローバル | |
| event | String | AJAX 要求を生成する DOM イベント。可能な値には、「onblur」、「onchange」、「onclick」、「ondblclick」、「onfocus」、「onkeydown」、「onkeypress」、「onkeyup」、「onmousedown」、「onmousemove」、「onmouseout」、「onmouseover」、「onmouseup」、「onselect」などなどがあります。これらの値では、大文字と小文字が区別されます。 | 10.0 | グローバル | |
| focus | String | AJAX 要求の完了後にフォーカスされるコンポーネントの ID。 | 10.0 | グローバル | |
| id | String | ページの他のコンポーネントがコンポーネントを参照できるようにする識別子。 | 10.0 | グローバル | |
| immediate | Boolean | ページの項目に関連付けられている入力規則を処理することなく、このコンポーネントに関連付けられているアクションをすぐに実行するかどうかを指定する boolean 値。true に設定すると、アクションがすぐに実行され、入力規則はスキップされます。指定されていない場合、この値はデフォルトの false に設定されます。 | 11.0 | グローバル | |
| onbeforedomupdate | String | onbeforedomupdate イベントの発生時 (AJAX 要求が処理されたとき、ただし、ブラウザーの DOM が更新される前) に呼び出される JavaScript。 | 11.0 | グローバル | |
| oncomplete | String | AJAX 更新要求の結果がクライアントで完了したときに呼び出される JavaScript。 | 10.0 | グローバル | |
| onsubmit | String | AJAX 更新要求がサーバーに送信される前に呼び出される JavaScript。 | 10.0 | グローバル | |
| rendered | Boolean | コンポーネントをページに表示するかどうかを指定する boolean 値。指定されていない場合、この値はデフォルトの true に設定されます。 | 10.0 | グローバル | |
| reRender | Object | AJAX 更新要求の結果がクライアントに返されるときに再作成される 1 つ以上のコンポーネントの ID。この値には、単一の ID、ID のカンマ区切りのリスト、または ID のリストまたはコレクションの差し込み項目の式を使用できます。 | 10.0 | グローバル | |
| status | String | AJAX 更新要求の状況を表示する関連付けられているコンポーネントの ID。「actionStatus コンポーネント」を参照してください。 | 10.0 | グローバル | |
| timeout | Integer | AJAX 更新要求がタイムアウトするまでの時間 (ミリ秒)。 | 10.0 | グローバル |