compact2, compact3

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 - イベントのデフォルト・アクションを抑制できるかどうかを指定します。