org.apache.batik.dom.events

Class AbstractEvent

public abstract class AbstractEvent extends Object implements Event, OriginalEvent, Cloneable

The abstract Event root class.
Field Summary
protected intbubbleLimit
The number of nodes in the document this event will visit during capturing, bubbling and firing at the target.
protected booleancancelable
Whether this event is cancelable.
protected EventTargetcurrentTarget
The EventTarget whose EventListeners are currently being processed.
protected ListdefaultActions
List of default Actionables to run at the end of bubble phase.
protected shorteventPhase
The event phase.
protected booleanisBubbling
Whether this event is bubbling.
protected StringnamespaceURI
Namespace URI of this event.
protected EventoriginalEvent
The event from which this event was cloned for sXBL event retargetting.
protected booleanpreventDefault
Whether the default action must be processed.
protected booleanstopImmediatePropagation
Whether the event propagation must be stopped immediately.
protected booleanstopPropagation
Whether the event propagation must be stopped after the current event listener group has been completed.
protected EventTargettarget
The target of this event.
protected longtimeStamp
The time the event was created.
protected Stringtype
The event type.
Method Summary
voidaddDefaultAction(Runnable rable)
Adds the runnable to the list of default action runnables
Objectclone()
Returns a new Event with the same field values as this object.
AbstractEventcloneEvent()
Clones this event and sets the originalEvent field of the new event to be equal to this event.
intgetBubbleLimit()
Returns the bubble limit for this event.
booleangetBubbles()
DOM: The bubbles property indicates whether or not an event is a bubbling event.
booleangetCancelable()
DOM: The cancelable property indicates whether or not an event can have its default action prevented.
EventTargetgetCurrentTarget()
DOM: The target property indicates the EventTarget whose EventListeners are currently being processed.
ListgetDefaultActions()
Returns the current list of default action runnables
booleangetDefaultPrevented()
DOM: Returns whether preventDefault has been called on this object.
shortgetEventPhase()
DOM: The eventPhase property indicates which phase of event flow is currently being evaluated.
StringgetNamespaceURI()
Get the namespace URI of this event.
EventgetOriginalEvent()
Gets the event from which this event was cloned.
EventTargetgetTarget()
DOM: The target property indicates the EventTarget to which the event was originally dispatched.
longgetTimeStamp()
DOM: Used to specify the time (in milliseconds relative to the epoch) at which the event was created.
StringgetType()
DOM: The type property represents the event name as a string property.
voidinitEvent(String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
DOM: The initEvent method is used to initialize the value of interface.
voidinitEventNS(String namespaceURIArg, String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
DOM: Implements {@link org.w3c.dom.events.Event#initEventNS(String,String,boolean,boolean)}.
voidpreventDefault()
DOM: If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur.
voidsetBubbleLimit(int n)
Set the number of nodse this event will visit.
voidstopImmediatePropagation()
DOM: Stops propagation of this event immediately, even to listeners in the current group.
voidstopPropagation()
DOM: The stopPropagation method is used prevent further propagation of an event during event flow.

Field Detail

bubbleLimit

protected int bubbleLimit
The number of nodes in the document this event will visit during capturing, bubbling and firing at the target. A value of 0 means to let the event be captured and bubble all the way to the document node. This field is used to handle events which should not cross sXBL shadow scopes without stopping or retargetting.

cancelable

protected boolean cancelable
Whether this event is cancelable.

currentTarget

protected EventTarget currentTarget
The EventTarget whose EventListeners are currently being processed.

defaultActions

protected List defaultActions
List of default Actionables to run at the end of bubble phase.

eventPhase

protected short eventPhase
The event phase.

isBubbling

protected boolean isBubbling
Whether this event is bubbling.

namespaceURI

protected String namespaceURI
Namespace URI of this event.

originalEvent

protected Event originalEvent
The event from which this event was cloned for sXBL event retargetting.

preventDefault

protected boolean preventDefault
Whether the default action must be processed.

stopImmediatePropagation

protected boolean stopImmediatePropagation
Whether the event propagation must be stopped immediately.

stopPropagation

protected boolean stopPropagation
Whether the event propagation must be stopped after the current event listener group has been completed.

target

protected EventTarget target
The target of this event.

timeStamp

protected long timeStamp
The time the event was created.

type

protected String type
The event type.

Method Detail

addDefaultAction

public void addDefaultAction(Runnable rable)
Adds the runnable to the list of default action runnables

clone

public Object clone()
Returns a new Event with the same field values as this object.

cloneEvent

public AbstractEvent cloneEvent()
Clones this event and sets the originalEvent field of the new event to be equal to this event.

getBubbleLimit

public int getBubbleLimit()
Returns the bubble limit for this event.

getBubbles

public boolean getBubbles()
DOM: The bubbles property indicates whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false.

getCancelable

public boolean getCancelable()
DOM: The cancelable property indicates whether or not an event can have its default action prevented. If the default action can be prevented the value is true, else the value is false.

getCurrentTarget

public EventTarget getCurrentTarget()
DOM: The target property indicates the EventTarget whose EventListeners are currently being processed.

getDefaultActions

public List getDefaultActions()
Returns the current list of default action runnables

getDefaultPrevented

public boolean getDefaultPrevented()
DOM: Returns whether preventDefault has been called on this object.

getEventPhase

public short getEventPhase()
DOM: The eventPhase property indicates which phase of event flow is currently being evaluated.

getNamespaceURI

public String getNamespaceURI()
Get the namespace URI of this event.

getOriginalEvent

public Event getOriginalEvent()
Gets the event from which this event was cloned.

getTarget

public EventTarget getTarget()
DOM: The target property indicates the EventTarget to which the event was originally dispatched.

getTimeStamp

public long getTimeStamp()
DOM: Used to specify the time (in milliseconds relative to the epoch) at which the event was created. Due to the fact that some systems may not provide this information the value of timeStamp may be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.

getType

public String getType()
DOM: The type property represents the event name as a string property. The string must be an XML name.

initEvent

public void initEvent(String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
DOM: The initEvent method is used to initialize the value of interface. This method may only be called before the Event has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times the final invocation takes precedence. If called from a subclass of Event interface only the values specified in the initEvent method are modified, all other attributes are left unchanged.

Parameters: eventTypeArg Specifies the event type. This type may be any event type currently defined in this specification or a new event type.. The string must be an XML name . Any new event type must not begin with any upper, lower, or mixed case version of the string "DOM". This prefix is reserved for future DOM event sets. canBubbleArg Specifies whether or not the event can bubble. cancelableArg Specifies whether or not the event's default action can be prevented.

initEventNS

public void initEventNS(String namespaceURIArg, String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
DOM: Implements {@link org.w3c.dom.events.Event#initEventNS(String,String,boolean,boolean)}.

preventDefault

public void preventDefault()
DOM: If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. If, during any stage of event flow, the preventDefault method is called the event is canceled. Any default action associated with the event will not occur. Calling this method for a non-cancelable event has no effect. Once preventDefault has been called it will remain in effect throughout the remainder of the event's propagation. This method may be used during any stage of event flow.

setBubbleLimit

public void setBubbleLimit(int n)
Set the number of nodse this event will visit.

stopImmediatePropagation

public void stopImmediatePropagation()
DOM: Stops propagation of this event immediately, even to listeners in the current group.

stopPropagation

public void stopPropagation()
DOM: The stopPropagation method is used prevent further propagation of an event during event flow. If this method is called by any EventListener the event will cease propagating through the tree. The event will complete dispatch to all listeners on the current EventTarget before event flow stops. This method may be used during any stage of event flow.
Copyright B) 2007 Apache Software Foundation. All Rights Reserved.