モジュール java.xml

パッケージ org.w3c.dom.events

インタフェースEventTarget

public interface EventTarget

EventTargetインタフェースは、DOMイベント・モデルをサポートする実装では、すべてのNodesによって実装されます。 そのため、このインタフェースは、Nodeインタフェースのインスタンスに対してバインディング固有のキャスト・メソッドを使用して取得できます。 このインタフェースでは、EventTargetへのEventListenersの登録と削除、およびそのEventTargetへのイベントのディスパッチが可能になります。

「Document Object Model (DOM) Level 2 Events Specification」も参照してください。

導入されたバージョン:

1.5、DOMレベル2

メソッドのサマリー

修飾子と型	メソッド	説明
void	addEventListener(String type, EventListener listener, boolean useCapture)	このメソッドでは、イベント・ターゲットにイベント・リスナーを登録できます。
boolean	dispatchEvent(Event evt)	このメソッドでは、実装イベント・モデルにイベントをディスパッチできます。
void	removeEventListener(String type, EventListener listener, boolean useCapture)	このメソッドでは、イベント・ターゲットからイベント・リスナーを削除できます。

メソッドの詳細

addEventListener

void addEventListener(String type,
                      EventListener listener,
                      boolean useCapture)

このメソッドでは、イベント・ターゲットにイベント・リスナーを登録できます。 EventListenerは、イベント処理中にEventTargetに追加された場合、現在のアクションによってはトリガーされませんが、イベント・フローのあとの段階(バブル・フェーズなど)でトリガーされることがあります。
複数の同じEventListenerが同じパラメータで同じEventTargetに登録されている場合は、重複するインスタンスが破棄されます。 これによってEventListenerが2回呼び出されることはなく、またこれらは破棄されるため、removeEventListenerメソッドを使用して削除する必要はありません。

パラメータ:

type - ユーザーが登録しているイベントの型

listener - listenerパラメータには、イベントが発生したときに呼び出されるメソッドを含む、ユーザーによって実装されたインタフェースを指定する。

useCapture - trueの場合、useCaptureはユーザーがキャプチャを開始することを示す。 キャプチャを開始したあとは、指定された型のすべてのイベントが、ツリー内で自身の下にあるEventTargetsにディスパッチされる前に、登録されたEventListenerにディスパッチされる。 ツリーを介して上方へ向かってバブルしているイベントは、キャプチャを使用するように指定されたEventListenerをトリガーしない。

removeEventListener

void removeEventListener(String type,
                         EventListener listener,
                         boolean useCapture)

このメソッドでは、イベント・ターゲットからイベント・リスナーを削除できます。 EventListenerは、イベント処理中にEventTargetから削除された場合、現在のアクションによってはトリガーされません。 EventListenerを、削除されたあとに呼び出すことはできません。
現在EventTargetに登録されているどのEventListenerも識別しない引数でremoveEventListenerを呼び出しても効果はありません。

パラメータ:

type - 削除されるEventListenerのイベントの型を指定する。

listener - EventListenerパラメータは削除されるEventListener を示す。

useCapture - 削除されるEventListenerがキャプチャ・リスナーとして登録されたかどうかを指定する。 リスナーを2回登録した場合、1回はキャプチャとして、もう1回はキャプチャとしてではなく登録したのであれば、それぞれのリスナーを別々に削除しなければならない。 また、そのような場合、キャプチャ・リスナーを削除しても、非キャプチャ・リスナーには影響が及ばない。その逆の削除でも同様である。

dispatchEvent

boolean dispatchEvent(Event evt)
               throws EventException

このメソッドでは、実装イベント・モデルにイベントをディスパッチできます。 このようにディスパッチされたイベントは、実装によって直接ディスパッチされたイベントと同じようにキャプチャとバブリングを実行します。 イベントのターゲットは、dispatchEventが呼び出される EventTargetです。

パラメータ:

evt - イベントの処理で使用されるイベントの型、動作、およびコンテキスト情報を指定する。

戻り値:

dispatchEventの戻り値は、イベントを処理したいずれかのリスナーがpreventDefaultを呼び出したかどうか示す。 preventDefaultが呼び出された場合、この値はfalse。それ以外の場合、この値はtrue。

例外:

EventException - UNSPECIFIED_EVENT_TYPE_ERR: dispatchEventが呼び出される前に、イベントを初期化することによってEventの型が指定されなかった場合に発生します。 Eventの型をnullまたは空の文字列として指定した場合も、この例外がトリガーされます。