DOM Events is designed with two main goals. The first goal is the design of an event system which allows registration of event listeners and describes event flow through a tree structure. Additionally, the specification will provide standard modules of events for user interface control and document mutation notifications, including defined contextual information for each of these event modules.
The second goal of the DOM Events is to provide a common subset of the current event systems used in DOM Level 0 browsers. This is intended to foster interoperability of existing scripts and content. It is not expected that this goal will be met with full backwards compatibility. However, the specification attempts to achieve this when possible.
The following sections of the specification define both the specification for the DOM Event Model and a number of conformant event modules designed for use within the model. The DOM Event Model consists of:
This document specifies an event flow for tree-based structures: DOM event flow. While it is expected that HTML and XML applications will follow this event flow, applications might reuse the interfaces defined in this document for non tree-based structures. In that case, it is the responsibility of such applications to define their event flow and how it relates to the DOM event flow. An example of such use can be found in [DOM Level 3 Load and Save].
An implementation is DOM Level 3 Events conformant if it
supports the Core module defined in [DOM Level 2 Core],
the DOM event flow and the interfaces with their
associated semantics defined in Basic interfaces. An implementation conforms to a DOM
Level 3 Events module if it conforms to DOM Level 3 Events and
the event types defined in the module. An implementation
conforms to an event type if it conforms to its associated
semantics and DOM interfaces. For example, an implementation
conforms to the DOM Level 3 User Interface Events module (see
User Interface event types) if it conforms
to DOM Level 3 Events (i.e. implements all the basic
interfaces), can generate the event types
{"http://www.w3.org/2001/xml-events", "DOMActivate"}
{"http://www.w3.org/2001/xml-events", "DOMFocusIn"}
{"http://www.w3.org/2001/xml-events", "DOMFocusOut"}
accordingly to
their semantics, supports the UIEvent
interface,
and conforms to the DOM Level 2 Core module.
Note:
An implementation which does not conform to an event module
can still implement the DOM interfaces associated with it. The
DOM application can then create an event object using the
DocumentEvent.createEvent()
method and dispatch an
event type associated with this interface using the
EventTarget.dispatchEvent()
method.
A DOM application may use the hasFeature(feature,
version)
method of the DOMImplementation
interface with parameter values "Events"
and
"3.0"
(respectively) to determine whether or not
DOM Level 3 Events is supported by the implementation. In order
to fully support DOM Level 3 Events, an implementation must also
support the "Core" feature defined in the DOM Level 2 Core
specification [DOM Level 2 Core] and use the DOM event flow. For additional information
about conformance,
please see the DOM Level 3 Core specification [DOM Level 3 Core]. DOM Level 3 Events is built on top of DOM Level
2 Events [DOM Level 2 Events], i.e. a DOM Level 3 Events
implementation where hasFeature("Events", "3.0")
returns true
must also return true
when the version
number is "2.0"
,
""
or, null
.
Each event module describes its own feature string in the event module listing.
The DOM event flow is the process through which the event originates from the DOM Events implementation and is dispatched into a tree. Each event has an event target, a targeted node in the case of the DOM Event flow, toward which the event is dispatched by the DOM Events implementation.
The event is dispatched following a path from the root of the tree to this target node. It can then be handled locally at the target node level or from any target's ancestors higher in the tree. The event dispatching (also called event propagation) occurs in three phases and the following order:
Figure: graphical representation of an event dispatched in a DOM tree using the DOM event flow [SVG 1.0 version]
Note: An SVG 1.0 version of the representation above is also available.
The target's ancestors are determined before the initial dispatch of the event. If the target node is removed during the dispatching, or a target's ancestor is added or removed, the event propagation will always be based on the target node and the target's ancestors determined before the dispatch.
Some events may not necessarily accomplish the three phases of
the DOM event flow, e.g. the event could only be defined for one
or two phases. As an example, events defined in this
specification will always accomplish the capture and target
phases but some will not accomplish the bubbling phase
("bubbling events" versus "non-bubbling events", see also the
Event.bubbles
attribute).
Each node encountered during the dispatch of the event may contain event listeners.
Event listeners can be registered on all nodes in the tree for a specific type of event (Event types) or event category (Event types and event categories), phase, and group (Event groups).
If the event listener is being registered on a node while an event gets processed on this node, the event listener will not be triggered during the current phase but may be triggered during a later phase in the event flow, i.e. the bubbling phase.
An event listener is always part of a group. It is either explicitly in a group if a group has been specified at the registration or implicitly in the default group if no group has been specified. Within a group, event listeners are ordered in their order of registration. If two event listeners {A1, A2}, which are part of the same group, are registered one after the other (A1, then A2) for the same phase, the DOM event flow guarantees their triggering order (A1, then A2). If the two listeners are not part of the same group, no specification is made as to the order in which they will be triggered.
In general, a DOM application does not need to define and use a separate group unless other event listeners, external to the DOM application, may change the event propagation (e.g. from a concurrent DOM application, from imported functionalities that rely on the event system, etc.).
Note: While this specification does not specify a full ordering (i.e. groups are still unordered), it does specify ordering within a group. This implies that if the event listeners {A1, A2, B1, B2}, with A and B being two different groups, are registered for the same phase in the order A1, A2, B1, and B2, the following triggering orders are possible and conform to the DOM event flow: {A1, A2, B1, B2}, {A1, B1, A2, B2}, {B1, A1, A2, B2}, {A1, B1, B2, A2}, {B1, A1, B2, A2}, {B1, B2, A1, A2}. DOM Events implementations may impose priorities on groups but DOM applications must not rely on it. Unlike this specification, [DOM Level 2 Events] did not specify any triggering order for event listeners.
When the event is dispatched through the tree, from node to node, event listeners registered on the node are triggered if the following three conditions are all met:
If an event listener is removed from a node while an event is being processed on the node, it will not be triggered by the current actions. Once removed, the event listener is never invoked again (unless registered again for future processing).
It is expected that actions taken by an event listener may
cause additional events to be dispatched. Additional events
should be handled in a synchronous manner and may cause
reentrance into the event model. If an event listener fires a
new event using EventTarget.dispatchEvent()
, the
event propagation that causes the event listener to be
triggered will resume only after the event propagation of the
new event is completed.
Since implementations may have restrictions such as stack-usage or other memory requirements, applications should not depend on how many synchronous events may be triggered.
All event listeners are part of a group (see Registration of event listeners). An event listener may prevent event listeners that are part of a same group from being triggered. The effect can be:
Event.stopImmediatePropagation()
);
Event.stopPropagation()
).
If two event listeners are registered for two different groups, one cannot prevent the other from being triggered.
Implementations may have a default action associated with an event
type. An example is the [HTML 4.01]
form element. When the user submits the form (e.g. by pressing on
a submit button), the event {"http://www.w3.org/2001/xml-events",
"submit"}
is dispatched to the element and the default
action for this event type is generally to send a request to a Web
server with the parameters from the form.
The default actions are not part of the DOM Event flow. Before invoking a default action, the implementation must first dispatch the event as described in the DOM event flow.
A cancelable event is an event associated with a default action which is allowed to be canceled during the DOM event flow. At any phase during the event flow, the triggered event listeners have the option of canceling the default action or allowing the default action to proceed. In the case of the hyperlink in the browser, canceling the action would have the result of not activating the hyperlink. Not all events defined in this specification are cancelable events.
Different implementations will specify their own default actions, if any, associated with each event. The DOM Events specification does not attempt to specify these actions.
This specification does not provide mechanisms for accessing default actions or adding new ones.
Note:
Some implementations also provide default actions
before the dispatch of the event. It is not
possible to cancel those default actions and this specification
does not address them. An example of such default actions can be
found in [DOM Level 2 HTML] on the
HTMLInputElement.checked
attribute.
Each event is associated with a type, called event
type. The event type is composed of a local name and a namespace URI as used in [DOM Level 3 Core]. All events defined in this specification use the
namespace URI "http://www.w3.org/2001/xml-events"
.
An event type could be part of one or more categories. A category is represented using a local name and a namespace URI as defined in [XML Namespaces]. The event types defined in this specification are not associated with one or more event categories and this specification does not provide methods to associate them. Other specifications may create and associate event categories with event listeners but in such case would need to inform the dispatch mechanism of those event categories. An example of the use of categories is given at Using VoiceXML Events.
Depending on the level of DOM support, or the devices used for
display (e.g. screen) or interaction (e.g. mouse, keyboard,
touch screen, voice, ...), these event types can be generated by
the implementation. When used with an [XML 1.0] or [HTML 4.01] application, the specifications of those
languages may restrict the semantics and scope (in particular the
possible target nodes) associated with an event type. For
example, {"http://www.w3.org/2001/xml-events", "click"}
can be targeted to all
[XHTML 1.0] elements except applet,
base, basefont, bdo, br, font, frame, frameset, head, html,
iframe, isindex, meta, param, script, style, and title. Refer to
the specification defining the language used in order to find
those restrictions or to find event types that are not defined
in this document.
The following list defines all event types (with the exception
of two event types preserved for backward compatibility with
[HTML 4.01], see HTML Events) provided in this
specification. All event types defined in this specification are
bound to the namespace URI "http://www.w3.org/2001/xml-events"
and the
following list only enumerates the local name of the event type.
Note: The activation of an element is device dependent but is also application dependent, e.g. a link in a document can be activated using a mouse click or a mouse double click.
{"http://www.w3.org/2001/xml-events",
"mousedown"}
, {"http://www.w3.org/2001/xml-events",
"mouseup"}
, and {"http://www.w3.org/2001/xml-events",
"click"}
. Note that, given the definition of a
click, If one or more of the event types
{"http://www.w3.org/2001/xml-events", "mouseover"}
,
{"http://www.w3.org/2001/xml-events", "mousemove"}
, and
{"http://www.w3.org/2001/xml-events", "mouseout"}
occur between
the press and release of the pointing device button, the
event type {"http://www.w3.org/2001/xml-events", "click"}
cannot
occur. In the case of nested elements, this event type is
always targeted at the most deeply nested element.
{"http://www.w3.org/2001/xml-events", "keyup"}
is produced. Whether a keydown contributes or not to the
generation of a text event is implementation dependent.
{"http://www.w3.org/2001/xml-events", "keydown"}
is
produced. Whether a keyup contributes or not to the
generation of a text event is implementation dependent.
{"http://www.w3.org/2001/xml-events",
"DOMNodeRemoved"}
will fire before this event type.
{"http://www.w3.org/2001/xml-events",
"DOMNodeInserted"}
will fire before this event
type.
Attr
has been modified on a
node. The target
node of this event is the parent
Element
node whose Attr
changed.
It is expected that string based replacement of an
Attr
value will be viewed as a modification
of the Attr
since its identity does not
change. Subsequently replacement of the Attr
node with a different Attr
node is viewed as
the removal of the first Attr
node and the
addition of the second.
CharacterData.data
or
ProcessingInstruction.data
have been modified
but the node itself has not been inserted or deleted. The
target node of
this event is the CharacterData
node or the
ProcessingInstruction
node.
namespaceURI
and/or the
nodeName
of an Element
node have
been modified (e.g., the element was renamed using
Document.renameNode()
). The target of this
event is the renamed Element
node.
namespaceURI
and/or the
nodeName
of a Attr
node have
been modified (e.g., the attribute was renamed using
Document.renameNode
). The target of this
event is the parent Element
node whose
Attr
has been renamed.
Document
node.
Document
node.
The following table provides additional information on the event types. All events will accomplish the capture and target phases, but not all of them will accomplish the bubbling phase (see also DOM event flow). Some events are not cancelable (see Default actions and cancelable events). Some events will only be dispatched to a specific set of possible targets, specified using node types. Contextual information related to the event type is accessible using DOM interfaces.
type | Bubbling phase | Cancelable | Target node types | DOM interface |
---|---|---|---|---|
DOMActivate | Yes | Yes |
Element |
UIEvent |
DOMFocusIn | Yes | No |
Element |
UIEvent |
DOMFocusOut | Yes | No |
Element |
UIEvent |
textInput | Yes | Yes |
Element |
TextEvent |
click | Yes | Yes |
Element |
MouseEvent |
mousedown | Yes | Yes |
Element |
MouseEvent |
mouseup | Yes | Yes |
Element |
MouseEvent |
mouseover | Yes | Yes |
Element |
MouseEvent |
mousemove | Yes | Yes |
Element |
MouseEvent |
mouseout | Yes | Yes |
Element |
MouseEvent |
keydown | Yes | Yes |
Element |
KeyboardEvent |
keyup | Yes | Yes |
Element |
KeyboardEvent |
DOMSubtreeModified | Yes | No |
Document , DocumentFragment ,
Element , Attr
|
MutationEvent |
DOMNodeInserted | Yes | No |
Element , Attr ,
Text , Comment ,
CDATASection , DocumentType ,
EntityReference , ProcessingInstruction |
MutationEvent |
DOMNodeRemoved | Yes | No |
Element , Attr ,
Text , Comment ,
CDATASection , DocumentType ,
EntityReference , ProcessingInstruction |
MutationEvent |
DOMNodeRemovedFromDocument | No | No |
Element , Attr ,
Text , Comment ,
CDATASection , DocumentType ,
EntityReference , ProcessingInstruction |
MutationEvent |
DOMNodeInsertedIntoDocument | No | No |
Element , Attr ,
Text , Comment ,
CDATASection , DocumentType ,
EntityReference , ProcessingInstruction |
MutationEvent |
DOMAttrModified | Yes | No |
Element |
MutationEvent |
DOMCharacterDataModified | Yes | No |
Text , Comment ,
CDATASection ,
ProcessingInstruction
|
MutationEvent |
DOMElementNameChanged | Yes | No |
Element
|
MutationNameEvent |
DOMAttributeNameChanged | Yes | No |
Element
|
MutationNameEvent |
load | No | No |
Document , Element
|
Event |
unload | No | No |
Document , Element
|
Event |
abort | Yes | No |
Element
|
Event |
error | Yes | No |
Element
|
Event |
select | Yes | No |
Element
|
Event |
change | Yes | No |
Element
|
Event |
submit | Yes | Yes |
Element
|
Event |
reset | Yes | Yes |
Element
|
Event |
resize | Yes | No |
Document , Element
|
UIEvent |
scroll | Yes | No |
Document , Element
|
UIEvent |
As an example, the event {"http://www.w3.org/2001/xml-events", "load"}
will trigger event listeners attached on Element
nodes for that event and on the capture and target phases. This
event cannot be cancelled. If an event listener for the load
event is attached to a node other than Element
nodes, or if it is attached to the bubbling phase only, this
event listener cannot be triggered.
The event objects associated with the event types described above may contain context information. Refer to the description of the DOM interfaces for further information.
Namespace URIs were
only introduced in DOM Level 3 Events and were not part of DOM
Level 2 Events. DOM Level 2 Events methods are namespace
ignorant and the event type is only represented by an XML name, specified in the
Event.type
attribute.
Therefore, while it is safe to use these methods when not
dealing with namespaces, using them and the new ones at the same
time should be avoided. DOM Level 2 Events methods solely
identify events by their Event.type
. On the
contrary, the namespaces aware DOM Level 3 Events methods,
identify attribute nodes by their
Event.namespaceURI
and
Event.type
. Because of this fundamental difference,
mixing both sets of methods can lead to unpredictable
results. For example, using
EventTarget.addEventListenerNS(namespaceURI, type,
listener, ...)
, two event listeners (or more) could be
registered using the same type
and same
useCapture
values, but different
namespaceURI
s. Calling
EventTarget.removeEventListener(type, listener,
...)
with that type
and
useCapture
could then remove any or none of those
event listeners. The result depends on the implementation. The
only guarantee in such cases is that all methods which access an
event listener by its namespaceURI
and
type
will access the same event listener. For
instance, EventTarget.removeEventListenerNS(namespaceURI,
type, listener, ...)
removes the event that
EventTarget.addEventListenerNS(namespaceURI, type,
listener, ...)
added.
For compatibility reasons, the dispatching of an event will
ignore namespace URIs if either the event or the event listener
has a null
namespace URI. If a DOM Level 2 event
(i.e. with a null
namespace URI) is dispatched in
the DOM tree, all event listeners that match the
type
will be triggered as described in the DOM event flow. If a DOM Level 3 event (i.e. with a
namespace URI) is dispatched in the DOM tree, all event listeners
with the same type and the same or null
namespace
URI will be triggered as described in the DOM event flow.
Note: This section is informative.
There are mainly two ways to associate an event listener to a node in the tree:
EventTarget
methods.EventTarget
methods
The user can attach an event listener using the methods on the
EventTarget
interface:
myCircle.addEventListenerNS("http://www.w3.org/2001/xml-events", "DOMActivate", myListener, true, null);
The methods do not provide the ability to register the same event listener more than once for the same event type and the same phase. It is not possible to register an event listener:
To register an event listener, DOM applications must use the
methods EventTarget.addEventListener()
and
EventTarget.addEventListenerNS()
.
An EventListener
being registered on an
EventTarget
may choose to have that
EventListener
triggered during the capture phase by
specifying the useCapture
parameter of the
EventTarget.addEventListener()
or
EventTarget.addEventListenerNS()
methods to be
true
. If false
, the
EventListener
will be triggered during the target
and bubbling phases.
In [XML Events], event listeners are attached using elements and attributes:
<listener event="DOMActivate" observer="myCircle" handler="#myListener" phase="capture" propagate="stop"/>
Event listeners can only be registered on Element
nodes, i.e. other Node
types are not addressable,
and cannot be registered for a specific group either, i.e. they
are always attached to the default group. The target phase and the bubbling phase are coupled
during the registration. [XML Events] does not address namespaces in event types. If
the value of the event
attribute of the
listener
element contains a colon (':'), it should
be interpreted as a QName as defined in [XML Schema Part 2].
In [VoiceXML 2.0], event listeners are attached using elements:
<form> <field> <prompt>Please say something</prompt> <catch event="error.noauthorization"> <prompt>You don't have the authorization!</prompt> </catch> <catch event="connection.disconnect.hangup"> <prompt>Connection error</prompt> </catch> <catch event="connection.disconnect"> <prompt>Connection error</prompt> </catch> </field> <catch event="error"> <prompt>Unknown error</prompt> </catch> </form>
Event listeners can only be registered on Element
nodes, i.e. other Node
types are not addressable,
and cannot be registered for a specific group either, i.e. they
are always attached to the default group. The target phase and the bubbling phase are coupled
during the registration. [VoiceXML 2.0] does not address namespaces in event types but
uses the notion of event categories. The event type
"connection.disconnect.hangup"
could be associated to
the event categories
{"http://www.example.org/2003/voicexml", "connection"}
and {"http://www.example.org/2003/voicexml",
"connection.disconnect"}
.
In languages such as [HTML 4.01], [XHTML 1.0], or [SVG 1.1], event listeners are specified as attributes:
<circle id="myCircle" onactivate="myListener(evt)" cx="300" cy="225" r="100" fill="red"/>
Since only one attribute with the same name can appear on an
element, it is therefore not possible to register more than one
event listener on a single EventTarget
for the
event type. Also, event listeners can only be registered on
Element
nodes for the target phase and bubbling phase, i.e. other
Node
types and the capture phase are not
addressable with these languages. Event listeners cannot be
registered for a specific group either, i.e. they are always
attached to the default group.
In order to achieve compatibility with those languages,
implementors may view the setting of attributes which represent
event handlers as the creation and registration of an
EventListener
on the EventTarget
. The value
of useCapture
defaults to false
. This
EventListener
behaves in the same manner as any
other EventListeners
which may be registered on the
EventTarget
. If the attribute representing the
event listener is changed, this may be viewed as the removal of
the previously registered EventListener
and the
registration of a new one. Furthermore, no specification is made
as to the order in which event attributes will receive the event
with regards to the other EventListeners
on the
EventTarget
.
The interfaces described in this section are fundamental to DOM Level 3 Events and must always be supported by the implementation.
The Event
interface is used to provide contextual
information about an event to the listener processing the event.
An object which implements the Event
interface is
passed as the parameter to an EventListener
. More
specific context information is passed to event listeners by
deriving additional interfaces from Event
which
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 Event
interface, use
the DocumentEvent.createEvent("Event")
method call.
// Introduced in DOM Level 2: interface Event { // PhaseType const unsigned short CAPTURING_PHASE = 1; const unsigned short AT_TARGET = 2; const unsigned short BUBBLING_PHASE = 3; readonly attribute DOMString type; readonly attribute EventTarget target; readonly attribute EventTarget currentTarget; readonly attribute unsigned short eventPhase; readonly attribute boolean bubbles; readonly attribute boolean cancelable; readonly attribute DOMTimeStamp timeStamp; void stopPropagation(); void preventDefault(); void initEvent(in DOMString eventTypeArg, in boolean canBubbleArg, in boolean cancelableArg); // Introduced in DOM Level 3: readonly attribute DOMString namespaceURI; // Introduced in DOM Level 3: boolean isCustom(); // Introduced in DOM Level 3: void stopImmediatePropagation(); // Introduced in DOM Level 3: boolean isDefaultPrevented(); // Introduced in DOM Level 3: void initEventNS(in DOMString namespaceURIArg, in DOMString eventTypeArg, in boolean canBubbleArg, in boolean cancelableArg); };
An integer indicating which phase of the event flow is being processed as defined in DOM event flow.
AT_TARGET
BUBBLING_PHASE
CAPTURING_PHASE
bubbles
of type boolean
, readonlytrue
,
otherwise the value is false
.
cancelable
of type boolean
, readonlytrue
, otherwise the value is
false
.
currentTarget
of type EventTarget
, readonlyEventTarget
whose
EventListeners
are 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 DOM event flow.
eventPhase
of type unsigned short
, readonlynamespaceURI
of type DOMString
, readonly, introduced in DOM Level 3null
if it is unspecified.
Event.initEvent()
, this is always null
.
target
of type EventTarget
, readonlytimeStamp
of type DOMTimeStamp
, readonlytimeStamp
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.
type
of type DOMString
, readonlyEvent.namespaceURI
is different
from null
, this attribute represents a local name.
initEvent
initEvent
method is used to initialize the
value of an Event
created through the
DocumentEvent.createEvent
method. This method may
only be called before the Event
has been dispatched
via the EventTarget.dispatchEvent()
method. If the
method is called several times before invoking
EventTarget.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 the Event
interface only the values specified in
this method are modified, all other attributes are left
unchanged.
Event.type
attribute to
eventTypeArg
, and Event.namespaceURI
to null
. To initialize an event with a namespace
URI, use the Event.initEventNS(namespaceURIArg, eventTypeArg,
...)
method.
eventTypeArg
of type
DOMString
Event.type
.
canBubbleArg
of type
boolean
Event.bubbles
. This parameter
overrides the intrinsic bubbling behavior of the event.
cancelableArg
of type
boolean
Event.cancelable
. This parameter
overrides the intrinsic cancelable behavior of the event.
initEventNS
introduced in DOM Level 3initEventNS
method is used to initialize the
value of an Event
object and has the same behavior
as Event.initEvent()
.
namespaceURIArg
of type
DOMString
Event.namespaceuRI
, the namespace URI associated
with this event, or null
if no namespace.
eventTypeArg
of type
DOMString
Event.type
, the local name of the event
type.canBubbleArg
of type
boolean
Event.initEvent()
method for
a description of this parameter.cancelableArg
of type
boolean
Event.initEvent()
method for a
description of this parameter.
isCustom
introduced in DOM Level 3false
, unless the
event implements the CustomEvent
interface.
|
|
isDefaultPrevented
introduced in DOM Level 3true
if the method
Event.preventDefault()
has been called for this
event, false
otherwise.
|
|
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 (see also Default actions and cancelable events), 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
stopPropagation
or
stopImmediatePropagation
for that effect.
stopImmediatePropagation
introduced in DOM Level 3stopPropagation
its
effect is immediate (see Event propagation and event groups). 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.
stopPropagation
currentTarget
have been
triggered (see Event propagation and event groups). 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 preventDefault
for that effect.
The EventTarget
interface is implemented by all the
objects which could be event
targets in an implementation which supports the Event flows. The interface allows registration, removal
or query of event listeners, and dispatch of events to an event
target.
When used with DOM event flow, this interface is
implemented by all target
nodes and target ancestors, i.e. all DOM
Nodes
of the tree support this interface when the
implementation conforms to DOM Level 3 Events and, therefore, this
interface can be obtained by using binding-specific casting
methods on an instance of the Node
interface.
Invoking addEventListener
or
addEventListenerNS
multiple times on the same
EventTarget
with the same parameters
(namespaceURI
, type
,
listener
, and useCapture
) is considered
to be a no-op and thus independently of the event group. They do
not cause the EventListener
to be called more than
once and do not cause a change in the triggering order. In order
to guarantee that an event listener will be added to the event
target for the specified event group, one needs to invoke
removeEventListener
or
removeEventListenerNS
first.
// Introduced in DOM Level 2: interface EventTarget { void addEventListener(in DOMString type, in EventListener listener, in boolean useCapture); void removeEventListener(in DOMString type, in EventListener listener, in boolean useCapture); // Modified in DOM Level 3: boolean dispatchEvent(in Event evt) raises(EventException); // Introduced in DOM Level 3: void addEventListenerNS(in DOMString namespaceURI, in DOMString type, in EventListener listener, in boolean useCapture, in DOMObject evtGroup); // Introduced in DOM Level 3: void removeEventListenerNS(in DOMString namespaceURI, in DOMString type, in EventListener listener, in boolean useCapture); // Introduced in DOM Level 3: boolean willTriggerNS(in DOMString namespaceURI, in DOMString type); // Introduced in DOM Level 3: boolean hasEventListenerNS(in DOMString namespaceURI, in DOMString type); };
addEventListener
useCapture
parameter, on the capture phase of the DOM event flow or its
target and bubbling phases.
type
of type
DOMString
Event.type
associated with the
event for which the user is registering.
listener
of type
EventListener
listener
parameter takes an object
implemented by the user which implements the
EventListener
interface and contains the method
to be called when the event occurs.
useCapture
of type
boolean
useCapture
indicates that the user
wishes to add the event listener for the capture phase only,
i.e. this event listener will not be triggered during the
target and bubbling phases. If
false
, the event listener will only be
triggered during the target and bubbling phases.
addEventListenerNS
introduced in DOM Level 3useCapture
parameter, on the capture phase of the
DOM event flow or its target and bubbling phases.
namespaceURI
of type
DOMString
Event.namespaceURI
associated
with the event for which the user is registering.
type
of type
DOMString
Event.type
associated
with the event for which the user is registering.
listener
of type
EventListener
listener
parameter takes an object
implemented by the user which implements the
EventListener
interface and contains the method
to be called when the event occurs.
useCapture
of type
boolean
useCapture
indicates that the user
wishes to add the event listener for the capture phase only,
i.e. this event listener will not be triggered during the
target and bubbling phases. If
false
, the event listener will only be
triggered during the target and bubbling phases.
evtGroup
of type
DOMObject
EventListener
(see also Event propagation and event groups). Use
null
to attach the event listener to the
default group.
dispatchEvent
modified in DOM Level 3EventTarget
object on which
dispatchEvent
is called.
evt
of type
Event
|
Indicates whether any of the listeners which handled the event
called |
UNSPECIFIED_EVENT_TYPE_ERR: Raised if the
DISPATCH_REQUEST_ERR: Raised if the
NOT_SUPPORTED_ERR: Raised if the |
hasEventListenerNS
introduced in DOM Level 3EventTarget
contains an event listener registered
for the specified event type. This is useful for determining at
which nodes within a hierarchy altered handling of specific
event types has been introduced, but should not be used to
determine whether the specified event type triggers an event
listener (see EventTarget.willTriggerNS()
).
namespaceURI
of type
DOMString
Event.namespaceURI
associated
with the event.
type
of type
DOMString
Event.type
associated
with the event.
|
|
removeEventListener
removeEventListener
with arguments which do
not identify any currently registered EventListener
on the EventTarget
has no effect.
type
of type
DOMString
Event.type
for which the user
registered the event listener.
listener
of type
EventListener
EventListener
to be removed.
useCapture
of type
boolean
EventListener
being
removed was registered for the capture phase or not. If a
listener was registered twice, once for the capture phase
and once for the target and bubbling phases, each must be
removed separately. Removal of an event listener registered
for the capture phase does not affect the same event
listener registered for the target and bubbling phases, and
vice versa.
removeEventListenerNS
introduced in DOM Level 3removeEventListenerNS
with arguments which
do not identify any currently registered
EventListener
on the EventTarget
has
no effect.
namespaceURI
of type
DOMString
Event.namespaceURI
associated
with the event for which the user registered the event
listener.
type
of type
DOMString
Event.type
associated with the
event for which the user registered the event listener.
listener
of type
EventListener
EventListener
parameter indicates the
EventListener
to be removed.
useCapture
of type
boolean
EventListener
being
removed was registered for the capture phase or not. If a
listener was registered twice, once for the capture phase
and once for the target and bubbling phases, each must be
removed separately. Removal of an event listener registered
for the capture phase does not affect the same event
listener registered for the target and bubbling phases, and
vice versa.
willTriggerNS
introduced in DOM Level 3EventTarget
or one of
its ancestors, will be triggered by the specified event type
during the dispatch of the event to this event target or one of
its descendants.
namespaceURI
of type
DOMString
Event.namespaceURI
associated
with the event.
type
of type
DOMString
Event.type
associated with the
event.
|
|
The EventListener
interface is the primary way for
handling events. Users implement the EventListener
interface and register their event listener on an
EventTarget
. The users should also remove their
EventListener
from its EventTarget
after
they have completed using the listener.
Copying a Node
, with methods such as
Node.cloneNode
or Range.cloneContents
,
does not copy the event listeners attached to it. Event listeners
must be attached to the newly created Node
afterwards
if so desired.
Moving a Node
, with methods
Document.adoptNode
, Node.appendChild
, or
Range.extractContents
, does not affect the event
listeners attached to it.
// Introduced in DOM Level 2: interface EventListener { void handleEvent(in Event evt); };
Event operations may throw an EventException
as specified in
their method descriptions.
// Introduced in DOM Level 2: exception EventException { unsigned short code; }; // EventExceptionCode const unsigned short UNSPECIFIED_EVENT_TYPE_ERR = 0; // Introduced in DOM Level 3: const unsigned short DISPATCH_REQUEST_ERR = 1;
An integer indicating the type of error generated.
DISPATCH_REQUEST_ERR
, introduced in DOM Level 3.Event
object is already dispatched in the
tree.
UNSPECIFIED_EVENT_TYPE_ERR
Event.type
was not specified by initializing
the event before the method was called. Specification of the
Event.type
as null
or an empty string
will also trigger this exception.
In most cases, the events dispatched by the DOM Events
implementation are also created by the implementation. It is
however possible to simulate events such as mouse events by
creating the Event
objects and dispatch them using
the DOM Events implementation.
DOM Events provides two ways for creating Event
objects. An application can either create Event
objects that are known to the implementation, or create its own
objects and have them dispatched by the DOM Events
implementation.
Creating Event
objects that are known to the DOM
Events implementation is done using
DocumentEvent.createEvent()
. The application must
then initialize the object by calling the appropriate
initialization method before invoking
EventTarget.dispatchEvent()
. The Event
objects created must be known by the DOM Events implementation;
otherwise an event exception is thrown.
The DOM application might want to create its own
Event
objects, in order to change the default
Event
implementation provided by the DOM Events
implementation or to generate new event types with specific
contextual information. In any case, the application is
responsible for creating and initializing the Event
object. The application can then dispatch the event using the
DOM Events implementation by using
EventTarget.dispatchEvent()
.
However, the DOM Events implementation requires to have access
to two attributes in the Event
object in order to
accomplish the dispatch appropriately:
Event.currentTarget
and
Event.eventPhase
. Those attributes are defined as
readonly
in the Event
interface since
event listeners must not change them and it is the
responsibility of the DOM Events implementation to update them
during the event flow. Therefore, implementing the
Event
interface when creating its own events is not
enough for an application since the DOM Events implementation
will not be able to update the current phase and the current
node during the dispatch, unless the event object also
implements the CustomEvent
interface to give access
to the relevant attributes.
The DocumentEvent
interface provides a mechanism by
which the user can create an Event
object of a type
supported by the implementation. If the feature "Events" is
supported by the Document
object, the
DocumentEvent
interface must be implemented on the
same object. If the feature "+Events" is supported by the
Document
object, an object that supports the
DocumentEvent
interface must be returned by invoking
the method Node.getFeature("+Events", "3.0")
on the
Document
object.
// Introduced in DOM Level 2: interface DocumentEvent { Event createEvent(in DOMString eventType) raises(DOMException); // Introduced in DOM Level 3: boolean canDispatch(in DOMString namespaceURI, in DOMString type); };
canDispatch
introduced in DOM Level 3namespaceURI
of type
DOMString
Event.namespaceURI
of the event.
type
of type
DOMString
Event.type
of the event.
|
|
createEvent
eventType
of type
DOMString
eventType
parameter specifies the name of
the DOM Events interface to be supported by the created
event object, e.g. "Event"
,
"MouseEvent"
, "MutationEvent"
and so on. If the Event
is to be dispatched via the
EventTarget.dispatchEvent()
method the
appropriate event init method must be called after creation
in order to initialize the Event
's values.
UIEvent
would invoke
DocumentEvent.createEvent("UIEvent")
. The
UIEvent.initUIEventNS()
method could then be
called on the newly created UIEvent
object to
set the specific type of user interface event to be
dispatched, {"http://www.w3.org/2001/xml-events", "DOMActivate"}
for example, and set its context information,
e.g. UIEvent.detail
in this example.
createEvent
method is used in creating
Event
s when it is either inconvenient or
unnecessary for the user to create an Event
themselves. In cases where the implementation provided
Event
is insufficient, users may supply their
own Event
implementations for use with the
EventTarget.dispatchEvent()
method. However, the
DOM implementation needs access to the attributes
Event.currentTarget
and
Event.eventPhase
to appropriately propagate the
event in the DOM tree. Therefore users' Event
implementations might need to support the
CustomEvent
interface for that effect.
Note:
For backward compatibility reason, "UIEvents",
"MouseEvents", "MutationEvents", and "HTMLEvents" feature
names are valid values for the parameter
eventType
and represent respectively the
interfaces "UIEvent", "MouseEvent", "MutationEvent", and
"Event".
The newly created event object. |
|
NOT_SUPPORTED_ERR: Raised if the implementation does not
support the |
The CustomEvent
interface gives access to the
attributes Event.currentTarget
and
Event.eventPhase
. It is intended to be used by the
DOM Events implementation to access the underlying current target
and event phase while dispatching a custom Event
in
the tree; it is also intended to be implemented, and not
used, by DOM applications.
The methods contained in this interface are not intended to be
used by a DOM application, especially during the dispatch on the
Event
object. Changing the current target or the
current phase may result in unpredictable results of the event
flow. The DOM Events implementation should ensure that both
methods return the appropriate current target and phase before
invoking each event listener on the current target to protect DOM
applications from malicious event listeners.
Note:
If this interface is supported by the event object,
Event.isCustom()
must return true
.
// Introduced in DOM Level 3: interface CustomEvent : Event { void setDispatchState(in EventTarget target, in unsigned short phase); boolean isPropagationStopped(); boolean isImmediatePropagationStopped(); };
isImmediatePropagationStopped
isImmediatePropagationStopped
method is used by
the DOM Events implementation to know if the method
stopImmediatePropagation()
has been called for this
event. It returns true
if the
method has been called, false
otherwise.
|
|
isPropagationStopped
true
if the method
stopPropagation()
has been called for this event,
false
in any other cases.
|
|
setDispatchState
setDispatchState
method is used by the DOM
Events implementation to set the values of
Event.currentTarget
and
Event.eventPhase
. It also reset the states of
isPropagationStopped
and
isImmediatePropagationStopped
.
target
of type
EventTarget
Event.currentTarget
attribute.
phase
of type
unsigned short
Event.eventPhase
attribute.
The DOM Event Model allows a DOM implementation to support multiple modules of events. The model has been designed to allow addition of new event modules if required. The DOM will not attempt to define all possible events. For purposes of interoperability, the DOM defines a module of user interface events including lower level device dependent events and a module of document mutation events.
The User Interface event module contains basic event types associated with user interfaces.
The UIEvent
interface provides specific contextual
information associated with User Interface events.
To create an instance of the UIEvent
interface, use
the DocumentEvent.createEvent("UIEvent")
method call.
// Introduced in DOM Level 2: interface UIEvent : Event { readonly attribute views::AbstractView view; readonly attribute long detail; void initUIEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in views::AbstractView viewArg, in long detailArg); // Introduced in DOM Level 3: void initUIEventNS(in DOMString namespaceURI, in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in views::AbstractView viewArg, in long detailArg); };
initUIEvent
initUIEvent
method is used to initialize the
value of a UIEvent
object and has the same behavior
as Event.initEvent()
.
typeArg
of type
DOMString
Event.initEvent()
method for a
description of this parameter.
canBubbleArg
of type
boolean
Event.initEvent()
method for a
description of this parameter.
cancelableArg
of type
boolean
Event.initEvent()
method for a
description of this parameter.
viewArg
of type
views::AbstractView
UIEvent.view
.detailArg
of type
long
UIEvent.detail
.
initUIEventNS
introduced in DOM Level 3initUIEventNS
method is used to initialize the
value of a UIEvent
object and has the same behavior
as Event.initEventNS()
.
namespaceURI
of type
DOMString
Event.initEventNS()
method for a
description of this parameter.
typeArg
of type
DOMString
Event.initEventNS()
method for a
description of this parameter.
canBubbleArg
of type
boolean
Event.initEventNS()
method for a
description of this parameter.
cancelableArg
of type
boolean
Event.initEventNS()
method for a
description of this parameter.
viewArg
of type
views::AbstractView
UIEvent.initUIEvent()
method for a
description of this parameter.
detailArg
of type
long
UIEvent.initUIEvent()
method for a
description of this parameter.
The User Interface event types are listed below. For a full
description of the semantics associated with these event types,
refer to the Complete list of event types. A DOM
application may use the hasFeature(feature,
version)
method of the DOMImplementation
interface with parameter values "UIEvents"
and "3.0"
(respectively) to determine whether or not the DOM Level 3 User
Interface event types are supported by the implementation. In
order to fully support this module, an implementation must also
support the "Events"
feature defined in this specification and
the "Views"
feature defined in the DOM Level 2 Views
specification [DOM Level 2 Views]. For
additional information about conformance,
please see the DOM Level 3 Core specification [DOM Level 3 Core]. The DOM Level 3 User Interface Events module is
built on top of the DOM Level 2 User Interface Events [DOM Level 2 Events] module, i.e. a DOM Level 3 User Interface
Events implementation where hasFeature("UIEvents",
"3.0")
returns true
must also return
true
when the version
number is
"2.0"
, ""
or, null
.
type | Context information |
---|---|
DOMActivate |
UIEvent.view is in use.
|
DOMFocusIn | (same as above) |
DOMFocusOut | (same as above) |
The text event module originates from the [HTML 4.01] onkeypress
attribute. Unlike
this attribute, the event type {"http://www.w3.org/2001/xml-events",
"textInput"}
applies only to characters and is designed
for use with any text input devices, not just keyboards. Refer
to Appendix A, "Keyboard events and key identifiers", for examples on how
text events are used in combination with keyboard events.
The TextEvent
interface provides specific contextual
information associated with Text Events.
To create an instance of the TextEvent
interface, use
the DocumentEvent.createEvent("TextEvent")
method
call.
// Introduced in DOM Level 3: interface TextEvent : UIEvent { readonly attribute DOMString data; void initTextEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in views::AbstractView viewArg, in DOMString dataArg); void initTextEventNS(in DOMString namespaceURI, in DOMString type, in boolean canBubbleArg, in boolean cancelableArg, in views::AbstractView viewArg, in DOMString dataArg); };
data
of type DOMString
, readonlydata
holds the value of the characters generated by
the character device. This may be a single Unicode character or
a non-empty sequence of Unicode characters [Unicode]. Characters should be normalized as defined by
the Unicode normalization form NFC, defined in
[UTR #15]. This attribute cannot be
null or contain the empty string.
initTextEvent
initTextEvent
method is used to initialize the
value of a TextEvent
object and has the same
behavior as UIEvent.initUIEvent()
. The value of
UIEvent.detail
remains undefined.
typeArg
of type
DOMString
UIEvent.initUIEvent()
method for a
description of this parameter.
canBubbleArg
of type
boolean
UIEvent.initUIEvent()
method for a
description of this parameter.
cancelableArg
of type
boolean
UIEvent.initUIEvent()
method for a
description of this parameter.
viewArg
of type
views::AbstractView
UIEvent.initUIEvent()
method for a
description of this parameter.
dataArg
of type
DOMString
TextEvent.data
.
initTextEventNS
initTextEventNS
method is used to initialize
the value of a TextEvent
object and has the same
behavior as UIEvent.initUIEventNS()
. The value of
UIEvent.detail
remains undefined.
namespaceURI
of type
DOMString
UIEvent.initUIEventNS()
method for a
description of this parameter.
type
of type
DOMString
UIEvent.initUIEventNS()
method for a
description of this parameter.
canBubbleArg
of type
boolean
UIEvent.initUIEventNS()
method for a
description of this parameter.
cancelableArg
of type
boolean
UIEvent.initUIEventNS()
method for a
description of this parameter.
viewArg
of type
views::AbstractView
UIEvent.initUIEventNS()
method for a
description of this parameter.
dataArg
of type
DOMString
TextEvent.initTextEvent()
method for a
description of this parameter.
The text event type is listed below. For a full description of
the semantics associated with this event type, refer to the
Complete list of event types. A DOM application
may use the hasFeature(feature, version)
method of
the DOMImplementation
interface with parameter
values "TextEvents"
and "3.0"
(respectively) to determine whether or not the Text event module
is supported by the implementation. In order to fully support
this module, an implementation must also support the
"UIEvents"
feature defined in this
specification. For additional information about conformance,
please see the DOM Level 3 Core specification [DOM Level 3 Core].
type | Context information |
---|---|
textInput |
UIEvent.view and TextEvent.data are
in use.
|
The Mouse event module originates from the [HTML 4.01] onclick
,
ondblclick
, onmousedown
,
onmouseup
, onmouseover
,
onmousemove
, and onmouseout
attributes. This event module is specifically designed for use
with pointing input devices, such as a mouse or a trackball.
The MouseEvent
interface provides specific contextual
information associated with Mouse events.
In the case of nested elements mouse events are always targeted at the most deeply nested element. Ancestors of the targeted element may use bubbling to obtain notification of mouse events which occur within theirs descendent elements.
To create an instance of the MouseEvent
interface,
use the DocumentEvent.createEvent("MouseEvent")
method
call.
Note:
When initializing MouseEvent
objects using
initMouseEvent
or initMouseEventNS
,
implementations should use the client coordinates
clientX
and clientY
for calculation of
other coordinates (such as target coordinates exposed by
DOM Level 0
implementations).
// Introduced in DOM Level 2: interface MouseEvent : UIEvent { readonly attribute long screenX; readonly attribute long screenY; readonly attribute long clientX; readonly attribute long clientY; readonly attribute boolean ctrlKey; readonly attribute boolean shiftKey; readonly attribute boolean altKey; readonly attribute boolean metaKey; readonly attribute unsigned short button; readonly attribute EventTarget relatedTarget; void initMouseEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in views::AbstractView viewArg, in long detailArg, in long screenXArg, in long screenYArg, in long clientXArg, in long clientYArg, in boolean ctrlKeyArg, in boolean altKeyArg, in boolean shiftKeyArg, in boolean metaKeyArg, in unsigned short buttonArg, in EventTarget relatedTargetArg); // Introduced in DOM Level 3: boolean getModifierState(in DOMString keyIdentifierArg); // Introduced in DOM Level 3: void initMouseEventNS(in DOMString namespaceURI, in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in views::AbstractView viewArg, in long detailArg, in long screenXArg, in long screenYArg, in long clientXArg, in long clientYArg, in unsigned short buttonArg, in EventTarget relatedTargetArg, in DOMString modifiersList); };
altKey
of type boolean
, readonlytrue
if the alt (alternative) key modifier is activated.
Note: The Option key modifier on Macintosh systems must be represented using this key modifier.
button
of type unsigned short
, readonlybutton
is used to indicate which
mouse button changed state. 0
indicates the normal
button of the mouse (in general on the left or the one button on
Macintosh mice, used to activate a button or select
text). 2
indicates the contextual property (in
general on the right, used to display a context menu) button of
the mouse if present. 1
indicates the extra (in
general in the middle and often combined with the mouse wheel)
button. Some mice may provide or simulate more buttons, and
values higher than 2
can be used to represent
such buttons.
clientX
of type long
, readonlyclientY
of type long
, readonlyctrlKey
of type boolean
, readonlytrue
if the control (Ctrl) key modifier is
activated.
metaKey
of type boolean
, readonlytrue
if the meta (Meta) key modifier is activated.
Note: The Command key modifier on Macintosh system must be represented using this meta key.
relatedTarget
of type EventTarget
, readonlyEventTarget
related to
a UI event. Currently this attribute is used with the mouseover
event to indicate the EventTarget
which the
pointing device exited and with the mouseout event to indicate
the EventTarget
which the pointing device
entered.screenX
of type long
, readonlyscreenY
of type long
, readonlyshiftKey
of type boolean
, readonlytrue
if the shift (Shift) key modifier is
activated.
getModifierState
introduced in DOM Level 3keyIdentifierArg
of type
DOMString
KeyboardEvent.keyIdentifier
attribute. Common
modifier keys are "Alt"
,
"AltGraph"
, "CapsLock"
,
"Control"
, "Meta"
,
"NumLock"
, "Scroll"
, or
"Shift"
.
Note:
If an application wishes to distinguish between right and
left modifiers, this information could be deduced using
keyboard events and
KeyboardEvent.keyLocation
.
|
|
initMouseEvent
initMouseEvent
method is used to initialize the
value of a MouseEvent
object and has the same
behavior as UIEvent.initUIEvent()
.
typeArg
of type
DOMString
UIEvent.initUIEvent()
method for a
description of this parameter.
canBubbleArg
of type
boolean
UIEvent.initUIEvent()
method for a
description of this parameter.
cancelableArg
of type
boolean
UIEvent.initUIEvent()
method for a
description of this parameter.
viewArg
of type
views::AbstractView
UIEvent.initUIEvent()
method for a
description of this parameter.
detailArg
of type
long
UIEvent.initUIEvent()
method for a
description of this parameter.
screenXArg
of type
long
MouseEvent.screenX
.
screenYArg
of type
long
MouseEvent.screenY
.
clientXArg
of type
long
MouseEvent.clientX
.
clientYArg
of type
long
MouseEvent.clientY
.
ctrlKeyArg
of type
boolean
MouseEvent.ctrlKey
.
altKeyArg
of type
boolean
MouseEvent.altKey
.
shiftKeyArg
of type
boolean
MouseEvent.shiftKey
.
metaKeyArg
of type
boolean
MouseEvent.metaKey
.
buttonArg
of type
unsigned short
MouseEvent.button
.
relatedTargetArg
of type
EventTarget
MouseEvent.relatedTarget
.
initMouseEventNS
introduced in DOM Level 3initMouseEventNS
method is used to initialize
the value of a MouseEvent
object and has the same
behavior as UIEvent.initUIEventNS()
.
namespaceURI
of type
DOMString
UIEvent.initUIEventNS()
method for a
description of this parameter.
typeArg
of type
DOMString
UIEvent.initUIEventNS()
method for a
description of this parameter.
canBubbleArg
of type
boolean
UIEvent.initUIEventNS()
method for a
description of this parameter.
cancelableArg
of type
boolean
UIEvent.initUIEventNS()
method for a
description of this parameter.
viewArg
of type
views::AbstractView
UIEvent.initUIEventNS()
method for a
description of this parameter.
detailArg
of type
long
UIEvent.initUIEventNS()
method for a
description of this parameter.
screenXArg
of type
long
MouseEvent.initMouseEvent()
method for a
description of this parameter.
screenYArg
of type
long
MouseEvent.initMouseEvent()
method for a
description of this parameter.
clientXArg
of type
long
MouseEvent.initMouseEvent()
method for a
description of this parameter.
clientYArg
of type
long
MouseEvent.initMouseEvent()
method for a
description of this parameter.
buttonArg
of type
unsigned short
MouseEvent.initMouseEvent()
method for a
description of this parameter.
relatedTargetArg
of type
EventTarget
MouseEvent.initMouseEvent()
method for a
description of this parameter.
modifiersList
of type
DOMString
"Control Alt"
will activated the control and
alt modifiers.
The Mouse event types are listed below. For a full description of the semantics associated with these event types, refer to the Complete list of event types. In the case of nested elements, mouse event types are always targeted at the most deeply nested element. Ancestors of the targeted element may use bubbling to obtain notification of mouse events which occur within its descendent elements.
A DOM application may use the hasFeature(feature,
version)
method of the DOMImplementation
interface with parameter values "MouseEvents"
and
"3.0"
(respectively) to determine whether or not
the Mouse event module is supported by the implementation. In
order to fully support this module, an implementation must also
support the "UIEvents" feature defined in this
specification. For additional information about conformance,
please see the DOM Level 3 Core specification [DOM Level 3 Core]. The DOM Level 3 Mouse Events
module is built on top of the DOM Level 2 Mouse Events [DOM Level 2 Events] module, i.e. a DOM Level 3 Mouse Events
implementation where hasFeature("MouseEvents",
"3.0")
returns true
must also return
true
when the version
number is
"2.0"
, ""
or, null
.
type | Context information |
---|---|
click |
MouseEvent.screenX ,
MouseEvent.screenY ,
MouseEvent.clientX ,
MouseEvent.clientY ,
MouseEvent.altKey ,
MouseEvent.ctrlKey ,
MouseEvent.shiftKey ,
MouseEvent.metaKey ,
MouseEvent.altGraphKey ,
MouseEvent.button , and
UIEvent.view are in use. The
UIEvent.detail attribute indicates the number
of consecutive clicks of a pointing device button during
a user action. The attribute value is 1 when
the user begins this action and increments by
1 for each click. The notion of consecutive
clicks depends on the environment configuration. For
example, a "double click" will not happen if there is a
long delay between the two clicks, even if the pointing
device did not move.
|
mousedown |
MouseEvent.screenX ,
MouseEvent.screenY ,
MouseEvent.clientX ,
MouseEvent.clientY ,
MouseEvent.altKey ,
MouseEvent.ctrlKey ,
MouseEvent.shiftKey ,
MouseEvent.metaKey ,
MouseEvent.altGraphKey ,
MouseEvent.button , and
UIEvent.view are in use. The
UIEvent.detail attribute indicates the number
of consecutive clicks, incremented by one, of a pointing
device button during a user action. For example, if no click
happened before the mousedown, UIEvent.detail
will contain the value 1 .
|
mouseup |
MouseEvent.screenX ,
MouseEvent.screenY ,
MouseEvent.clientX ,
MouseEvent.clientY ,
MouseEvent.altKey ,
MouseEvent.ctrlKey ,
MouseEvent.shiftKey ,
MouseEvent.metaKey ,
MouseEvent.altGraphKey ,
MouseEvent.button , and
UIEvent.view are in use. The
UIEvent.detail attribute indicates the number
of consecutive clicks, incremented by one, of a pointing
device button during a user action.
|
mouseover |
MouseEvent.screenX ,
MouseEvent.screenY ,
MouseEvent.clientX ,
MouseEvent.clientY ,
MouseEvent.altKey ,
MouseEvent.ctrlKey ,
MouseEvent.shiftKey ,
MouseEvent.metaKey ,
MouseEvent.altGraphKey , and
UIEvent.view are in
use. MouseEvent.relatedTarget indicates the
event target a
pointing device is exiting.
|
mousemove |
MouseEvent.screenX ,
MouseEvent.screenY ,
MouseEvent.clientX ,
MouseEvent.clientY ,
MouseEvent.altKey ,
MouseEvent.ctrlKey ,
MouseEvent.shiftKey ,
MouseEvent.metaKey ,
MouseEvent.altGraphKey , and
UIEvent.view are in use.
|
mouseout |
MouseEvent.screenX ,
MouseEvent.screenY ,
MouseEvent.clientX ,
MouseEvent.clientY ,
MouseEvent.altKey ,
MouseEvent.ctrlKey ,
MouseEvent.shiftKey ,
MouseEvent.metaKey ,
MouseEvent.altGraphKey , and
UIEvent.view are in
use. MouseEvent.relatedTarget indicates the
event target a
pointing device is entering.
|
As an example, a "double-click" on a mouse device will produce
the following events (the value of UIEvent.detail
is indicated in parenthesis):
"http://www.w3.org/2001/xml-events", "mousedown"
}
(1
)"http://www.w3.org/2001/xml-events", "mouseup"
}
(1
)"http://www.w3.org/2001/xml-events", "click"
}
(1
)"http://www.w3.org/2001/xml-events", "mousedown"
}
(2
)"http://www.w3.org/2001/xml-events", "mouseup"
}
(2
)"http://www.w3.org/2001/xml-events", "click"
}
(2
)Keyboard events are device dependent, i.e. they rely on the capabilities of the input devices and how they are mapped in the operating systems. It is therefore highly recommended to rely on Text events types when dealing with character input.
The KeyboardEvent
interface provides specific
contextual information associated with keyboard devices. Each
keyboard event references a key using an identifier. Keyboard
events are commonly directed at the element that has the
focus.
The KeyboardEvent
interface provides convenient
attributes for some common modifiers keys:
KeyboardEvent.ctrlKey
,
KeyboardEvent.shiftKey
,
KeyboardEvent.altKey
,
KeyboardEvent.metaKey
. These attributes are
equivalent to use the method
KeyboardEvent.getModifierState(keyIdentifierArg)
with
"Control", "Shift", "Alt", or "Meta" respectively.
To create an instance of the KeyboardEvent
interface,
use the DocumentEvent.createEvent("KeyboardEvent")
method call.
// Introduced in DOM Level 3: interface KeyboardEvent : UIEvent { // KeyLocationCode const unsigned long DOM_KEY_LOCATION_STANDARD = 0x00; const unsigned long DOM_KEY_LOCATION_LEFT = 0x01; const unsigned long DOM_KEY_LOCATION_RIGHT = 0x02; const unsigned long DOM_KEY_LOCATION_NUMPAD = 0x03; readonly attribute DOMString keyIdentifier; readonly attribute unsigned long keyLocation; readonly attribute boolean ctrlKey; readonly attribute boolean shiftKey; readonly attribute boolean altKey; readonly attribute boolean metaKey; boolean getModifierState(in DOMString keyIdentifierArg); void initKeyboardEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in views::AbstractView viewArg, in DOMString keyIdentifierArg, in unsigned long keyLocationArg, in DOMString modifiersList); void initKeyboardEventNS(in DOMString namespaceURI, in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in views::AbstractView viewArg, in DOMString keyIdentifierArg, in unsigned long keyLocationArg, in DOMString modifiersList); };
This set of constants is used to indicate the location of a key on the device. In case a DOM implementation wishes to provide a new location information, a value different from the following constant values must be used.
DOM_KEY_LOCATION_LEFT
DOM_KEY_LOCATION_NUMPAD
DOM_KEY_LOCATION_RIGHT
DOM_KEY_LOCATION_STANDARD
altKey
of type boolean
, readonlytrue
if the alternative (Alt) key modifier is
activated.
Note: The Option key modifier on Macintosh systems must be represented using this key modifier.
ctrlKey
of type boolean
, readonlytrue
if the control (Ctrl) key modifier is
activated.
keyIdentifier
of type DOMString
, readonlykeyIdentifier
holds the identifier of the key. The
key identifiers are defined in Appendix A.2 "Key identifiers set". Implementations that are unable to identify
a key must use the key identifier "Unidentified"
.
keyLocation
of type unsigned long
, readonlykeyLocation
attribute contains an indication of
the location of they key on the device, as described in Keyboard event types.
metaKey
of type boolean
, readonlytrue
if the meta (Meta) key modifier is activated.
Note: The Command key modifier on Macintosh systems must be represented using this key modifier.
shiftKey
of type boolean
, readonlytrue
if the shift (Shift) key modifier is
activated.
getModifierState
keyIdentifierArg
of type
DOMString
"Alt"
, "AltGraph"
,
"CapsLock"
, "Control"
,
"Meta"
, "NumLock"
,
"Scroll"
, or "Shift"
.
Note:
If an application wishes to distinguish between right and
left modifiers, this information could be deduced using
keyboard events and
KeyboardEvent.keyLocation
.
|
|
initKeyboardEvent
initKeyboardEvent
method is used to initialize
the value of a KeyboardEvent
object and has the
same behavior as UIEvent.initUIEvent()
. The value of
UIEvent.detail
remains undefined.
typeArg
of type
DOMString
UIEvent.initUIEvent()
method for a
description of this parameter.
canBubbleArg
of type
boolean
UIEvent.initUIEvent()
method for a
description of this parameter.
cancelableArg
of type
boolean
UIEvent.initUIEvent()
method for a
description of this parameter.
viewArg
of type
views::AbstractView
UIEvent.initUIEvent()
method for a
description of this parameter.
keyIdentifierArg
of type
DOMString
KeyboardEvent.keyIdentifier
.
keyLocationArg
of type
unsigned long
KeyboardEvent.keyLocation
.
modifiersList
of type
DOMString
initKeyboardEventNS
initKeyboardEventNS
method is used to initialize
the value of a KeyboardEvent
object and has the
same behavior as UIEvent.initUIEventNS()
. The value of
UIEvent.detail
remains undefined.
namespaceURI
of type
DOMString
UIEvent.initUIEventNS()
method for a
description of this parameter.
typeArg
of type
DOMString
UIEvent.initUIEventNS()
method for a
description of this parameter.
canBubbleArg
of type
boolean
UIEvent.initUIEventNS()
method for a
description of this parameter.
cancelableArg
of type
boolean
UIEvent.initUIEventNS()
method for a
description of this parameter.
viewArg
of type
views::AbstractView
UIEvent.initUIEventNS()
method for
a description of this parameter.
keyIdentifierArg
of type
DOMString
KeyboardEvent.initKeyboardEvent()
method for a description of this parameter.
keyLocationArg
of type
unsigned long
KeyboardEvent.initKeyboardEvent()
method for a description of this parameter.
modifiersList
of type
DOMString
"Control Alt"
will activated the control and
alt modifiers.
Depending on the character generation device, keyboard events may or may not be generated.
The keyboard event types are listed below. For a full
description of the semantics associated with these event types,
refer to the Complete list of event types. A DOM
application may use the hasFeature(feature,
version)
method of the DOMImplementation
interface with parameter values "KeyboardEvents"
and "3.0"
(respectively) to determine whether or
not the Keyboard event module is supported by the
implementation. In order to fully support this module, an
implementation must also support the "UIEvents"
feature defined in this specification. For additional
information about conformance,
please see the DOM Level 3 Core specification [DOM Level 3 Core].
type | Context information |
---|---|
keydown |
UIEvent.view ,
KeyboardEvent.keyIdentifier ,
KeyboardEvent.location ,
KeyboardEvent.altKey ,
KeyboardEvent.altGraphKey ,
KeyboardEvent.shiftKey ,
KeyboardEvent.ctrlKey , and
KeyboardEvent.metaKey are in use.
|
keyup |
UIEvent.view ,
KeyboardEvent.keyIdentifier , and
KeyboardEvent.location are in use.
KeyboardEvent.altKey ,
KeyboardEvent.altGraphKey ,
KeyboardEvent.shiftKey ,
KeyboardEvent.ctrlKey , and
KeyboardEvent.metaKey are in use unless the
Keyboard.keyIdentifier corresponds to the key
modifier itself.
|
The mutation and mutation name event modules are designed to allow notification of any changes to the structure of a document, including attribute, text, or name modifications. It may be noted that none of the event types associated with the modules are designated as cancelable. This stems from the fact that it is very difficult to make use of existing DOM interfaces which cause document modifications if any change to the document might or might not take place due to cancelation of the resulting event. Although this is still a desired capability, it was decided that it would be better left until the addition of transactions into the DOM.
Many single modifications of the tree can cause multiple mutation events to be dispatched. Rather than attempt to specify the ordering of mutation events due to every possible modification of the tree, the ordering of these events is left to the implementation.
The MutationEvent
interface provides specific contextual
information associated with Mutation events.
To create an instance of the MutationEvent
interface,
use the DocumentEvent.createEvent("MutationEvent")
method call.
// Introduced in DOM Level 2: interface MutationEvent : Event { // attrChangeType const unsigned short MODIFICATION = 1; const unsigned short ADDITION = 2; const unsigned short REMOVAL = 3; readonly attribute Node relatedNode; readonly attribute DOMString prevValue; readonly attribute DOMString newValue; readonly attribute DOMString attrName; readonly attribute unsigned short attrChange; void initMutationEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in Node relatedNodeArg, in DOMString prevValueArg, in DOMString newValueArg, in DOMString attrNameArg, in unsigned short attrChangeArg); // Introduced in DOM Level 3: void initMutationEventNS(in DOMString namespaceURI, in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in Node relatedNodeArg, in DOMString prevValueArg, in DOMString newValueArg, in DOMString attrNameArg, in unsigned short attrChangeArg); };
An integer indicating in which way the Attr
was
changed.
ADDITION
Attr
was just added.MODIFICATION
Attr
was modified in place.REMOVAL
Attr
was just removed.attrChange
of type unsigned short
, readonlyattrChange
indicates the type of change which
triggered the {"http://www.w3.org/2001/xml-events", "DOMAttrModified"}
event. The values can be MODIFICATION
,
ADDITION
, or REMOVAL
.
attrName
of type DOMString
, readonlyattrName
indicates the name of the changed
Attr
node in a {"http://www.w3.org/2001/xml-events",
"DOMAttrModified"}
event.
newValue
of type DOMString
, readonlynewValue
indicates the new value of the
Attr
node in {"http://www.w3.org/2001/xml-events",
"DOMAttrModified"}
events, and of the
CharacterData
node in {"http://www.w3.org/2001/xml-events",
"DOMCharacterDataModified"}
events.
prevValue
of type DOMString
, readonlyprevValue
indicates the previous value of the
Attr
node in {"http://www.w3.org/2001/xml-events",
"DOMAttrModified"}
events, and of the
CharacterData
node in {"http://www.w3.org/2001/xml-events",
"DOMCharacterDataModified"}
events.
relatedNode
of type Node
, readonlyrelatedNode
is used to identify a secondary node
related to a mutation event. For example, if a mutation event
is dispatched to a node indicating that its parent has changed,
the relatedNode
is the changed parent. If an event
is instead dispatched to a subtree indicating a node was changed
within it, the relatedNode
is the changed node. In
the case of the {"http://www.w3.org/2001/xml-events",
"DOMAttrModified"}
event it indicates the
Attr
node which was modified, added, or removed.
initMutationEvent
initMutationEvent
method is used to initialize
the value of a MutationEvent
object and has the
same behavior as Event.initEvent()
.
typeArg
of type
DOMString
Event.initEvent()
method for a
description of this parameter.
canBubbleArg
of type
boolean
Event.initEvent()
method for a
description of this parameter.
cancelableArg
of type
boolean
Event.initEvent()
method for a
description of this parameter.
relatedNodeArg
of type
Node
MutationEvent.relatedNode
.
prevValueArg
of type
DOMString
MutationEvent.prevValue
. This value
may be null.
newValueArg
of type
DOMString
MutationEvent.newValue
. This value
may be null.
attrNameArg
of type
DOMString
MutationEvent.attrname
. This value
may be null.
attrChangeArg
of type
unsigned short
MutationEvent.attrChange
. This value
may be null.
initMutationEventNS
introduced in DOM Level 3initMutationEventNS
method is used to
initialize the value of a MutationEvent
object and
has the same behavior as Event.initEventNS()
.
namespaceURI
of type
DOMString
Event.initEventNS()
method for a
description of this parameter.
typeArg
of type
DOMString
Event.initEventNS()
method for a
description of this parameter.
canBubbleArg
of type
boolean
Event.initEventNS()
method for a
description of this parameter.
cancelableArg
of type
boolean
Event.initEventNS()
method for a
description of this parameter.
relatedNodeArg
of type
Node
MutationEvent.initMutationEvent()
method for a description of this parameter.
prevValueArg
of type
DOMString
MutationEvent.initMutationEvent()
method for a description of this parameter.
newValueArg
of type
DOMString
MutationEvent.initMutationEvent()
method for a description of this parameter.
attrNameArg
of type
DOMString
MutationEvent.initMutationEvent()
method for a description of this parameter.
attrChangeArg
of type
unsigned short
MutationEvent.initMutationEvent()
method for a description of this parameter.
The mutation event types are listed below. For a full
description of the semantics associated with these event types,
refer to the Complete list of event types. A DOM
application may use the hasFeature(feature,
version)
method of the DOMImplementation
interface with parameter values "MutationEvents"
and "3.0"
(respectively) to determine whether or
not the MutationEvent
is supported by the
implementation. In order to fully support this module, an
implementation must also support the "Events"
feature defined in this specification. For additional
information about conformance,
please see the DOM Level 3 Core specification [DOM Level 3 Core]. This
MutationEvent
interface is built on top of the DOM
Level 2 Mutation Events [DOM Level 2 Events] module,
i.e. a DOM Level 3 MutationEvent
interface
implementation where
hasFeature("MutationEvents","3.0")
returns
true
must also return true
when the
version
number is "2.0"
,
""
or, null
.
type | Context information |
---|---|
DOMSubtreeModified | None |
DOMNodeInserted |
MutationEvent.relatedNode holds the parent
node of the node being inserted.
|
DOMNodeRemoved |
MutationEvent.relatedNode holds the parent
node of the node being removed.
|
DOMNodeRemovedFromDocument | None |
DOMNodeInsertedIntoDocument | None |
DOMAttrModified |
MutationEvent.attrName is in use. The value
of MutationEvent.relatedNode indicates the
Attr node whose value has been affected. The
value of MutationEvent.attrChange indicates
whether the Attr was modified, added, or
removed. If the Attr node is being added,
MutationEvent.newValue is in use. If the
Attr node is being removed,
MutationEvent.prevValue is in value. If the
Attr node is being modified,
MutationEvent.newValue and
MutationEvent.prevValue are in use.
|
DOMCharacterDataModified |
MutationEvent.prevValue , and
MutationEvent.newValue are in use.
|
The MutationNameEvent
interface provides specific
contextual information associated with Mutation name event types.
To create an instance of the MutationNameEvent
interface, use the
Document.createEvent("MutationNameEvent")
method
call.
// Introduced in DOM Level 3: interface MutationNameEvent : MutationEvent { readonly attribute DOMString prevNamespaceURI; readonly attribute DOMString prevNodeName; // Introduced in DOM Level 3: void initMutationNameEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in Node relatedNodeArg, in DOMString prevNamespaceURIArg, in DOMString prevNodeNameArg); // Introduced in DOM Level 3: void initMutationNameEventNS(in DOMString namespaceURI, in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in Node relatedNodeArg, in DOMString prevNamespaceURIArg, in DOMString prevNodeNameArg); };
prevNamespaceURI
of type DOMString
, readonlyrelatedNode
's
namespaceURI
.
prevNodeName
of type DOMString
, readonlyrelatedNode
's
nodeName
.
initMutationNameEvent
introduced in DOM Level 3initMutationNameEvent
method is used to
initialize the value of a MutationNameEvent
object
and has the same behavior as
MutationEvent.initMutationEvent()
.
typeArg
of type
DOMString
MutationEvent.initMutationEvent()
method for a description of this parameter.
canBubbleArg
of type
boolean
MutationEvent.initMutationEvent()
method for a description of this parameter.
cancelableArg
of type
boolean
MutationEvent.initMutationEvent()
method for a description of this parameter.
relatedNodeArg
of type
Node
MutationEvent.initMutationEvent()
method for a description of this parameter.
prevNamespaceURIArg
of type
DOMString
MutationNameEvent.prevNamespaceURI
. This value
may be null
.prevNodeNameArg
of type
DOMString
MutationNameEvent.prevNodeName
.
initMutationNameEventNS
introduced in DOM Level 3initMutationNameEventNS
method is used to
initialize the value of a MutationNameEvent
object
and has the same behavior as
MutationEvent.initMutationEventNS()
.
namespaceURI
of type
DOMString
MutationEvent.initMutationEventNS()
method for
a description of this parameter.
typeArg
of type
DOMString
MutationEvent.initMutationEventNS()
method for
a description of this parameter.
canBubbleArg
of type
boolean
MutationEvent.initMutationEventNS()
method for
a description of this parameter.
cancelableArg
of type
boolean
MutationEvent.initMutationEventNS()
method for
a description of this parameter.
relatedNodeArg
of type
Node
MutationEvent.initMutationEventNS()
method for
a description of this parameter.
prevNamespaceURIArg
of type
DOMString
MutationEvent.initMutationEvent()
method for a description of this parameter.
prevNodeNameArg
of type
DOMString
MutationEvent.initMutationEvent()
method for a description of this parameter.
The mutation name event types are listed below. For a full
description of the semantics associated with these event types,
refer to the Complete list of event types. A DOM
application may use the hasFeature(feature,
version)
method of the DOMImplementation
interface with parameter values "MutationNameEvents" and "3.0"
(respectively) to determine whether or not the
MutationNameEvent
is supported by the
implementation. In order to fully support this module, an
implementation must also support the
"MutationEvents"
feature defined in this
specification and the "Core"
feature defined in the
DOM Level 3 Core specification [DOM Level 3 Core]. For additional information about conformance,
please see the DOM Level 3 Core specification [DOM Level 3 Core].
type | Context information |
---|---|
DOMElementNameChanged |
MutationNameEvent.prevNamespaceURI , and
MutationNameEvent.prevNodeName are in use.
|
DOMAttributeNameChanged |
MutationNameEvent.prevNamespaceURI , and
MutationNameEvent.prevNodeName are in
use. The value of MutationEvent.relatedNode
contains the renamed Attr node.
|
This event module contains basic event types associated with document manipulation.
A DOM application may use the hasFeature(feature,
version)
method of the DOMImplementation
interface with parameter values "BasicEvents"
and
"3.0"
(respectively) to determine whether or not
the basic event module is supported by the implementation. In
order to fully support this module, an implementation must also
support the "Events"
feature defined in this
specification. For additional information about conformance,
please see the DOM Level 3 Core specification [DOM Level 3 Core].
The basic event types are listed below. For a full description of the semantics associated with these event types, refer to the Complete list of event types.
The event types {"http://www.w3.org/2001/xml-events", "resize"}
and
{"http://www.w3.org/2001/xml-events", "scroll"}
implement the
UIEvent
interface. All other HTML event types implement
at least the basic Event
interface. However, they
may be generated from a user interface; in that case, the event
objects also implements the UIEvent
interface and
UIEvent.view
is in use.
type | Context information |
---|---|
load |
UIEvent.view may be in use.
|
unload | (same as above) |
abort | (same as above) |
error | (same as above) |
select | (same as above) |
change | (same as above) |
submit | (same as above) |
reset | (same as above) |
resize |
UIEvent.view is in use.
|
scroll |
UIEvent.view is in use.
|
The HTML event module is composed of events listed in [HTML 4.01] and additional events which
are supported in DOM Level
0 browsers. It refines the semantics and scope of the
basic event types and provides two new event types. This event
module is only applicable if the Document
supports
the [DOM Level 2 HTML]
specification. Use Node.isSupported(feature,
version)
with the parameter values "HTML" and "2.0"
(respectively) to determine whether or not the
Document
node supports the HTML module.
A DOM application may use the hasFeature(feature,
version)
method of the DOMImplementation
interface with parameter values "HTMLEvents"
and
"3.0"
(respectively) to determine whether or not
the HTML event module is supported by the implementation. In
order to fully support this module, an implementation must also
support the "BasicEvents"
feature defined in this
specification and the "HTML"
feature defined in
[DOM Level 2 HTML]. For additional information about
conformance,
please see the DOM Level 3 Core specification [DOM Level 3 Core]. The DOM Level 3 HTML Events module is built on
top of the DOM Level 2 HTML Events [DOM Level 2 Events]
module, i.e. a DOM Level 3 HTML Events implementation where
hasFeature("HTMLEvents", "3.0")
returns
true
must also return true
when the
version
number is "2.0"
,
""
or, null
.
The following descriptions of event types are refinements of the
general descriptions provided in Complete list of event types, with the addition of the
events {"http://www.w3.org/2001/xml-events", "focus"}
and
{"http://www.w3.org/2001/xml-events", "blur"}
. All events types are
bound to the namespace URI "http://www.w3.org/2001/xml-events"
and the
following list only enumerates the local name of the event type.
focus()
methods and the attributes defined in
[DOM Level 2 HTML]. This event is
valid for INPUT, SELECT, and TEXTAREA element.
HTMLFormElement.submit()
method defined in
[DOM Level 2 HTML] does not fire
this event type.
HTMLFormElement.reset()
method defined in
[DOM Level 2 HTML]. This event
only applies to the FORM element.
focus()
methods defined in [DOM Level 2 HTML], or by tabbing
navigation. This event is only valid for the following
elements: A, AREA, LABEL, INPUT, SELECT, TEXTAREA, and
BUTTON. This event type is dispatched after the event type
{"http://www.w3.org/2001/xml-events", "DOMFocusIn"
}.
blur()
methods defined in [DOM Level 2 HTML], or by tabbing
navigation. This event is only valid for the following
elements: A, AREA, LABEL, INPUT, SELECT, TEXTAREA, and
BUTTON. This event type is dispatched after the event type
{"http://www.w3.org/2001/xml-events", "DOMFocusOut"
}.
The following table provides refinements or additional information on the event types. Some events will only be dispatched to a specific set of possible targets, specified using HTML node types.
type | Bubbling phase | Cancelable | Target node types | DOM interface |
---|---|---|---|---|
load | [no changes] | [no changes] |
HTMLDocument ,
HTMLBodyElement ,
HTMLFrameSetElement ,
HTMLObjectElement ,
HTMLLinkElement ,
HTMLMetaElement ,
HTMLScriptElement ,
HTMLFrameElement ,
HTMLIFrameElement ,
HTMLImageElement
| [no changes] |
unload | [no changes] | [no changes] |
HTMLDocument ,
HTMLBodyElement ,
HTMLFrameSetElement
| [no changes] |
abort | [no changes] | [no changes] |
HTMLObjectElement
| [no changes] |
error | [no changes] | [no changes] |
HTMLObjectElement ,
HTMLBodyElement ,
HTMLFrameSetElement
| [no changes] |
select | [no changes] | [no changes] |
HTMLInputElement ,
HTMLTextAreaElement
| [no changes] |
change | [no changes] | [no changes] |
HTMLInputElement ,
HTMLSelectElement ,
HTMLTextAreaElement
| [no changes] |
submit | [no changes] | [no changes] |
HTMLFormElement
| [no changes] |
reset | [no changes] | [no changes] |
HTMLFormElement
| [no changes] |
resize | [no changes] | [no changes] |
HTMLDocument , HTMLElement
| [no changes] |
scroll | [no changes] | [no changes] |
HTMLDocument , HTMLElement
| [no changes] |
focus | No | No |
HTMLAnchorElement ,
HTMLAreaElement ,
HTMLLabelElement ,
HTMLInputElement ,
HTMLSelectElement ,
HTMLtextAreaElement ,
HTMLButtonElement .
|
Event |
blur | No | No |
HTMLAnchorElement ,
HTMLAreaElement ,
HTMLLabelElement ,
HTMLInputElement ,
HTMLSelectElement ,
HTMLtextAreaElement ,
HTMLButtonElement .
|
Event |
The event types {"http://www.w3.org/2001/xml-events", "focus"}
and
{"http://www.w3.org/2001/xml-events", "blur"}
may be generated from a
user interface; in that case, the event objects also implements
the UIEvent
interface and UIEvent.view
is in use.
The concept of activation ({"http://www.w3.org/2001/xml-events",
"DOMActivate"}
) was introduced in [DOM Level 2 Events] to separate generic actions from the
devices used to activate them. For example, an hyperlink can
be activated using a mouse or a keyboard, and the activation
will force the user agent to follow the link. It is expected
that the action of following the link is done using a default
action attached to the hyperlink element. In such case, the
default action of the device event type is to trigger the
event type {"http://www.w3.org/2001/xml-events",
"DOMActivate"}
. Preventing the default action of a
mouse click when the target node is an hyperlink will prevent
the activation. The same approach is made for control
elements.
Implementations could react to an event before dispatching it
and do changes on the display and the DOM tree. In such case,
if a DOM attribute is changed before the event is fired,
cancelling the device event type will also reverse the
change. A good example is the attribute
HTMLInputElement.checked
: As described in [DOM Level 2 HTML], the value of this property may be changed
before the dispatch of the event; the user clicks on the radio
button, the radio button is being checked (or unchecked) on
the display, the attribute
HTMLInputElement.checked
is changed as well, and
then the device event type {"http://www.w3.org/2001/xml-events",
"click"}
is being dispatched. If the default action of
the device event type is prevented, or if the default action
attached to the {"http://www.w3.org/2001/xml-events", "DOMActivate"}
event type is prevented, the property
HTMLInputElement.checked
will need to be changed
back to its original value.