org.apache.xerces.dom.events

Class EventImpl

java.lang.Object

org.apache.xerces.dom.events.EventImpl

All Implemented Interfaces:

Event

Direct Known Subclasses:

MutationEventImpl, UIEventImpl

public class EventImpl
extends Object
implements Event

EventImpl is an implementation of the basic "generic" DOM Level 2 Event object. It may be subclassed by more specialized event sets. Note that in our implementation, events are re-dispatchable (dispatch clears the stopPropagation and preventDefault flags before it starts); I believe that is the DOM's intent but I don't see an explicit statement to this effect.

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bubbles
boolean	cancelable
EventTarget	currentTarget
short	eventPhase
boolean	initialized
boolean	preventDefault
boolean	stopPropagation
EventTarget	target
protected long	timeStamp
String	type

Fields inherited from interface org.w3c.dom.events.Event

AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE

Constructor Summary

Constructors

Constructor and Description
EventImpl()

Method Summary

Modifier and Type	Method and Description
boolean	getBubbles()
boolean	getCancelable()
EventTarget	getCurrentTarget()
short	getEventPhase()
EventTarget	getTarget()
long	getTimeStamp()
String	getType()
void	initEvent(String eventTypeArg, boolean canBubbleArg, boolean cancelableArg) The DOM doesn't deal with constructors, so instead we have an initializer call to set most of the read-only fields.
void	preventDefault() Prevents any default processing built into the target node from occurring.
void	stopPropagation() Causes exit from in-progress event dispatch before the next currentTarget is selected.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

public String type

target

public EventTarget target

currentTarget

public EventTarget currentTarget

eventPhase

public short eventPhase

initialized

public boolean initialized

bubbles

public boolean bubbles

cancelable

public boolean cancelable

stopPropagation

public boolean stopPropagation

preventDefault

public boolean preventDefault

timeStamp

protected long timeStamp

Constructor Detail

EventImpl

public EventImpl()

Method Detail

initEvent

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

The DOM doesn't deal with constructors, so instead we have an initializer call to set most of the read-only fields. The others are set, and reset, by the event subsystem during dispatch.

Note that init() -- and the subclass-specific initWhatever() calls -- may be reinvoked. At least one initialization is required; repeated initializations overwrite the event with new values of their parameters.

Specified by:

initEvent in interface Event

getBubbles

public boolean getBubbles()

Specified by:

getBubbles in interface Event

Returns:

true iff this Event is of a class and type which supports bubbling. In the generic case, this is True.

getCancelable

public boolean getCancelable()

Specified by:

getCancelable in interface Event

Returns:

true iff this Event is of a class and type which (a) has a Default Behavior in this DOM, and (b)allows cancellation (blocking) of that behavior. In the generic case, this is False.

getCurrentTarget

public EventTarget getCurrentTarget()

Specified by:

getCurrentTarget in interface Event

Returns:

the Node (EventTarget) whose EventListeners are currently being processed. During capture and bubble phases, this may not be the target node.

getEventPhase

public short getEventPhase()

Specified by:

getEventPhase in interface Event

Returns:

the current processing phase for this event -- CAPTURING_PHASE, AT_TARGET, BUBBLING_PHASE. (There may be an internal DEFAULT_PHASE as well, but the users won't see it.)

getTarget

public EventTarget getTarget()

Specified by:

getTarget in interface Event

Returns:

the EventTarget (Node) to which the event was originally dispatched.

getType

public String getType()

Specified by:

getType in interface Event

Returns:

event name as a string

getTimeStamp

public long getTimeStamp()

Specified by:

getTimeStamp in interface Event

stopPropagation

public void stopPropagation()

Causes exit from in-progress event dispatch before the next currentTarget is selected. Replaces the preventBubble() and preventCapture() methods which were present in early drafts; they may be reintroduced in future levels of the DOM.

Specified by:

stopPropagation in interface Event

preventDefault

public void preventDefault()

Prevents any default processing built into the target node from occurring.

Specified by:

preventDefault in interface Event