Package org.apache.batik.dom.events
Class AbstractEvent
- java.lang.Object
-
- org.apache.batik.dom.events.AbstractEvent
-
- All Implemented Interfaces:
java.lang.Cloneable,OriginalEvent,org.w3c.dom.events.Event
- Direct Known Subclasses:
DOMEvent,DOMMutationEvent,DOMTimeEvent,DOMUIEvent,SVGOMEvent,XBLOMShadowTreeEvent
public abstract class AbstractEvent extends java.lang.Object implements org.w3c.dom.events.Event, OriginalEvent, java.lang.Cloneable
The abstractEventroot class.- Version:
- $Id: AbstractEvent.java 1806580 2017-08-29 12:06:44Z ssteiner $
-
-
Field Summary
Fields Modifier and Type Field Description protected intbubbleLimitThe number of nodes in the document this event will visit during capturing, bubbling and firing at the target.protected booleancancelableWhether this event is cancelable.protected org.w3c.dom.events.EventTargetcurrentTargetThe EventTarget whose EventListeners are currently being processed.protected java.util.ListdefaultActionsList of default Actionables to run at the end of bubble phase.protected shorteventPhaseThe event phase.protected booleanisBubblingWhether this event is bubbling.protected java.lang.StringnamespaceURINamespace URI of this event.protected org.w3c.dom.events.EventoriginalEventThe event from which this event was cloned for sXBL event retargetting.protected booleanpreventDefaultWhether the default action must be processed.protected booleanstopImmediatePropagationWhether the event propagation must be stopped immediately.protected booleanstopPropagationWhether the event propagation must be stopped after the current event listener group has been completed.protected org.w3c.dom.events.EventTargettargetThe target of this event.protected longtimeStampThe time the event was created.protected java.lang.StringtypeThe event type.
-
Constructor Summary
Constructors Constructor Description AbstractEvent()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDefaultAction(java.lang.Runnable rable)Adds the runnable to the list of default action runnablesjava.lang.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: Thebubblesproperty indicates whether or not an event is a bubbling event.booleangetCancelable()DOM: Thecancelableproperty indicates whether or not an event can have its default action prevented.org.w3c.dom.events.EventTargetgetCurrentTarget()DOM: Thetargetproperty indicates theEventTargetwhoseEventListenersare currently being processed.java.util.ListgetDefaultActions()Returns the current list of default action runnablesbooleangetDefaultPrevented()DOM: Returns whetherpreventDefaulthas been called on this object.shortgetEventPhase()DOM: TheeventPhaseproperty indicates which phase of event flow is currently being evaluated.java.lang.StringgetNamespaceURI()Get the namespace URI of this event.org.w3c.dom.events.EventgetOriginalEvent()Gets the event from which this event was cloned.(package private) booleangetStopImmediatePropagation()(package private) booleangetStopPropagation()org.w3c.dom.events.EventTargetgetTarget()DOM: Thetargetproperty indicates theEventTargetto 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.java.lang.StringgetType()DOM: Thetypeproperty represents the event name as a string property.voidinitEvent(java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)DOM: TheinitEventmethod is used to initialize the value of interface.voidinitEventNS(java.lang.String namespaceURIArg, java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)DOM: Implements org.w3c.dom.events.Event#initEventNS(String,String,boolean,boolean).voidpreventDefault()DOM: If an event is cancelable, thepreventDefaultmethod 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.(package private) voidpreventDefault(boolean state)voidsetBubbleLimit(int n)Set the number of nodse this event will visit.(package private) voidsetCurrentTarget(org.w3c.dom.events.EventTarget currentTarget)(package private) voidsetEventPhase(short eventPhase)(package private) voidsetTarget(org.w3c.dom.events.EventTarget target)voidstopImmediatePropagation()DOM: Stops propagation of this event immediately, even to listeners in the current group.(package private) voidstopImmediatePropagation(boolean state)voidstopPropagation()DOM: ThestopPropagationmethod is used prevent further propagation of an event during event flow.(package private) voidstopPropagation(boolean state)
-
-
-
Field Detail
-
type
protected java.lang.String type
The event type.
-
isBubbling
protected boolean isBubbling
Whether this event is bubbling.
-
cancelable
protected boolean cancelable
Whether this event is cancelable.
-
currentTarget
protected org.w3c.dom.events.EventTarget currentTarget
The EventTarget whose EventListeners are currently being processed.
-
target
protected org.w3c.dom.events.EventTarget target
The target of this event.
-
eventPhase
protected short eventPhase
The event phase.
-
timeStamp
protected long timeStamp
The time the event was created.
-
stopPropagation
protected boolean stopPropagation
Whether the event propagation must be stopped after the current event listener group has been completed.
-
stopImmediatePropagation
protected boolean stopImmediatePropagation
Whether the event propagation must be stopped immediately.
-
preventDefault
protected boolean preventDefault
Whether the default action must be processed.
-
namespaceURI
protected java.lang.String namespaceURI
Namespace URI of this event.
-
originalEvent
protected org.w3c.dom.events.Event originalEvent
The event from which this event was cloned for sXBL event retargetting.
-
defaultActions
protected java.util.List defaultActions
List of default Actionables to run at the end of bubble phase.
-
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.
-
-
Method Detail
-
getType
public java.lang.String getType()
DOM: Thetypeproperty represents the event name as a string property. The string must be an XML name.- Specified by:
getTypein interfaceorg.w3c.dom.events.Event
-
getCurrentTarget
public org.w3c.dom.events.EventTarget getCurrentTarget()
DOM: Thetargetproperty indicates theEventTargetwhoseEventListenersare currently being processed.- Specified by:
getCurrentTargetin interfaceorg.w3c.dom.events.Event
-
getTarget
public org.w3c.dom.events.EventTarget getTarget()
DOM: Thetargetproperty indicates theEventTargetto which the event was originally dispatched.- Specified by:
getTargetin interfaceorg.w3c.dom.events.Event
-
getEventPhase
public short getEventPhase()
DOM: TheeventPhaseproperty indicates which phase of event flow is currently being evaluated.- Specified by:
getEventPhasein interfaceorg.w3c.dom.events.Event
-
getBubbles
public boolean getBubbles()
DOM: Thebubblesproperty indicates whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false.- Specified by:
getBubblesin interfaceorg.w3c.dom.events.Event
-
getCancelable
public boolean getCancelable()
DOM: Thecancelableproperty 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.- Specified by:
getCancelablein interfaceorg.w3c.dom.events.Event
-
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 oftimeStampmay be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.- Specified by:
getTimeStampin interfaceorg.w3c.dom.events.Event
-
getNamespaceURI
public java.lang.String getNamespaceURI()
Get the namespace URI of this event.
-
getOriginalEvent
public org.w3c.dom.events.Event getOriginalEvent()
Gets the event from which this event was cloned.- Specified by:
getOriginalEventin interfaceOriginalEvent
-
stopPropagation
public void stopPropagation()
DOM: ThestopPropagationmethod is used prevent further propagation of an event during event flow. If this method is called by anyEventListenerthe event will cease propagating through the tree. The event will complete dispatch to all listeners on the currentEventTargetbefore event flow stops. This method may be used during any stage of event flow.- Specified by:
stopPropagationin interfaceorg.w3c.dom.events.Event
-
preventDefault
public void preventDefault()
DOM: If an event is cancelable, thepreventDefaultmethod 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, thepreventDefaultmethod 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. OncepreventDefaulthas 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.- Specified by:
preventDefaultin interfaceorg.w3c.dom.events.Event
-
getDefaultPrevented
public boolean getDefaultPrevented()
DOM: Returns whetherpreventDefaulthas been called on this object.
-
getDefaultActions
public java.util.List getDefaultActions()
Returns the current list of default action runnables
-
addDefaultAction
public void addDefaultAction(java.lang.Runnable rable)
Adds the runnable to the list of default action runnables
-
stopImmediatePropagation
public void stopImmediatePropagation()
DOM: Stops propagation of this event immediately, even to listeners in the current group.
-
initEvent
public void initEvent(java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)DOM: TheinitEventmethod is used to initialize the value of interface. This method may only be called before theEventhas been dispatched via thedispatchEventmethod, 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 ofEventinterface only the values specified in theinitEventmethod are modified, all other attributes are left unchanged.- Specified by:
initEventin interfaceorg.w3c.dom.events.Event- 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(java.lang.String namespaceURIArg, java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)DOM: Implements org.w3c.dom.events.Event#initEventNS(String,String,boolean,boolean).
-
getStopPropagation
boolean getStopPropagation()
-
getStopImmediatePropagation
boolean getStopImmediatePropagation()
-
setEventPhase
void setEventPhase(short eventPhase)
-
stopPropagation
void stopPropagation(boolean state)
-
stopImmediatePropagation
void stopImmediatePropagation(boolean state)
-
preventDefault
void preventDefault(boolean state)
-
setCurrentTarget
void setCurrentTarget(org.w3c.dom.events.EventTarget currentTarget)
-
setTarget
void setTarget(org.w3c.dom.events.EventTarget target)
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedExceptionReturns a new Event with the same field values as this object.- Overrides:
clonein classjava.lang.Object- Throws:
java.lang.CloneNotSupportedException
-
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.
-
setBubbleLimit
public void setBubbleLimit(int n)
Set the number of nodse this event will visit.
-
-