Package org.w3c.dom.events
Interface Event
-
- All Known Subinterfaces:
CustomEvent,KeyboardEvent,MouseEvent,MutationEvent,MutationNameEvent,ShadowTreeEvent,TextEvent,UIEvent
- All Known Implementing Classes:
AbstractEvent,DOMCustomEvent,DOMEvent,DOMKeyboardEvent,DOMKeyEvent,DOMMouseEvent,DOMMutationEvent,DOMMutationNameEvent,DOMTextEvent,DOMTimeEvent,DOMUIEvent,SVGOMEvent,SVGOMWheelEvent,XBLOMShadowTreeEvent
public interface EventTheEventinterface is used to provide contextual information about an event to the listener processing the event. An object which implements theEventinterface is passed as the parameter to anEventListener. More specific context information is passed to event listeners by deriving additional interfaces fromEventwhich contain information directly relating to the type of event they represent. These derived interfaces are also implemented by the object passed to the event listener.To create an instance of the
Eventinterface, use theDocumentEvent.createEvent("Event")method call.See also the Document Object Model (DOM) Level 3 Events Specification .
- Since:
- DOM Level 2
-
-
Field Summary
Fields Modifier and Type Field Description static shortAT_TARGETThe current event is in the target phase, i.e.static shortBUBBLING_PHASEThe current event phase is the bubbling phase.static shortCAPTURING_PHASEThe current event phase is the capture phase.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleangetBubbles()Used to indicate whether or not an event is a bubbling event.booleangetCancelable()Used to indicate whether or not an event can have its default action prevented (see also ).EventTargetgetCurrentTarget()Used to indicate theEventTargetwhoseEventListenersare currently being processed.booleangetDefaultPrevented()Used to indicate whetherEvent.preventDefault()has been called for this event.shortgetEventPhase()Used to indicate which phase of event flow is currently being accomplished.java.lang.StringgetNamespaceURI()The namespace URI associated with this event at creation time, ornullif it is unspecified.EventTargetgetTarget()Used to indicate the event target.longgetTimeStamp()Used to specify the time at which the event was created in milliseconds relative to 1970-01-01T00:00:00Z.java.lang.StringgetType()The local name of the event type.voidinitEvent(java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)TheinitEventmethod is used to initialize the value of anEventcreated through theDocumentEvent.createEventmethod.voidinitEventNS(java.lang.String namespaceURIArg, java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)TheinitEventNSmethod is used to initialize the value of anEventobject and has the same behavior asEvent.initEvent().voidpreventDefault()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 (see also ), and thus independently of event groups.voidstopImmediatePropagation()This method is used to prevent event listeners of the same group to be triggered and, unlikeEvent.stopPropagation()its effect is immediate (see ).voidstopPropagation()This method is used to prevent event listeners of the same group to be triggered but its effect is deferred until all event listeners attached on theEvent.currentTargethave been triggered (see ).
-
-
-
Field Detail
-
CAPTURING_PHASE
static final short CAPTURING_PHASE
The current event phase is the capture phase.- See Also:
- Constant Field Values
-
AT_TARGET
static final short AT_TARGET
The current event is in the target phase, i.e. it is being evaluated at the event target.- See Also:
- Constant Field Values
-
BUBBLING_PHASE
static final short BUBBLING_PHASE
The current event phase is the bubbling phase.- See Also:
- Constant Field Values
-
-
Method Detail
-
getType
java.lang.String getType()
The local name of the event type. The name must be an NCName as defined in [XML Namespaces 1.1] and is case-sensitive.
-
getTarget
EventTarget getTarget()
Used to indicate the event target. This attribute contains the target node when used with the .
-
getCurrentTarget
EventTarget getCurrentTarget()
Used to indicate theEventTargetwhoseEventListenersare currently being processed. This is particularly useful during the capture and bubbling phases. This attribute could contain the target node or a target ancestor when used with the .
-
getEventPhase
short getEventPhase()
Used to indicate which phase of event flow is currently being accomplished.
-
getBubbles
boolean getBubbles()
Used to indicate whether or not an event is a bubbling event. If the event can bubble the value istrue, otherwise the value isfalse.
-
getCancelable
boolean getCancelable()
Used to indicate whether or not an event can have its default action prevented (see also ). If the default action can be prevented the value istrue, otherwise the value isfalse.
-
getTimeStamp
long getTimeStamp()
Used to specify the time at which the event was created in milliseconds relative to 1970-01-01T00:00:00Z. Due to the fact that some systems may not provide this information the value oftimeStampmay be not available for all events. When not available, the value is0.
-
stopPropagation
void stopPropagation()
This method is used to prevent event listeners of the same group to be triggered but its effect is deferred until all event listeners attached on theEvent.currentTargethave been triggered (see ). Once it has been called, further calls to that method have no additional effect.Note: This method does not prevent the default action from being invoked; use
Event.preventDefault()for that effect.
-
preventDefault
void preventDefault()
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 (see also ), and thus independently of event groups. Calling this method for a non-cancelable event has no effect.Note: This method does not stop the event propagation; use
Event.stopPropagation()orEvent.stopImmediatePropagation()for that effect.
-
initEvent
void initEvent(java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)TheinitEventmethod is used to initialize the value of anEventcreated through theDocumentEvent.createEventmethod. This method may only be called before theEventhas been dispatched via theEventTarget.dispatchEvent()method. If the method is called several times before invokingEventTarget.dispatchEvent, only the final invocation takes precedence. This method has no effect if called after the event has been dispatched. If called from a subclass of theEventinterface only the values specified in this method are modified, all other attributes are left unchanged.
This method sets theEvent.typeattribute toeventTypeArg, andEvent.namespaceURItonull. To initialize an event with a namespace URI, use theEvent.initEventNS()method.- Parameters:
eventTypeArg- SpecifiesEvent.type, the local name of the event type.canBubbleArg- SpecifiesEvent.bubbles. This parameter overrides the intrinsic bubbling behavior of the event.cancelableArg- SpecifiesEvent.cancelable. This parameter overrides the intrinsic cancelable behavior of the event.
-
getNamespaceURI
java.lang.String getNamespaceURI()
The namespace URI associated with this event at creation time, ornullif it is unspecified.
For events initialized with a DOM Level 2 Events method, such asEvent.initEvent(), this is alwaysnull.- Since:
- DOM Level 3
-
stopImmediatePropagation
void stopImmediatePropagation()
This method is used to prevent event listeners of the same group to be triggered and, unlikeEvent.stopPropagation()its effect is immediate (see ). Once it has been called, further calls to that method have no additional effect.Note: This method does not prevent the default action from being invoked; use
Event.preventDefault()for that effect.- Since:
- DOM Level 3
-
getDefaultPrevented
boolean getDefaultPrevented()
Used to indicate whetherEvent.preventDefault()has been called for this event.- Since:
- DOM Level 3
-
initEventNS
void initEventNS(java.lang.String namespaceURIArg, java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)TheinitEventNSmethod is used to initialize the value of anEventobject and has the same behavior asEvent.initEvent().- Parameters:
namespaceURIArg- SpecifiesEvent.namespaceURI, the namespace URI associated with this event, ornullif no namespace.eventTypeArg- Refer to theEvent.initEvent()method for a description of this parameter.canBubbleArg- Refer to theEvent.initEvent()method for a description of this parameter.cancelableArg- Refer to theEvent.initEvent()method for a description of this parameter.- Since:
- DOM Level 3
-
-