- All Known Subinterfaces:
LSLoadEvent
,LSProgressEvent
,MouseEvent
,MutationEvent
,UIEvent
public interface Event
The
Event
interface is used to provide contextual information
about an event to the handler processing the event. An object which
implements the Event
interface is generally passed as the
first parameter to an event handler. More specific context information is
passed to event handlers by deriving additional interfaces from
Event
which contain information directly relating to the
type of event they accompany. These derived interfaces are also
implemented by the object passed to the event listener.
See also the Document Object Model (DOM) Level 2 Events Specification.
- Since:
- 1.5, DOM Level 2
-
Field Summary
Modifier and TypeFieldDescriptionstatic final short
The event is currently being evaluated at the targetEventTarget
.static final short
The current event phase is the bubbling phase.static final short
The current event phase is the capturing phase. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Used to indicate whether or not an event is a bubbling event.boolean
Used to indicate whether or not an event can have its default action prevented.Used to indicate theEventTarget
whoseEventListeners
are currently being processed.short
Used to indicate which phase of event flow is currently being evaluated.Used to indicate theEventTarget
to which the event was originally dispatched.long
Used to specify the time (in milliseconds relative to the epoch) at which the event was created.getType()
The name of the event (case-insensitive).void
TheinitEvent
method is used to initialize the value of anEvent
created through theDocumentEvent
interface.void
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.void
ThestopPropagation
method is used prevent further propagation of an event during event flow.
-
Field Details
-
CAPTURING_PHASE
static final short CAPTURING_PHASEThe current event phase is the capturing phase.- See Also:
-
AT_TARGET
static final short AT_TARGETThe event is currently being evaluated at the targetEventTarget
.- See Also:
-
BUBBLING_PHASE
static final short BUBBLING_PHASEThe current event phase is the bubbling phase.- See Also:
-
-
Method Details
-
getType
String getType()The name of the event (case-insensitive). The name must be an XML name. -
getTarget
EventTarget getTarget()Used to indicate theEventTarget
to which the event was originally dispatched. -
getCurrentTarget
EventTarget getCurrentTarget()Used to indicate theEventTarget
whoseEventListeners
are currently being processed. This is particularly useful during capturing and bubbling. -
getEventPhase
short getEventPhase()Used to indicate which phase of event flow is currently being evaluated. -
getBubbles
boolean getBubbles()Used to indicate whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false. -
getCancelable
boolean getCancelable()Used to indicate 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. -
getTimeStamp
long getTimeStamp()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 not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970. -
stopPropagation
void stopPropagation()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. -
preventDefault
void preventDefault()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. -
initEvent
TheinitEvent
method is used to initialize the value of anEvent
created through theDocumentEvent
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.- 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. It is also strongly recommended that third parties adding their own events use their own prefix to avoid confusion and lessen the probability of conflicts with other new events.canBubbleArg
- Specifies whether or not the event can bubble.cancelableArg
- Specifies whether or not the event's default action can be prevented.
-