Common DOM API

org.w3c.dom.events
インタフェース Event

既知のサブインタフェースの一覧:
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()
          EventTarget のうち、EventListeners が現在処理中の ものを知らせるために使用します。
 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

public static final short CAPTURING_PHASE
現在のイベントフェーズは、キャプチャフェーズです。

関連項目:
定数フィールド値

AT_TARGET

public static final short AT_TARGET
イベントは、ターゲットの EventTarget で評価されている最中です。

関連項目:
定数フィールド値

BUBBLING_PHASE

public static final short BUBBLING_PHASE
現在のイベントフェーズは、バブルフェーズです。

関連項目:
定数フィールド値
メソッドの詳細

getType

public String getType()
イベントの名前です (大文字小文字は区別されない)。名前は、XML の名前でなければ なりません。


getTarget

public EventTarget getTarget()
イベントが最初にディスパッチされた EventTarget を知らせるために 使用します。


getCurrentTarget

public EventTarget getCurrentTarget()
EventTarget のうち、EventListeners が現在処理中の ものを知らせるために使用します。これは、キャプチャ中およびバブル中に、特に便利 です。


getEventPhase

public short getEventPhase()
イベントフローのどのフェーズが現在評価されているかを知らせるために使用します。


getBubbles

public boolean getBubbles()
イベントがバブルイベントであるかどうかを知らせるために使用します。イベントがバブル できる場合の値は true、そうでない場合の値は false です。


getCancelable

public boolean getCancelable()
イベントのデフォルトのアクションを阻止できるかどうかを知らせるために使用します。 デフォルトのアクションを阻止できる場合の値は true、そうでない場合の値は false です。


getTimeStamp

public long getTimeStamp()
イベントが作成された時刻 (基準日時からのミリ秒数) を示すために使用します。一部の システムはこの情報を提供しないため、timeStamp の値を利用できない イベントもあります。この値を利用できない場合、0 という値が返されます。基準日時の 例としては、システムが始動した日時や、1970 年 1 月 1 日の 0 時 0 分 0 秒 (協定世界時) があります。


stopPropagation

public void stopPropagation()
stopPropagation メソッドは、イベントフローにおいてこれ以上イベントが 伝えられるのを止めるために使用します。EventListener によって このメソッドが呼び出されると、そのイベントはツリーをたどって伝えられなくなります。 イベントフローが停止する前に、現在の EventTarget 上のすべての リスナーに対するイベントのディスパッチが完了します。このメソッドは、イベントフロー のどの段階でも使用できます。


preventDefault

public void preventDefault()
イベントがキャンセル可能な場合、preventDefault メソッドを使用すると イベントのキャンセルを通知できるため、そのイベントの結果として通常は実装により 実行されるデフォルトのアクションが実行されません。イベントフローのどの段階で preventDefault メソッドが呼び出されても、そのイベントはキャンセル されます。そのイベントに関連付けられているデフォルトのアクションは実行され ません。キャンセル可能ではないイベントに対してこのメソッドを呼び出しても、 何も効果がありません。いったん preventDefault が呼び出されると、 イベント伝播の残り全体でその効果が有効になります。このメソッドは、イベントフロー のどの段階でも使用できます。


initEvent

public void initEvent(String eventTypeArg,
                      boolean canBubbleArg,
                      boolean cancelableArg)
initEvent メソッドは、DocumentEvent インタフェースを 介して作成された Event の値を初期化するために使用します。 このメソッドは、dispatchEvent メソッドによって Event をディスパッチする前にのみ呼び出すことができます。ただし、必要なら、初期化 フェーズ中に 2 回以上呼び出すことができます。このメソッドを 2 回以上呼び出した 場合、最後の呼び出しが優先されます。Event インタフェースの サブクラスからこのメソッドを呼び出した場合は、initEvent メソッドに 指定した値だけが変更され、その他の属性は変更されないままになります。

パラメータ:
eventTypeArg - イベントの型を指定するこの仕様で現在定義されている 任意のイベント型、または新しいイベント型を指定できる。文字列は、XML の名前に する必要がある。新しいイベント型の先頭は、文字列 "DOM" (大文字小文字の すべての組み合わせを含む) であってはならない。この接頭辞は、将来の DOM イベント セットのために予約されている。さらに、独自のイベントを追加するサードパーティは、 それぞれ独自の接頭辞を使用することで混乱を避け、ほかの新しいイベントと衝突する 可能性を抑えることが強く推奨されている
canBubbleArg - イベントがバブルできるかどうかを指定する
cancelableArg - デフォルトのアクションを阻止できるかどうかを指定する

Common DOM API

バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.