13.8.2. $im.event¶
13.8.2.1. 概要¶
各エレメントのイベントを契機にアクションが実行された場合、イベントの発生元を特定するためのエレメントID、キーボードに関する情報を取得できます。
13.8.2.2. $im.event.target / $im.event.currentTarget¶
イベントを契機にアクションが実行された場合、イベント発火の原因となったエレメントに関する情報を取得できます。
$im.event.target と $im.event.currentTarget から取得できる情報の種類は同一ですが、以下の違いがあります。
- エレメントの親子関係例:
- im-element-1
- im-element-2 (イベントにアクションが設定されているエレメント[緑])
- im-element-3 (イベントが発生したエレメント[青])
- $im.event.target
イベントが発生したエレメントに関する情報を取得します。 例えば、イベントにアクションが設定されているエレメント(im-element-2)の子要素(im-element-3)でイベントが発生した場合、子要素(im-element-3)の情報が取得できます。
- $im.event.currentTarget
アクションが設定されているエレメントに関する情報を取得します。 例えば、イベントにアクションが設定されているエレメント(im-element-2)の子要素(im-element-3)でイベントが発生した場合、親要素(im-element-2)の情報が取得できます。
それぞれ取得できるプロパティは、以下の通りです。
- elementId
- エレメントの「エレメントID」と同じ値
- renderedElementId
- エレメントがアプリケーション画面上でレンダリングされたときに付与された一意のID
- 繰り返し要素でない場合は elementId と同一の値が取得されますが、繰り返し要素でレンダリングされた場合、「エレメントID」とは異なる値が取得されます。
- userClass
- エレメントの「CSSクラス」と同じ値
13.8.2.3. $im.event.keyboard¶
キーボードの操作によってイベントが発火した場合、キーボードに関する情報を取得できます。
取得できるプロパティは、以下の通りです。
- key
- 押下されたキーの名称
- 例: 'a', 'Enter', 'Space'
- altKey
- Alt キーが押下されている場合は true、それ以外は false
- ctrlKey
- Ctrl キーが押下されている場合は true、それ以外は false
- metaKey
- Meta キー(Windows キー、Command キー)が押下されている場合は true、それ以外は false
- shiftKey
- Shift キーが押下されている場合は true、それ以外は false