org.w3c.dom.events

インタフェース Event

既知のすべてのサブインタフェース:

LSLoadEvent, LSProgressEvent, MouseEvent, MutationEvent, UIEvent

public interface Event

Event インタフェースを使用して、イベントに関するコンテキスト情報を、イベントを処理するハンドラに提供します。Event インタフェースを実装するオブジェクトが一般に、イベントハンドラへの最初のパラメータとして渡されます。より具体的なコンテキスト情報は、付随するイベントの型に直接関連した情報を含む、Event からの追加のインタフェースを派生させることによってイベントハンドラに渡されます。これらの派生したインタフェースは、イベントリスナーに渡されるオブジェクトによっても実装されます。

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

導入されたバージョン:

DOM Level 2

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static short	AT_TARGET イベントは現在、ターゲット EventTarget で評価されています。
static short	BUBBLING_PHASE 現在のイベントフェーズはバブリングフェーズです。
static short	CAPTURING_PHASE 現在のイベントフェーズはキャプチャーフェーズです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	getBubbles() イベントがバブルするイベントであるかどうかを示す場合に使用します。
boolean	getCancelable() イベントがデフォルトアクションを抑制できるかどうかを示す場合に使用します。
EventTarget	getCurrentTarget() 現在 EventListeners を処理している EventTarget を示す場合に使用します。
short	getEventPhase() 現在、どのイベントフローのフェーズが評価されているかを示す場合に使用します。
EventTarget	getTarget() イベントが最初にディスパッチされた EventTarget を示す場合に使用します。
long	getTimeStamp() イベントを作成した時間 (元期に関してはミリ秒) を指定する場合に使用します。
String	getType() 大文字と小文字を区別しないイベント名。
void	initEvent(String eventTypeArg, boolean canBubbleArg, boolean cancelableArg) initEvent メソッドは、DocumentEvent インタフェースによって作成される Event の値を初期化する場合に使用します。
void	preventDefault() イベントが取り消し可能である場合、preventDefault メソッドを使用してイベントが取り消されることを示します。つまり、イベントの結果として実装によって通常実行されるデフォルトアクションは発生しません。
void	stopPropagation() stopPropagation メソッドは、イベントフロー中にこれ以上イベントが伝播しないようにするときに使用します。

フィールドの詳細

CAPTURING_PHASE

static final short CAPTURING_PHASE

現在のイベントフェーズはキャプチャーフェーズです。

関連項目:

定数フィールド値

AT_TARGET

static final short AT_TARGET

イベントは現在、ターゲット EventTarget で評価されています。

関連項目:

定数フィールド値

BUBBLING_PHASE

static final short BUBBLING_PHASE

現在のイベントフェーズはバブリングフェーズです。

関連項目:

定数フィールド値

メソッドの詳細

getType

String getType()

大文字と小文字を区別しないイベント名。名前は XML 名にする必要があります。

getTarget

EventTarget getTarget()

イベントが最初にディスパッチされた EventTarget を示す場合に使用します。

getCurrentTarget

EventTarget getCurrentTarget()

現在 EventListeners を処理している EventTarget を示す場合に使用します。特に、キャプチャーとバブリングの処理中に有効です。

getEventPhase

short getEventPhase()

現在、どのイベントフローのフェーズが評価されているかを示す場合に使用します。

getBubbles

boolean getBubbles()

イベントがバブルするイベントであるかどうかを示す場合に使用します。値は、イベントがバブルできる場合は true、そうでない場合は false になります。

getCancelable

boolean getCancelable()

イベントがデフォルトアクションを抑制できるかどうかを示す場合に使用します。値は、デフォルトアクションを抑制できる場合は true、そうでない場合は false になります。

getTimeStamp

long getTimeStamp()

イベントを作成した時間 (元期に関してはミリ秒) を指定する場合に使用します。この情報が提供されない可能性のあるシステムも存在するため、timeStamp の値がすべてのイベントに使用できるとは限りません。使用できない場合は、値 0 が返されます。元期時間には、システムの開始時間や「1970 年 1 月 1 日 0 時 0 分 0 秒 UTC」などがあります。

stopPropagation

void stopPropagation()

stopPropagation メソッドは、イベントフロー中にこれ以上イベントが伝播しないようにするときに使用します。このメソッドがいずれかの EventListener から呼び出された場合、イベントはツリーを介した伝播を停止します。イベントは、イベントフローが停止する前に、現在の EventTarget でのすべてのリスナーへのディスパッチを完了します。このメソッドはイベントフローのどの段階でも使用できます。

preventDefault

void preventDefault()

イベントが取り消し可能である場合、preventDefault メソッドを使用してイベントが取り消されることを示します。つまり、イベントの結果として実装によって通常実行されるデフォルトアクションは発生しません。イベントフローのどの段階で preventDefault メソッドが呼び出されても、イベントは取り消されます。そのイベントに関連付けられているデフォルトのアクションは実行されません。取り消しできないイベントに対してこのメソッドを呼び出しても、効果はまったくありません。preventDefault は、いったん呼び出されると、イベントの伝播の残りの部分を通して有効なままになります。このメソッドはイベントフローのどの段階でも使用できます。

initEvent

void initEvent(String eventTypeArg,
             boolean canBubbleArg,
             boolean cancelableArg)

initEvent メソッドは、DocumentEvent インタフェースによって作成される Event の値を初期化する場合に使用します。このメソッドは、Event が dispatchEvent メソッドを介してディスパッチされる前にかぎり呼び出されますが、必要な場合はその段階で複数回呼び出されることもあります。複数回呼び出した場合は、最後の呼び出しが優先されます。Event インタフェースのサブクラスから呼び出された場合は、initEvent メソッドで指定された値のみが変更され、その他の属性はすべて変更されずに残ります。

パラメータ:

eventTypeArg - イベントの型を指定します。この型は、現在この仕様、または新しいイベントの型で定義されているイベントの型です。文字列は XML 名にする必要があります。新しいイベントの型は「DOM」文字列 (大文字、小文字、または大文字と小文字の混在) では開始できません。この接頭辞は、将来の DOM イベントセットのために予約されます。また、混乱を避け、ほかの新しいイベントとの競合が起きる可能性を少なくするためにも、サードパーティーが独自のイベントを追加する場合は独自の接頭辞を使用することも強く推奨されます。

canBubbleArg - イベントをバブルできるかどうかを指定します。

cancelableArg - イベントのデフォルトアクションを抑制できるかどうかを指定します。