public abstract class AbstractEvent extends java.lang.Object implements Event, OriginalEvent, java.lang.Cloneable
Event
root class.Modifier and Type | Field and Description |
---|---|
protected int |
bubbleLimit
The number of nodes in the document this event will visit
during capturing, bubbling and firing at the target.
|
protected boolean |
cancelable
Whether this event is cancelable.
|
protected EventTarget |
currentTarget
The EventTarget whose EventListeners are currently being processed.
|
protected java.util.List |
defaultActions
List of default Actionables to run at the end of bubble phase.
|
protected short |
eventPhase
The event phase.
|
protected boolean |
isBubbling
Whether this event is bubbling.
|
protected java.lang.String |
namespaceURI
Namespace URI of this event.
|
protected Event |
originalEvent
The event from which this event was cloned for sXBL event retargetting.
|
protected boolean |
preventDefault
Whether the default action must be processed.
|
protected boolean |
stopImmediatePropagation
Whether the event propagation must be stopped immediately.
|
protected boolean |
stopPropagation
Whether the event propagation must be stopped after the current
event listener group has been completed.
|
protected EventTarget |
target
The target of this event.
|
protected long |
timeStamp
The time the event was created.
|
protected java.lang.String |
type
The event type.
|
AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE
Constructor and Description |
---|
AbstractEvent() |
Modifier and Type | Method and Description |
---|---|
void |
addDefaultAction(java.lang.Runnable rable)
Adds the runnable to the list of default action runnables
|
java.lang.Object |
clone()
Returns a new Event with the same field values as this object.
|
AbstractEvent |
cloneEvent()
Clones this event and sets the originalEvent field of the new event
to be equal to this event.
|
int |
getBubbleLimit()
Returns the bubble limit for this event.
|
boolean |
getBubbles()
DOM: The
bubbles property indicates whether or not
an event is a bubbling event. |
boolean |
getCancelable()
DOM: The
cancelable property indicates whether or
not an event can have its default action prevented. |
EventTarget |
getCurrentTarget()
DOM: The
target property indicates the
EventTarget whose EventListeners are
currently being processed. |
java.util.List |
getDefaultActions()
Returns the current list of default action runnables
|
boolean |
getDefaultPrevented()
DOM: Returns whether
preventDefault has been
called on this object. |
short |
getEventPhase()
DOM: The
eventPhase property indicates which phase
of event flow is currently being evaluated. |
java.lang.String |
getNamespaceURI()
Get the namespace URI of this event.
|
Event |
getOriginalEvent()
Gets the event from which this event was cloned.
|
EventTarget |
getTarget()
DOM: The
target property indicates the
EventTarget to which the event was originally
dispatched. |
long |
getTimeStamp()
DOM: Used to specify the time (in milliseconds relative to the
epoch) at
which the event was created.
|
java.lang.String |
getType()
DOM: The
type property represents the event name
as a string property. |
void |
initEvent(java.lang.String eventTypeArg,
boolean canBubbleArg,
boolean cancelableArg)
DOM: The
initEvent method is used to initialize the
value of interface. |
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).
|
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. |
void |
setBubbleLimit(int n)
Set the number of nodse this event will visit.
|
void |
stopImmediatePropagation()
DOM: Stops propagation of this event immediately, even to
listeners in the current group.
|
void |
stopPropagation()
DOM: The
stopPropagation method is used prevent
further propagation of an event during event flow. |
protected java.lang.String type
protected boolean isBubbling
protected boolean cancelable
protected EventTarget currentTarget
protected EventTarget target
protected short eventPhase
protected long timeStamp
protected boolean stopPropagation
protected boolean stopImmediatePropagation
protected boolean preventDefault
protected java.lang.String namespaceURI
protected Event originalEvent
protected java.util.List defaultActions
protected int bubbleLimit
public java.lang.String getType()
type
property represents the event name
as a string property. The string must be an XML name.public EventTarget getCurrentTarget()
target
property indicates the
EventTarget
whose EventListeners
are
currently being processed.getCurrentTarget
in interface Event
public EventTarget getTarget()
target
property indicates the
EventTarget
to which the event was originally
dispatched.public short getEventPhase()
eventPhase
property indicates which phase
of event flow is currently being evaluated.getEventPhase
in interface Event
public boolean getBubbles()
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.getBubbles
in interface Event
public boolean getCancelable()
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.getCancelable
in interface Event
public long getTimeStamp()
timeStamp
may be
returned. Examples of epoch time are the time of the system start or
0:0:0 UTC 1st January 1970.getTimeStamp
in interface Event
public java.lang.String getNamespaceURI()
public Event getOriginalEvent()
getOriginalEvent
in interface OriginalEvent
public void stopPropagation()
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.stopPropagation
in interface Event
public void preventDefault()
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.preventDefault
in interface Event
public boolean getDefaultPrevented()
preventDefault
has been
called on this object.public java.util.List getDefaultActions()
public void addDefaultAction(java.lang.Runnable rable)
public void stopImmediatePropagation()
public void initEvent(java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
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.initEvent
in interface Event
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.public void initEventNS(java.lang.String namespaceURIArg, java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public AbstractEvent cloneEvent()
public int getBubbleLimit()
public void setBubbleLimit(int n)
Copyright © 2022 Apache Software Foundation. All Rights Reserved.