Faces Client コンポーネントのイベント・ハンドラーを使用すると、Faces Client コンポーネントから
特定のイベントに対してアクションを定義することができます。 イベント・ハンドラーを使用すると、1 つの Faces Client コンポーネントからのイベントを他の Faces Client コンポーネント、およびいくつかの Faces コンポーネントに接続することができます。Faces Client イベントを HTML コントロールまたは JavaScript™
にある他のカスタム・ロジックに接続することもできます。
例えば、編成を表示するためにツリー・ビューを使用し、ツリーの各ノードは異なる部門であると仮定します。各部門はクライアント・データ・オブジェクトで、
部門名は属性です。各部門の名前が、ツリーのノードとして表示されます。
データ・グリッドには、特定の部門内の従業員の名前が含まれています。
ツリー内の別の部門が強調表示になると、その部門がデータ・グリッドのルート・オブジェクトとして使用され、
その部門内の従業員を示すようにデータ・グリッドが更新されます。
「高速編集」ビューで定義されたイベント・ハンドラーは、この相互作用に反応します。
注: いったんイベント・ハンドラーを選択すると、「高速編集」ビューの右側のペインに JavaScript™ コードを入力しなければなりません。
このコードは、イベント (例えば、onhighlight など) が呼び出されたときに実行されるアクションです。
以下のリストには特定の Faces Client コンポーネントの「高速編集」ビューの左側に
表示される Faces Client イベントが含まれています。
ツリー・ビュー
- onhighlight
- onhighlight イベントは、
データ・グリッド・コンポーネントとツリー・ビュー・コンポーネントでサポートされます。
データ・グリッド内の行またはツリー内のノードが強調表示になったとき、あるいはユーザーにクリックされたときに、
このイベントが起動されます。
このイベント・オブジェクトには 2 つのプロパティーがあります。
- eobject - 強調表示になっている行またはノードにマップされたオブジェクト。
例えば、部門。
- propertyName - ユーザーがクリックしたオブジェクト・プロパティーの名前。
例えば、部門名。(ツリー・ビューにのみ適用されます。)
- onselect / onunselect
- onselect および onunselect イベントは、
データ・グリッド・コンポーネントとツリー・ビュー・コンポーネントでサポートされます。
ツリー・ビュー内のノードまたはデータ・グリッド内の行に対応するチェック・ボックスをユーザーが選択または選択解除したとき、
あるいはデータ・グリッド内の行に対応するラジオ・ボタンをユーザーが選択または選択解除したときに、
これらのイベントが起動されます。
- eobject - 現在選択された、あるいは選択解除された行またはノードにマップされたオブジェクト。
- checkedItemsArray - 現在選択されている行またはノードのリスト・オブジェクト (複数)。
例えば、従業員オブジェクト。
- onnodehighlight
- onnodehighlight イベントは、ツリー・ビュー・コンポーネントでサポートされます。
ツリー内のノードがユーザーによって強調表示にされたときに、このイベントが起動されます。
特定のノードに onhighlight イベントのイベント・ハンドラーがすでに定義されている場合は、
この onnodehighlight の前に、onhighlight のイベント・ハンドラーが呼び出されます。
このイベント・オブジェクトには 2 つのプロパティーがあります。
- eobject - 強調表示にされたノードにマップされたオブジェクト。
例えば、部門。
- propertyName - ユーザーがクリックしたオブジェクト・プロパティーの名前。
例えば、部門名。
- onnodeselect/onnodeunselect
- onnodeselect および onnodeunselect イベントは、ツリー・ビュー・コンポーネントでサポートされます。ツリー内のノードが選択または選択解除されたときに、これらのイベントが起動されます。
特定のノードに onselect または onunselect イベントのイベント・ハンドラーがすでに定義されている場合は、
この onnodeselect または onnodeunselect の前に、onselect または onunselect のイベント・ハンドラーが呼び出されます。
このイベント・オブジェクトには 2 つのプロパティーがあります。
- eobject - 現在選択された、あるいは選択解除されたノードにマップされたオブジェクト。
- checkedItemsArray - 現在選択されているノードのリスト・オブジェクト (複数)。
例えば、従業員オブジェクト。
- onexpand
- このイベントは、ツリー・ビューの特定のノードが拡張されたときに起動されます。
このイベント・オブジェクトには 3 つのプロパティーがあります。
- eobject - これは、ユーザーがクリックしたノードにマップされたオブジェクトです。
- openedItemsArray - これは、 eobjects を含んでいる、ツリーの中の現在拡張されているすべての
ノードを表す配列です。
- levels - これは、拡張されているレベルの数を示す整数です。
この値が -1 の場合、拡張されている現在のノードの下のすべてのノードは、同様に
拡張されます。この値が 1 の場合、クリックされたノードのみが拡張されます。
- oncollapse
- このイベントは、ツリー・ビューの特定のノードが縮小されたときに起動されます。
このイベント・オブジェクトには 3 つのプロパティーがあります。
- eobject - これは、ユーザーがクリックしたノードにマップされたオブジェクトです。
- openedItemsArray - これは、 eobjects を含んでいる、ツリーの中の現在拡張されているすべての
ノードを表す配列です。
- levels - これは、縮小されているレベルの数を示す整数です。
この値が -1 の場合、縮小されている現在のノードの下のすべてのノードは、同様に
縮小されます。この値が 1 の場合、クリックされたノードのみが縮小されます。
- onnodeexpand
- このイベントは、ツリー・ビューの任意のノードが拡張されたときに起動されます。
このイベントを起動したツリー・ノードに、onexpand イベントのためのハンドラーがすでにある場合、
それはこのハンドラーの前に呼び出されます。このイベント・オブジェクトには 3 つのプロパティーがあります。
- eobject - これは、ユーザーがクリックしたノードにマップされたオブジェクトです。
- openedItemsArray - これは、 eobjects を含んでいる、ツリーの中の現在拡張されているすべての
ノードを表す配列です。
- levels - これは、拡張されているレベルの数を示す整数です。
この値が -1 の場合、拡張されている現在のノードの下のすべてのノードは、同様に
拡張されます。この値が 1 の場合、クリックされたノードのみが拡張されます。
- onnodecollapse
- このイベントは、ツリー・ビューの任意のノードが縮小されたときに起動されます。
縮小されているツリー・ノードに oncollapse イベントのためのハンドラーがすでにある場合、
それはこのハンドラーの前に呼び出されます。 このイベント・オブジェクトには 3 つのプロパティーがあります。
- eobject - これは、ユーザーがクリックしたノードにマップされたオブジェクトです。
- openedItemsArray - これは、eobjects
を含んでいる、ツリーの中で現在拡張されているすべてのノードを表す配列です。
- levels - これは、縮小されているレベルの数を示す整数です。
この値が -1 の場合、縮小されている現在のノードの下のすべてのノードは、同様に
縮小されます。この値が 1 の場合、クリックされたノードのみが縮小されます。
データ・グリッド
- onhighlight
- onhighlight イベントは、
データ・グリッド・コンポーネントとツリー・ビュー・コンポーネントでサポートされます。
データ・グリッド内の行またはツリー内のノードが強調表示になったとき、あるいはユーザーにクリックされたときに、
このイベントが起動されます。
このイベント・オブジェクトには 2 つのプロパティーがあります。
- eobject - 強調表示になっている行またはノードにマップされたオブジェクト。
例えば、部門。
- propertyName - ユーザーがクリックしたオブジェクト・プロパティーの名前。
例えば、部門名。(ツリー・ビューにのみ適用されます。)
- onselect / onunselect
- onselect および onunselect イベントは、
データ・グリッド・コンポーネントとツリー・ビュー・コンポーネントでサポートされます。
ツリー・ビュー内のノードまたはデータ・グリッド内の行に対応するチェック・ボックスをユーザーが選択または選択解除したとき、
あるいはデータ・グリッド内の行に対応するラジオ・ボタンをユーザーが選択または選択解除したときに、
これらのイベントが起動されます。
- eobject - 現在選択された、あるいは選択解除された行またはノードにマップされたオブジェクト。
- checkedItemsArray - 現在選択されている行またはノードのリスト・オブジェクト (複数)。
例えば、従業員オブジェクト。
- onnodeselect/onnodeunselect
- onnodeselect および onnodeunselect イベントは、
データ・グリッド・コンポーネントとツリー・ビュー・コンポーネントでサポートされます。
ツリー内のノードが選択または選択解除されたときに、これらのイベントが起動されます。
特定のノードに onselect または onunselect イベントのイベント・ハンドラーがすでに定義されている場合は、
この onnodeselect または onnodeunselect の前に、onselect または onunselect のイベント・ハンドラーが呼び出されます。
このイベント・オブジェクトには 2 つのプロパティーがあります。
- eobject - 現在選択された、あるいは選択解除されたノードにマップされたオブジェクト。
- checkedItemsArray - 現在選択されているノードのリスト・オブジェクト (複数)。
例えば、従業員オブジェクト。
- onfilter
- ユーザーが提供したデータ・グリッドのプロパティー・ビューで Row Filter 式を使用して、データ・グリッドがデータをフィルター操作したときに onfilter イベントが起動されます。 このイベント・オブジェクトには 1 つのプロパティーがあります。
- filterExpression - これは、データをフィルターをフィルター操作するためにユーザーから提供された JavaScript 式です。
- onpage
- onpage イベントは、
ユーザーがデータ・グリッドで異なるページの間でページ付けする場合に起動されます。このイベント・オブジェクトには 2 つのプロパティーがあります。
- pageSelectChoice - このプロパティーの値は、ユーザーが、次ページ、前ページ、最初のページ、または最終ページへナビゲートされるのか、もしくはページ番号を指定して特定のページにジャンプするのかということを示します。 したがって、このプロパティーの値は、
next、 previous、first、last、
または jump となります。
- pageStartIndex - このプロパティーの値は、ユーザーに
そのページに表示されている最初の項目の索引を示します。
例えば、ユーザーが 1 ページあたり 5 項目を表示して 2 ページ目にジャンプする場合、このプロパティーの値は 6 になります。
- onsort
- このイベントは、ユーザーがソートするためにデータ・グリッドのいずれかの列をクリックしたときに起動されます。このイベント・オブジェクトには 2 つのプロパティーがあります。
- sortOrder - このプロパティーの値は、ユーザーにソートが昇順か降順かどちらかを示します。 したがって、このプロパティーの値は、asc または desc となります。
- propertyName - このプロパティーの値は、
ソートされた列の値を表示するために使用する Bean プロパティーの名前です。
- onselectall
- このイベントは、ユーザーがグリッドの行のすべて選択を選んだ場合にデータ・グリッドによって起動されますが、選択列があるデータ・グリッド上でのみ起動されます。このイベント・オブジェクトには 2 つのプロパティーがあります。
- allEobjs - これは、現在そのデータ・グリッドにバインドされているすべてのオブジェクトの配列です。例えば、データ・グリッドが部門のリストを表示している場合、
配列のそれぞれの項目は、部門オブジェクトになります。
- toBeSelectEobjs - これは、アクション全選択の呼び出しの結果として選択される、データ・グリッドのオブジェクトの配列です。
- onunselectall
- このイベントは、ユーザーがグリッドですべての行の選択解除を選んだ場合に
データ・グリッドによって起動されますが、選択列があるデータ・グリッド上でのみ起動されます。このイベント・オブジェクトには 2 つのプロパティーがあります。
- allEobjs - これは、現在そのデータ・グリッドにバインドされているすべてのオブジェクトの配列です。例えば、データ・グリッドが部門のリストを表示している場合、
配列のそれぞれの項目は、部門オブジェクトになります。
- toBeUnselectedEobjs - これは、アクションの選択をすべて解除の呼び出しの結果として選択を解除するデータ・グリッドのオブジェクトの配列です。
注: ハンドラー属性のパラメーターにストリング変数を含める場合は、
必ずすべての引用符を正しくエスケープしてください。