Package org.apache.batik.dom.events
Class AbstractEvent
java.lang.Object
org.apache.batik.dom.events.AbstractEvent
- All Implemented Interfaces:
Cloneable
,OriginalEvent
,Event
- Direct Known Subclasses:
DOMEvent
,DOMMutationEvent
,DOMTimeEvent
,DOMUIEvent
,SVGOMEvent
,XBLOMShadowTreeEvent
The abstract
Event
root class.- Version:
- $Id: AbstractEvent.java 1806580 2017-08-29 12:06:44Z ssteiner $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
The number of nodes in the document this event will visit during capturing, bubbling and firing at the target.protected boolean
Whether this event is cancelable.protected EventTarget
The EventTarget whose EventListeners are currently being processed.protected List
List of default Actionables to run at the end of bubble phase.protected short
The event phase.protected boolean
Whether this event is bubbling.protected String
Namespace URI of this event.protected Event
The event from which this event was cloned for sXBL event retargetting.protected boolean
Whether the default action must be processed.protected boolean
Whether the event propagation must be stopped immediately.protected boolean
Whether the event propagation must be stopped after the current event listener group has been completed.protected EventTarget
The target of this event.protected long
The time the event was created.protected String
The event type.Fields inherited from interface org.w3c.dom.events.Event
AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDefaultAction
(Runnable rable) Adds the runnable to the list of default action runnablesclone()
Returns a new Event with the same field values as this object.Clones this event and sets the originalEvent field of the new event to be equal to this event.int
Returns the bubble limit for this event.boolean
DOM: Thebubbles
property indicates whether or not an event is a bubbling event.boolean
DOM: Thecancelable
property indicates whether or not an event can have its default action prevented.DOM: Thetarget
property indicates theEventTarget
whoseEventListeners
are currently being processed.Returns the current list of default action runnablesboolean
DOM: Returns whetherpreventDefault
has been called on this object.short
DOM: TheeventPhase
property indicates which phase of event flow is currently being evaluated.Get the namespace URI of this event.Gets the event from which this event was cloned.(package private) boolean
(package private) boolean
DOM: Thetarget
property indicates theEventTarget
to which the event was originally dispatched.long
DOM: Used to specify the time (in milliseconds relative to the epoch) at which the event was created.getType()
DOM: Thetype
property represents the event name as a string property.void
DOM: TheinitEvent
method is used to initialize the value of interface.void
initEventNS
(String namespaceURIArg, String eventTypeArg, boolean canBubbleArg, boolean cancelableArg) DOM: Implements org.w3c.dom.events.Event#initEventNS(String,String,boolean,boolean).void
DOM: If an event is cancelable, thepreventDefault
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.(package private) void
preventDefault
(boolean state) void
setBubbleLimit
(int n) Set the number of nodse this event will visit.(package private) void
setCurrentTarget
(EventTarget currentTarget) (package private) void
setEventPhase
(short eventPhase) (package private) void
setTarget
(EventTarget target) void
DOM: Stops propagation of this event immediately, even to listeners in the current group.(package private) void
stopImmediatePropagation
(boolean state) void
DOM: ThestopPropagation
method is used prevent further propagation of an event during event flow.(package private) void
stopPropagation
(boolean state)
-
Field Details
-
type
The event type. -
isBubbling
protected boolean isBubblingWhether this event is bubbling. -
cancelable
protected boolean cancelableWhether this event is cancelable. -
currentTarget
The EventTarget whose EventListeners are currently being processed. -
target
The target of this event. -
eventPhase
protected short eventPhaseThe event phase. -
timeStamp
protected long timeStampThe time the event was created. -
stopPropagation
protected boolean stopPropagationWhether the event propagation must be stopped after the current event listener group has been completed. -
stopImmediatePropagation
protected boolean stopImmediatePropagationWhether the event propagation must be stopped immediately. -
preventDefault
protected boolean preventDefaultWhether the default action must be processed. -
namespaceURI
Namespace URI of this event. -
originalEvent
The event from which this event was cloned for sXBL event retargetting. -
defaultActions
List of default Actionables to run at the end of bubble phase. -
bubbleLimit
protected int bubbleLimitThe 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.
-
-
Constructor Details
-
AbstractEvent
public AbstractEvent()
-
-
Method Details
-
getType
DOM: Thetype
property represents the event name as a string property. The string must be an XML name. -
getCurrentTarget
DOM: Thetarget
property indicates theEventTarget
whoseEventListeners
are currently being processed.- Specified by:
getCurrentTarget
in interfaceEvent
-
getTarget
DOM: Thetarget
property indicates theEventTarget
to which the event was originally dispatched. -
getEventPhase
public short getEventPhase()DOM: TheeventPhase
property indicates which phase of event flow is currently being evaluated.- Specified by:
getEventPhase
in interfaceEvent
-
getBubbles
public boolean getBubbles()DOM: Thebubbles
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.- Specified by:
getBubbles
in interfaceEvent
-
getCancelable
public boolean getCancelable()DOM: Thecancelable
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.- Specified by:
getCancelable
in interfaceEvent
-
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 oftimeStamp
may be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.- Specified by:
getTimeStamp
in interfaceEvent
-
getNamespaceURI
Get the namespace URI of this event. -
getOriginalEvent
Gets the event from which this event was cloned.- Specified by:
getOriginalEvent
in interfaceOriginalEvent
-
stopPropagation
public void stopPropagation()DOM: ThestopPropagation
method is used prevent further propagation of an event during event flow. If this method is called by anyEventListener
the event will cease propagating through the tree. The event will complete dispatch to all listeners on the currentEventTarget
before event flow stops. This method may be used during any stage of event flow.- Specified by:
stopPropagation
in interfaceEvent
-
preventDefault
public void preventDefault()DOM: If an event is cancelable, thepreventDefault
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, thepreventDefault
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. OncepreventDefault
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.- Specified by:
preventDefault
in interfaceEvent
-
getDefaultPrevented
public boolean getDefaultPrevented()DOM: Returns whetherpreventDefault
has been called on this object. -
getDefaultActions
Returns the current list of default action runnables -
addDefaultAction
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
DOM: TheinitEvent
method is used to initialize the value of interface. This method may only be called before theEvent
has been dispatched via thedispatchEvent
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 ofEvent
interface only the values specified in theinitEvent
method are modified, all other attributes are left unchanged.- Specified by:
initEvent
in interfaceEvent
- 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 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
-
setTarget
-
clone
Returns a new Event with the same field values as this object.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-
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.
-