org.apache.xerces.dom.events

Class EventImpl

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.

INTERNAL:

Usage of this class is not supported. It may be altered or removed at any time.

Version: $Id: EventImpl.java,v 1.10 2004/10/06 15:25:33 mrglavas Exp $

Field Summary
booleanbubbles
booleancancelable
EventTargetcurrentTarget
shorteventPhase
booleaninitialized
booleanpreventDefault
booleanstopPropagation
EventTargettarget
protected longtimeStamp
Stringtype
Method Summary
booleangetBubbles()
booleangetCancelable()
EventTargetgetCurrentTarget()
shortgetEventPhase()
EventTargetgetTarget()
longgetTimeStamp()
StringgetType()
voidinitEvent(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.
voidpreventDefault()
Prevents any default processing built into the target node from occurring.
voidstopPropagation()
Causes exit from in-progress event dispatch before the next currentTarget is selected.

Field Detail

bubbles

public boolean bubbles

cancelable

public boolean cancelable

currentTarget

public EventTarget currentTarget

eventPhase

public short eventPhase

initialized

public boolean initialized

preventDefault

public boolean preventDefault

stopPropagation

public boolean stopPropagation

target

public EventTarget target

timeStamp

protected long timeStamp

type

public String type

Method Detail

getBubbles

public boolean getBubbles()

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()

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()

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()

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()

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

getTimeStamp

public long getTimeStamp()

getType

public String getType()

Returns: event name as a string

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.

preventDefault

public void preventDefault()
Prevents any default processing built into the target node from occurring.

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.
Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.