Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
gnu.xml.dom

Class DomEvent

java.lang.Object
|
+--gnu.xml.dom.DomEvent

All Implemented Interfaces:

org.w3c.dom.events.Event


public class DomEvent

extends Object

implements org.w3c.dom.events.Event

"Event" implementation. Events are created (through DocumentEvent interface methods on the document object), and are sent to any target node in the document.

Applications may define application specific event subclasses, but should otherwise use the DocumentTraversal interface to acquire event objects.

Author:

Constructor Summary

DomEvent(java.lang.String type)

Constructs, but does not initialize, an event.

Method Summary

booleangetBubbles()

Returns true if the news of the event bubbles to tree tops (as specified during initialization).
booleangetCancelable()

Returns true if the default handling may be canceled (as specified during initialization).
EventTargetgetCurrentTarget()

Returns the target to which events are currently being delivered.
shortgetEventPhase()

Returns CAPTURING_PHASE, AT_TARGET, or BUBBLING; only meaningful within EventListener.handleEvent
EventTargetgetTarget()

Returns event's target; delivery of an event is initiated by a target.dispatchEvent(event) invocation.
longgetTimeStamp()

Returns the event's timestamp.
java.lang.StringgetType()

Returns the event's type (name) as initialized
voidinitEvent(java.lang.String typeArg, boolean canBubbleArg, boolean cancelableArg)

Initializes basic event state.
voidpreventDefault()

Requests that whoever dispatched the event not perform their default processing when event delivery completes.
voidstopPropagation()

Requests the event no longer be captured or bubbled; only listeners on the event target will see the event, if they haven't yet been notified.
java.lang.StringtoString()

Returns a basic printable description of the event's type, state, and delivery conditions

Constructor Details

DomEvent

public DomEvent(java.lang.String type)

Constructs, but does not initialize, an event.

Parameters:


Method Details

getBubbles

public final boolean getBubbles()

Returns true if the news of the event bubbles to tree tops (as specified during initialization).


getCancelable

public final boolean getCancelable()

Returns true if the default handling may be canceled (as specified during initialization).


getCurrentTarget

public final EventTarget getCurrentTarget()

Returns the target to which events are currently being delivered. When capturing or bubbling, this will not be what getTarget returns.


getEventPhase

public final short getEventPhase()

Returns CAPTURING_PHASE, AT_TARGET, or BUBBLING; only meaningful within EventListener.handleEvent


getTarget

public final EventTarget getTarget()

Returns event's target; delivery of an event is initiated by a target.dispatchEvent(event) invocation.


getTimeStamp

public final long getTimeStamp()

Returns the event's timestamp.


getType

public final String getType()

Returns the event's type (name) as initialized


initEvent

public void initEvent(java.lang.String typeArg, boolean canBubbleArg, boolean cancelableArg)

Initializes basic event state.

Parameters:


preventDefault

public final void preventDefault()

Requests that whoever dispatched the event not perform their default processing when event delivery completes. Initializes event timestamp.


stopPropagation

public void stopPropagation()

Requests the event no longer be captured or bubbled; only listeners on the event target will see the event, if they haven't yet been notified.

Avoid using this except for application-specific events, for which you the protocol explicitly "blesses" the use of this with some event types. Otherwise, you are likely to break algorithms which depend on event notification either directly or through bubbling or capturing.

Note that this method is not final, specifically to enable enforcing of policies about events always propagating.


toString

public String toString()

Returns a basic printable description of the event's type, state, and delivery conditions