--- a/html/DOM3-Events.html Tue May 27 09:26:23 2014 -0700
+++ b/html/DOM3-Events.html Tue May 27 16:15:00 2014 -0700
@@ -152,19 +152,31 @@
<q>RECOMMENDED</q>, <q>MAY</q>, and <q>OPTIONAL</q> are to be interpreted as described in
[<a href="#RFC2119">RFC2119</a>].</p>
- <p>This specification is to be understood in the context of the DOM Level 3 Core specification [<cite><a class="normative" href="#references-DOMCore">DOM3 Core</a></cite>]
- and the general considerations for DOM implementations apply. For example, handling of <a class="def" href="#glossary-namespaceURI">namespace URIs</a> is discussed in
- <a class="normative" href="http://www.w3.org/TR/DOM-Level-3-Core/core.html#Namespaces-Considerations"><em>XML Namespaces</em></a>. For additional information about
- <a class="normative" href="http://www.w3.org/TR/DOM-Level-3-Core/introduction.html#ID-Conformance"><em>conformance</em></a>, please see the DOM Level 3 Core specification
- [<cite><a class="normative" href="#references-DOMCore">DOM3 Core</a></cite>]. A <a class="def" href="#glossary-user-agent">user agent</a> is not required to conform
- to the entirety of another specification in order to conform to this specification, but it MUST conform to the specific parts of any other specification which are called
- out in this specification (e.g., a conforming DOM3 Events <a class="def" href="#glossary-user-agent">user agent</a> MUST support the <code>DOMString</code> data type as defined
- in <a href="#references-WebIDL">Web IDL</a>, but need not support every method or data type defined in <a href="#references-WebIDL">Web IDL</a> in order to conform
- to DOM3 Events).</p>
-
- <p>This specification defines several classes of conformance for different <a class="def" href="#glossary-user-agent">user agents</a>, specifications, and content authors:</p>
+ <p>This specification is to be understood in the context of the DOM Level 3 Core specification
+ [<cite><a class="normative" href="#references-DOMCore">DOM3 Core</a></cite>] and the general
+ considerations for DOM implementations apply.
+ For example, handling of <a class="def" href="#glossary-namespaceURI">namespace URIs</a> is discussed in
+ <a class="normative" href="http://www.w3.org/TR/DOM-Level-3-Core/core.html#Namespaces-Considerations"><em>XML Namespaces</em></a>.
+ For additional information about
+ <a class="normative" href="http://www.w3.org/TR/DOM-Level-3-Core/introduction.html#ID-Conformance"><em>conformance</em></a>,
+ please see the DOM Level 3 Core specification
+ [<cite><a class="normative" href="#references-DOMCore">DOM3 Core</a></cite>].
+ A <a class="def" href="#glossary-user-agent">user agent</a> is not required to conform
+ to the entirety of another specification in order to conform to this specification, but it MUST
+ conform to the specific parts of any other specification which are called out in this specification
+ (e.g., a conforming DOM3 Events <a class="def" href="#glossary-user-agent">user agent</a> MUST support
+ the <code>DOMString</code> data type as defined in <a href="#references-WebIDL">Web IDL</a>, but need
+ not support every method or data type defined in <a href="#references-WebIDL">Web IDL</a> in order to
+ conform to DOM3 Events).
+ </p>
+
+ <p>This specification defines several classes of conformance for different
+ <a class="def" href="#glossary-user-agent">user agents</a>, specifications, and content authors:
+ </p>
<dl>
- <dt id="conf-interactive-ua">Web browsers and other dynamic or interactive <a class="def" href="#glossary-user-agent">user agents</a></dt>
+ <dt id="conf-interactive-ua">Web browsers and other dynamic or interactive
+ <a class="def" href="#glossary-user-agent">user agents</a>
+ </dt>
<dd>
<p>A dynamic or interactive <a class="def" href="#glossary-user-agent">user agent</a>, referred to
here as a <q>browser</q> (be it a Web browser, AT (Accessibility Technology) application,
@@ -195,66 +207,109 @@
for that <a class="def" href="#glossary-event-type">event type</a> have been met.
</p>
- <p><span id="conform-arch">A browser conforms specifically to the DOM Level 3 Events Architecture if it implements the <a href="#dom-event-architecture">DOM Event
- Architecture</a> and <a href="#event-interfaces">Basic Event Interfaces</a>, regardless of its support for any other event interfaces or <a class="def" href="#glossary-event-type">
- event types</a> defined in this specification.</span> <span id="conform-module">A browser conforms specifically to the DOM Level 3 Events Module if it implements
- the interfaces and its related <a class="def" href="#glossary-event-type">event types</a> specified in the <a href="#events-module">Events Module</a>, and to each
- event interface if it implements that interface and its related <a class="def" href="#glossary-event-type">event types</a>.</span></p>
-
- <p><span id="conform-script">A conforming browser MUST support scripting, declarative interactivity, or some other means of detecting and dispatching events in the manner
- described by this specification, and MUST support the APIs specified for that <a class="def" href="#glossary-event-type">event type</a>.</span></p>
-
- <p>In addition to meeting all other conformance criteria, a conforming browser MAY implement features of this specification marked as <a class="def" href="#glossary-deprecated">
- deprecated</a>, for backwards compatibility with existing content, but such implementation is discouraged.</p>
-
- <p>A conforming browser MAY also support features not found in this specification, but which use the <a href="#event-flow">Event dispatch and DOM event flow</a> mechanism,
- interfaces, events, or other features defined in DOM Level 3 Events, and MAY implement additional interfaces and <a class="def" href="#glossary-event-type">event types</a>
- appropriate to that implementation. Such features can be later standardized in future specifications.</p>
-
- <p>A browser which does not conform to all required portions of this specification MUST NOT claim conformance to DOM Level 3 Events. Such an implementation which
- does conform to portions of this specification MAY claim conformance to those specific portions.</p>
-
- <p>A conforming browser MUST also be a <i>conforming implementation</i> of the IDL fragments in this specification, as described in the Web IDL specification. <a
- href="#references-WebIDL">[WEBIDL]</a></p>
+ <p>A browser conforms specifically to DOM Level 3 Events if it implements
+ the interfaces and its related <a class="def" href="#glossary-event-type">event types</a>
+ specified in <a href="#event-types">Event Types</a>, and to each event interface if it implements
+ that interface and its related <a class="def" href="#glossary-event-type">event types</a>.
+ </p>
+
+ <p>A conforming browser MUST support scripting, declarative interactivity, or some other means of
+ detecting and dispatching events in the manner described by this specification, and MUST support
+ the APIs specified for that <a class="def" href="#glossary-event-type">event type</a>.
+ </p>
+
+ <p>In addition to meeting all other conformance criteria, a conforming browser MAY implement
+ features of this specification marked as
+ <a class="def" href="#glossary-deprecated">deprecated</a>, for backwards compatibility with
+ existing content, but such implementation is discouraged.
+ </p>
+
+ <p>A conforming browser MAY also support features not found in this specification, but which use
+ the <a href="#event-flow">Event dispatch and DOM event flow</a> mechanism, interfaces, events,
+ or other features defined in DOM Level 3 Events, and MAY implement additional interfaces and
+ <a class="def" href="#glossary-event-type">event types</a> appropriate to that implementation.
+ Such features can be later standardized in future specifications.
+ </p>
+
+ <p>A browser which does not conform to all required portions of this specification MUST NOT claim
+ conformance to DOM Level 3 Events.
+ Such an implementation which does conform to portions of this specification MAY claim
+ conformance to those specific portions.
+ </p>
+
+ <p>A conforming browser MUST also be a <i>conforming implementation</i> of the IDL fragments in this
+ specification, as described in the Web IDL specification <a href="#references-WebIDL">[WEBIDL]</a>.
+ </p>
</dd>
<dt id="conf-author-tools">Authoring tools</dt>
<dd>
- <p>A content authoring tool conforms to DOM Level 3 Events if it produces content which uses the <a class="def" href="#glossary-event-type">event types</a> and <a
- href="#event-flow">Event dispatch and DOM event flow</a> model, consistent in a manner as defined in this specification. A content authoring tool MUST NOT claim
- conformance to DOM Level 3 Events for content it produces which uses features of this specification marked as <a class="def" href="#glossary-deprecated">deprecated</a>
- in this specification. A conforming content authoring tool SHOULD provide to the content author a means to use all <a class="def" href="#glossary-event-type">event
- types</a> and interfaces appropriate to all <a class="def" href="#glossary-host-language">host languages</a> in the content document being produced.</p>
+ <p>A content authoring tool conforms to DOM Level 3 Events if it produces content which uses the
+ <a class="def" href="#glossary-event-type">event types</a> and
+ <a href="#event-flow">Event dispatch and DOM event flow</a> model, consistent in a manner as
+ defined in this specification.
+ </p>
+ <p>A content authoring tool MUST NOT claim conformance to DOM Level 3 Events for content it produces
+ which uses features of this specification marked as
+ <a class="def" href="#glossary-deprecated">deprecated</a> in this specification.
+ </p>
+ <p>A conforming content authoring tool SHOULD provide to the content author a means to use all
+ <a class="def" href="#glossary-event-type">event types</a> and interfaces appropriate to all
+ <a class="def" href="#glossary-host-language">host languages</a> in the content document being
+ produced.
+ </p>
</dd>
<dt id="conf-authors">Content authors and content</dt>
<dd>
- <p>A content author creates conforming DOM Level 3 Events content if that content uses the <a class="def" href="#glossary-event-type">event types</a> and <a href="#event-flow">
- Event dispatch and DOM event flow</a> model, consistent in a manner as defined in this specification. A content author SHOULD NOT use features of this specification
- marked as <a class="def" href="#glossary-deprecated">deprecated</a>, but SHOULD rely instead upon replacement mechanisms defined in this specification and elsewhere.
- Conforming content MUST use the semantics of the interfaces and <a class="def" href="#glossary-event-type">event types</a> as described in this specification.</p>
-
- <p class="note"><strong>Authoring Note: </strong>Content authors are advised to follow best practices as described in <a href="http://www.w3.org/TR/WAI-WEBCONTENT/">
- accessibility</a> and <a href="http://www.w3.org/standards/techs/i18n">internationalization</a> guideline specifications.</p>
+ <p>A content author creates conforming DOM Level 3 Events content if that content uses the
+ <a class="def" href="#glossary-event-type">event types</a> and
+ <a href="#event-flow">Event dispatch and DOM event flow</a> model, consistent in a manner as
+ defined in this specification.
+ </p>
+ <p>A content author SHOULD NOT use features of this specification marked as
+ <a class="def" href="#glossary-deprecated">deprecated</a>, but SHOULD rely instead upon
+ replacement mechanisms defined in this specification and elsewhere.
+ </p>
+ <p>Conforming content MUST use the semantics of the interfaces and
+ <a class="def" href="#glossary-event-type">event types</a> as described in this specification.
+ </p>
+
+ <p class="note"><strong>Authoring Note:</strong>
+ Content authors are advised to follow best practices as described in
+ <a href="http://www.w3.org/TR/WAI-WEBCONTENT/">accessibility</a> and
+ <a href="http://www.w3.org/standards/techs/i18n">internationalization</a> guideline
+ specifications.
+ </p>
</dd>
<dt id="conf-specs">Specifications and host languages</dt>
<dd>
- <p>A specification or <a class="def" href="#glossary-host-language">host language</a> conforms to DOM Level 3 Events if it references and uses the <a href="#event-flow">
- Event dispatch and DOM event flow</a> mechanism, interfaces, events, or other features defined in this specification, and does not extend these
- features in incompatible ways. A specification or <a class="def" href="#glossary-host-language">host language</a> conforms specifically to the DOM Level 3 Events
- Architecture if it references and uses the <a href="#dom-event-architecture">DOM Event Architecture</a> and <a href="#event-interfaces">Basic Event Interfaces</a>,
- regardless of its use of any other event interfaces or <a class="def" href="#glossary-event-type">event types</a> defined in this specification.</p>
-
- <p>A specification or <a class="def" href="#glossary-host-language">host language</a> conforms specifically to the DOM Level 3 Events Module if it references and uses the interfaces and
- its related <a class="def" href="#glossary-event-type">event types</a> specified in the <a href="#events-module">Events Module</a>, and to each event interface
- if it references and uses that interface and its related <a class="def" href="#glossary-event-type">event types</a>. A conforming specification MAY
- define additional interfaces and <a class="def" href="#glossary-event-type">event types</a> appropriate to that specification, or MAY extend the DOM Level 3 Events
- interfaces and <a class="def" href="#glossary-event-type">event types</a> in a manner that does not contradict or conflict with the definitions of those interfaces
- and <a class="def" href="#glossary-event-type">event types</a> in this specification.</p>
-
- <p>Specifications or <a class="def" href="#glossary-host-language">host languages</a> which reference DOM Level 3 Events SHOULD NOT use or recommend features of this
- specification marked as <a class="def" href="#glossary-deprecated">deprecated</a>, but SHOULD use or recommend the indicated replacement for that the feature (if available).</p>
+ <p>A specification or <a class="def" href="#glossary-host-language">host language</a> conforms
+ to DOM Level 3 Events if it references and uses the
+ <a href="#event-flow">Event dispatch and DOM event flow</a> mechanism, interfaces, events,
+ or other features defined in [<a href="#references-DOM4">DOM4</a>], and does not extend these
+ features in incompatible ways.
+ </p>
+ <p>A specification or <a class="def" href="#glossary-host-language">host language</a> conforms
+ specifically to the DOM Level 3 Events Module if it references and uses the interfaces and
+ its related <a class="def" href="#glossary-event-type">event types</a> specified in
+ <a href="#event-types">Event Types</a>, and to each event interface if it references
+ and uses that interface and its related
+ <a class="def" href="#glossary-event-type">event types</a>.
+ A conforming specification MAY define additional interfaces and
+ <a class="def" href="#glossary-event-type">event types</a> appropriate to that specification,
+ or MAY extend the DOM Level 3 Events interfaces and
+ <a class="def" href="#glossary-event-type">event types</a> in a manner that does not contradict
+ or conflict with the definitions of those interfaces and
+ <a class="def" href="#glossary-event-type">event types</a> in this specification.
+ </p>
+
+ <p>Specifications or <a class="def" href="#glossary-host-language">host languages</a> which
+ reference DOM Level 3 Events SHOULD NOT use or recommend features of this
+ specification marked as <a class="def" href="#glossary-deprecated">deprecated</a>, but
+ SHOULD use or recommend the indicated replacement for that the feature (if available).
+ </p>
</dd>
</dl>
</section> <!-- dom-events-conformance -->
@@ -300,6 +355,8 @@
<section id="dom-event-architecture">
<h1>DOM Event Architecture</h1>
+ <p><em>This section is informative.</em></p>
+
<section id="event-flow">
<h2>Event dispatch and DOM event flow</h2>
@@ -1327,2510 +1384,2675 @@
</dl>
</section><!-- interface-DocumentEvent -->
+ <section id="event-types-list">
+ <h3>List of Event Types</h3>
+
+ <p>Each event MUST be associated with a type, called <em>event type</em> and available as the <a href="#widl-Event-type"><code class="interface-attribute">type</code></a>
+ attribute on the event object. The event type MUST be of type <code>DOMString</code>.</p>
+
+ <p>Depending on the level of DOM support, or the devices used for display (e.g., screen) or interaction (e.g., mouse, keyboard, touch screen, or voice), these event
+ types can be generated by the implementation. When used with an [<cite><a class="informative" href="#references-XML">XML 1.0</a></cite>] or
+ [<cite><a class="informative" href="#references-HTML5">HTML5</a></cite>] application, the specifications of those languages MAY restrict the
+ semantics and scope (in particular the possible <a class="def" href="#glossary-event-target">event targets</a>) associated
+ with an event type. 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.</p>
+
+ <p>The following table provides an informative summary of the event types defined in this specification.</p>
+
+ <table class="data-table"
+ summary="This table contains the complete list of event types defined by DOM Level 3 Events. The first column contains the local name of the event type. The second column indicates if the event accomplish the bubbling phase or not (all events accomplish the capture and target phases). The third column indicates if the default action associated with the event can be canceled. The fourth column indicates the nodes that can be target of the event. the fifth (and last) column indicates the DOM interface implemented by the event object.">
+ <tr>
+ <th>Event Type</th>
+ <th>Sync / Async</th>
+ <th>Bubbling phase</th>
+ <th>Trusted event target types</th>
+ <th>DOM interface</th>
+ <th>Cancelable</th>
+ <th>Default Action</th>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-abort"><code>abort</code></a></td>
+ <td>Sync</td>
+ <td>No</td>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ <td><a href="#interface-Event"><code>Event</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-InputEvent"><code>InputEvent</code></a></td>
+ <td>Yes</td>
+ <td>Update the DOM element</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-blur"><code>blur</code></a></td>
+ <td>Sync</td>
+ <td>No</td>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-click"><code>click</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td>Yes</td>
+ <td>Varies:
+ for <a class="def" href="#glossary-event-target">targets</a> with an associated activation
+ behavior, executes the <a class="def" href="#glossary-activation-behavior">activation behavior</a>;
+ for focusable <a class="def" href="#glossary-event-target">targets</a>, gives the element focus.
+ </td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
+ <td>Yes</td>
+ <td>Show a <a class="def" href="#glossary-text-composition-system">text composition system</a> candidate window</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td>No</td>
+ <td>Varies:
+ for <a class="def" href="#glossary-event-target">targets</a> with an associated activation
+ behavior, executes the <a class="def" href="#glossary-activation-behavior">activation behavior</a>;
+ for focusable <a class="def" href="#glossary-event-target">targets</a>, gives the element focus;
+ for selectable <a class="def" href="#glossary-event-target">targets</a>, selects part or all of the
+ element's content.
+ </td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-error"><code>error</code></a></td>
+ <td>Async</td>
+ <td>No</td>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ <td><a href="#interface-Event"><code>Event</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-focus"><code>focus</code></a></td>
+ <td>Sync</td>
+ <td>No</td>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-focusin"><code>focusin</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-focusout"><code>focusout</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-InputEvent"><code>InputEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a></td>
+ <td>Yes</td>
+ <td>Varies:
+ <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> and <a class="eventtype" href="#event-type-input"><code>input</code></a> events;
+ launch <a class="def" href="#glossary-text-composition-system">text composition system</a>;
+ <a class="eventtype" href="#event-type-blur"><code>blur</code></a> and <a class="eventtype" href="#event-type-focus"><code>focus</code></a> events;
+ <a class="eventtype" href="#event-type-keypress"><code>keypress</code></a> event;
+ <a class="def" href="#glossary-activation-behavior">activation behavior</a>;
+ other event</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a></td>
+ <td>Yes</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-load"><code>load</code></a></td>
+ <td>Async</td>
+ <td>No</td>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Document</code>, <code>Element</code></td>
+ <td><a href="#interface-Event"><code>Event</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td>Yes</td>
+ <td>Varies: start a drag/drop operation; start a text selection; start a scroll/pan interaction (in combination with the middle mouse button, if supported)</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
+ <td>Sync</td>
+ <td>No</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
+ <td>Sync</td>
+ <td>No</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td><a href="#mousemove-now-cancelable">Yes</a></td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td>Yes</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td>Yes</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td>Yes</td>
+ <td>Invoke a context menu (in combination with the right mouse button, if supported)</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-resize"><code>resize</code></a></td>
+ <td>Sync</td>
+ <td>No</td>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ <td><a href="#interface-UIEvent"><code>UIEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-scroll"><code>scroll</code></a></td>
+ <td>Async</td>
+ <td>No / <a href="#scroll-document">Yes</a></td>
+ <td><code>Document</code>, <code>Element</code></td>
+ <td><a href="#interface-UIEvent"><code>UIEvent</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-select"><code>select</code></a></td>
+ <td>Sync</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-Event"><code>Event</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-unload"><code>unload</code></a></td>
+ <td>Sync</td>
+ <td>No</td>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Document</code>, <code>Element</code></td>
+ <td><a href="#interface-Event"><code>Event</code></a></td>
+ <td>No</td>
+ <td>None</td>
+ </tr>
+ <tr>
+ <td><a class="eventtype" href="#event-type-wheel"><code>wheel</code></a></td>
+ <td>Async</td>
+ <td>Yes</td>
+ <td><code>Element</code></td>
+ <td><a href="#interface-WheelEvent"><code>WheelEvent</code></a></td>
+ <td>Yes</td>
+ <td>Scroll (or zoom) the document</td>
+ </tr>
+ </table>
+
+ <p>For a list of events which are deprecated in this specification, see the <a href="#legacy-event-types">Legacy Event Types</a> appendix
+ at the end of this document.</p>
+
+ <div class="example">
+ <div class="example-title"></div>
+ <p>The following is one way to interpret the above tables: the <a class="eventtype" href="#event-type-load"><code>load</code></a> event will
+ trigger event listeners attached on <code>Element</code> nodes for that event and on the capture and target phases. This event is not cancelable. If an event listener for the
+ <a class="eventtype" href="#event-type-load"><code>load</code></a> event is attached to a node other than <a class="def" href="#glossary-window"><code>Window</code></a>,
+ <code>Document</code>, or <code>Element</code> nodes, or if it is attached to the bubbling phase only, this event listener would not be triggered.</p>
+ </div>
+
+ <p class="note"><strong>Note: </strong>Don't interpret the above tables as definitive for the listed event types. For example, the <a class="eventtype"><code>load</code></a> event is used in other
+ specifications, for example, in XMLHttpRequest. Similarly, <a href="#widl-EventTarget-dispatchEvent"><code>dispatchEvent</code></a> can be used to dispatch untrusted events to
+ listeners on <strong>any</strong> object that also implements <a href="#interface-EventTarget"><code>EventTarget</code></a>.</p>
+
+ <p class="note"><strong>Note: </strong>The event objects associated with the event types described above contain additional context information--refer to the description of the DOM
+ interfaces for further information.</p>
+ </section> <!-- event-types-list -->
+
</section> <!-- event-interfaces -->
<!-- Section 5: The Events ========================================================-->
- <section id="events-module">
- <h1>Events Module</h1>
-
- <section id="event-types">
- <h2>Event Types</h2>
- <p>Each event MUST be associated with a type, called <em>event type</em> and available as the <a href="#widl-Event-type"><code class="interface-attribute">type</code></a>
- attribute on the event object. The event type MUST be of type <code>DOMString</code>.</p>
-
- <section id="event-types-list">
- <h3>List of DOM3 Event Types</h3>
- <p>Depending on the level of DOM support, or the devices used for display (e.g., screen) or interaction (e.g., mouse, keyboard, touch screen, or voice), these event
- types can be generated by the implementation. When used with an [<cite><a class="informative" href="#references-XML">XML 1.0</a></cite>] or
- [<cite><a class="informative" href="#references-HTML5">HTML5</a></cite>] application, the specifications of those languages MAY restrict the
- semantics and scope (in particular the possible <a class="def" href="#glossary-event-target">event targets</a>) associated
- with an event type. 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.</p>
-
- <p>The following table provides an informative summary of the event types defined in this specification.</p>
-
- <table class="data-table"
- summary="This table contains the complete list of event types defined by DOM Level 3 Events. The first column contains the local name of the event type. The second column indicates if the event accomplish the bubbling phase or not (all events accomplish the capture and target phases). The third column indicates if the default action associated with the event can be canceled. The fourth column indicates the nodes that can be target of the event. the fifth (and last) column indicates the DOM interface implemented by the event object.">
- <tr>
- <th>Event Type</th>
- <th>Sync / Async</th>
- <th>Bubbling phase</th>
- <th>Trusted event target types</th>
- <th>DOM interface</th>
- <th>Cancelable</th>
- <th>Default Action</th>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-abort"><code>abort</code></a></td>
- <td>Sync</td>
- <td>No</td>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- <td><a href="#interface-Event"><code>Event</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-InputEvent"><code>InputEvent</code></a></td>
- <td>Yes</td>
- <td>Update the DOM element</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-blur"><code>blur</code></a></td>
- <td>Sync</td>
- <td>No</td>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-click"><code>click</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- <td>Yes</td>
- <td>Varies:
- for <a class="def" href="#glossary-event-target">targets</a> with an associated activation
- behavior, executes the <a class="def" href="#glossary-activation-behavior">activation behavior</a>;
- for focusable <a class="def" href="#glossary-event-target">targets</a>, gives the element focus.
- </td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
- <td>Yes</td>
- <td>Show a <a class="def" href="#glossary-text-composition-system">text composition system</a> candidate window</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- <td>No</td>
- <td>Varies:
- for <a class="def" href="#glossary-event-target">targets</a> with an associated activation
- behavior, executes the <a class="def" href="#glossary-activation-behavior">activation behavior</a>;
- for focusable <a class="def" href="#glossary-event-target">targets</a>, gives the element focus;
- for selectable <a class="def" href="#glossary-event-target">targets</a>, selects part or all of the
- element's content.
- </td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-error"><code>error</code></a></td>
- <td>Async</td>
- <td>No</td>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- <td><a href="#interface-Event"><code>Event</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-focus"><code>focus</code></a></td>
- <td>Sync</td>
- <td>No</td>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-focusin"><code>focusin</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-focusout"><code>focusout</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-InputEvent"><code>InputEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a></td>
- <td>Yes</td>
- <td>Varies:
- <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> and <a class="eventtype" href="#event-type-input"><code>input</code></a> events;
- launch <a class="def" href="#glossary-text-composition-system">text composition system</a>;
- <a class="eventtype" href="#event-type-blur"><code>blur</code></a> and <a class="eventtype" href="#event-type-focus"><code>focus</code></a> events;
- <a class="eventtype" href="#event-type-keypress"><code>keypress</code></a> event;
- <a class="def" href="#glossary-activation-behavior">activation behavior</a>;
- other event</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a></td>
- <td>Yes</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-load"><code>load</code></a></td>
- <td>Async</td>
- <td>No</td>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Document</code>, <code>Element</code></td>
- <td><a href="#interface-Event"><code>Event</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- <td>Yes</td>
- <td>Varies: start a drag/drop operation; start a text selection; start a scroll/pan interaction (in combination with the middle mouse button, if supported)</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
- <td>Sync</td>
- <td>No</td>
- <td><code>Element</code></td>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
- <td>Sync</td>
- <td>No</td>
- <td><code>Element</code></td>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- <td><a href="#mousemove-now-cancelable">Yes</a></td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- <td>Yes</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- <td>Yes</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- <td>Yes</td>
- <td>Invoke a context menu (in combination with the right mouse button, if supported)</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-resize"><code>resize</code></a></td>
- <td>Sync</td>
- <td>No</td>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- <td><a href="#interface-UIEvent"><code>UIEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-scroll"><code>scroll</code></a></td>
- <td>Async</td>
- <td>No / <a href="#scroll-document">Yes</a></td>
- <td><code>Document</code>, <code>Element</code></td>
- <td><a href="#interface-UIEvent"><code>UIEvent</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-select"><code>select</code></a></td>
- <td>Sync</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-Event"><code>Event</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-unload"><code>unload</code></a></td>
- <td>Sync</td>
- <td>No</td>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Document</code>, <code>Element</code></td>
- <td><a href="#interface-Event"><code>Event</code></a></td>
- <td>No</td>
- <td>None</td>
- </tr>
- <tr>
- <td><a class="eventtype" href="#event-type-wheel"><code>wheel</code></a></td>
- <td>Async</td>
- <td>Yes</td>
- <td><code>Element</code></td>
- <td><a href="#interface-WheelEvent"><code>WheelEvent</code></a></td>
- <td>Yes</td>
- <td>Scroll (or zoom) the document</td>
- </tr>
- </table>
-
- <p>For a list of events which are deprecated in this specification, see the <a href="#legacy-event-types">Legacy Event Types</a> appendix
- at the end of this document.</p>
-
- <div class="example">
- <div class="example-title"></div>
- <p>The following is one way to interpret the above tables: the <a class="eventtype" href="#event-type-load"><code>load</code></a> event will
- trigger event listeners attached on <code>Element</code> nodes for that event and on the capture and target phases. This event is not cancelable. If an event listener for the
- <a class="eventtype" href="#event-type-load"><code>load</code></a> event is attached to a node other than <a class="def" href="#glossary-window"><code>Window</code></a>,
- <code>Document</code>, or <code>Element</code> nodes, or if it is attached to the bubbling phase only, this event listener would not be triggered.</p>
- </div>
-
- <p class="note"><strong>Note: </strong>Don't interpret the above tables as definitive for the listed event types. For example, the <a class="eventtype"><code>load</code></a> event is used in other
- specifications, for example, in XMLHttpRequest. Similarly, <a href="#widl-EventTarget-dispatchEvent"><code>dispatchEvent</code></a> can be used to dispatch untrusted events to
- listeners on <strong>any</strong> object that also implements <a href="#interface-EventTarget"><code>EventTarget</code></a>.</p>
-
- <p class="note"><strong>Note: </strong>The event objects associated with the event types described above contain additional context information--refer to the description of the DOM
- interfaces for further information.</p>
- </section> <!-- event-types-list -->
- </section> <!-- event-types -->
-
- <section id="event-definitions">
- <h2>Event Module Definitions</h2>
- <p>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 in the future.
- This document does 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.
+ <section id="event-types">
+ <h2>Event Types</h2>
+ <p>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 in the future.
+ This document does 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.
+ </p>
+
+ <section id="events-uievents">
+ <h3>User Interface Event Types</h3>
+ <p>The User Interface event module contains basic event types associated with user
+ interfaces and document manipulation.
</p>
- <section id="events-uievents">
- <h3>User Interface Event Types</h3>
- <p>The User Interface event module contains basic event types associated with user
- interfaces and document manipulation.
- </p>
-
- <section id="interface-UIEvent">
- <h4>Interface UIEvent</h4>
-
- <p class="intro-dom">Introduced in DOM Level 2</p>
-
- <p>The <code>UIEvent</code> interface provides specific contextual information associated
- with User Interface events.
- </p>
-
- <p>To create an instance of the <code>UIEvent</code> interface, use the
- <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("UIEvent")</code></a>
- method call.
- </p>
-
- <dl class="idl" title="[Constructor(DOMString type, optional UIEventInit eventInitDict)] interface UIEvent : Event">
- <dt>readonly attribute WindowProxy? view</dt>
- <dd>
- <p>The <code>view</code> attribute identifies the <code>Window</code> from which the event was generated.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>null</code>.</p>
- </dd>
-
- <dt>readonly attribute long detail</dt>
- <dd>
- <p>Specifies some detail information about the <a href="#interface-Event"><code>Event</code></a>, depending on the type of event.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>0</code>.</p>
- </dd>
- </dl>
-
- <dl class="idl" title="dictionary UIEventInit : EventInit">
- <dt>WindowProxy? view = null</dt>
- <dd>
- <p>Should be initialized to the Window object of the global environment
- in which this event will be dispatched. If this event will be dispatched
- to an element, the view property should be set to the Window object
- containing the element's <code>ownerDocument</code>.
- </p>
- </dd>
-
- <dt>long detail = 0</dt>
- <dd>
- <p>This value is initialized to a number that is application-specific.
- </p>
- </dd>
- </dl>
-
- </section> <!-- interface-UIEvent -->
-
- <p>The User Interface event types are listed below. Some of these events use the
- <a href="#interface-UIEvent"><code>UIEvent</code></a> interface if generated from a
- user interface, but the <a href="#interface-Event"><code>Event</code></a> interface
- otherwise, as detailed in each event.
+ <section id="interface-UIEvent">
+ <h4>Interface UIEvent</h4>
+
+ <p class="intro-dom">Introduced in DOM Level 2</p>
+
+ <p>The <code>UIEvent</code> interface provides specific contextual information associated
+ with User Interface events.
</p>
- <!-- load -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-load"><dfn><a class="eventtype" href="#event-type-load"><code>load</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>load</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Async</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Document</code>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- common object whose contained resources have loaded</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the DOM implementation finishes loading the resource (such as the document)
- and any dependent resources (such as images, style sheets, or scripts). Dependent resources that fail to load MUST NOT prevent this event from firing if the resource
- that loaded them is still accessible via the DOM. If this event type is dispatched, implementations are REQUIRED to dispatch this event at least on the <code>Document</code>
- node.</p>
-
- <p class="note"><strong>Note:</strong> For legacy reasons, <a class="eventtype" href="#event-type-load"><code>load</code></a> events for resources inside
- the document (e.g., images) do not include the <a class="def" href="#glossary-window">Window</a> in the propagation path in HTML implementations. See
- [<cite><a class="informative" href="#references-HTML5">HTML5</a></cite>] for more information.</p>
- </dd>
- </dl>
- </div>
-
- <!-- unload -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-unload"><dfn><a class="eventtype" href="#event-type-unload"><code>unload</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>unload</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Document</code>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- common object whose contained resources have been removed</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the DOM Implementation removes from the environment the resource (such
- as the document) or any dependent resources (such as images, style sheets, scripts). The document MUST be unloaded after the dispatch of this event type. If this
- event type is dispatched, implementations are REQUIRED to dispatch this event at least on the <code>Document</code> node.</p>
- </dd>
- </dl>
- </div>
-
- <!-- abort -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-abort"><dfn><a class="eventtype" href="#event-type-abort"><code>abort</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>abort</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- element whose resources have been stopped from loading without error</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the loading of a resource has been aborted, such as by a user canceling
- the load while it is still in progress.</p>
- </dd>
- </dl>
- </div>
-
- <!-- error -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-error"><dfn><a class="eventtype" href="#event-type-error"><code>error</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>error</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Async</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- element whose resources have been stopped from loading due to an error</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a resource failed to load, or has been loaded but cannot be interpreted
- according to its semantics, such as an invalid image, a script execution error, or non-well-formed XML.</p>
- </dd>
- </dl>
- </div>
-
- <!-- select -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-select"><dfn><a class="eventtype" href="#event-type-select"><code>select</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>select</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- element whose text content has been selected</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a user selects some text. This event is dispatched after the selection
- has occurred.</p>
-
- <p>This specification does not provide contextual information to access the selected text. Where applicable, a <a class="def" href="#glossary-host-language">host
- language</a> SHOULD define rules for how a user MAY select content (with consideration for international language conventions), at what point the <a class="eventtype"
- href="#event-type-select"><code>select</code></a> event is dispatched, and how a content author MAY access the user-selected content.</p>
-
- <p class="note"><strong>Note:</strong> In order to access to user-selected content, content authors will use native capabilities of the <a
- class="def" href="#glossary-host-language">host languages</a>, such as the <code>Document.getSelection()</code> method of the <a href="https://dvcs.w3.org/hg/editing/raw-file/tip/editing.html#selections">
- HTML Editing APIs</a> [<cite><a class="informative" href="#references-HTMLEd">HTML Editing</a></cite>].</p>
-
- <p class="note"><strong>Note:</strong> The <a class="eventtype" href="#event-type-select"><code>select</code></a> event might not be available
- for all elements in all languages. For example, in [<cite><a class="informative" href="#references-HTML5">HTML5</a></cite>], <a class="eventtype" href="#event-type-select">
- <code>select</code></a> events can be dispatched only on form <code>input</code> and <code>textarea</code> elements. Implementations can dispatch <a class="eventtype"
- href="#event-type-select"><code>select</code></a> events in any context deemed appropriate, including text selections outside of form controls, or image or
- markup selections such as in SVG.</p>
- </dd>
- </dl>
- </div>
-
- <!-- resize -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-resize"><dfn><a class="eventtype" href="#event-type-resize"><code>resize</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>resize</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-UIEvent"><code>UIEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- object which has been resized</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a document view has been resized. This event type is dispatched after
- all effects for that occurrence of resizing of that particular <a class="def" href="#glossary-event-target">event target</a> have been executed by the <a class="def"
- href="#glossary-user-agent">user agent</a>.</p>
-
- <p><a class="def" href="#glossary-user-agent">User agents</a> which support continuous reflow of the document's layout during user-initiated resizing MUST dispatch
- this event synchronously after each reflow of the document.</p>
-
- <p>The <a class="def" href="#glossary-window"><code>Window</code></a> object SHOULD always be resizable. A <a class="def" href="#glossary-host-language">
- host language</a> MAY define certain elements to be resizable, and under what conditions (e.g., specific elements like <code><iframe></code>, or elements
- with particular characteristics like width and height). However, this specification does not define the behavior for elements.</p>
-
- <p class="note"><strong>Note:</strong> The <a class="eventtype" href="#event-type-resize"><code>resize</code></a> event is distinct from the
- SVG <code class="eventtype">zoom</code> event types, though both can occur at the same time, or as the consequence of the same user action. In particular, browser
- <q>font zooming</q> or <q>page zooming</q> will not necessarily trigger a <a class="eventtype" href="#event-type-resize"><code>resize</code></a> event.</p>
-
- <p class="note"><strong>Note:</strong> In previous DOM Events specifications, the <a class="eventtype" href="#event-type-resize"><code>resize</code></a>
- event type was defined to have a <a class="def" href="#glossary-bubbling-phase">bubbling phase</a>, but for performance reasons, this was not implemented in most
- user agents, and this specification removes the <a class="def" href="#glossary-bubbling-phase">bubbling phase</a> for this event.</p>
- </dd>
- </dl>
- </div>
-
- <!-- scroll -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-scroll"><dfn><a class="eventtype" href="#event-type-scroll"><code>scroll</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>scroll</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-UIEvent"><code>UIEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Async</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No / <a href="#scroll-document">Yes</a></td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Document</code>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- object which has been scrolled</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a document view or an element has been scrolled. This event type is dispatched
- after the scroll has occurred.</p>
-
- <p id="scroll-document">When dispatched on the <code>Document</code> element, this event type MUST
- bubble to the <a class="def" href="#glossary-window"><code>Window</code></a> object.</p>
- </dd>
- </dl>
- </div>
- </section>
-
- <section id="events-focusevent">
- <h3>Focus Event Types</h3>
-
- <p class="note"><strong>Note:</strong>
- This interface and its associated event types and
- <a href="#events-focusevent-event-order">focus event order</a>
- were designed in accordance to the concepts and guidelines defined in
- <a href="http://www.w3.org/WAI/UA/2010/ED-UAAG20-20100308/">User Agent Accessibility Guidelines 2.0</a>
- [<a href="#references-UAAG2">UAAG 2.0</a>],
- with particular attention on the
- <a href="http://www.w3.org/WAI/UA/2010/ED-UAAG20-20100308/#gl-focus-mechanism">focus mechanism</a>
- and the terms defined in the
- <a href="http://www.w3.org/WAI/UA/2010/ED-UAAG20-20100308/#def-focus">glossary entry for focus</a>.
+ <p>To create an instance of the <code>UIEvent</code> interface, use the
+ <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("UIEvent")</code></a>
+ method call.
</p>
- <section id="interface-FocusEvent">
- <h4>Interface FocusEvent</h4>
-
- <p class="intro-dom">Introduced in DOM Level 3</p>
-
- <p>The <code>FocusEvent</code> interface provides specific contextual information associated
- with Focus events.
- </p>
-
- <p>To create an instance of the <code>FocusEvent</code> interface, use the
- <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("FocusEvent")</code></a>
- method call.
- </p>
-
- <dl class="idl" title="[Constructor(DOMString typeArg, optional FocusEventInit focusEventInitDict)] interface FocusEvent : UIEvent">
- <dt>readonly attribute EventTarget? relatedTarget</dt>
- <dd>
- <p>Used to identify a secondary <a href="#interface-EventTarget"><code>EventTarget</code></a>
- related to a Focus event, depending on the type of event.
- </p>
-
- <p>For security reasons with nested browsing contexts, when tabbing into or out of a nested
- context, the relevant EventTarget SHOULD be <code>null</code>.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this
- attribute MUST be <code>null</code>.
- </p>
- </dd>
-
- <dl class="idl" title="dictionary FocusEventInit : UIEventInit">
- <dt>EventTarget? relatedTarget = null</dt>
- <dd>
- <p>The <code>relatedTarget</code> should be initialized to the element
- losing focus (in the case of a <em>focus</em> or <em>focusin</em>
- event) or the element gaining focus (in the case of a <em>blur</em>
- or <em>focusout</em> event).
- </p>
- </dd>
- </dl>
- </dl>
-
+ <dl class="idl" title="[Constructor(DOMString type, optional UIEventInit eventInitDict)] interface UIEvent : Event">
+ <dt>readonly attribute WindowProxy? view</dt>
+ <dd>
+ <p>The <code>view</code> attribute identifies the <code>Window</code> from which the event was generated.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>null</code>.</p>
+ </dd>
+
+ <dt>readonly attribute long detail</dt>
+ <dd>
+ <p>Specifies some detail information about the <a href="#interface-Event"><code>Event</code></a>, depending on the type of event.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>0</code>.</p>
+ </dd>
+ </dl>
+
+ <dl class="idl" title="dictionary UIEventInit : EventInit">
+ <dt>WindowProxy? view = null</dt>
+ <dd>
+ <p>Should be initialized to the Window object of the global environment
+ in which this event will be dispatched. If this event will be dispatched
+ to an element, the view property should be set to the Window object
+ containing the element's <code>ownerDocument</code>.
+ </p>
+ </dd>
+
+ <dt>long detail = 0</dt>
+ <dd>
+ <p>This value is initialized to a number that is application-specific.
+ </p>
+ </dd>
+ </dl>
+
+ </section> <!-- interface-UIEvent -->
+
+ <p>The User Interface event types are listed below. Some of these events use the
+ <a href="#interface-UIEvent"><code>UIEvent</code></a> interface if generated from a
+ user interface, but the <a href="#interface-Event"><code>Event</code></a> interface
+ otherwise, as detailed in each event.
+ </p>
+
+ <!-- load -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-load"><dfn><a class="eventtype" href="#event-type-load"><code>load</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>load</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Async</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Document</code>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ common object whose contained resources have loaded</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the DOM implementation finishes loading the resource (such as the document)
+ and any dependent resources (such as images, style sheets, or scripts). Dependent resources that fail to load MUST NOT prevent this event from firing if the resource
+ that loaded them is still accessible via the DOM. If this event type is dispatched, implementations are REQUIRED to dispatch this event at least on the <code>Document</code>
+ node.</p>
+
+ <p class="note"><strong>Note:</strong> For legacy reasons, <a class="eventtype" href="#event-type-load"><code>load</code></a> events for resources inside
+ the document (e.g., images) do not include the <a class="def" href="#glossary-window">Window</a> in the propagation path in HTML implementations. See
+ [<cite><a class="informative" href="#references-HTML5">HTML5</a></cite>] for more information.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- unload -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-unload"><dfn><a class="eventtype" href="#event-type-unload"><code>unload</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>unload</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Document</code>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ common object whose contained resources have been removed</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the DOM Implementation removes from the environment the resource (such
+ as the document) or any dependent resources (such as images, style sheets, scripts). The document MUST be unloaded after the dispatch of this event type. If this
+ event type is dispatched, implementations are REQUIRED to dispatch this event at least on the <code>Document</code> node.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- abort -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-abort"><dfn><a class="eventtype" href="#event-type-abort"><code>abort</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>abort</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ element whose resources have been stopped from loading without error</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the loading of a resource has been aborted, such as by a user canceling
+ the load while it is still in progress.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- error -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-error"><dfn><a class="eventtype" href="#event-type-error"><code>error</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>error</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Async</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ element whose resources have been stopped from loading due to an error</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a resource failed to load, or has been loaded but cannot be interpreted
+ according to its semantics, such as an invalid image, a script execution error, or non-well-formed XML.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- select -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-select"><dfn><a class="eventtype" href="#event-type-select"><code>select</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>select</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-UIEvent"><code>UIEvent</code></a> if generated from a user interface, <a href="#interface-Event"><code>Event</code></a> otherwise.</td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ element whose text content has been selected</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a user selects some text. This event is dispatched after the selection
+ has occurred.</p>
+
+ <p>This specification does not provide contextual information to access the selected text. Where applicable, a <a class="def" href="#glossary-host-language">host
+ language</a> SHOULD define rules for how a user MAY select content (with consideration for international language conventions), at what point the <a class="eventtype"
+ href="#event-type-select"><code>select</code></a> event is dispatched, and how a content author MAY access the user-selected content.</p>
+
+ <p class="note"><strong>Note:</strong> In order to access to user-selected content, content authors will use native capabilities of the <a
+ class="def" href="#glossary-host-language">host languages</a>, such as the <code>Document.getSelection()</code> method of the <a href="https://dvcs.w3.org/hg/editing/raw-file/tip/editing.html#selections">
+ HTML Editing APIs</a> [<cite><a class="informative" href="#references-HTMLEd">HTML Editing</a></cite>].</p>
+
+ <p class="note"><strong>Note:</strong> The <a class="eventtype" href="#event-type-select"><code>select</code></a> event might not be available
+ for all elements in all languages. For example, in [<cite><a class="informative" href="#references-HTML5">HTML5</a></cite>], <a class="eventtype" href="#event-type-select">
+ <code>select</code></a> events can be dispatched only on form <code>input</code> and <code>textarea</code> elements. Implementations can dispatch <a class="eventtype"
+ href="#event-type-select"><code>select</code></a> events in any context deemed appropriate, including text selections outside of form controls, or image or
+ markup selections such as in SVG.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- resize -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-resize"><dfn><a class="eventtype" href="#event-type-resize"><code>resize</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>resize</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-UIEvent"><code>UIEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ object which has been resized</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a document view has been resized. This event type is dispatched after
+ all effects for that occurrence of resizing of that particular <a class="def" href="#glossary-event-target">event target</a> have been executed by the <a class="def"
+ href="#glossary-user-agent">user agent</a>.</p>
+
+ <p><a class="def" href="#glossary-user-agent">User agents</a> which support continuous reflow of the document's layout during user-initiated resizing MUST dispatch
+ this event synchronously after each reflow of the document.</p>
+
+ <p>The <a class="def" href="#glossary-window"><code>Window</code></a> object SHOULD always be resizable. A <a class="def" href="#glossary-host-language">
+ host language</a> MAY define certain elements to be resizable, and under what conditions (e.g., specific elements like <code><iframe></code>, or elements
+ with particular characteristics like width and height). However, this specification does not define the behavior for elements.</p>
+
+ <p class="note"><strong>Note:</strong> The <a class="eventtype" href="#event-type-resize"><code>resize</code></a> event is distinct from the
+ SVG <code class="eventtype">zoom</code> event types, though both can occur at the same time, or as the consequence of the same user action. In particular, browser
+ <q>font zooming</q> or <q>page zooming</q> will not necessarily trigger a <a class="eventtype" href="#event-type-resize"><code>resize</code></a> event.</p>
+
+ <p class="note"><strong>Note:</strong> In previous DOM Events specifications, the <a class="eventtype" href="#event-type-resize"><code>resize</code></a>
+ event type was defined to have a <a class="def" href="#glossary-bubbling-phase">bubbling phase</a>, but for performance reasons, this was not implemented in most
+ user agents, and this specification removes the <a class="def" href="#glossary-bubbling-phase">bubbling phase</a> for this event.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- scroll -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-scroll"><dfn><a class="eventtype" href="#event-type-scroll"><code>scroll</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>scroll</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-UIEvent"><code>UIEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Async</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No / <a href="#scroll-document">Yes</a></td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Document</code>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ object which has been scrolled</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a document view or an element has been scrolled. This event type is dispatched
+ after the scroll has occurred.</p>
+
+ <p id="scroll-document">When dispatched on the <code>Document</code> element, this event type MUST
+ bubble to the <a class="def" href="#glossary-window"><code>Window</code></a> object.</p>
+ </dd>
+ </dl>
+ </div>
+ </section>
+
+ <section id="events-focusevent">
+ <h3>Focus Event Types</h3>
+
+ <p class="note"><strong>Note:</strong>
+ This interface and its associated event types and
+ <a href="#events-focusevent-event-order">focus event order</a>
+ were designed in accordance to the concepts and guidelines defined in
+ <a href="http://www.w3.org/WAI/UA/2010/ED-UAAG20-20100308/">User Agent Accessibility Guidelines 2.0</a>
+ [<a href="#references-UAAG2">UAAG 2.0</a>],
+ with particular attention on the
+ <a href="http://www.w3.org/WAI/UA/2010/ED-UAAG20-20100308/#gl-focus-mechanism">focus mechanism</a>
+ and the terms defined in the
+ <a href="http://www.w3.org/WAI/UA/2010/ED-UAAG20-20100308/#def-focus">glossary entry for focus</a>.
+ </p>
+
+ <section id="interface-FocusEvent">
+ <h4>Interface FocusEvent</h4>
+
+ <p class="intro-dom">Introduced in DOM Level 3</p>
+
+ <p>The <code>FocusEvent</code> interface provides specific contextual information associated
+ with Focus events.
+ </p>
+
+ <p>To create an instance of the <code>FocusEvent</code> interface, use the
+ <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("FocusEvent")</code></a>
+ method call.
+ </p>
+
+ <dl class="idl" title="[Constructor(DOMString typeArg, optional FocusEventInit focusEventInitDict)] interface FocusEvent : UIEvent">
+ <dt>readonly attribute EventTarget? relatedTarget</dt>
+ <dd>
+ <p>Used to identify a secondary <a href="#interface-EventTarget"><code>EventTarget</code></a>
+ related to a Focus event, depending on the type of event.
+ </p>
+
+ <p>For security reasons with nested browsing contexts, when tabbing into or out of a nested
+ context, the relevant EventTarget SHOULD be <code>null</code>.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this
+ attribute MUST be <code>null</code>.
+ </p>
+ </dd>
+
<dl class="idl" title="dictionary FocusEventInit : UIEventInit">
-
<dt>EventTarget? relatedTarget = null</dt>
<dd>
<p>The <code>relatedTarget</code> should be initialized to the element
- whose bounds the mouse pointer just left (in the case of a
- <em>mouseover</em> or <em>mouseenter</em> event) or the element
- whose bounds the mouse pointer is entering (in the case of a
- <em>mouseout</em> or <em>mouseleave</em>
- or <em>focusout</em> event). For other events, this value need not
- be assigned (and will default to null).
+ losing focus (in the case of a <em>focus</em> or <em>focusin</em>
+ event) or the element gaining focus (in the case of a <em>blur</em>
+ or <em>focusout</em> event).
</p>
</dd>
</dl>
-
- </section> <!-- interface-FocusEvent -->
-
- <section id="events-focusevent-event-order">
- <h4>Focus Event Order</h4>
- <p>
- The focus events defined in this specification occur in a set order relative to one another. The following is the typical sequence of events when a focus is shifted
- between elements (this order assumes that no element is initially focused):</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td><em>User shifts focus</em></td>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-focusin"><code>focusin</code></a></td>
- <td>Sent before first target element receives focus</td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-focus"><code>focus</code></a></td>
- <td>Sent after first target element receives focus</td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td><em>User shifts focus</em></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-focusout"><code>focusout</code></a></td>
- <td>Sent before first target element loses focus</td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-focusin"><code>focusin</code></a></td>
- <td>Sent before second target element receives focus</td>
- </tr>
- <tr>
- <td class="cell-number">5.</td>
- <td><a class="eventtype" href="#event-type-blur"><code>blur</code></a></td>
- <td>Sent after first target element loses focus</td>
- </tr>
- <tr>
- <td class="cell-number">6.</td>
- <td><a class="eventtype" href="#event-type-focus"><code>focus</code></a></td>
- <td>Sent after second target element receives focus</td>
- </tr>
- </table>
-
- <p class="note"><strong>Note:</strong> This specification does not define the behavior of focus events when interacting with methods such as <code>focus()</code> or
- <code>blur()</code>. See the relevant specifications where those methods are defined for such behavior.</p>
- </section> <!-- events-focusevent-event-order -->
-
- <section id="events-focusevent-doc-focus">
- <h4>Document Focus and Focus Context</h4>
-
- <p>This event module includes event types for notification of changes in document
- <a class="def" href="#glossary-event-focus">focus</a>.
- There are three distinct focus contexts that are relevant to this discussion:
- </p>
-
- <ul>
- <li>The <em>operating system focus context</em> which MAY be on one of many different applications currently
- running on the computer. One of these applications with focus can be a browser.
- </li>
- <li>When the browser has focus, the user can switch (such as with the tab key) the
- <em>application focus context</em> among the different browser user interface fields (e.g., the
- Web site location bar, a search field, etc.). One of these user interface fields can be the
- document being shown in a tab.
- </li>
- <li>When the document itself has focus, the <em>document focus context</em> can be set to any of the
- focusable elements in the document.
- </li>
- </ul>
-
- <p>The event types defined in this specification deal exclusively with document focus, and the
- <a class="def" href="#glossary-event-target">event target</a> identified in the event details
- MUST only be part of the document or documents in the window, never a part of the browser or
- operating system, even when switching from one focus context to another.
- </p>
-
- <p>Normally, a document always has a focused element (even if it is the document element itself) and a persistent <a class="def" href="#glossary-event-focus-ring">focus
- ring</a>. When switching between focus contexts, the document's currently focused element and focus ring normally remain in their current state. For example,
- if a document has three focusable elements, with the second element focused, when a user changes operating system focus to another application and then back to
- the browser, the second element will still be focused within the document, and tabbing will change the focus to the third element. A <a class="def" href="#glossary-host-language">
- host language</a> MAY define specific elements which might receive focus, the conditions under which an element MAY receive focus, the means by which
- focus MAY be changed, and the order in which the focus changes. For example, in some cases an element might be given focus by moving a pointer over it, while other
- circumstances might require a mouse click. Some elements might not be focusable at all, and some might be focusable only by special means (clicking on the element),
- but not by tabbing to it. Documents MAY contain multiple focus rings. Other specifications MAY define a more complex focus model than is described in this specification,
- including allowing multiple elements to have the current focus.
- </p>
- </section> <!-- events-focusevent-doc-focus -->
-
- <p>The Focus event types are listed below.</p>
-
- <!-- blur -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-blur"><dfn><a class="eventtype" href="#event-type-blur"><code>blur</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>blur</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> losing focus</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-FocusEvent-relatedTarget"><code class="attribute-name">FocusEvent.relatedTarget</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> receiving focus.</li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when an <a class="def" href="#glossary-event-target">event target</a> loses
- focus. The focus MUST be taken from the element before the dispatch of this event type. This event type is similar to <a class="eventtype" href="#event-type-focusout">
- <code>focusout</code></a>, but is dispatched after focus is shifted, and does not bubble.</p>
- </dd>
- </dl>
+ </dl>
+
+ <dl class="idl" title="dictionary FocusEventInit : UIEventInit">
+
+ <dt>EventTarget? relatedTarget = null</dt>
+ <dd>
+ <p>The <code>relatedTarget</code> should be initialized to the element
+ whose bounds the mouse pointer just left (in the case of a
+ <em>mouseover</em> or <em>mouseenter</em> event) or the element
+ whose bounds the mouse pointer is entering (in the case of a
+ <em>mouseout</em> or <em>mouseleave</em>
+ or <em>focusout</em> event). For other events, this value need not
+ be assigned (and will default to null).
+ </p>
+ </dd>
+ </dl>
+
+ </section> <!-- interface-FocusEvent -->
+
+ <section id="events-focusevent-event-order">
+ <h4>Focus Event Order</h4>
+ <p>
+ The focus events defined in this specification occur in a set order relative to one another. The following is the typical sequence of events when a focus is shifted
+ between elements (this order assumes that no element is initially focused):</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td><em>User shifts focus</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-focusin"><code>focusin</code></a></td>
+ <td>Sent before first target element receives focus</td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-focus"><code>focus</code></a></td>
+ <td>Sent after first target element receives focus</td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td><em>User shifts focus</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-focusout"><code>focusout</code></a></td>
+ <td>Sent before first target element loses focus</td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-focusin"><code>focusin</code></a></td>
+ <td>Sent before second target element receives focus</td>
+ </tr>
+ <tr>
+ <td class="cell-number">5.</td>
+ <td><a class="eventtype" href="#event-type-blur"><code>blur</code></a></td>
+ <td>Sent after first target element loses focus</td>
+ </tr>
+ <tr>
+ <td class="cell-number">6.</td>
+ <td><a class="eventtype" href="#event-type-focus"><code>focus</code></a></td>
+ <td>Sent after second target element receives focus</td>
+ </tr>
+ </table>
+
+ <p class="note"><strong>Note:</strong> This specification does not define the behavior of focus events when interacting with methods such as <code>focus()</code> or
+ <code>blur()</code>. See the relevant specifications where those methods are defined for such behavior.</p>
+ </section> <!-- events-focusevent-event-order -->
+
+ <section id="events-focusevent-doc-focus">
+ <h4>Document Focus and Focus Context</h4>
+
+ <p>This event module includes event types for notification of changes in document
+ <a class="def" href="#glossary-event-focus">focus</a>.
+ There are three distinct focus contexts that are relevant to this discussion:
+ </p>
+
+ <ul>
+ <li>The <em>operating system focus context</em> which MAY be on one of many different applications currently
+ running on the computer. One of these applications with focus can be a browser.
+ </li>
+ <li>When the browser has focus, the user can switch (such as with the tab key) the
+ <em>application focus context</em> among the different browser user interface fields (e.g., the
+ Web site location bar, a search field, etc.). One of these user interface fields can be the
+ document being shown in a tab.
+ </li>
+ <li>When the document itself has focus, the <em>document focus context</em> can be set to any of the
+ focusable elements in the document.
+ </li>
+ </ul>
+
+ <p>The event types defined in this specification deal exclusively with document focus, and the
+ <a class="def" href="#glossary-event-target">event target</a> identified in the event details
+ MUST only be part of the document or documents in the window, never a part of the browser or
+ operating system, even when switching from one focus context to another.
+ </p>
+
+ <p>Normally, a document always has a focused element (even if it is the document element itself) and a persistent <a class="def" href="#glossary-event-focus-ring">focus
+ ring</a>. When switching between focus contexts, the document's currently focused element and focus ring normally remain in their current state. For example,
+ if a document has three focusable elements, with the second element focused, when a user changes operating system focus to another application and then back to
+ the browser, the second element will still be focused within the document, and tabbing will change the focus to the third element. A <a class="def" href="#glossary-host-language">
+ host language</a> MAY define specific elements which might receive focus, the conditions under which an element MAY receive focus, the means by which
+ focus MAY be changed, and the order in which the focus changes. For example, in some cases an element might be given focus by moving a pointer over it, while other
+ circumstances might require a mouse click. Some elements might not be focusable at all, and some might be focusable only by special means (clicking on the element),
+ but not by tabbing to it. Documents MAY contain multiple focus rings. Other specifications MAY define a more complex focus model than is described in this specification,
+ including allowing multiple elements to have the current focus.
+ </p>
+ </section> <!-- events-focusevent-doc-focus -->
+
+ <p>The Focus event types are listed below.</p>
+
+ <!-- blur -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-blur"><dfn><a class="eventtype" href="#event-type-blur"><code>blur</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>blur</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> losing focus</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-FocusEvent-relatedTarget"><code class="attribute-name">FocusEvent.relatedTarget</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> receiving focus.</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when an <a class="def" href="#glossary-event-target">event target</a> loses
+ focus. The focus MUST be taken from the element before the dispatch of this event type. This event type is similar to <a class="eventtype" href="#event-type-focusout">
+ <code>focusout</code></a>, but is dispatched after focus is shifted, and does not bubble.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- focus -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-focus"><dfn><a class="eventtype" href="#event-type-focus"><code>focus</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>focus</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> receiving focus</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-FocusEvent-relatedTarget"><code class="attribute-name">FocusEvent.relatedTarget</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> losing focus (if any).</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when an <a class="def" href="#glossary-event-target">event target</a> receives
+ focus. The focus MUST be given to the element before the dispatch of this event type. This event type is similar to <a class="eventtype" href="#event-type-focusin">
+ <code>focusin</code></a>, but is dispatched after focus is shifted, and does not bubble.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- focusin -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-focusin"><dfn><a class="eventtype" href="#event-type-focusin"><code>focusin</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>focusin</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> receiving focus</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-FocusEvent-relatedTarget"><code class="attribute-name">FocusEvent.relatedTarget</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> losing focus (if any).</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when an <a class="def" href="#glossary-event-target">event target</a> is about
+ to receive focus. This event type MUST be dispatched before the element is given focus. The <a class="def" href="#glossary-event-target">event target</a> MUST
+ be the element which is about to receive focus. This event type is similar to <a class="eventtype" href="#event-type-focus"><code>focus</code></a>, but is dispatched
+ before focus is shifted, and does bubble.</p>
+
+ <p class="note" id="_9"><strong>Note:</strong> When using this event type, the content author can use the event's <code class="attribute-name"><a href="#widl-FocusEvent-relatedTarget">
+ FocusEvent.relatedTarget</a></code> attribute (or a host-language-specific method or means) to get the currently focused element before the focus shifts to the
+ next focus <a class="def" href="#glossary-event-target">event target</a>, thus having access to both the element losing focus and the element gaining focus
+ without the use of the <a class="eventtype" href="#event-type-blur"><code>blur</code></a> or <a class="eventtype" href="#event-type-focusout"><code>focusout</code></a> event
+ types.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- focusout -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-focusout"><dfn><a class="eventtype" href="#event-type-focusout"><code>focusout</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>focusout</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> losing focus</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-FocusEvent-relatedTarget"><code class="attribute-name">FocusEvent.relatedTarget</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> receiving focus.</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when an <a class="def" href="#glossary-event-target">event target</a> is about
+ to lose focus. This event type MUST be dispatched before the element loses focus. The <a class="def" href="#glossary-event-target">event target</a> MUST be the
+ element which is about to lose focus. This event type is similar to <a class="eventtype" href="#event-type-blur"><code>blur</code></a>, but is dispatched before
+ focus is shifted, and does bubble.</p>
+ </dd>
+ </dl>
+ </div>
+ </section> <!-- events-focusevent -->
+
+ <section id="events-mouseevents">
+ <h3>Mouse Event Types</h3>
+
+ <p>The mouse event module originates from the [<cite><a class="informative" href="#references-HTML40">HTML 4.01</a></cite>] <code>onclick</code>, <code>ondblclick</code>,
+ <code>onmousedown</code>, <code>onmouseup</code>, <code>onmouseover</code>, <code>onmousemove</code>, and <code>onmouseout</code> attributes. This event module
+ is specifically designed for use with pointing input devices, such as a mouse or a trackball.</p>
+
+ <section id="interface-MouseEvent">
+ <h4>Interface MouseEvent</h4>
+
+ <p class="intro-dom">Introduced in DOM Level 2, modified in DOM Level 3</p>
+
+ <p>The <code>MouseEvent</code> interface provides specific contextual information
+ associated with Mouse events.
+ </p>
+
+ <p>In the case of nested elements, mouse events are always targeted at the most deeply
+ nested element.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ Ancestors of the targeted element can use event bubbling to obtain notifications
+ of mouse events which occur within their descendent elements.
+ </p>
+
+ <p>To create an instance of the <code>MouseEvent</code> interface, use the
+ <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("MouseEvent")</code></a>
+ method call.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ When initializing <code>MouseEvent</code> objects using <code>initMouseEvent</code>,
+ implementations can use the client coordinates <code>clientX</code> and <code>clientY</code>
+ for calculation of other coordinates (such as target coordinates exposed by
+ <a class="def" href="#glossary-DOM-Level-0">DOM Level 0</a>
+ implementations or other proprietary attributes, e.g., <code>pageX</code>).
+ </p>
+
+ <dl class="idl" title="[Constructor(DOMString typeArg, optional MouseEventInit mouseEventInitDict)] interface MouseEvent : UIEvent">
+ <dt>readonly attribute long screenX</dt>
+ <dd>
+ <p>The horizontal coordinate at which the event occurred relative to the origin
+ of the screen coordinate system.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>0</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute long screenY</dt>
+ <dd>
+ <p>The vertical coordinate at which the event occurred relative to the origin
+ of the screen coordinate system.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>0</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute long clientX</dt>
+ <dd>
+ <p>The horizontal coordinate at which the event occurred relative to the viewport
+ associated with the event.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>0</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute long clientY</dt>
+ <dd>
+ <p>The vertical coordinate at which the event occurred relative to the viewport
+ associated with the event.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>0</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute boolean ctrlKey</dt>
+ <dd>
+ <p>Refer to the <a href="#widl-KeyboardEvent-ctrlKey"><code>KeyboardEvent.ctrlKey</code></a> attribute.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>false</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute boolean shiftKey</dt>
+ <dd>
+ <p>Refer to the <a href="#widl-KeyboardEvent-shiftKey"><code>KeyboardEvent.shiftKey</code></a> attribute.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>false</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute boolean altKey</dt>
+ <dd>
+ <p>Refer to the <a href="#widl-KeyboardEvent-altKey"><code>KeyboardEvent.altKey</code></a> attribute.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>false</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute boolean metaKey</dt>
+ <dd>
+ <p>Refer to the <a href="#widl-KeyboardEvent-metaKey"><code>KeyboardEvent.metaKey</code></a> attribute.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>false</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute short button</dt>
+ <dd>
+ <p>During mouse events caused by the depression or release of a mouse button,
+ <code>button</code> MUST be used to indicate which pointer device button
+ changed state.
+ </p>
+
+ <p>The value of the <a href="#widl-MouseEvent-button"><code>MouseEvent.button</code></a>
+ attribute MUST be as follows:
+ </p>
+
+ <ul>
+ <li><code>0</code> MUST indicate the primary button of the device
+ (in general, the left button or the only button on single-button devices,
+ used to activate a user interface control or select text) or the
+ un-initialized value.</li>
+ <li><code>1</code> MUST indicate the auxiliary button
+ (in general, the middle button, often combined with a mouse wheel).</li>
+ <li><code>2</code> MUST indicate the secondary button
+ (in general, the right button, often used to display a context menu).</li>
+ </ul>
+
+ <p>Some pointing devices provide or simulate more button states, and values higher than
+ <code>2</code> or lower than <code>0</code> MAY be used to represent such buttons.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ The value of <code>button</code> is not updated for events not caused by the
+ depression/release of a mouse button.
+ In these scenarios, take care not to interpret the value <code>0</code> as the
+ left button, but rather as the
+ <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>.
+ </p>
+
+ <p class="note"><strong>Authoring Note:</strong>
+ Some <a class="def" href="#glossary-default-action">default actions</a> related
+ to events such as <a class="eventtype"><code>mousedown</code></a> and
+ <a class="eventtype"><code>mouseup</code></a> depend on the specific mouse
+ button in use.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>0</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute EventTarget? relatedTarget</dt>
+ <dd>
+ <p>Used to identify a secondary <a href="#interface-EventTarget"><code>EventTarget</code></a> related to a UI event, depending on the type of event.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>null</code>.</p>
+ </dd>
+
+ <dt>// Introduced in DOM Level 3</dt>
+
+ <dt>readonly attribute unsigned short buttons</dt>
+ <dd>
+ <p>During any mouse events, <code>buttons</code> MUST be used to indicate
+ which combination of mouse buttons are currently being pressed,
+ expressed as a bitmask.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ Though similarly named, the values for the <code>buttons</code> attribute
+ and the <a href="#widl-MouseEvent-button"><code>button</code></a>
+ attribute are very different.
+ The value of <code>button</code> is assumed to be valid during
+ <a class="eventtype"><code>mousedown</code></a> /
+ <a class="eventtype"><code>mouseup</code></a> event handlers,
+ whereas the <code>buttons</code> attribute reflects the state of the
+ mouse's buttons for any trusted <code>MouseEvent</code> object
+ (while it is being dispatched), because it can represent the
+ "no button currently active" state (0).
+ </p>
+
+ <p>The value of the <a href="#widl-MouseEvent-buttons"><code>MouseEvent.buttons</code></a>
+ attribute MUST be as follows:
+ </p>
+
+ <ul>
+ <li><code>0</code> MUST indicate no button is currently active.</li>
+ <li><code>1</code> MUST indicate the primary button of the device
+ (in general, the left button or the only button on single-button devices,
+ used to activate a user interface control or select text).</li>
+ <li><code>2</code> MUST indicate the secondary button
+ (in general, the right button, often used to display a context menu), if present.</li>
+ <li><code>4</code> MUST indicate the auxiliary button
+ (in general, the middle button, often combined with a mouse wheel).</li>
+ </ul>
+
+ <p>Some pointing devices provide or simulate more buttons.
+ To represent such buttons, the value MUST be doubled for each successive button
+ (in the binary series <code>8</code>, <code>16</code>, <code>32</code>, ... ).
+ </p>
+
+ <p class="note" id="buttons-mask"><strong>Note:</strong>
+ Because the sum of any set of button values is a unique number, a content
+ author can use a bitwise operation to determine how many buttons are currently
+ being pressed and which buttons they are, for an arbitrary number of mouse buttons
+ on a device.
+ For example, the value <code>3</code> indicates that the left and right button are
+ currently both pressed, while the value <code>5</code> indicates that the left and
+ middle button are currently both pressed.
+ </p>
+
+ <p class="note"><strong>Authoring Note:</strong>
+ Some <a class="def" href="#glossary-default-action">default actions</a> related
+ to events such as <a class="eventtype"><code>mousedown</code></a> and
+ <a class="eventtype"><code>mouseup</code></a> depend on the specific mouse button
+ in use.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
+ of this attribute MUST be <code>0</code>.
+ </p>
+ </dd>
+
+ <dt>boolean getModifierState()</dt>
+ <dd>
+ <p class="intro-dom">Introduced in DOM Level 3</p>
+
+ <p>Queries the state of a modifier using a key value.
+ See <a href="#keys-modifiers">Modifier keys</a> for a list of valid (case-sensitive) arguments to this method.
+ </p>
+
+ <p>Returns <code>true</code> if it is a modifier key and the modifier is activated,
+ <code>false</code> otherwise.
+ </p>
+
+ <dl class="parameters">
+ <dt>DOMString keyArg</dt>
+ <dd>
+ <p>Refer to the <a href="#widl-KeyboardEvent-getModifierState"><code>KeyboardEvent.getModifierState()</code></a> method for a description of this parameter.</p>
+ </dd>
+ </dl>
+ </dd>
+
+ </dl>
+
+ <dl class="idl" title="dictionary MouseEventInit : UIEventInit">
+
+ <dt>long screenX = 0</dt>
+ <dd>
+ <p>See <code>screenY</code> (substituting "horizontal" for "veritcal").</p>
+ </dd>
+
+ <dt>long screenY = 0</dt>
+ <dd>
+ <p>Initializes the <code>screenY</code> attribute of the MouseEvent
+ object to the desired vertical relative position of the mouse
+ pointer on the user's screen.
+ </p>
+
+ <p>Initializing the event object to the given mouse position must
+ not move the user's mouse pointer to the initialized position.
+ </p>
+ </dd>
+
+ <dt>long clientX = 0</dt>
+ <dd>
+ <p>See <code>clientY</code> (substituting "horizontal" for "vertical").</p>
+ </dd>
+
+ <dt>long clientY = 0</dt>
+ <dd>
+ <p>Initializes the <code>clientY</code> attribute of the MouseEvent
+ object to the desired vertical position of the mouse pointer
+ relative to the client window of the user's browser.
+ </p>
+
+ <p>Initializing the event object to the given mouse position must
+ not move the user's mouse pointer to the initialized position.
+ </p>
+ </dd>
+
+ <dt>boolean ctrlKey = false</dt>
+ <dd>
+ <p>Initializes the <code>altKey</code> attribute of the MouseEvent
+ object to <code>true</code> if the <code class="key">'Control'</code>
+ (control) key modifier is to be considered active,
+ <code>false</code> otherwise.</p>
+ </dd>
+
+ <dt>boolean shiftKey = false</dt>
+ <dd>
+ <p>Initializes the <code>shiftKey</code> attribute of the MouseEvent
+ object to <code>true</code> if the <code class="key">'Shift'</code>
+ key modifier is to be considered active, <code>false</code> otherwise.</p>
+ </dd>
+
+ <dt>boolean altKey = false</dt>
+ <dd>
+ <p>Initializes the <code>altKey</code> attribute of the MouseEvent
+ object to <code>true</code> if the <code class="key">'Alt'</code>
+ (alternative) (or <code class="glyph">'Option'</code>) key modifier
+ is to be considered active, <code>false</code> otherwise.</p>
+ </dd>
+
+ <dt>boolean metaKey = false</dt>
+ <dd>
+ <p>Initializes the <code>metaKey</code> attribute of the MouseEvent
+ object to <code>true</code> if the <code class="key">'Meta'</code>
+ key modifier is to be considered active, <code>false</code> otherwise.</p>
+ </dd>
+
+ <dt>short button = 0</dt>
+ <dd>
+ <p>Initializes the <code>button</code> attribute of the MouseEvent
+ object to a number representing the desired state of the button(s)
+ of the mouse.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ The value 0 is used to represent
+ the primary mouse button, 1 is used to represent the auxiliary/middle
+ mouse button, and 2 to represent the right mouse button.
+ Numbers greater than 2 are also possible, but are not specified
+ in this document.
+ </p>
+ </dd>
+
+ <dt>unsigned short buttons = 0</dt>
+ <dd>
+ <p>Initializes the <code>buttons</code> attribute of the MouseEvent
+ object to a number representing one <em>or more</em> of the button(s) of the mouse
+ that are to be considered active.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ The <code>buttons</code>
+ attribute is a bit-field. If a mask value of 1 is true when applied to
+ the value of the bit field, then the primary mouse button is down. If a
+ mask value of 2 is true when applied to the value of the bit field, then
+ the right mouse button is down. If a mask value of 4 is true when applied
+ to the value of the bit field, then the auxiliary/middle button is down.</p>
+
+ <div class="example">
+ <p>In JavaScript, to initialize the
+ <code>buttons</code> attribute as if the right (2) and middle
+ button (4) were being pressed simultaneously, the buttons value
+ can be assigned as either:<br/>
+ <code>{ buttons: 2 | 4 }</code></br/>
+ or:<br/>
+ <code>{ buttons: 6 }</code>
+ </p>
+ </div><!-- Initializing buttons -->
+ </dd>
+
+ <dt>EventTarget? relatedTarget = null</dt>
+ <dd>
+ <p>The <code>relatedTarget</code> should be initialized to the element
+ whose bounds the mouse pointer just left (in the case of a
+ <em>mouseover</em> or <em>mouseenter</em> event) or the element
+ whose bounds the mouse pointer is entering (in the case of a
+ <em>mouseout</em> or <em>mouseleave</em>
+ or <em>focusout</em> event). For other events, this value need not
+ be assigned (and will default to null).
+ </p>
+ </dd>
+ </dl>
+
+ </section> <!-- interface-MouseEvent -->
+
+ <p id="current-click-count">Implementations MUST maintain the <em>current click count</em> when generating mouse events. This MUST be a non-negative integer indicating
+ the number of consecutive clicks of a pointing device button within a specific time. The delay after which the count resets is specific to the
+ environment configuration.</p>
+
+ <section id="events-mouseevent-event-order">
+ <h4>Mouse Event Order</h4>
+
+ <p>Certain mouse events defined in this specification MUST occur in a set order relative to one another.
+ The following shows the event sequence that MUST occur when a pointing
+ device's cursor is moved over an element:</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th class="cell-center">Element</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td class="cell-center"></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em>Pointing device is moved into element A...</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td class="cell-center">A</td>
+ <td>Multiple events</td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em>Pointing device is moved out of element A...</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">5.</td>
+ <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">6.</td>
+ <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ </table>
+
+ <p>When a pointing device is moved into an element <em>A</em>, and then into a nested element <em>B</em>
+ and then back out again, the following sequence of events MUST occur:
+ </p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th class="cell-center">Element</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td class="cell-center"></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em>Pointing device is moved into element A...</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td class="cell-center">A</td>
+ <td>Multiple events</td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em>Pointing device is moved into nested element B...</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">5.</td>
+ <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">6.</td>
+ <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
+ <td class="cell-center">B</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">7.</td>
+ <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
+ <td class="cell-center">B</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">8.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td class="cell-center">B</td>
+ <td>Multiple events</td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em>Pointing device is moved from element B into A...</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">9.</td>
+ <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
+ <td class="cell-center">B</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">10.</td>
+ <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
+ <td class="cell-center">B</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">11.</td>
+ <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">12.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td class="cell-center">A</td>
+ <td>Multiple events</td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em>Pointing device is moved out of element A...</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">13.</td>
+ <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">14.</td>
+ <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ </table>
+
+ <p>Sometimes elements can be visually overlapped using CSS. In the following example, three elements
+ labeled A, B, and C all have the same dimensions and absolute position on a web page.
+ Element C is a child of B, and B is a child of A in the DOM:
+ </p>
+
+ <figure id="figure-mouse-event-stacked-elements">
+ <img src='images/stacked-event-mouse-dispatch.svg' width="403" height="217" />
+ <figcaption>Graphical representation of three stacked elements all on top of each other, with the pointing device moving over the stack.</figcaption>
+ </figure>
+
+ <p>When the pointing device is moved from outside the element stack to the element labeled C and then moved
+ out again, the following series of events MUST occur:</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th class="cell-center">Element</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td class="cell-center"></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em>Pointing device is moved into element C, the topmost element in the stack</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
+ <td class="cell-center">C</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
+ <td class="cell-center">B</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">5.</td>
+ <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
+ <td class="cell-center">C</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">6.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td class="cell-center">C</td>
+ <td>Multiple events</td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em>Pointing device is moved out of element C...</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">7.</td>
+ <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
+ <td class="cell-center">C</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">8.</td>
+ <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
+ <td class="cell-center">C</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">9.</td>
+ <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
+ <td class="cell-center">B</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">10.</td>
+ <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
+ <td class="cell-center">A</td>
+ <td></td>
+ </tr>
+ </table>
+
+ <p class="note"><strong>Note:</strong> The <code>mouseover</code>/<code>mouseout</code> events are only fired once, while <code>mouseenter</code>/<code>mouseleave</code>
+ events are fired three times (once to each element).</p>
+
+ <p>The following is the typical sequence of events when a button associated with a pointing device (e.g., a mouse button or trackpad) is pressed and released over
+ an element:</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td>OPTIONAL, multiple events, some limits</td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-click"><code>click</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">5.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td>OPTIONAL, multiple events, some limits</td>
+ </tr>
+ <tr>
+ <td class="cell-number">6.</td>
+ <td><a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">7.</td>
+ <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
+ <td>OPTIONAL, multiple events, some limits</td>
+ </tr>
+ <tr>
+ <td class="cell-number">8.</td>
+ <td><a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">9.</td>
+ <td><a class="eventtype" href="#event-type-click"><code>click</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">10.</td>
+ <td><a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a></td>
+ <td></td>
+ </tr>
+ </table>
+
+ <p class="note"><strong>Note: </strong>The lag time, degree, distance, and number of <a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a>
+ events allowed between the <a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a> and <a class="eventtype" href="#event-type-mouseup">
+ <code>mouseup</code></a> events while still firing a <a class="eventtype" href="#event-type-click"><code>click</code></a> or <a class="eventtype"
+ href="#event-type-dblclick"><code>dblclick</code></a> event will be implementation-, device-, and platform-specific. This tolerance can aid users that have physical
+ disabilities like unsteady hands when these users interact with a pointing device.</p>
+
+ <p>Each implementation will determine the appropriate <a class="def" href="#glossary-hysteresis">hysteresis</a> tolerance, but in general SHOULD fire <a class="eventtype" href="#event-type-click"><code>click</code></a>
+ and <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a> events when the event target of the associated <a class="eventtype"
+ href="#event-type-mousedown"><code>mousedown</code></a> and <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> events is the same element with no
+ <a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a> or <a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a>
+ events intervening, and SHOULD fire <a class="eventtype" href="#event-type-click"><code>click</code></a> and <a class="eventtype" href="#event-type-dblclick">
+ <code>dblclick</code></a> events on the nearest common ancestor when the event targets of the associated <a class="eventtype" href="#event-type-mousedown">
+ <code>mousedown</code></a> and <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> events are different.</p>
+
+ <p>If the <a class="def" href="#glossary-event-target">event target</a> (e.g. the target element) is removed from the DOM during the mouse events sequence, the remaining
+ events of the sequence MUST NOT be fired on that element.</p>
+
+ <div class="example">
+ <div class="example-title"></div>
+ <p>If the target element is removed from the DOM as the result of a <a class="eventtype" href="#event-type-mousedown">
+ <code>mousedown</code></a> event, no events for that element will be dispatched for <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a>,
+ <a class="eventtype" href="#event-type-click"><code>click</code></a>, or <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a>, nor any default
+ activation events. However, the <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> event will still be dispatched on the element that is exposed
+ to the mouse after the removal of the initial target element. Similarly, if the target element is removed from the DOM during the dispatch of a <a class="eventtype"
+ href="#event-type-mouseup"><code>mouseup</code></a> event, the <a class="eventtype" href="#event-type-click"><code>click</code></a> and subsequent events will
+ not be dispatched.</p>
</div>
- <!-- focus -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-focus"><dfn><a class="eventtype" href="#event-type-focus"><code>focus</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>focus</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> receiving focus</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-FocusEvent-relatedTarget"><code class="attribute-name">FocusEvent.relatedTarget</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> losing focus (if any).</li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when an <a class="def" href="#glossary-event-target">event target</a> receives
- focus. The focus MUST be given to the element before the dispatch of this event type. This event type is similar to <a class="eventtype" href="#event-type-focusin">
- <code>focusin</code></a>, but is dispatched after focus is shifted, and does not bubble.</p>
- </dd>
- </dl>
- </div>
-
- <!-- focusin -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-focusin"><dfn><a class="eventtype" href="#event-type-focusin"><code>focusin</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>focusin</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> receiving focus</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-FocusEvent-relatedTarget"><code class="attribute-name">FocusEvent.relatedTarget</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> losing focus (if any).</li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when an <a class="def" href="#glossary-event-target">event target</a> is about
- to receive focus. This event type MUST be dispatched before the element is given focus. The <a class="def" href="#glossary-event-target">event target</a> MUST
- be the element which is about to receive focus. This event type is similar to <a class="eventtype" href="#event-type-focus"><code>focus</code></a>, but is dispatched
- before focus is shifted, and does bubble.</p>
-
- <p class="note" id="_9"><strong>Note:</strong> When using this event type, the content author can use the event's <code class="attribute-name"><a href="#widl-FocusEvent-relatedTarget">
- FocusEvent.relatedTarget</a></code> attribute (or a host-language-specific method or means) to get the currently focused element before the focus shifts to the
- next focus <a class="def" href="#glossary-event-target">event target</a>, thus having access to both the element losing focus and the element gaining focus
- without the use of the <a class="eventtype" href="#event-type-blur"><code>blur</code></a> or <a class="eventtype" href="#event-type-focusout"><code>focusout</code></a> event
- types.</p>
- </dd>
- </dl>
- </div>
-
- <!-- focusout -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-focusout"><dfn><a class="eventtype" href="#event-type-focusout"><code>focusout</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ </section> <!-- events-mouseevent-event-order -->
+
+ <p>The Mouse event types are listed below. 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.</p>
+
+ <!-- click -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-click"><dfn><a class="eventtype" href="#event-type-click"><code>click</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>click</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>Varies</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ indicates the <a href="#current-click-count">current click count</a>;
+ the attribute value MUST be <code>1</code> when the user begins this action and increments by <code>1</code> for each click.</li>
+ <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
+ value based on current button pressed</li>
+ <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
+ value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
+ <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
+ <code>null</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>The <a class="eventtype" href="#event-type-click"><code>click</code></a> event type MUST be dispatched on the
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a> indicated by the pointer, when
+ the user presses down and releases the primary pointer button,
+ or otherwise activates the pointer in a manner that simulates such an action.
+ The actuation method of the mouse button depends upon the pointer device and the environment configuration,
+ e.g., it MAY depend on the screen location or the delay between the press and release of the pointing device button.
+ </p>
+
+ <p class="note"><strong>Note:</strong> The <code>click</code> event should only be fired for the primary
+ pointer button (i.e., when <a href="#widl-MouseEvent-button"><code>MouseEvent.button</code></a> value is <code>0</code>,
+ <a href="#widl-MouseEvent-buttons"><code>MouseEvent.buttons</code></a> value is <code>1</code>).
+ Secondary buttons (like the middle or right button on a standard mouse) MUST NOT fire
+ <code>click</code> events.
+ </p>
+
+ <p>The <a class="eventtype" href="#event-type-click"><code>click</code></a> event MAY be preceded by the <a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a>
+ and <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> events on the same element, disregarding changes between other node types (e.g., text
+ nodes). Depending upon the environment configuration, the <a class="eventtype" href="#event-type-click"><code>click</code></a> event MAY be dispatched if one or
+ more of the event types <a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a>, <a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a>,
+ and <a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a> occur between the press and release of the pointing device button. The <a class="eventtype"
+ href="#event-type-click"><code>click</code></a> event MAY also be followed by the <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a>
+ event.</p>
+
+ <div class="example">
+ <div class="example-title"></div>
+ <p>If a user mouses down on a text node child of a <code><p></code> element which has been styled with
+ a large line-height, shifts the mouse slightly such that it is no longer over an area containing text but is still within the containing block of that <code><p></code>
+ element (i.e., the pointer is between lines of the same text block, but not over the text node per se), then subsequently mouses up, this will likely still trigger
+ a <a class="eventtype" href="#event-type-click"><code>click</code></a> event (if it falls within the normal temporal <a class="def" href="#glossary-hysteresis">hysteresis</a> for a <a class="eventtype" href="#event-type-click">
+ <code>click</code></a>), since the user has stayed within the scope of the same element. Note that user-agent-generated mouse events are not dispatched on text nodes.
+ </p>
+ </div>
+
+ <p>In addition to being associated with pointer devices, the <a class="eventtype" href="#event-type-click"><code>click</code></a> event type MUST be dispatched as
+ part of an element activation, as described in <a href="#event-flow-activation">Activation triggers and behavior</a>.</p>
+
+ <p class="note"><strong>Note:</strong> For maximum accessibility, content authors are encouraged to use the
+ <a class="eventtype" href="#event-type-click"><code>click</code></a> event type when defining activation
+ behavior for custom controls, rather than other pointing-device event types such as
+ <a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a> or
+ <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a>, which are more device-specific.
+ Though the <a class="eventtype" href="#event-type-click"><code>click</code></a> event type has its origins
+ in pointer devices (e.g., a mouse), subsequent implementation
+ enhancements have extended it beyond that association, and it can be considered a device-independent event
+ type for element activation.
+ </p>
+
+ <p>The <a class="def" href="#glossary-default-action">default action</a> of the
+ <a class="eventtype" href="#event-type-click"><code>click</code></a> event type varies
+ based on the <a class="def" href="#glossary-event-target">event target</a> of the event and the value of the
+ <a href="#widl-MouseEvent-button"><code>MouseEvent.button</code></a>
+ or <a href="#widl-MouseEvent-buttons"><code>MouseEvent.buttons</code></a> attributes.
+ Typical <a class="def" href="#glossary-default-action">default actions</a>
+ of the <a class="eventtype" href="#event-type-click"><code>click</code></a> event type are as follows:
+ </p>
+
+ <ul>
+ <li>If the <a class="def" href="#glossary-event-target">event target</a> has associated activation behavior, the <a class="def" href="#glossary-default-action">default
+ action</a> MUST be to execute that activation behavior (see <a href="#event-flow-activation">Activation triggers and behavior</a>).</li>
+
+ <li>If the <a class="def" href="#glossary-event-target">event target</a> is focusable, the <a class="def" href="#glossary-default-action">default action</a> MUST be
+ to give that element document focus.</li>
+ </ul>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- dblclick -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-dblclick"><dfn><a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>dblclick</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ indicates the <a href="#current-click-count">current click count</a></li>
+ <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
+ value based on current button pressed</li>
+ <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
+ value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
+ <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
+ <code>null</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the primary button
+ of a pointing device is clicked twice over an element. The definition of a double click depends on the environment
+ configuration, except that the event target MUST be the same between
+ <a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a>,
+ <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a>, and
+ <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a>.
+ This event type MUST be dispatched after the event type
+ <a class="eventtype" href="#event-type-click"><code>click</code></a>
+ if a click and double click occur simultaneously,
+ and after the event type <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> otherwise.
+ </p>
+
+ <p class="note"><strong>Note:</strong> As with the <code>click</code> event, the <code>dblclick</code> event
+ should only be fired for the primary pointer button.
+ Secondary buttons MUST NOT fire <code>dblclick</code> events.
+ </p>
+
+ <p class="note"><strong>Note:</strong> Canceling the
+ <a class="eventtype" href="#event-type-click"><code>click</code></a> event does not affect the firing
+ of a <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a> event.
+ </p>
+
+ <p>As with the <a class="eventtype" href="#event-type-click"><code>click</code></a> event type, the
+ <a class="def" href="#glossary-default-action">default action</a>
+ of the <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a> event type varies based on the
+ <a class="def" href="#glossary-event-target">event target</a> of the event and the value of the
+ <a href="#widl-MouseEvent-button"><code>MouseEvent.button</code></a> or
+ <a href="#widl-MouseEvent-buttons"><code>MouseEvent.buttons</code></a> attributes.
+ Normally, the typical <a class="def" href="#glossary-default-action">default actions</a> of the
+ <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a> event type match those of the
+ <a class="eventtype" href="#event-type-click"><code>click</code></a> event type, with the following additional
+ behavior:
+ </p>
+
+ <ul>
+ <li>If the <a class="def" href="#glossary-event-target">event target</a> is selectable, the <a class="def" href="#glossary-default-action">default action</a> MUST
+ be to select part or all of the selectable content. Subsequent clicks MAY select additional selectable portions of that content.</li>
+ </ul>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- mousedown -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-mousedown"><dfn><a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>mousedown</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>Varies: Start a drag/drop operation; start a text selection; start a scroll/pan interaction (in combination with the middle mouse button, if supported)</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ indicates the <a href="#current-click-count">current click count</a> incremented by one. For example, if no click happened
+ before the <a class="eventtype"><code>mousedown</code></a>, <a href="#widl-UIEvent-detail"><code>UIEvent.detail</code></a>
+ will contain the value <code>1</code></li>
+ <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
+ value based on current button pressed</li>
+ <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
+ value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
+ <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
+ <code>null</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device button is pressed over an element.</p>
+
+ <p class="note"><strong>Note: </strong>Many implementations use the <a class="eventtype"><code>mousedown</code></a> event to begin a variety of contextually dependent <a class="def"
+ href="#glossary-default-action">default actions</a>. These default actions can be prevented if this event is canceled. Some of these default actions could include: beginning
+ a drag/drop interaction with an image or link, starting text selection, etc. Additionally, some implementations provide a mouse-driven panning feature that is activated when
+ the middle mouse button is pressed at the time the <a class="eventtype"><code>mousedown</code></a> event is dispatched.</p>
+
+ </dd>
+ </dl>
+ </div>
+
+ <!-- mouseenter -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-mouseenter"><dfn><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>mouseenter</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
+ value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
+ <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
+ indicates the <a class="def" href="#glossary-event-target">event target</a> a pointing device is exiting, if any.</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved onto the boundaries of an element or one of
+ its descendent elements. This event type is similar to <a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a>, but differs in that it does
+ not bubble, and MUST NOT be dispatched when the pointer device moves from an element onto the boundaries of one of its descendent elements.</p>
+
+ <p class="note"><strong>Note:</strong> There are similarities between this event type and the CSS <a href="http://www.w3.org/TR/CSS2/selector.html#dynamic-pseudo-classes"
+ title="Selectors"><code>:hover</code> pseudo-class</a> <a href="#references-CSS2">[CSS2.1]</a>. See also the <a class="eventtype" href="#event-type-mouseleave"><code>
+ mouseleave</code></a> event type.</p>
+
+ </dd>
+ </dl>
+ </div>
+
+ <!-- mouseleave -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-mouseleave"><dfn><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>mouseleave</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
+ value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
+ <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
+ indicates the <a class="def" href="#glossary-event-target">event target</a> a pointing device is entering, if any.</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved off of the boundaries of an element and all
+ of its descendent elements. This event type is similar to <a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a>, but differs in that does
+ not bubble, and that it MUST NOT be dispatched until the pointing device has left the boundaries of the element and the boundaries of all of its children.</p>
+
+ <p class="note"><strong>Note:</strong> There are similarities between this event type and the CSS <a href="http://www.w3.org/TR/CSS2/selector.html#dynamic-pseudo-classes"
+ title="Selectors"><code>:hover</code> pseudo-class</a> <a href="#references-CSS2">[CSS2.1]</a>. See also the <a class="eventtype" href="#event-type-mouseenter"><code>
+ mouseenter</code></a> event type.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- mousemove -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-mousemove"><dfn><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>mousemove</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
+ value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
+ <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
+ <code>null</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved while it is over an element. The frequency
+ rate of events while the pointing device is moved is implementation-, device-, and platform-specific, but multiple consecutive <a class="eventtype" href="#event-type-mousemove">
+ <code>mousemove</code></a> events SHOULD be fired for sustained pointer-device movement, rather than a single event for each instance of mouse movement. Implementations
+ are encouraged to determine the optimal frequency rate to balance responsiveness with performance.
+ </p>
+
+ <p class="note"><strong>Authoring Note: </strong>In some implementation environments, such as a browser, <a class="eventtype"><code>mousemove</code></a> events can continue
+ to fire if the user began a drag operation (e.g., a mouse button is pressed) and the pointing device has left the boundary of the user agent.
+ </p>
+
+ <p class="note" id="mousemove-now-cancelable"><strong>Note: </strong>This event was formerly specified to be non-cancelable in DOM Level 2 Events
+ [<a href="#references-DOM2Events">DOM2 Events</a>], but was changed to reflect existing interoperability between
+ user agents.
+ </p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- mouseout -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-mouseout"><dfn><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>mouseout</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
+ value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
+ <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
+ indicates the <a class="def" href="#glossary-event-target">event target</a> a pointing device is entering, if any.</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved off of the boundaries of an element. This
+ event type is similar to <a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a>, but differs in that does bubble, and that it MUST be dispatched
+ when the pointer device moves from an element onto the boundaries of one of its descendent elements.</p>
+
+ <p class="note"><strong>Note:</strong> See also the <a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a> event type.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- mouseover -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-mouseover"><dfn><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></dfn></dt>
+ <dd>
+ <table summary="This table contains information about the semantics of the given event type" border="0" cellpadding="2" cellspacing="0">
+ <tbody>
<tr>
<th>Type</th>
- <td><strong><code>focusout</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-FocusEvent"><code>FocusEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><a class="def" href="#glossary-window"><code>Window</code></a>, <code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> losing focus</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-FocusEvent-relatedTarget"><code class="attribute-name">FocusEvent.relatedTarget</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> receiving focus.</li>
- </ul>
- </td>
- </tr>
- </table>
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when an <a class="def" href="#glossary-event-target">event target</a> is about
- to lose focus. This event type MUST be dispatched before the element loses focus. The <a class="def" href="#glossary-event-target">event target</a> MUST be the
- element which is about to lose focus. This event type is similar to <a class="eventtype" href="#event-type-blur"><code>blur</code></a>, but is dispatched before
- focus is shifted, and does bubble.</p>
- </dd>
- </dl>
- </div>
- </section> <!-- events-focusevent -->
-
- <section id="events-mouseevents">
- <h3>Mouse Event Types</h3>
-
- <p>The mouse event module originates from the [<cite><a class="informative" href="#references-HTML40">HTML 4.01</a></cite>] <code>onclick</code>, <code>ondblclick</code>,
- <code>onmousedown</code>, <code>onmouseup</code>, <code>onmouseover</code>, <code>onmousemove</code>, and <code>onmouseout</code> attributes. This event module
- is specifically designed for use with pointing input devices, such as a mouse or a trackball.</p>
-
- <section id="interface-MouseEvent">
- <h4>Interface MouseEvent</h4>
-
- <p class="intro-dom">Introduced in DOM Level 2, modified in DOM Level 3</p>
-
- <p>The <code>MouseEvent</code> interface provides specific contextual information
- associated with Mouse events.
- </p>
-
- <p>In the case of nested elements, mouse events are always targeted at the most deeply
- nested element.
- </p>
-
- <p class="note"><strong>Note:</strong>
- Ancestors of the targeted element can use event bubbling to obtain notifications
- of mouse events which occur within their descendent elements.
- </p>
-
- <p>To create an instance of the <code>MouseEvent</code> interface, use the
- <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("MouseEvent")</code></a>
- method call.
- </p>
-
- <p class="note"><strong>Note:</strong>
- When initializing <code>MouseEvent</code> objects using <code>initMouseEvent</code>,
- implementations can use the client coordinates <code>clientX</code> and <code>clientY</code>
- for calculation of other coordinates (such as target coordinates exposed by
- <a class="def" href="#glossary-DOM-Level-0">DOM Level 0</a>
- implementations or other proprietary attributes, e.g., <code>pageX</code>).
- </p>
-
- <dl class="idl" title="[Constructor(DOMString typeArg, optional MouseEventInit mouseEventInitDict)] interface MouseEvent : UIEvent">
- <dt>readonly attribute long screenX</dt>
- <dd>
- <p>The horizontal coordinate at which the event occurred relative to the origin
- of the screen coordinate system.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>0</code>.
- </p>
- </dd>
-
- <dt>readonly attribute long screenY</dt>
- <dd>
- <p>The vertical coordinate at which the event occurred relative to the origin
- of the screen coordinate system.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>0</code>.
- </p>
- </dd>
-
- <dt>readonly attribute long clientX</dt>
- <dd>
- <p>The horizontal coordinate at which the event occurred relative to the viewport
- associated with the event.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>0</code>.
- </p>
- </dd>
-
- <dt>readonly attribute long clientY</dt>
- <dd>
- <p>The vertical coordinate at which the event occurred relative to the viewport
- associated with the event.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>0</code>.
- </p>
- </dd>
-
- <dt>readonly attribute boolean ctrlKey</dt>
- <dd>
- <p>Refer to the <a href="#widl-KeyboardEvent-ctrlKey"><code>KeyboardEvent.ctrlKey</code></a> attribute.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>false</code>.
- </p>
- </dd>
-
- <dt>readonly attribute boolean shiftKey</dt>
- <dd>
- <p>Refer to the <a href="#widl-KeyboardEvent-shiftKey"><code>KeyboardEvent.shiftKey</code></a> attribute.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>false</code>.
- </p>
- </dd>
-
- <dt>readonly attribute boolean altKey</dt>
- <dd>
- <p>Refer to the <a href="#widl-KeyboardEvent-altKey"><code>KeyboardEvent.altKey</code></a> attribute.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>false</code>.
- </p>
- </dd>
-
- <dt>readonly attribute boolean metaKey</dt>
- <dd>
- <p>Refer to the <a href="#widl-KeyboardEvent-metaKey"><code>KeyboardEvent.metaKey</code></a> attribute.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>false</code>.
- </p>
- </dd>
-
- <dt>readonly attribute short button</dt>
- <dd>
- <p>During mouse events caused by the depression or release of a mouse button,
- <code>button</code> MUST be used to indicate which pointer device button
- changed state.
- </p>
-
- <p>The value of the <a href="#widl-MouseEvent-button"><code>MouseEvent.button</code></a>
- attribute MUST be as follows:
- </p>
-
- <ul>
- <li><code>0</code> MUST indicate the primary button of the device
- (in general, the left button or the only button on single-button devices,
- used to activate a user interface control or select text) or the
- un-initialized value.</li>
- <li><code>1</code> MUST indicate the auxiliary button
- (in general, the middle button, often combined with a mouse wheel).</li>
- <li><code>2</code> MUST indicate the secondary button
- (in general, the right button, often used to display a context menu).</li>
- </ul>
-
- <p>Some pointing devices provide or simulate more button states, and values higher than
- <code>2</code> or lower than <code>0</code> MAY be used to represent such buttons.
- </p>
-
- <p class="note"><strong>Note:</strong>
- The value of <code>button</code> is not updated for events not caused by the
- depression/release of a mouse button.
- In these scenarios, take care not to interpret the value <code>0</code> as the
- left button, but rather as the
- <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>.
- </p>
-
- <p class="note"><strong>Authoring Note:</strong>
- Some <a class="def" href="#glossary-default-action">default actions</a> related
- to events such as <a class="eventtype"><code>mousedown</code></a> and
- <a class="eventtype"><code>mouseup</code></a> depend on the specific mouse
- button in use.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>0</code>.
- </p>
- </dd>
-
- <dt>readonly attribute EventTarget? relatedTarget</dt>
- <dd>
- <p>Used to identify a secondary <a href="#interface-EventTarget"><code>EventTarget</code></a> related to a UI event, depending on the type of event.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>null</code>.</p>
- </dd>
-
- <dt>// Introduced in DOM Level 3</dt>
-
- <dt>readonly attribute unsigned short buttons</dt>
- <dd>
- <p>During any mouse events, <code>buttons</code> MUST be used to indicate
- which combination of mouse buttons are currently being pressed,
- expressed as a bitmask.
- </p>
-
- <p class="note"><strong>Note:</strong>
- Though similarly named, the values for the <code>buttons</code> attribute
- and the <a href="#widl-MouseEvent-button"><code>button</code></a>
- attribute are very different.
- The value of <code>button</code> is assumed to be valid during
- <a class="eventtype"><code>mousedown</code></a> /
- <a class="eventtype"><code>mouseup</code></a> event handlers,
- whereas the <code>buttons</code> attribute reflects the state of the
- mouse's buttons for any trusted <code>MouseEvent</code> object
- (while it is being dispatched), because it can represent the
- "no button currently active" state (0).
- </p>
-
- <p>The value of the <a href="#widl-MouseEvent-buttons"><code>MouseEvent.buttons</code></a>
- attribute MUST be as follows:
- </p>
-
- <ul>
- <li><code>0</code> MUST indicate no button is currently active.</li>
- <li><code>1</code> MUST indicate the primary button of the device
- (in general, the left button or the only button on single-button devices,
- used to activate a user interface control or select text).</li>
- <li><code>2</code> MUST indicate the secondary button
- (in general, the right button, often used to display a context menu), if present.</li>
- <li><code>4</code> MUST indicate the auxiliary button
- (in general, the middle button, often combined with a mouse wheel).</li>
- </ul>
-
- <p>Some pointing devices provide or simulate more buttons.
- To represent such buttons, the value MUST be doubled for each successive button
- (in the binary series <code>8</code>, <code>16</code>, <code>32</code>, ... ).
- </p>
-
- <p class="note" id="buttons-mask"><strong>Note:</strong>
- Because the sum of any set of button values is a unique number, a content
- author can use a bitwise operation to determine how many buttons are currently
- being pressed and which buttons they are, for an arbitrary number of mouse buttons
- on a device.
- For example, the value <code>3</code> indicates that the left and right button are
- currently both pressed, while the value <code>5</code> indicates that the left and
- middle button are currently both pressed.
- </p>
-
- <p class="note"><strong>Authoring Note:</strong>
- Some <a class="def" href="#glossary-default-action">default actions</a> related
- to events such as <a class="eventtype"><code>mousedown</code></a> and
- <a class="eventtype"><code>mouseup</code></a> depend on the specific mouse button
- in use.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a>
- of this attribute MUST be <code>0</code>.
- </p>
- </dd>
-
- <dt>boolean getModifierState()</dt>
- <dd>
- <p class="intro-dom">Introduced in DOM Level 3</p>
-
- <p>Queries the state of a modifier using a key value.
- See <a href="#keys-modifiers">Modifier keys</a> for a list of valid (case-sensitive) arguments to this method.
- </p>
-
- <p>Returns <code>true</code> if it is a modifier key and the modifier is activated,
- <code>false</code> otherwise.
- </p>
-
- <dl class="parameters">
- <dt>DOMString keyArg</dt>
- <dd>
- <p>Refer to the <a href="#widl-KeyboardEvent-getModifierState"><code>KeyboardEvent.getModifierState()</code></a> method for a description of this parameter.</p>
- </dd>
- </dl>
- </dd>
-
- </dl>
-
- <dl class="idl" title="dictionary MouseEventInit : UIEventInit">
-
- <dt>long screenX = 0</dt>
- <dd>
- <p>See <code>screenY</code> (substituting "horizontal" for "veritcal").</p>
- </dd>
-
- <dt>long screenY = 0</dt>
- <dd>
- <p>Initializes the <code>screenY</code> attribute of the MouseEvent
- object to the desired vertical relative position of the mouse
- pointer on the user's screen.
- </p>
-
- <p>Initializing the event object to the given mouse position must
- not move the user's mouse pointer to the initialized position.
- </p>
- </dd>
-
- <dt>long clientX = 0</dt>
- <dd>
- <p>See <code>clientY</code> (substituting "horizontal" for "vertical").</p>
- </dd>
-
- <dt>long clientY = 0</dt>
- <dd>
- <p>Initializes the <code>clientY</code> attribute of the MouseEvent
- object to the desired vertical position of the mouse pointer
- relative to the client window of the user's browser.
- </p>
-
- <p>Initializing the event object to the given mouse position must
- not move the user's mouse pointer to the initialized position.
- </p>
- </dd>
-
- <dt>boolean ctrlKey = false</dt>
- <dd>
- <p>Initializes the <code>altKey</code> attribute of the MouseEvent
- object to <code>true</code> if the <code class="key">'Control'</code>
- (control) key modifier is to be considered active,
- <code>false</code> otherwise.</p>
- </dd>
-
- <dt>boolean shiftKey = false</dt>
- <dd>
- <p>Initializes the <code>shiftKey</code> attribute of the MouseEvent
- object to <code>true</code> if the <code class="key">'Shift'</code>
- key modifier is to be considered active, <code>false</code> otherwise.</p>
- </dd>
-
- <dt>boolean altKey = false</dt>
- <dd>
- <p>Initializes the <code>altKey</code> attribute of the MouseEvent
- object to <code>true</code> if the <code class="key">'Alt'</code>
- (alternative) (or <code class="glyph">'Option'</code>) key modifier
- is to be considered active, <code>false</code> otherwise.</p>
- </dd>
-
- <dt>boolean metaKey = false</dt>
- <dd>
- <p>Initializes the <code>metaKey</code> attribute of the MouseEvent
- object to <code>true</code> if the <code class="key">'Meta'</code>
- key modifier is to be considered active, <code>false</code> otherwise.</p>
- </dd>
-
- <dt>short button = 0</dt>
- <dd>
- <p>Initializes the <code>button</code> attribute of the MouseEvent
- object to a number representing the desired state of the button(s)
- of the mouse.
- </p>
-
- <p class="note"><strong>Note:</strong>
- The value 0 is used to represent
- the primary mouse button, 1 is used to represent the auxiliary/middle
- mouse button, and 2 to represent the right mouse button.
- Numbers greater than 2 are also possible, but are not specified
- in this document.
- </p>
- </dd>
-
- <dt>unsigned short buttons = 0</dt>
- <dd>
- <p>Initializes the <code>buttons</code> attribute of the MouseEvent
- object to a number representing one <em>or more</em> of the button(s) of the mouse
- that are to be considered active.
- </p>
-
- <p class="note"><strong>Note:</strong>
- The <code>buttons</code>
- attribute is a bit-field. If a mask value of 1 is true when applied to
- the value of the bit field, then the primary mouse button is down. If a
- mask value of 2 is true when applied to the value of the bit field, then
- the right mouse button is down. If a mask value of 4 is true when applied
- to the value of the bit field, then the auxiliary/middle button is down.</p>
-
- <div class="example">
- <p>In JavaScript, to initialize the
- <code>buttons</code> attribute as if the right (2) and middle
- button (4) were being pressed simultaneously, the buttons value
- can be assigned as either:<br/>
- <code>{ buttons: 2 | 4 }</code></br/>
- or:<br/>
- <code>{ buttons: 6 }</code>
- </p>
- </div><!-- Initializing buttons -->
- </dd>
-
- <dt>EventTarget? relatedTarget = null</dt>
- <dd>
- <p>The <code>relatedTarget</code> should be initialized to the element
- whose bounds the mouse pointer just left (in the case of a
- <em>mouseover</em> or <em>mouseenter</em> event) or the element
- whose bounds the mouse pointer is entering (in the case of a
- <em>mouseout</em> or <em>mouseleave</em>
- or <em>focusout</em> event). For other events, this value need not
- be assigned (and will default to null).
- </p>
- </dd>
- </dl>
-
- </section> <!-- interface-MouseEvent -->
-
- <p id="current-click-count">Implementations MUST maintain the <em>current click count</em> when generating mouse events. This MUST be a non-negative integer indicating
- the number of consecutive clicks of a pointing device button within a specific time. The delay after which the count resets is specific to the
- environment configuration.</p>
-
- <section id="events-mouseevent-event-order">
- <h4>Mouse Event Order</h4>
-
- <p>Certain mouse events defined in this specification MUST occur in a set order relative to one another.
- The following shows the event sequence that MUST occur when a pointing
- device's cursor is moved over an element:</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th class="cell-center">Element</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td class="cell-center"></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em>Pointing device is moved into element A...</em></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td class="cell-center">A</td>
- <td>Multiple events</td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em>Pointing device is moved out of element A...</em></td>
- </tr>
- <tr>
- <td class="cell-number">5.</td>
- <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">6.</td>
- <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- </table>
-
- <p>When a pointing device is moved into an element <em>A</em>, and then into a nested element <em>B</em>
- and then back out again, the following sequence of events MUST occur:
- </p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th class="cell-center">Element</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td class="cell-center"></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em>Pointing device is moved into element A...</em></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td class="cell-center">A</td>
- <td>Multiple events</td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em>Pointing device is moved into nested element B...</em></td>
- </tr>
- <tr>
- <td class="cell-number">5.</td>
- <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">6.</td>
- <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
- <td class="cell-center">B</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">7.</td>
- <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
- <td class="cell-center">B</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">8.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td class="cell-center">B</td>
- <td>Multiple events</td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em>Pointing device is moved from element B into A...</em></td>
- </tr>
- <tr>
- <td class="cell-number">9.</td>
- <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
- <td class="cell-center">B</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">10.</td>
- <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
- <td class="cell-center">B</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">11.</td>
- <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">12.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td class="cell-center">A</td>
- <td>Multiple events</td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em>Pointing device is moved out of element A...</em></td>
- </tr>
- <tr>
- <td class="cell-number">13.</td>
- <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">14.</td>
- <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- </table>
-
- <p>Sometimes elements can be visually overlapped using CSS. In the following example, three elements
- labeled A, B, and C all have the same dimensions and absolute position on a web page.
- Element C is a child of B, and B is a child of A in the DOM:
- </p>
-
- <figure id="figure-mouse-event-stacked-elements">
- <img src='images/stacked-event-mouse-dispatch.svg' width="403" height="217" />
- <figcaption>Graphical representation of three stacked elements all on top of each other, with the pointing device moving over the stack.</figcaption>
- </figure>
-
- <p>When the pointing device is moved from outside the element stack to the element labeled C and then moved
- out again, the following series of events MUST occur:</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th class="cell-center">Element</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td class="cell-center"></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em>Pointing device is moved into element C, the topmost element in the stack</em></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></td>
- <td class="cell-center">C</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
- <td class="cell-center">B</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">5.</td>
- <td><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></td>
- <td class="cell-center">C</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">6.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td class="cell-center">C</td>
- <td>Multiple events</td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em>Pointing device is moved out of element C...</em></td>
- </tr>
- <tr>
- <td class="cell-number">7.</td>
- <td><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></td>
- <td class="cell-center">C</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">8.</td>
- <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
- <td class="cell-center">C</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">9.</td>
- <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
- <td class="cell-center">B</td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">10.</td>
- <td><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></td>
- <td class="cell-center">A</td>
- <td></td>
- </tr>
- </table>
-
- <p class="note"><strong>Note:</strong> The <code>mouseover</code>/<code>mouseout</code> events are only fired once, while <code>mouseenter</code>/<code>mouseleave</code>
- events are fired three times (once to each element).</p>
-
- <p>The following is the typical sequence of events when a button associated with a pointing device (e.g., a mouse button or trackpad) is pressed and released over
- an element:</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td>OPTIONAL, multiple events, some limits</td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-click"><code>click</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">5.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td>OPTIONAL, multiple events, some limits</td>
- </tr>
- <tr>
- <td class="cell-number">6.</td>
- <td><a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">7.</td>
- <td><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></td>
- <td>OPTIONAL, multiple events, some limits</td>
- </tr>
- <tr>
- <td class="cell-number">8.</td>
- <td><a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">9.</td>
- <td><a class="eventtype" href="#event-type-click"><code>click</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">10.</td>
- <td><a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a></td>
- <td></td>
- </tr>
- </table>
-
- <p class="note"><strong>Note: </strong>The lag time, degree, distance, and number of <a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a>
- events allowed between the <a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a> and <a class="eventtype" href="#event-type-mouseup">
- <code>mouseup</code></a> events while still firing a <a class="eventtype" href="#event-type-click"><code>click</code></a> or <a class="eventtype"
- href="#event-type-dblclick"><code>dblclick</code></a> event will be implementation-, device-, and platform-specific. This tolerance can aid users that have physical
- disabilities like unsteady hands when these users interact with a pointing device.</p>
-
- <p>Each implementation will determine the appropriate <a class="def" href="#glossary-hysteresis">hysteresis</a> tolerance, but in general SHOULD fire <a class="eventtype" href="#event-type-click"><code>click</code></a>
- and <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a> events when the event target of the associated <a class="eventtype"
- href="#event-type-mousedown"><code>mousedown</code></a> and <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> events is the same element with no
- <a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a> or <a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a>
- events intervening, and SHOULD fire <a class="eventtype" href="#event-type-click"><code>click</code></a> and <a class="eventtype" href="#event-type-dblclick">
- <code>dblclick</code></a> events on the nearest common ancestor when the event targets of the associated <a class="eventtype" href="#event-type-mousedown">
- <code>mousedown</code></a> and <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> events are different.</p>
-
- <p>If the <a class="def" href="#glossary-event-target">event target</a> (e.g. the target element) is removed from the DOM during the mouse events sequence, the remaining
- events of the sequence MUST NOT be fired on that element.</p>
-
- <div class="example">
- <div class="example-title"></div>
- <p>If the target element is removed from the DOM as the result of a <a class="eventtype" href="#event-type-mousedown">
- <code>mousedown</code></a> event, no events for that element will be dispatched for <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a>,
- <a class="eventtype" href="#event-type-click"><code>click</code></a>, or <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a>, nor any default
- activation events. However, the <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> event will still be dispatched on the element that is exposed
- to the mouse after the removal of the initial target element. Similarly, if the target element is removed from the DOM during the dispatch of a <a class="eventtype"
- href="#event-type-mouseup"><code>mouseup</code></a> event, the <a class="eventtype" href="#event-type-click"><code>click</code></a> and subsequent events will
- not be dispatched.</p>
- </div>
-
- </section> <!-- events-mouseevent-event-order -->
-
- <p>The Mouse event types are listed below. 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.</p>
-
- <!-- click -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-click"><dfn><a class="eventtype" href="#event-type-click"><code>click</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>click</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>Varies</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- indicates the <a href="#current-click-count">current click count</a>;
- the attribute value MUST be <code>1</code> when the user begins this action and increments by <code>1</code> for each click.</li>
- <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
- value based on current button pressed</li>
- <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
- value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
- <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- <code>null</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>The <a class="eventtype" href="#event-type-click"><code>click</code></a> event type MUST be dispatched on the
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a> indicated by the pointer, when
- the user presses down and releases the primary pointer button,
- or otherwise activates the pointer in a manner that simulates such an action.
- The actuation method of the mouse button depends upon the pointer device and the environment configuration,
- e.g., it MAY depend on the screen location or the delay between the press and release of the pointing device button.
- </p>
-
- <p class="note"><strong>Note:</strong> The <code>click</code> event should only be fired for the primary
- pointer button (i.e., when <a href="#widl-MouseEvent-button"><code>MouseEvent.button</code></a> value is <code>0</code>,
- <a href="#widl-MouseEvent-buttons"><code>MouseEvent.buttons</code></a> value is <code>1</code>).
- Secondary buttons (like the middle or right button on a standard mouse) MUST NOT fire
- <code>click</code> events.
- </p>
-
- <p>The <a class="eventtype" href="#event-type-click"><code>click</code></a> event MAY be preceded by the <a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a>
- and <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> events on the same element, disregarding changes between other node types (e.g., text
- nodes). Depending upon the environment configuration, the <a class="eventtype" href="#event-type-click"><code>click</code></a> event MAY be dispatched if one or
- more of the event types <a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a>, <a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a>,
- and <a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a> occur between the press and release of the pointing device button. The <a class="eventtype"
- href="#event-type-click"><code>click</code></a> event MAY also be followed by the <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a>
- event.</p>
-
- <div class="example">
- <div class="example-title"></div>
- <p>If a user mouses down on a text node child of a <code><p></code> element which has been styled with
- a large line-height, shifts the mouse slightly such that it is no longer over an area containing text but is still within the containing block of that <code><p></code>
- element (i.e., the pointer is between lines of the same text block, but not over the text node per se), then subsequently mouses up, this will likely still trigger
- a <a class="eventtype" href="#event-type-click"><code>click</code></a> event (if it falls within the normal temporal <a class="def" href="#glossary-hysteresis">hysteresis</a> for a <a class="eventtype" href="#event-type-click">
- <code>click</code></a>), since the user has stayed within the scope of the same element. Note that user-agent-generated mouse events are not dispatched on text nodes.
- </p>
- </div>
-
- <p>In addition to being associated with pointer devices, the <a class="eventtype" href="#event-type-click"><code>click</code></a> event type MUST be dispatched as
- part of an element activation, as described in <a href="#event-flow-activation">Activation triggers and behavior</a>.</p>
-
- <p class="note"><strong>Note:</strong> For maximum accessibility, content authors are encouraged to use the
- <a class="eventtype" href="#event-type-click"><code>click</code></a> event type when defining activation
- behavior for custom controls, rather than other pointing-device event types such as
- <a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a> or
- <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a>, which are more device-specific.
- Though the <a class="eventtype" href="#event-type-click"><code>click</code></a> event type has its origins
- in pointer devices (e.g., a mouse), subsequent implementation
- enhancements have extended it beyond that association, and it can be considered a device-independent event
- type for element activation.
- </p>
-
- <p>The <a class="def" href="#glossary-default-action">default action</a> of the
- <a class="eventtype" href="#event-type-click"><code>click</code></a> event type varies
- based on the <a class="def" href="#glossary-event-target">event target</a> of the event and the value of the
- <a href="#widl-MouseEvent-button"><code>MouseEvent.button</code></a>
- or <a href="#widl-MouseEvent-buttons"><code>MouseEvent.buttons</code></a> attributes.
- Typical <a class="def" href="#glossary-default-action">default actions</a>
- of the <a class="eventtype" href="#event-type-click"><code>click</code></a> event type are as follows:
- </p>
-
- <ul>
- <li>If the <a class="def" href="#glossary-event-target">event target</a> has associated activation behavior, the <a class="def" href="#glossary-default-action">default
- action</a> MUST be to execute that activation behavior (see <a href="#event-flow-activation">Activation triggers and behavior</a>).</li>
-
- <li>If the <a class="def" href="#glossary-event-target">event target</a> is focusable, the <a class="def" href="#glossary-default-action">default action</a> MUST be
- to give that element document focus.</li>
- </ul>
- </dd>
- </dl>
- </div>
-
- <!-- dblclick -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-dblclick"><dfn><a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>dblclick</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- indicates the <a href="#current-click-count">current click count</a></li>
- <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
- value based on current button pressed</li>
- <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
- value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
- <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- <code>null</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the primary button
- of a pointing device is clicked twice over an element. The definition of a double click depends on the environment
- configuration, except that the event target MUST be the same between
- <a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a>,
- <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a>, and
- <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a>.
- This event type MUST be dispatched after the event type
- <a class="eventtype" href="#event-type-click"><code>click</code></a>
- if a click and double click occur simultaneously,
- and after the event type <a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a> otherwise.
- </p>
-
- <p class="note"><strong>Note:</strong> As with the <code>click</code> event, the <code>dblclick</code> event
- should only be fired for the primary pointer button.
- Secondary buttons MUST NOT fire <code>dblclick</code> events.
- </p>
-
- <p class="note"><strong>Note:</strong> Canceling the
- <a class="eventtype" href="#event-type-click"><code>click</code></a> event does not affect the firing
- of a <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a> event.
- </p>
-
- <p>As with the <a class="eventtype" href="#event-type-click"><code>click</code></a> event type, the
- <a class="def" href="#glossary-default-action">default action</a>
- of the <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a> event type varies based on the
- <a class="def" href="#glossary-event-target">event target</a> of the event and the value of the
- <a href="#widl-MouseEvent-button"><code>MouseEvent.button</code></a> or
- <a href="#widl-MouseEvent-buttons"><code>MouseEvent.buttons</code></a> attributes.
- Normally, the typical <a class="def" href="#glossary-default-action">default actions</a> of the
- <a class="eventtype" href="#event-type-dblclick"><code>dblclick</code></a> event type match those of the
- <a class="eventtype" href="#event-type-click"><code>click</code></a> event type, with the following additional
- behavior:
- </p>
-
- <ul>
- <li>If the <a class="def" href="#glossary-event-target">event target</a> is selectable, the <a class="def" href="#glossary-default-action">default action</a> MUST
- be to select part or all of the selectable content. Subsequent clicks MAY select additional selectable portions of that content.</li>
- </ul>
- </dd>
- </dl>
- </div>
-
- <!-- mousedown -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-mousedown"><dfn><a class="eventtype" href="#event-type-mousedown"><code>mousedown</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>mousedown</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>Varies: Start a drag/drop operation; start a text selection; start a scroll/pan interaction (in combination with the middle mouse button, if supported)</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- indicates the <a href="#current-click-count">current click count</a> incremented by one. For example, if no click happened
- before the <a class="eventtype"><code>mousedown</code></a>, <a href="#widl-UIEvent-detail"><code>UIEvent.detail</code></a>
- will contain the value <code>1</code></li>
- <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
- value based on current button pressed</li>
- <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
- value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
- <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- <code>null</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device button is pressed over an element.</p>
-
- <p class="note"><strong>Note: </strong>Many implementations use the <a class="eventtype"><code>mousedown</code></a> event to begin a variety of contextually dependent <a class="def"
- href="#glossary-default-action">default actions</a>. These default actions can be prevented if this event is canceled. Some of these default actions could include: beginning
- a drag/drop interaction with an image or link, starting text selection, etc. Additionally, some implementations provide a mouse-driven panning feature that is activated when
- the middle mouse button is pressed at the time the <a class="eventtype"><code>mousedown</code></a> event is dispatched.</p>
-
- </dd>
- </dl>
- </div>
-
- <!-- mouseenter -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-mouseenter"><dfn><a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>mouseenter</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
- <code>0</code></li>
- <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
- value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
- <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- indicates the <a class="def" href="#glossary-event-target">event target</a> a pointing device is exiting, if any.</li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved onto the boundaries of an element or one of
- its descendent elements. This event type is similar to <a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a>, but differs in that it does
- not bubble, and MUST NOT be dispatched when the pointer device moves from an element onto the boundaries of one of its descendent elements.</p>
-
- <p class="note"><strong>Note:</strong> There are similarities between this event type and the CSS <a href="http://www.w3.org/TR/CSS2/selector.html#dynamic-pseudo-classes"
- title="Selectors"><code>:hover</code> pseudo-class</a> <a href="#references-CSS2">[CSS2.1]</a>. See also the <a class="eventtype" href="#event-type-mouseleave"><code>
- mouseleave</code></a> event type.</p>
-
- </dd>
- </dl>
- </div>
-
- <!-- mouseleave -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-mouseleave"><dfn><a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>mouseleave</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
- <code>0</code></li>
- <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
- value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
- <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- indicates the <a class="def" href="#glossary-event-target">event target</a> a pointing device is entering, if any.</li>
- </ul>
- </td>
- </tr>
- </table>
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved off of the boundaries of an element and all
- of its descendent elements. This event type is similar to <a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a>, but differs in that does
- not bubble, and that it MUST NOT be dispatched until the pointing device has left the boundaries of the element and the boundaries of all of its children.</p>
-
- <p class="note"><strong>Note:</strong> There are similarities between this event type and the CSS <a href="http://www.w3.org/TR/CSS2/selector.html#dynamic-pseudo-classes"
- title="Selectors"><code>:hover</code> pseudo-class</a> <a href="#references-CSS2">[CSS2.1]</a>. See also the <a class="eventtype" href="#event-type-mouseenter"><code>
- mouseenter</code></a> event type.</p>
- </dd>
- </dl>
- </div>
-
- <!-- mousemove -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-mousemove"><dfn><a class="eventtype" href="#event-type-mousemove"><code>mousemove</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>mousemove</code></strong></td>
+ <td><strong><code>mouseover</code></strong></td>
</tr>
<tr>
<th>Interface</th>
@@ -3887,206 +4109,1826 @@
<li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
<li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- <code>null</code></li>
+ indicates the <a class="def" href="#glossary-event-target">event target</a> a pointing device is exiting, if any.</li>
</ul>
</td>
</tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved while it is over an element. The frequency
- rate of events while the pointing device is moved is implementation-, device-, and platform-specific, but multiple consecutive <a class="eventtype" href="#event-type-mousemove">
- <code>mousemove</code></a> events SHOULD be fired for sustained pointer-device movement, rather than a single event for each instance of mouse movement. Implementations
- are encouraged to determine the optimal frequency rate to balance responsiveness with performance.
- </p>
-
- <p class="note"><strong>Authoring Note: </strong>In some implementation environments, such as a browser, <a class="eventtype"><code>mousemove</code></a> events can continue
- to fire if the user began a drag operation (e.g., a mouse button is pressed) and the pointing device has left the boundary of the user agent.
- </p>
-
- <p class="note" id="mousemove-now-cancelable"><strong>Note: </strong>This event was formerly specified to be non-cancelable in DOM Level 2 Events
- [<a href="#references-DOM2Events">DOM2 Events</a>], but was changed to reflect existing interoperability between
- user agents.
- </p>
- </dd>
- </dl>
+ </tbody>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved onto the boundaries of an element. This event
+ type is similar to <a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a>, but differs in that it bubbles, and that it MUST be dispatched
+ when the pointer device moves onto the boundaries of an element whose ancestor element is the <a class="def" href="#glossary-event-target">event target</a> for
+ the same event listener instance.</p>
+
+ <p class="note"><strong>Note:</strong> See also the <a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a> event type.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- mouseup -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-mouseup"><dfn><a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>mouseup</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>Invoke a context menu (in combination with the right mouse button, if supported)</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ indicates the <a href="#current-click-count">current click count</a> incremented by one.</li>
+ <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
+ value based on the pointer position on the screen</li>
+ <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
+ value based on the pointer position within the viewport</li>
+ <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
+ value based on current button pressed</li>
+ <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
+ value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
+ <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
+ <code>null</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device button is released over an element.</p>
+
+ <p class="note"><strong>Note: </strong>Many implementations will invoke a context menu as the default action of this event if the right mouse button is being released.</p>
+
+ <p class="note"><strong>Authoring Note: </strong>In some implementation environments,
+ such as a browser, a <a class="eventtype"><code>mouseup</code></a> event
+ can be dispatched even if the pointing device has left the boundary of the user
+ agent, e.g., if the user began a drag operation with a mouse button pressed.</p>
+ </dd>
+ </dl>
+ </div>
+ </section> <!-- events-mouseevents -->
+
+ <section id="events-wheelevents">
+ <h3>Wheel Event Types</h3>
+ <p>Wheels are devices that can be rotated in one or more spatial dimensions, and which can be associated with a pointer device. The coordinate system depends on the
+ environment configuration.</p>
+
+ <div class="example">
+ <div class="example-title"></div>
+ <p>The user's environment might be configured to associate vertical scrolling
+ with rotation along the y-axis, horizontal scrolling with rotation along
+ the x-axis, and zooming with rotation along the z-axis.
+ </p>
+ </div>
+
+ <p>The deltaX, deltaY, and deltaZ attributes of
+ <a href="#interface-WheelEvent"><code>WheelEvent</code></a> objects indicate a
+ measurement along their respective axes in units of pixels, lines, or pages.
+ The reported measurements are provided after an environment-specific algorithm
+ translates the actual rotation/movement of the wheel device into the appropriate
+ values and units.
+ </p>
+
+ <p class="note"><strong>Authoring Note:</strong>
+ A user's environment settings can be customized to interpret actual rotation/movement
+ of a wheel device in different ways.
+ One movement of a common <q>dented</q> mouse wheel can produce a measurement of 162 pixels
+ (162 is just an example value, actual values can depend on the current screen
+ dimensions of the user-agent).
+ But a user can change their default environment settings to speed-up their mouse wheel,
+ increasing this number.
+ Furthermore, some mouse wheel software can support acceleration (the faster the wheel
+ is rotated/moved, the greater the <a class="def" href="#glossary-delta">delta</a> of each measurement) or even sub-pixel <a class="def" href="#glossary-rotation">rotation</a>
+ measurements.
+ Because of this, authors can not assume a given <a class="def" href="#glossary-rotation">rotation</a> amount in one user agent will
+ produce the same <a class="def" href="#glossary-delta">delta</a> value in all user agents.
+ </p>
+
+ <p>The sign (positive or negative) of the values of the deltaX, deltaY, and deltaZ attributes
+ MUST be consistent between multiple dispatches of the
+ <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event while the
+ motion of the actual wheel device is rotating/moving in the same direction.
+ If a user agent scrolls as the default action of the
+ <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event then the sign
+ of the <a class="def" href="#glossary-delta">delta</a> SHOULD be given by a right-hand coordinate system where positive X,
+ Y, and Z axes are directed towards the right-most edge, bottom-most edge, and farthest
+ depth (away from the user) of the document, respectively.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ Individual user agents can (depending on their environment and hardware configuration)
+ interpret the same physical user interaction on the wheel differently.
+ For example, a vertical swipe on the edge of a trackpad from top to bottom can be
+ interpreted as a wheel action intended to either scroll the
+ page down or to pan the page up (i.e., resulting in either a positive or negative
+ deltaY value respectively).
+ </p>
+
+ <section id="interface-WheelEvent">
+ <h4>Interface WheelEvent</h4>
+
+ <p class="intro-dom">Introduced in DOM Level 3</p>
+
+ <p>The <code>WheelEvent</code> interface provides specific contextual information
+ associated with <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a>
+ events.
+ </p>
+
+ <p>To create an instance of the <code>WheelEvent</code> interface, use the
+ <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("WheelEvent")</code></a>
+ method call.
+ </p>
+
+ <dl class="idl" title="[Constructor(DOMString typeArg, optional WheelEventInit wheelEventInitDict)] interface WheelEvent : MouseEvent">
+ <dt>// DeltaModeCode</dt>
+
+ <dt>const unsigned long DOM_DELTA_PIXEL = 0x00</dt>
+ <dd>
+ <p>The units of measurement for the <a href="#glossary-delta">delta</a> MUST be
+ pixels. This is the most typical case in most operating system and implementation
+ configurations.
+ </p>
+ </dd>
+
+ <dt>const unsigned long DOM_DELTA_LINE = 0x01</dt>
+ <dd>
+ <p>The units of measurement for the <a href="#glossary-delta">delta</a> MUST be
+ individual lines of text. This is the case for many form controls.
+ </p>
+ </dd>
+
+ <dt>const unsigned long DOM_DELTA_PAGE = 0x02</dt>
+ <dd>
+ <p>The units of measurement for the <a href="#glossary-delta">delta</a> MUST be
+ pages, either defined as a single screen or as a demarcated page.
+ </p>
+ </dd>
+
+ <dt>readonly attribute double deltaX</dt>
+ <dd>
+ <p>In user agents where the default action of the
+ <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event is to scroll,
+ the value MUST be the measurement along the x-axis (in pixels, lines, or pages) to be scrolled
+ in the case where the event is not cancelled. Otherwise, this is an implementation-specific
+ measurement (in pixels, lines, or pages) of the movement of a wheel device around the x-axis.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
+ MUST be <code>0.0</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute double deltaY</dt>
+ <dd>
+ <p>In user agents where the default action of the
+ <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event is to scroll, the value
+ MUST be the measurement along the y-axis (in pixels, lines, or pages) to be scrolled in the case
+ where the event is not cancelled. Otherwise, this is an implementation-specific
+ measurement (in pixels, lines, or pages) of the movement of a wheel device around the y-axis.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
+ MUST be <code>0.0</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute double deltaZ</dt>
+ <dd>
+ <p>In user agents where the default action of the
+ <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event is to scroll, the value
+ MUST be the measurement along the z-axis (in pixels, lines, or pages) to be scrolled in the case
+ where the event is not cancelled. Otherwise, this is an implementation-specific
+ measurement (in pixels, lines, or pages) of the movement of a wheel device around the z-axis.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
+ MUST be <code>0.0</code>.
+ </p>
+ </dd>
+
+ <dt>readonly attribute unsigned long deltaMode</dt>
+ <dd>
+ <p>The <code>deltaMode</code> attribute contains an indication of the units of measurement for the
+ <a href="#glossary-delta">delta</a> values.
+ The default value is
+ <a href="#widl-WheelEvent-DOM_DELTA_PIXEL"><code class="constant-name">DOM_DELTA_PIXEL</code></a>
+ (pixels).
+ </p>
+
+ <p>This attribute MUST be set to one of the DOM_DELTA constants to indicate the units of measurement
+ for the <a href="#glossary-delta">delta</a> values. The precise measurement
+ is specific to device, operating system, and application configurations.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
+ MUST be <code>0</code>.
+ </p>
+ </dd>
+
+ </dl>
+
+ <dl class="idl" title="dictionary WheelEventInit : MouseEventInit">
+ <dt>double deltaX = 0.0</dt>
+ <dd><p>See <code>deltaZ</code> attribute.</p></dd>
+
+ <dt>double deltaY = 0.0</dt>
+ <dd><p>See <code>deltaZ</code> attribute.</p></dd>
+
+ <dt>double deltaZ = 0.0</dt>
+ <dd>
+ <p>Initializes the <code>deltaZ</code> attribute of the WheelEvent object.
+ Relative positive values for this attribute (as well as the
+ <code>deltaX</code> and <code>deltaY</code> attributes) are given by
+ a right-hand coordinate system where the X, Y, and Z axes are
+ directed towards the right-most edge, bottom-most edge, and farthest
+ depth (away from the user) of the document, respectively. Negative
+ relative values are in the respective opposite directions.
+ </p>
+ </dd>
+
+ <dt>unsigned long deltaMode = 0</dt>
+ <dd>
+ <p>Initializes the <code>deltaMode</code> attribute on the WheelEvent
+ object to the enumerated values 0, 1, or 2, which represent the amount
+ of pixels scrolled
+ (<a href="#widl-WheelEvent-DOM_DELTA_PIXEL"><code class="constant-name">DOM_DELTA_PIXEL</code></a>),
+ lines scrolled
+ (<a href="#widl-WheelEvent-DOM_DELTA_LINE"><code class="constant-name">DOM_DELTA_LINE</code></a>),
+ or pages scrolled
+ (<a href="#widl-WheelEvent-DOM_DELTA_PAGE"><code class="constant-name">DOM_DELTA_PAGE</code></a>)
+ if the <a class="def" href="#glossary-rotation">rotation</a> of the wheel would
+ have resulted in scrolling.
+ </p>
+ </dd>
+ </dl>
+
+ </section> <!-- interface-WheelEvent -->
+
+ <p>The Wheel event types are listed below.</p>
+
+ <!-- wheel -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-wheel"><dfn><a class="eventtype" href="#event-type-wheel"><code>wheel</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>wheel</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-WheelEvent"><code>WheelEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Async</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>Scroll (or zoom) the document</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
+ if the wheel is associated with a pointing device, the value based on the pointer position on the screen, otherwise <code>0</code></li>
+ <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
+ if the wheel is associated with a pointing device, the value based
+ on the pointer position on the screen, otherwise <code>0</code></li>
+ <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
+ if the wheel is associated with a pointing device, the value based
+ on the pointer position within the viewport, otherwise <code>0</code></li>
+ <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
+ if the wheel is associated with a pointing device, the value
+ based on the pointer position within the viewport, otherwise <code>0</code></li>
+ <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code>
+ modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
+ if wheel is associated with a pointing device, value based on current button pressed, otherwise <code>0</code></li>
+ <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
+ if wheel is associated with a pointing device, value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
+ <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
+ indicates the <a class="def" href="#glossary-event-target">event target</a> the pointing device is pointing at, if any.</li>
+ <li><a href="#widl-WheelEvent-deltaX"><code class="attribute-name">WheelEvent.deltaX</code></a>:
+ expected amount that the page will scroll along the x-axis according
+ to the deltaMode units; or an implemenation-specific value of movement of a wheel around the x-axis</li>
+ <li><a href="#widl-WheelEvent-deltaY"><code class="attribute-name">WheelEvent.deltaY</code></a>:
+ expected amount that the page will scroll along the y-axis according
+ to the deltaMode units; or an implemenation-specific value of movement of a wheel around the y-axis</li>
+ <li><a href="#widl-WheelEvent-deltaZ"><code class="attribute-name">WheelEvent.deltaZ</code></a>:
+ expected amount that the page will scroll along the z-axis according
+ to the deltaMode units; or an implemenation-specific value of movement of a wheel around the z-axis</li>
+ <li><a href="#widl-WheelEvent-deltaMode"><code class="attribute-name">WheelEvent.deltaMode</code></a>:
+ unit indicator (pixels, lines, or pages) for the deltaX, deltaY, and deltaZ attributes</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a mouse wheel has been rotated around any axis, or when an equivalent
+ input device (such as a mouse-ball, certain tablets or touchpads, etc.) has emulated such an action. Depending on the platform and input device, diagonal wheel
+ <a class="def" href="#glossary-delta">deltas</a> MAY be delivered either as a single <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event with multiple non-zero axes or as separate <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a>
+ events for each non-zero axis.</p>
+
+ <p>The typical <a class="def" href="#glossary-default-action">default action</a> of the <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event
+ type is to scroll (or in some cases, zoom) the document by the indicated amount. If this event is canceled, the implementation MUST NOT scroll or zoom the document
+ (or perform whatever other implementation-specific default action is associated with this event type).</p>
+
+ <p class="note"><strong>Note:</strong> In some <a class="def" href="#glossary-user-agent">user agents</a>, or with some input devices, the speed that the wheel has been
+ turned can affect the <a href="#glossary-delta">delta</a> values, with a faster speed producing a higher <a href="#glossary-delta">delta</a> value.</p>
+ </dd>
+ </dl>
+ </div>
+ </section> <!-- events-wheelevents -->
+
+ <section id="events-inputevents">
+ <h3>Input Event Types</h3>
+ <p>Input events are sent as notifications whenever the DOM is being updated.</p>
+
+ <section id="interface-InputEvent">
+ <h4>Interface InputEvent</h4>
+
+ <p class="intro-dom">Introduced in DOM Level 3</p>
+
+ <dl class="idl" title="[Constructor(DOMString typeArg, optional InputEventInit inputEventInitDict)] interface InputEvent : UIEvent">
+ <dt>readonly attribute DOMString data</dt>
+ <dd>
+ <p><code>data</code> holds the value of the characters generated by an input method.
+ This MAY be a single Unicode character or a non-empty sequence of Unicode characters
+ [<cite><a class="normative" href="#references-Unicode">Unicode</a></cite>].
+ Characters SHOULD be normalized as defined by the Unicode normalization form <em>NFC</em>,
+ defined in [<cite><a class="normative" href="#references-UnicodeNormalization">UAX #15</a></cite>].
+ This attribute MAY contain the <a class="def" href="#glossary-empty-string">empty string</a>.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
+ MUST be <code>""</code> (the empty string).
+ </p>
+ </dd>
+
+ <dt>readonly attribute boolean isComposing</dt>
+ <dd>
+ <p><code>true</code> if the input event occurs as part of a composition session, i.e., after a
+ <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a>
+ event and before the corresponding
+ <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>
+ event.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this
+ attribute MUST be <code>false</code>.
+ </p>
+ </dd>
+
+ </dl>
+
+ <dl class="idl" title="dictionary InputEventInit : UIEventInit">
+ <dt>DOMString data = ""</dt>
+ <dd>
+ <p>Initializes the <code>data</code> attribute of the InputEvent object.
+ </p>
+ </dd>
+
+ <dt>boolean isComposing = false</dt>
+ <dd>
+ <p>Initializes the <code>isComposing</code> attribute of the InputEvent object.
+ </p>
+ </dd>
+ </dl>
+
+ </section> <!-- interface-InputEvent -->
+
+ <section id="events-inputevent-event-order">
+ <h4>Input Event Order</h4>
+
+ <p>The input events defined in this specification MUST occur in a set order relative to one another.
+ </p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td colspan="2"><em>DOM element is updated</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
+ <td></td>
+ </tr>
+ </table>
+
+ </section> <!-- events-inputevent-event-order -->
+
+ <p>The Input event types are listed below.</p>
+
+ <!-- beforeinput -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-beforeinput"><dfn><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>beforeinput</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-InputEvent"><code>InputEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code> (specifically: control types such as <code>HTMLInputElement</code>, etc.) or any <code>Element</code> with
+ <code>contenteditable</code> attribute enabled.</td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>Update the DOM element</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> that is about to be updated</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-InputEvent-data"><code class="attribute-name">InputEvent.data</code></a>:
+ the string containing the data that will be added to the element,
+ which MAY be the <a class="def" href="#glossary-empty-string">empty string</a> if the content has been deleted</li>
+ <li><a href="#widl-InputEvent-isComposing"><code class="attribute-name">InputEvent.isComposing</code></a>:
+ <code>true</code> if this event is dispatched during a <a href="#keys-dead">dead key</a> sequence or while an
+ <a href="#glossary-ime">input method editor</a> is active (such that
+ <a href="#events-compositionevents">composition events</a> are being dispatched); <code>false</code> otherwise.</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the DOM is about to be updated.</p>
+ </dd>
+ </dl>
+ </div><!-- beforeinput -->
+
+ <!-- input -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-input"><dfn><a class="eventtype" href="#event-type-input"><code>input</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>input</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-InputEvent"><code>InputEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code> (specifically: control types such as <code>HTMLInputElement</code>, etc.) or any <code>Element</code> with
+ <code>contenteditable</code> attribute enabled.</td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>No</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ <a class="def" href="#glossary-event-target">event target</a> that was just updated</li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-InputEvent-data"><code class="attribute-name">InputEvent.data</code></a>:
+ the string containing the data that was added to the element,
+ which MAY be the <a class="def" href="#glossary-empty-string">empty string</a> if the content has been deleted</li>
+ <li><a href="#widl-InputEvent-isComposing"><code class="attribute-name">InputEvent.isComposing</code></a>:
+ <code>true</code> if this event is dispatched during a <a href="#keys-dead">dead key</a> sequence or while an
+ <a href="#glossary-ime">input method editor</a> is active (such that
+ <a href="#events-compositionevents">composition events</a> are being dispatched); <code>false</code> otherwise.</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event immediately after the DOM has been updated.</p>
+ </dd>
+ </dl>
+ </div><!-- input -->
+
+ </section> <!-- events-inputevents -->
+
+ <section id="events-keyboardevents">
+ <h3>Keyboard Event Types</h3>
+
+ <p>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. Refer to
+ <a href="#keys">Keyboard events and key values</a> for more details, including
+ examples on how Keyboard Events are used in combination with Composition Events.
+ Depending on the
+ character generation device, keyboard events might not be generated.
+ </p>
+
+ <p class="note"><strong>Authoring Note:</strong>
+ Keyboard events are only one modality of providing textual input.
+ For editing scenarios, consider also using the
+ <a href="#interface-InputEvent"><code>InputEvent</code></a>
+ as an alternate to (or in addition to) keyboard events.
+ </p>
+
+ <section id="interface-KeyboardEvent">
+ <h4>Interface KeyboardEvent</h4>
+
+ <p class="intro-dom">Introduced in DOM Level 3</p>
+
+ <p>The <a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a> interface
+ provides specific contextual information associated with keyboard devices.
+ Each keyboard event references a key using a value.
+ Keyboard events are commonly directed at the element that has the focus.
+ </p>
+
+ <p>The <a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a> interface
+ provides convenient attributes for some common modifiers keys:
+ <a href="#widl-KeyboardEvent-ctrlKey"><code>KeyboardEvent.ctrlKey</code></a>,
+ <a href="#widl-KeyboardEvent-shiftKey"><code>KeyboardEvent.shiftKey</code></a>,
+ <a href="#widl-KeyboardEvent-altKey"><code>KeyboardEvent.altKey</code></a>,
+ <a href="#widl-KeyboardEvent-metaKey"><code>KeyboardEvent.metaKey</code></a>.
+ These attributes are equivalent to using the method
+ <a href="#widl-KeyboardEvent-getModifierState"><code>KeyboardEvent.getModifierState(keyArg)</code></a>
+ with
+ <code class="key">'Control'</code>,
+ <code class="key">'Shift'</code>,
+ <code class="key">'Alt'</code>, or
+ <code class="key">'Meta'</code>
+ respectively.
+ </p>
+
+ <p>To create an instance of the <a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a>
+ interface, use the
+ <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("KeyboardEvent")</code></a>
+ method call.
+ </p>
+
+ <dl class="idl" title="[Constructor(DOMString typeArg, optional KeyboardEventInit keyboardEventInitDict)] interface KeyboardEvent : UIEvent">
+ <dt>// KeyLocationCode</dt>
+
+ <dt>const unsigned long DOM_KEY_LOCATION_STANDARD = 0x00</dt>
+ <dd>
+ <p>The key activation MUST NOT be distinguished as the left or right version of the key, and (other than the
+ <code class="key">'NumLock'</code> key) did not originate from the numeric keypad (or did not originate
+ with a virtual key corresponding to the numeric keypad).</p>
+
+ <div class="example">
+ <div class="example-title"></div>
+ <p>The <code class="key">'Q'</code> key on a PC 101 Key US keyboard.</p>
+ <p>The <code class="key">'NumLock'</code> key on a PC 101 Key US keyboard.</p>
+ <p>The <code class="key">'1'</code> key on a PC 101 Key US keyboard located in the main section of the keyboard.</p>
+ </div>
+ </dd>
+
+ <dt>const unsigned long DOM_KEY_LOCATION_LEFT = 0x01</dt>
+ <dd>
+ <p>The key activated originated from the left key location (when there is more than one possible location for this key).</p>
+
+ <div class="example">
+ <div class="example-title"></div>
+ <p>The left <code class="key">'Control'</code> key on a PC 101 Key US keyboard.</p>
+ </div>
+ </dd>
+
+ <dt>const unsigned long DOM_KEY_LOCATION_RIGHT = 0x02</dt>
+ <dd>
+ <p>The key activation originated from the right key location (when there is more than one possible location for this key).</p>
+
+ <div class="example">
+ <div class="example-title"></div>
+ <p>The right <code class="key">'Shift'</code> key on a PC 101 Key US keyboard.</p>
+ </div>
+ </dd>
+
+ <dt>const unsigned long DOM_KEY_LOCATION_NUMPAD = 0x03</dt>
+ <dd>
+ <p>The key activation originated on the numeric keypad or with a virtual key corresponding to the numeric
+ keypad (when there is more than one possible location for this key). Note that the <code class="key">'NumLock'</code>
+ key should always be encoded with a location of
+ <a href="#widl-KeyboardEvent-DOM_KEY_LOCATION_STANDARD"><code class="constant-name">DOM_KEY_LOCATION_STANDARD</code></a>.
+ </p>
+
+ <div class="example">
+ <div class="example-title"></div>
+ <p>The <code class="key">'1'</code> key on a PC 101 Key US keyboard located on the numeric pad.</p>
+ </div>
+ </dd>
+
+ <dt>readonly attribute DOMString key</dt>
+ <dd>
+ <p><code>key</code> holds the key value of the key pressed.
+ If the value is has a printed representation, it MUST be a non-empty Unicode character
+ string, conforming to the <a href="#key-algorithm">algorithm for determining the key value</a> defined in this specification.
+ If the value is a control key which has no printed representation, it MUST be one of the key values defined in the
+ <a href="#keys-keyvalues">key values set</a>, as determined by the <a href="#key-algorithm">algorithm for determining the key value</a>. Implementations that are
+ unable to identify a key MUST use the key value <code class="key">'Unidentified'</code>.</p>
+
+ <p class="note"><strong>Note:</strong> The <code>key</code> attribute is not related to the legacy <code>keyCode</code> attribute and does not have the same set of values.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>""</code> (the empty string).</p>
+ </dd>
+
+ <dt>readonly attribute DOMString code</dt>
+ <dd>
+ <p><code>code</code> holds a string that identifies the physical key being pressed.
+ The value is not affected by the current keyboard layout or modifier state, so a particular
+ key will always return the same value.
+ </p>
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>""</code> (the empty string).</p>
+ </dd>
+
+ <dt>readonly attribute unsigned long location</dt>
+ <dd>
+ <p>The <code>location</code> attribute contains an indication of the location of the key on the device.</p>
+
+ <p>This attribute MUST be set to one of the DOM_KEY_LOCATION constants to indicate the location of a key on the device. In case a DOM implementation wishes to provide a new location value, a
+ value different from the defined constant values MUST be used.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>0</code>.</p>
+ </dd>
+
+ <dt>readonly attribute boolean ctrlKey</dt>
+ <dd>
+ <p><code>true</code> if the <code class="key">'Control'</code> (control) key modifier was active.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
+ </dd>
+
+ <dt>readonly attribute boolean shiftKey</dt>
+ <dd>
+ <p><code>true</code> if the shift (<code class="key">'Shift'</code>) key modifier was active.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
+ </dd>
+
+ <dt>readonly attribute boolean altKey</dt>
+ <dd>
+ <p><code>true</code> if the <code class="key">'Alt'</code> (alternative) (or <code class="glyph">'Option'</code>) key modifier was active.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
+ </dd>
+
+ <dt>readonly attribute boolean metaKey</dt>
+ <dd>
+ <p><code>true</code> if the meta (<code class="key">'Meta'</code>) key modifier was active.</p>
+
+ <p class="note"><strong>Note:</strong> The <code class="glyph">'Command'</code> (<code class="glyph">'⌘'</code>) key modifier on Macintosh systems is represented using this key modifier.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
+ </dd>
+
+ <dt>readonly attribute boolean repeat</dt>
+ <dd>
+ <p><code>true</code> if the key has been pressed in a sustained manner. Holding down a key MUST result in the repeating the events
+ <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>,
+ <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a>,
+ <a class="eventtype" href="#event-type-input"><code>input</code></a>
+ in this order, at a rate determined by the system configuration. For mobile devices which have <em>long-key-press</em>
+ behavior, the first key event with a <a href="#widl-KeyboardEvent-repeat"><code>repeat</code></a> attribute value of <code>'true'</code> MUST serve as an
+ indication of a <em>long-key-press</em>. The length of time that the key MUST be pressed in order to begin repeating is configuration-dependent.</p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
+ </dd>
+
+ <dt>readonly attribute boolean isComposing</dt>
+ <dd>
+ <p><code>true</code> if the key event occurs as part of a composition session, i.e., after a
+ <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a>
+ event and before the corresponding
+ <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>
+ event.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this
+ attribute MUST be <code>false</code>.
+ </p>
+ </dd>
+
+ <dt>boolean getModifierState()</dt>
+ <dd>
+ <p>Queries the state of a modifier using a key value.
+ See <a href="#keys-modifiers">Modifier keys</a> for a list of valid (case-sensitive) arguments to this method.
+ </p>
+
+ <dl class="parameters">
+ <dt>DOMString keyArg</dt>
+ <dd>
+ <p>A modifier key value. Valid modifier keys are defined in the
+ <a href="DOM3Events-key.html#keys-modifier">Modifier Keys</a> table in
+ [<a href="#references-D3E-key">DOM3 key Values</a>].
+ </p>
+
+ <p>Returns <code>true</code> if it is a modifier key and the modifier is activated, <code>false</code> otherwise.</p>
+
+ <p class="note"><strong>Note:</strong> If an application wishes to distinguish between right and left modifiers, this information could be
+ deduced using keyboard events and <a href="#widl-KeyboardEvent-location"><code>KeyboardEvent.location</code></a>.</p>
+ </dd>
+
+ </dl>
+ </dd>
+ </dl>
+
+ <dl class="idl" title="dictionary KeyboardEventInit : UIEventInit">
+ <dt>DOMString key = ""</dt>
+ <dd>
+ <p>Initializes the <code>key</code> attribute of the KeyboardEvent
+ object to the unicode character string representing the meaning of a
+ key after taking into account all keyboard modifications (such as
+ shift-state). This value is the final effective value of the key.
+ If the key is not a printable character, then it should be one of
+ the key values defined in
+ [<a href="#references-D3E-key">DOM3 key Values</a>].
+ </p>
+ </dd>
+
+ <dt>DOMString code = ""</dt>
+ <dd>
+ <p>Initializes the <code>code</code> attribute of the KeyboardEvent
+ object to the unicode character string representing the key that
+ was pressed, ignoring any keyboard modifications such as keyboard
+ layout.
+ This value should be one of the code values defined in
+ [<a href="#references-D3E-code">DOM3 code Values</a>].
+ </p>
+ </dd>
+
+ <dt>unsigned long location = 0</dt>
+ <dd>
+ <p>Initializes the <code>location</code> attribute of the KeyboardEvent
+ object to one of the following location numerical constants:
+ </p>
+ <ul>
+ <li><code>KeyboardEvent.DOM_KEY_LOCATION_STANDARD</code> (numerical value 0)</li>
+ <li><code>KeyboardEvent.DOM_KEY_LOCATION_LEFT</code> (numerical value 1)</li>
+ <li><code>KeyboardEvent.DOM_KEY_LOCATION_RIGHT</code> (numerical value 2)</li>
+ <li><code>KeyboardEvent.DOM_KEY_LOCATION_NUMPAD</code> (numerical value 3)</li>
+ </ul>
+ </dd>
+
+ <dt>boolean ctrlKey = false</dt>
+ <dd>
+ <p>Initializes the <code>altKey</code> attribute of the KeyboardEvent
+ object to <code>true</code> if the <code class="key">'Control'</code>
+ (control) key modifier is to be considered active,
+ <code>false</code> otherwise.</p>
+ </dd>
+
+ <dt>boolean shiftKey = false</dt>
+ <dd>
+ <p>Initializes the <code>shiftKey</code> attribute of the KeyboardEvent
+ object to <code>true</code> if the <code class="key">'Shift'</code>
+ key modifier is to be considered active, <code>false</code> otherwise.</p>
+ </dd>
+
+ <dt>boolean altKey = false</dt>
+ <dd>
+ <p>Initializes the <code>altKey</code> attribute of the KeyboardEvent
+ object to <code>true</code> if the <code class="key">'Alt'</code>
+ (alternative) (or <code class="glyph">'Option'</code>) key modifier
+ is to be considered active, <code>false</code> otherwise.</p>
+ </dd>
+
+ <dt>boolean metaKey = false</dt>
+ <dd>
+ <p>Initializes the <code>metaKey</code> attribute of the KeyboardEvent
+ object to <code>true</code> if the <code class="key">'Meta'</code>
+ key modifier is to be considered active, <code>false</code> otherwise.</p>
+ </dd>
+
+ <dt>boolean repeat = false</dt>
+ <dd>
+ <p>Initializes the <code>repeat</code> attribute of the KeyboardEvent
+ object. This attribute should be set to <code>true</code> if the the current KeyboardEvent is
+ considered part of a repeating sequence of similar events caused
+ by the long depression of any single key, <code>false</code> otherwise.
+ </p>
+ </dd>
+
+ <dt>boolean isComposing = false</dt>
+ <dd>
+ <p>Initializes the <code>isComposing</code> attribute of the KeyboardEvent
+ object. This attribute should be set to <code>true</code> if the
+ event being constructed occurs as part of a composition sequence,
+ <code>false</code> otherwise.
+ </p>
+ </dd>
+ </dl>
+
+ </section> <!-- interface-KeyboardEvent -->
+
+ <div class="warning">
+ <p><strong>Warning!</strong></p>
+ <p>Legacy keyboard event implementations include three additional attributes,
+ <code>keyCode</code>, <code>charCode</code>, and <code>which</code>.
+ The <code>keyCode</code> attribute indicates a numeric value associated with
+ a particular key on a computer keyboard,
+ while the <code>charCode</code> attribute indicates the
+ <acronym title="American Standard Code for Information Interchange">ASCII</acronym>
+ value of the character associated with that key (which might be the same as
+ the <code>keyCode</code> value) and is applicable only to keys that produce a
+ <a class="def" href="#glossary-character-value">character value</a>.
+ </p>
+ <p>In practice, <code>keyCode</code> and <code>charCode</code> are inconsistent across platforms
+ and even the same implementation on different operating systems or using different localizations.
+ DOM Level 3 Events does not define values for either
+ <code>keyCode</code> or <code>charCode</code>, or behavior for <code>charCode</code>.
+ In conforming DOM Level 3 Events implementations, content authors can instead use
+ <a href="#widl-KeyboardEvent-key"><code>KeyboardEvent.key</code></a> and
+ <a href="#widl-KeyboardEvent-code"><code>KeyboardEvent.code</code></a>.
+ </p>
+ <p><em>For more information, see the informative appendix on
+ <a href="#legacy-key-attributes">Legacy key attributes</a>.</em>
+ </p>
</div>
- <!-- mouseout -->
+ <p class="note"><strong>Note:</strong>
+ For compatibility with existing content, virtual keyboards, such as software keyboards
+ on screen-based input devices, are expected to produce the normal range of keyboard
+ events, even though they do not possess physical keys.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ In some implementations or system configurations, some key events, or their values,
+ might be suppressed by the <a class="def" href="#glossary-ime">IME</a> in use.
+ </p>
+
+ <section id="events-keyboard-event-order">
+ <h4>Keyboard Event Order</h4>
+ <p>The keyboard events defined in this specification occur in a set order relative
+ to one another, for any given key:</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
+ <td><em>(only for keys which produce a <a class="def" href="#glossary-character-value">character value</a>)</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td><em>Any <a class="def" href="#glossary-default-action">default actions</a> related to this key, such as inserting a
+ character in to the DOM.</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
+ <td><em>(only for keys which have updated the DOM)</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td><em>Any events as a result of the key being held for a sustained period (see below).</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
+ <td></td>
+ </tr>
+ </table>
+
+ <p>If the key is depressed for a sustained period, the following events MAY repeat
+ at an environment-dependent rate: <!-- and the key should seek counseling -->
+ </p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
+ <td><em>(with <a href="#widl-KeyboardEvent-repeat">repeat</a> attribute set to <code> true</code>)</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
+ <td><em>(only for keys which produce a <a class="def" href="#glossary-character-value">character value</a>)</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td><em>Any <a class="def" href="#glossary-default-action">default actions</a> related to this key, such as inserting a
+ character in to the DOM.</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
+ <td><em>(only for keys which have updated the DOM)</em></td>
+ </tr>
+ </table>
+
+ <p class="note"><strong>Note:</strong>
+ Typically, any <a class="def" href="#glossary-default-action">default actions</a>
+ associated with any particular key are completed before the
+ <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event is dispatched.
+ This might delay the <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>
+ event slightly (though this is not likely to be a perceptible delay).
+ </p>
+
+ <p>The <a class="def" href="#glossary-event-target">event target</a> of a key event is
+ the currently focused element which is processing the keyboard activity.
+ This is often an HTML <code>input</code> element or a textual element which is editable,
+ but MAY be an element defined by the
+ <a class="def" href="#glossary-host-language">host language</a> to accept keyboard input
+ for non-text purposes, such as the activation of an accelerator key or trigger of some
+ other behavior. If no suitable element is in focus, the event target will be the HTML
+ <a href="#glossary-body-element">body element</a> if available,
+ otherwise the <a href="#glossary-root-element">root element</a>.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ The <a class="def" href="#glossary-event-target">event target</a> might change between
+ different key events.
+ For example, a <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>
+ event for the <code class="key">'Tab'</code> key
+ will likely have a different <a class="def" href="#glossary-event-target">event target</a>
+ than the <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>
+ event on the same keystroke.
+ </p>
+ </section> <!-- events-keyboard-event-order -->
+
+ <p>The keyboard event types are listed below.</p>
+
+ <!-- keydown -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-keydown"><dfn><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>keydown</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>Varies:
+ <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> and <a class="eventtype" href="#event-type-input"><code>input</code></a> events;
+ launch <a class="def" href="#glossary-text-composition-system">text composition system</a>;
+ <a class="eventtype" href="#event-type-blur"><code>blur</code></a> and <a class="eventtype" href="#event-type-focus"><code>focus</code></a> events;
+ <a class="eventtype" href="#event-type-keypress"><code>keypress</code></a> event;
+ <a class="def" href="#glossary-activation-behavior">activation behavior</a>;
+ other event</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ focused element processing the key event or if no element focused, then the
+ <a href="#glossary-body-element">body element</a> if available, otherwise the
+ <a href="#glossary-root-element">root element</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-KeyboardEvent-key"><code class="attribute-name">KeyboardEvent.key</code></a>:
+ the key value of the key pressed.</li>
+ <li><a href="#widl-KeyboardEvent-code"><code class="attribute-name">KeyboardEvent.code</code></a>:
+ the code value associated with the key's physical placement on the keyboard.</li>
+ <li><a href="#widl-KeyboardEvent-location"><code class="attribute-name">KeyboardEvent.location</code></a>:
+ the location of the key on the device.</li>
+ <li><a href="#widl-KeyboardEvent-altKey"><code class="attribute-name">KeyboardEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-shiftKey"><code class="attribute-name">KeyboardEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-ctrlKey"><code class="attribute-name">KeyboardEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-metaKey"><code class="attribute-name">KeyboardEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-repeat"><code class="attribute-name">KeyboardEvent.repeat</code></a>:
+ <code>true</code> if a key has been depressed long enough to trigger key repetition, otherwise <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-isComposing"><code class="attribute-name">KeyboardEvent.isComposing</code></a>:
+ <code>true</code> if the key event occurs as part of a composition session, otherwise <code>false</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a key is pressed down. The <a class="eventtype" href="#event-type-keydown">
+ <code>keydown</code></a> event type is device dependent and relies on the capabilities of the input devices and how they are mapped in the operating system. This
+ event type MUST be generated after the <a class="def" href="#glossary-key-mapping">key mapping</a>.
+ This event type MUST be dispatched before the
+ <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a>,
+ <a class="eventtype" href="#event-type-input"><code>input</code></a>,
+ and <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>
+ events associated with the same key.</p>
+
+ <p>The default action of the <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> event depends upon the key:</p>
+
+ <ul>
+ <li>If the key is associated with a character, the default action MUST be to dispatch
+ a <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> event
+ followed by an <a class="eventtype" href="#event-type-input"><code>input</code></a>
+ event.
+ In the case where the key which is associated with multiple characters (such as with a macro or certain sequences of dead keys), the default action MUST
+ be to dispatch one set of
+ <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> /
+ <a class="eventtype" href="#event-type-input"><code>input</code></a>
+ events for each character</li>
+
+ <li>If the key is associated with a <a class="def" href="#glossary-text-composition-system">text composition system</a>, the default action MUST be to launch that
+ system</li>
+
+ <li>If the key is the <code class="key">'Tab'</code> key, the default action MUST be to shift the document focus from the currently focused
+ element (if any) to the new focused element, as described in <a href="#events-focusevent">Focus Event Types</a></li>
+
+ <li>If the key is the <code class="key">'Enter'</code> or <code class="key">' '</code> key and the
+ current focus is on a state-changing element, the default action MUST be to dispatch a <a class="eventtype" href="#event-type-click"><code>click</code></a> event,
+ and a <a class="eventtype" href="#event-type-DOMActivate"><code>DOMActivate</code></a> event if that event type is supported by the <a class="def" href="#glossary-user-agent">
+ user agent</a> (refer to <a href="#event-flow-activation">activation triggers and behavior</a> for more details)</li>
+ </ul>
+
+ <p>If this event is canceled, the associated event types MUST NOT be dispatched, and the associated actions MUST NOT be performed.</p>
+
+ <p class="note"><strong>Note:</strong> The <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and <a class="eventtype" href="#event-type-keyup">
+ <code>keyup</code></a> events are traditionally associated with detecting any key, not just those which produce a <a class="def" href="#glossary-character-value">character
+ value</a>.</p>
+ </dd>
+ </dl>
+ </div>
+
+ <!-- keyup -->
+ <div class="event-definition">
+ <dl>
+ <dt id="event-type-keyup"><dfn><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></dfn></dt>
+ <dd>
+ <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Type</th>
+ <td><strong><code>keyup</code></strong></td>
+ </tr>
+ <tr>
+ <th>Interface</th>
+ <td><a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a></td>
+ </tr>
+ <tr>
+ <th>Sync / Async</th>
+ <td>Sync</td>
+ </tr>
+ <tr>
+ <th>Bubbles</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Trusted Targets</th>
+ <td><code>Element</code></td>
+ </tr>
+ <tr>
+ <th>Cancelable</th>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <th>Default action</th>
+ <td>None</td>
+ </tr>
+ <tr>
+ <th>Context<br/>(trusted events)</th>
+ <td>
+ <ul>
+ <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
+ focused element processing the key event or if no element focused, then the
+ <a href="#glossary-body-element">body element</a> if available, otherwise the
+ <a href="#glossary-root-element">root element</a></li>
+ <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
+ <a class="def" href="#glossary-window"><code>Window</code></a></li>
+ <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
+ <code>0</code></li>
+ <li><a href="#widl-KeyboardEvent-key"><code class="attribute-name">KeyboardEvent.key</code></a>:
+ the key value of the key pressed.</li>
+ <li><a href="#widl-KeyboardEvent-code"><code class="attribute-name">KeyboardEvent.code</code></a>:
+ the code value associated with the key's physical placement on the keyboard.</li>
+ <li><a href="#widl-KeyboardEvent-location"><code class="attribute-name">KeyboardEvent.location</code></a>:
+ the location of the key on the device.</li>
+ <li><a href="#widl-KeyboardEvent-altKey"><code class="attribute-name">KeyboardEvent.altKey</code></a>:
+ <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-shiftKey"><code class="attribute-name">KeyboardEvent.shiftKey</code></a>:
+ <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-ctrlKey"><code class="attribute-name">KeyboardEvent.ctrlKey</code></a>:
+ <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-metaKey"><code class="attribute-name">KeyboardEvent.metaKey</code></a>:
+ <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-repeat"><code class="attribute-name">KeyboardEvent.repeat</code></a>:
+ <code>false</code></li>
+ <li><a href="#widl-KeyboardEvent-isComposing"><code class="attribute-name">KeyboardEvent.isComposing</code></a>:
+ <code>true</code> if the key event occurs as part of a composition session, otherwise <code>false</code></li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a key is released.
+ The <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event type is device dependent and relies on the
+ capabilities of the input devices and how they are mapped in the operating system.
+ This event type MUST be generated after the <a class="def" href="#glossary-key-mapping">key mapping</a>.
+ This event type MUST be dispatched after the
+ <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>,
+ <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a>,
+ and <a class="eventtype" href="#event-type-input"><code>input</code></a>
+ events associated with the same key.</p>
+
+ <p class="note"><strong>Note:</strong> the <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and <a class="eventtype" href="#event-type-keyup">
+ <code>keyup</code></a> events are traditionally associated with detecting any key, not just those which produce a <a class="def" href="#glossary-character-value">character
+ value</a>.</p>
+ </dd>
+ </dl>
+ </div>
+ </section> <!-- events-keyboardevents -->
+
+ <section id="events-compositionevents">
+ <h3>Composition Event Types</h3>
+
+ <p>Composition Events provide a means for inputing text in a supplementary or alternate
+ manner than by Keyboard Events, in order to allow the use of characters that
+ might not be commonly available on keyboard.
+ For example, Composition Events might be used
+ to add accents to characters despite their absence from standard US keyboards,
+ to build up logograms of many Asian languages from their base components or categories,
+ to select word choices from a combination of key presses on a mobile device keyboard,
+ or to convert voice commands into text using a speech recognition processor.
+ Refer to <a href="#keys">Keyboard events and key values</a> for examples
+ on how Composition Events are used in combination with keyboard events.
+ </p>
+
+ <p>Conceptually, a composition session consists of one
+ <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a>
+ event, one or more
+ <a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a>
+ events, and one
+ <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>
+ event, with the value of the <a href="#widl-CompositionEvent-data"><code>data</code></a>
+ attribute persisting between each <q>stage</q> of this event chain during each session.
+ </p>
+
+ <p class="note"><strong>Note:</strong>
+ While a composition session is active, keyboard events can be dispatched to the DOM
+ if the keyboard is the input device used with the composition session.
+ See the <a href="#event-type-compositionstart"><code>compositionstart</code> event details</a>
+ and <a href="#keys-IME">IME section</a> for relevent event ordering.
+ </p>
+
+ <p>Not all <a class="def" href="#glossary-ime">IME</a> systems or devices expose the necessary
+ data to the DOM, so the active composition string (the <q>Reading Window</q>
+ or <q>candidate selection menu option</q>) might not be available through this interface,
+ in which case the selection MAY be represented by the
+ <a class="def" href="#glossary-empty-string">empty string</a>.
+ </p>
+
+ <section id="interface-CompositionEvent">
+ <h4>Interface CompositionEvent</h4>
+
+ <p class="intro-dom">Introduced in DOM Level 3</p>
+
+ <p>The <code>CompositionEvent</code> interface provides specific contextual information associated with Composition Events.</p>
+
+ <p>To create an instance of the <code>CompositionEvent</code> interface, use the <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("CompositionEvent")</code></a>
+ method call.</p>
+
+ <dl class="idl" title="[Constructor(DOMString typeArg, optional CompositionEventInit compositionEventInitDict)] interface CompositionEvent : UIEvent">
+ <dt>readonly attribute DOMString data</dt>
+ <dd>
+ <p><code>data</code> holds the value of the characters generated by an input method.
+ This MAY be a single Unicode character or a non-empty sequence of Unicode characters
+ [<cite><a class="normative" href="#references-Unicode">Unicode</a></cite>].
+ Characters SHOULD be normalized as defined by the Unicode normalization form <em>NFC</em>,
+ defined in [<cite><a class="normative" href="#references-UnicodeNormalization">UAX #15</a></cite>].
+ This attribute MAY be the <a class="def" href="#glossary-empty-string">empty string</a>.
+ </p>
+
+ <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
+ MUST be <code>""</code> (the empty string).
+ </p>
+ </dd>
+ </dl>
+
+ <dl class="idl" title="dictionary CompositionEventInit : UIEventInit">
+ <dt>DOMString data = ""</dt>
+ <dd>
+ <p>Initializes the <code>data</code> attribute of the CompositionEvent
+ object to the characters generated by the IME composition.
+ </p>
+ </dd>
+ </dl>
+
+ </section> <!-- interface-CompositionEvent -->
+
+ <section id="events-composition-event-order">
+ <h4>Composition Event Order</h4>
+
+ <p>The Composition Events defined in this specification MUST occur in the following set order relative to one another:</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
+ <td>Multiple events</td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
+ <td></td>
+ </tr>
+ </table>
+ </section> <!-- events-composition-event-order -->
+
+ <section id="handwriting">
+ <h4>Handwriting Recognition Systems</h4>
+ <p>The following example describes a possible sequence of events when composing a text passage <q>text</q> with a handwriting recognition system, such as on a pen
+ tablet, as modeled using Composition Events.</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th><a href="#widl-CompositionEvent-data"><code>CompositionEvent<br/>data</code></a></th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
+ <td><code>''</code></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td colspan="2"><em>User writes word on tablet surface</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
+ <td><code>'test'</code></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td colspan="2"><em>User rejects first word-match suggestion, selects different match</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
+ <td><code>'text'</code></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
+ <td><code>'text'</code></td>
+ <td></td>
+ </tr>
+ </table>
+ </section> <!-- handwriting -->
+
+ <section id="events-composition-event-canceling">
+ <h4>Canceling Composition Events</h4>
+ <p>If a <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> event is canceled then any
+ Composition Events that would have fired as a result of that
+ <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> SHOULD not be dispatched:</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
+ <td>The <a class="def" href="#glossary-default-action">default action</a> is
+ prevented, e.g., by invoking <a href="#widl-Event-preventDefault"><code>Event.preventDefault()</code></a>.
+ </td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td><em>No Composition Events are dispatched</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
+ <td></td>
+ </tr>
+ </table>
+
+ <p>If the initial <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a> event is
+ canceled then the text composition session SHOULD be terminated. Regardless of whether or not the composition
+ session is terminated, the <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>
+ event MUST be sent.</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
+ <td>The <a class="def" href="#glossary-default-action">default action</a> is
+ prevented, e.g., by invoking <a href="#widl-Event-preventDefault"><code>Event.preventDefault()</code></a>.
+ </td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td><em>No Composition Events are dispatched</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
+ <td></td>
+ </tr>
+ </table>
+ </section> <!-- events-composition-event-canceling -->
+
+ <section id="events-composition-event-key-events">
+ <h4>Key Events During Composition</h4>
+ <p>During the composition session, all <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>
+ and <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> events MAY be suppressed.</p>
+
+ <section id="events-composition-event-including-key-events">
+ <h4>Including Key Events During Composition</h4>
+
+ <p>If a <a class="def" href="#glossary-user-agent">user agent</a> does not suppress these events during
+ composition, then it MUST set the key event's
+ <a href="#widl-KeyboardEvent-isComposing"><code>isComposing</code></a>
+ attribute to <code>true</code> for any events that occur during a composition session.
+ </p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th class="cell-center"><a href="#widl-KeyboardEvent-isComposing"><code>KeyboardEvent<br/>isComposing</code></a></th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
+ <td class="cell-center"><code>false</code></td>
+ <td>This is the key event that initiates the composition.</td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
+ <td class="cell-center"><code>true</code></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td>...</td>
+ <td></td>
+ <td>Any key events sent during the composition session MUST have <code>isComposing</code> set to <code>true</code>.</td>
+ </tr>
+ <tr>
+ <td class="cell-number">5.</td>
+ <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
+ <td class="cell-center"><code>true</code></td>
+ <td>This is the key event that exits the composition.</td>
+ </tr>
+ <tr>
+ <td class="cell-number">6.</td>
+ <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">7.</td>
+ <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
+ <td class="cell-center"><code>false</code></td>
+ <td></td>
+ </tr>
+ </table>
+
+ </section> <!-- events-composition-event-including-key-events -->
+
+ <section id="events-composition-event-suppressing-key-events">
+ <h4>Suppressing Key Events During Composition</h4>
+
+ <p>If key events are suppressed between
+ <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a> and
+ <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>, then the first
+ or last key pressed might result in unmatched
+ <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and
+ <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> events.
+ If a <a class="def" href="#glossary-user-agent">user agent</a> suppresses key events during composition,
+ then it MUST ensure that all <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and
+ <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> events occur in matching pairs.
+ </p>
+
+ <p>To ensure that the initial <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> has a
+ matching <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>, a
+ <a class="def" href="#glossary-user-agent">user agent</a> might insert an extra
+ <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> to match the
+ <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> that initiated a composition session,
+ as shown in the following example:
+ </p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th class="cell-center"><a href="#widl-KeyboardEvent-isComposing"><code>KeyboardEvent<br/>isComposing</code></a></th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
+ <td class="cell-center"><code>false</code></td>
+ <td>This is the key event that initiates the composition.</td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">4.</td>
+ <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
+ <td class="cell-center"><code>true</code></td>
+ <td>This event would normally be suppressed because of the ongoing composition session, but it is sent
+ to match the previously sent <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>
+ event.</td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td>...</td>
+ <td></td>
+ <td>Any other key events that occur during the composition session are suppressed.</td>
+ </tr>
+ <tr>
+ <td class="cell-number">5.</td>
+ <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ </table>
+
+ <p>To ensure that the composition session doesn't end with a dangling
+ <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event, a
+ <a class="def" href="#glossary-user-agent">user agent</a> can choose either (A) to suppress this
+ <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event, or (B) to insert an extra
+ <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> event.</p>
+
+ <p>An example event sequence where both the
+ <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and
+ <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> events have
+ been suppressed:</p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th class="cell-center"><a href="#widl-KeyboardEvent-isComposing"><code>KeyboardEvent<br/>isComposing</code></a></th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> for key that exits IME suppressed
+ during composition session</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em>A <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event would normally be sent
+ at this time, but it is suppressed to avoid generating an unmatched
+ <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event.</em></td>
+ </tr>
+ </table>
+
+ <p>An example event sequence where a <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> has been inserted:
+ </p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th class="cell-center"><a href="#widl-KeyboardEvent-isComposing"><code>KeyboardEvent<br/>isComposing</code></a></th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td></td>
+ <td><em><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> for key that exits IME suppressed
+ during composition session</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
+ <td class="cell-center"><code>false</code></td>
+ <td>This is key event that was suppressed earlier. It is sent now to match the upcoming
+ <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>.</td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
+ <td class="cell-center"><code>false</code></td>
+ <td></td>
+ </tr>
+ </table>
+
+ </section> <!-- events-composition-event-suppressing-key-events -->
+
+ </section> <!-- events-composition-event-key-events -->
+
+ <section id="events-composition-event-input-events">
+ <h4>Input Events During Composition</h4>
+
+ <p>During the composition session, the
+ <a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a> MUST be dispatched
+ before the <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> and <code>input</code> events are sent.
+ </p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td><em>Any DOM updates occur at this point.</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
+ <td></td>
+ </tr>
+ </table>
+
+ <p class="note"><strong>Note:</strong> Most IMEs do not support canceling updates
+ during a composition session.
+ </p>
+
+ <p>When a composition session is finished, any
+ <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> and
+ <a class="eventtype" href="#event-type-input"><code>input</code></a> events MUST be dispatched after the
+ <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a> event.
+ </p>
+
+ <table class="event-sequence-table">
+ <tr>
+ <td class="cell-number"></td>
+ <th>Event Name</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td class="cell-number">1.</td>
+ <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td class="cell-number">2.</td>
+ <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
+ <td><em>Sent only if we’re about to update the DOM (i.e., the composition was not canceled).
+ Canceling this will prevent the DOM update and the
+ <a class="eventtype" href="#event-type-input"><code>input</code></a> event.</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number"></td>
+ <td></td>
+ <td><em>Any DOM updates occur at this point.</em></td>
+ </tr>
+ <tr>
+ <td class="cell-number">3.</td>
+ <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
+ <td><em>Sent only if the DOM was updated.</em></td>
+ </tr>
+ </table>
+
+ <p class="note"><strong>Note:</strong> Some IMEs update the DOM before the
+ <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a> event is dispatched.
+ In this case, canceling the <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a>
+ event will have no effect (i.e., the <a class="eventtype" href="#event-type-input"><code>input</code></a>
+ event will still fire).</p>
+
+ </section> <!-- events-composition-event-input-events -->
+
+ <section id="events-composition-event-types">
+ <h4>Composition Event Types</h4>
+ <p>The composition event types are listed below.</p>
+
+ <!-- compositionstart -->
<div class="event-definition">
<dl>
- <dt id="event-type-mouseout"><dfn><a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a></dfn></dt>
+ <dt id="event-type-compositionstart"><dfn><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></dfn></dt>
<dd>
<table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
<tr>
<th>Type</th>
- <td><strong><code>mouseout</code></strong></td>
+ <td><strong><code>compositionstart</code></strong></td>
</tr>
<tr>
<th>Interface</th>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
- <code>0</code></li>
- <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
- value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
- <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- indicates the <a class="def" href="#glossary-event-target">event target</a> a pointing device is entering, if any.</li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved off of the boundaries of an element. This
- event type is similar to <a class="eventtype" href="#event-type-mouseleave"><code>mouseleave</code></a>, but differs in that does bubble, and that it MUST be dispatched
- when the pointer device moves from an element onto the boundaries of one of its descendent elements.</p>
-
- <p class="note"><strong>Note:</strong> See also the <a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a> event type.</p>
- </dd>
- </dl>
- </div>
-
- <!-- mouseover -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-mouseover"><dfn><a class="eventtype" href="#event-type-mouseover"><code>mouseover</code></a></dfn></dt>
- <dd>
- <table summary="This table contains information about the semantics of the given event type" border="0" cellpadding="2" cellspacing="0">
- <tbody>
- <tr>
- <th>Type</th>
- <td><strong><code>mouseover</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
- <code>0</code></li>
- <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
- value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
- <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- indicates the <a class="def" href="#glossary-event-target">event target</a> a pointing device is exiting, if any.</li>
- </ul>
- </td>
- </tr>
- </tbody>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device is moved onto the boundaries of an element. This event
- type is similar to <a class="eventtype" href="#event-type-mouseenter"><code>mouseenter</code></a>, but differs in that it bubbles, and that it MUST be dispatched
- when the pointer device moves onto the boundaries of an element whose ancestor element is the <a class="def" href="#glossary-event-target">event target</a> for
- the same event listener instance.</p>
-
- <p class="note"><strong>Note:</strong> See also the <a class="eventtype" href="#event-type-mouseout"><code>mouseout</code></a> event type.</p>
- </dd>
- </dl>
- </div>
-
- <!-- mouseup -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-mouseup"><dfn><a class="eventtype" href="#event-type-mouseup"><code>mouseup</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>mouseup</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-MouseEvent"><code>MouseEvent</code></a></td>
+ <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
</tr>
<tr>
<th>Sync / Async</th>
@@ -4106,1030 +5948,62 @@
</tr>
<tr>
<th>Default action</th>
- <td>Invoke a context menu (in combination with the right mouse button, if supported)</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- indicates the <a href="#current-click-count">current click count</a> incremented by one.</li>
- <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
- value based on the pointer position on the screen</li>
- <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
- value based on the pointer position within the viewport</li>
- <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
- value based on current button pressed</li>
- <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
- value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
- <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- <code>null</code></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a pointing device button is released over an element.</p>
-
- <p class="note"><strong>Note: </strong>Many implementations will invoke a context menu as the default action of this event if the right mouse button is being released.</p>
-
- <p class="note"><strong>Authoring Note: </strong>In some implementation environments,
- such as a browser, a <a class="eventtype"><code>mouseup</code></a> event
- can be dispatched even if the pointing device has left the boundary of the user
- agent, e.g., if the user began a drag operation with a mouse button pressed.</p>
- </dd>
- </dl>
- </div>
- </section> <!-- events-mouseevents -->
-
- <section id="events-wheelevents">
- <h3>Wheel Event Types</h3>
- <p>Wheels are devices that can be rotated in one or more spatial dimensions, and which can be associated with a pointer device. The coordinate system depends on the
- environment configuration.</p>
-
- <div class="example">
- <div class="example-title"></div>
- <p>The user's environment might be configured to associate vertical scrolling
- with rotation along the y-axis, horizontal scrolling with rotation along
- the x-axis, and zooming with rotation along the z-axis.
- </p>
- </div>
-
- <p>The deltaX, deltaY, and deltaZ attributes of
- <a href="#interface-WheelEvent"><code>WheelEvent</code></a> objects indicate a
- measurement along their respective axes in units of pixels, lines, or pages.
- The reported measurements are provided after an environment-specific algorithm
- translates the actual rotation/movement of the wheel device into the appropriate
- values and units.
- </p>
-
- <p class="note"><strong>Authoring Note:</strong>
- A user's environment settings can be customized to interpret actual rotation/movement
- of a wheel device in different ways.
- One movement of a common <q>dented</q> mouse wheel can produce a measurement of 162 pixels
- (162 is just an example value, actual values can depend on the current screen
- dimensions of the user-agent).
- But a user can change their default environment settings to speed-up their mouse wheel,
- increasing this number.
- Furthermore, some mouse wheel software can support acceleration (the faster the wheel
- is rotated/moved, the greater the <a class="def" href="#glossary-delta">delta</a> of each measurement) or even sub-pixel <a class="def" href="#glossary-rotation">rotation</a>
- measurements.
- Because of this, authors can not assume a given <a class="def" href="#glossary-rotation">rotation</a> amount in one user agent will
- produce the same <a class="def" href="#glossary-delta">delta</a> value in all user agents.
- </p>
-
- <p>The sign (positive or negative) of the values of the deltaX, deltaY, and deltaZ attributes
- MUST be consistent between multiple dispatches of the
- <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event while the
- motion of the actual wheel device is rotating/moving in the same direction.
- If a user agent scrolls as the default action of the
- <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event then the sign
- of the <a class="def" href="#glossary-delta">delta</a> SHOULD be given by a right-hand coordinate system where positive X,
- Y, and Z axes are directed towards the right-most edge, bottom-most edge, and farthest
- depth (away from the user) of the document, respectively.
- </p>
-
- <p class="note"><strong>Note:</strong>
- Individual user agents can (depending on their environment and hardware configuration)
- interpret the same physical user interaction on the wheel differently.
- For example, a vertical swipe on the edge of a trackpad from top to bottom can be
- interpreted as a wheel action intended to either scroll the
- page down or to pan the page up (i.e., resulting in either a positive or negative
- deltaY value respectively).
- </p>
-
- <section id="interface-WheelEvent">
- <h4>Interface WheelEvent</h4>
-
- <p class="intro-dom">Introduced in DOM Level 3</p>
-
- <p>The <code>WheelEvent</code> interface provides specific contextual information
- associated with <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a>
- events.
- </p>
-
- <p>To create an instance of the <code>WheelEvent</code> interface, use the
- <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("WheelEvent")</code></a>
- method call.
- </p>
-
- <dl class="idl" title="[Constructor(DOMString typeArg, optional WheelEventInit wheelEventInitDict)] interface WheelEvent : MouseEvent">
- <dt>// DeltaModeCode</dt>
-
- <dt>const unsigned long DOM_DELTA_PIXEL = 0x00</dt>
- <dd>
- <p>The units of measurement for the <a href="#glossary-delta">delta</a> MUST be
- pixels. This is the most typical case in most operating system and implementation
- configurations.
- </p>
- </dd>
-
- <dt>const unsigned long DOM_DELTA_LINE = 0x01</dt>
- <dd>
- <p>The units of measurement for the <a href="#glossary-delta">delta</a> MUST be
- individual lines of text. This is the case for many form controls.
- </p>
- </dd>
-
- <dt>const unsigned long DOM_DELTA_PAGE = 0x02</dt>
- <dd>
- <p>The units of measurement for the <a href="#glossary-delta">delta</a> MUST be
- pages, either defined as a single screen or as a demarcated page.
- </p>
- </dd>
-
- <dt>readonly attribute double deltaX</dt>
- <dd>
- <p>In user agents where the default action of the
- <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event is to scroll,
- the value MUST be the measurement along the x-axis (in pixels, lines, or pages) to be scrolled
- in the case where the event is not cancelled. Otherwise, this is an implementation-specific
- measurement (in pixels, lines, or pages) of the movement of a wheel device around the x-axis.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
- MUST be <code>0.0</code>.
- </p>
- </dd>
-
- <dt>readonly attribute double deltaY</dt>
- <dd>
- <p>In user agents where the default action of the
- <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event is to scroll, the value
- MUST be the measurement along the y-axis (in pixels, lines, or pages) to be scrolled in the case
- where the event is not cancelled. Otherwise, this is an implementation-specific
- measurement (in pixels, lines, or pages) of the movement of a wheel device around the y-axis.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
- MUST be <code>0.0</code>.
- </p>
- </dd>
-
- <dt>readonly attribute double deltaZ</dt>
- <dd>
- <p>In user agents where the default action of the
- <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event is to scroll, the value
- MUST be the measurement along the z-axis (in pixels, lines, or pages) to be scrolled in the case
- where the event is not cancelled. Otherwise, this is an implementation-specific
- measurement (in pixels, lines, or pages) of the movement of a wheel device around the z-axis.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
- MUST be <code>0.0</code>.
- </p>
- </dd>
-
- <dt>readonly attribute unsigned long deltaMode</dt>
- <dd>
- <p>The <code>deltaMode</code> attribute contains an indication of the units of measurement for the
- <a href="#glossary-delta">delta</a> values.
- The default value is
- <a href="#widl-WheelEvent-DOM_DELTA_PIXEL"><code class="constant-name">DOM_DELTA_PIXEL</code></a>
- (pixels).
- </p>
-
- <p>This attribute MUST be set to one of the DOM_DELTA constants to indicate the units of measurement
- for the <a href="#glossary-delta">delta</a> values. The precise measurement
- is specific to device, operating system, and application configurations.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
- MUST be <code>0</code>.
- </p>
- </dd>
-
- </dl>
-
- <dl class="idl" title="dictionary WheelEventInit : MouseEventInit">
- <dt>double deltaX = 0.0</dt>
- <dd><p>See <code>deltaZ</code> attribute.</p></dd>
-
- <dt>double deltaY = 0.0</dt>
- <dd><p>See <code>deltaZ</code> attribute.</p></dd>
-
- <dt>double deltaZ = 0.0</dt>
- <dd>
- <p>Initializes the <code>deltaZ</code> attribute of the WheelEvent object.
- Relative positive values for this attribute (as well as the
- <code>deltaX</code> and <code>deltaY</code> attributes) are given by
- a right-hand coordinate system where the X, Y, and Z axes are
- directed towards the right-most edge, bottom-most edge, and farthest
- depth (away from the user) of the document, respectively. Negative
- relative values are in the respective opposite directions.
- </p>
- </dd>
-
- <dt>unsigned long deltaMode = 0</dt>
- <dd>
- <p>Initializes the <code>deltaMode</code> attribute on the WheelEvent
- object to the enumerated values 0, 1, or 2, which represent the amount
- of pixels scrolled
- (<a href="#widl-WheelEvent-DOM_DELTA_PIXEL"><code class="constant-name">DOM_DELTA_PIXEL</code></a>),
- lines scrolled
- (<a href="#widl-WheelEvent-DOM_DELTA_LINE"><code class="constant-name">DOM_DELTA_LINE</code></a>),
- or pages scrolled
- (<a href="#widl-WheelEvent-DOM_DELTA_PAGE"><code class="constant-name">DOM_DELTA_PAGE</code></a>)
- if the <a class="def" href="#glossary-rotation">rotation</a> of the wheel would
- have resulted in scrolling.
- </p>
- </dd>
- </dl>
-
- </section> <!-- interface-WheelEvent -->
-
- <p>The Wheel event types are listed below.</p>
-
- <!-- wheel -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-wheel"><dfn><a class="eventtype" href="#event-type-wheel"><code>wheel</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>wheel</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-WheelEvent"><code>WheelEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Async</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>Scroll (or zoom) the document</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-topmost-event-target">topmost event target</a></li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-MouseEvent-screenX"><code class="attribute-name">MouseEvent.screenX</code></a>:
- if the wheel is associated with a pointing device, the value based on the pointer position on the screen, otherwise <code>0</code></li>
- <li><a href="#widl-MouseEvent-screenY"><code class="attribute-name">MouseEvent.screenY</code></a>:
- if the wheel is associated with a pointing device, the value based
- on the pointer position on the screen, otherwise <code>0</code></li>
- <li><a href="#widl-MouseEvent-clientX"><code class="attribute-name">MouseEvent.clientX</code></a>:
- if the wheel is associated with a pointing device, the value based
- on the pointer position within the viewport, otherwise <code>0</code></li>
- <li><a href="#widl-MouseEvent-clientY"><code class="attribute-name">MouseEvent.clientY </code></a>:
- if the wheel is associated with a pointing device, the value
- based on the pointer position within the viewport, otherwise <code>0</code></li>
- <li><a href="#widl-MouseEvent-altKey"><code class="attribute-name">MouseEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code>
- modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-ctrlKey"><code class="attribute-name">MouseEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-shiftKey"><code class="attribute-name">MouseEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-metaKey"><code class="attribute-name">MouseEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-MouseEvent-button"><code class="attribute-name">MouseEvent.button</code></a>:
- if wheel is associated with a pointing device, value based on current button pressed, otherwise <code>0</code></li>
- <li><a href="#widl-MouseEvent-buttons"><code class="attribute-name">MouseEvent.buttons</code></a>:
- if wheel is associated with a pointing device, value based on all buttons current depressed, <code>0</code> if no buttons pressed</li>
- <li><a href="#widl-MouseEvent-relatedTarget"><code class="attribute-name">MouseEvent.relatedTarget</code></a>:
- indicates the <a class="def" href="#glossary-event-target">event target</a> the pointing device is pointing at, if any.</li>
- <li><a href="#widl-WheelEvent-deltaX"><code class="attribute-name">WheelEvent.deltaX</code></a>:
- expected amount that the page will scroll along the x-axis according
- to the deltaMode units; or an implemenation-specific value of movement of a wheel around the x-axis</li>
- <li><a href="#widl-WheelEvent-deltaY"><code class="attribute-name">WheelEvent.deltaY</code></a>:
- expected amount that the page will scroll along the y-axis according
- to the deltaMode units; or an implemenation-specific value of movement of a wheel around the y-axis</li>
- <li><a href="#widl-WheelEvent-deltaZ"><code class="attribute-name">WheelEvent.deltaZ</code></a>:
- expected amount that the page will scroll along the z-axis according
- to the deltaMode units; or an implemenation-specific value of movement of a wheel around the z-axis</li>
- <li><a href="#widl-WheelEvent-deltaMode"><code class="attribute-name">WheelEvent.deltaMode</code></a>:
- unit indicator (pixels, lines, or pages) for the deltaX, deltaY, and deltaZ attributes</li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a mouse wheel has been rotated around any axis, or when an equivalent
- input device (such as a mouse-ball, certain tablets or touchpads, etc.) has emulated such an action. Depending on the platform and input device, diagonal wheel
- <a class="def" href="#glossary-delta">deltas</a> MAY be delivered either as a single <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event with multiple non-zero axes or as separate <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a>
- events for each non-zero axis.</p>
-
- <p>The typical <a class="def" href="#glossary-default-action">default action</a> of the <a class="eventtype" href="#event-type-wheel"><code>wheel</code></a> event
- type is to scroll (or in some cases, zoom) the document by the indicated amount. If this event is canceled, the implementation MUST NOT scroll or zoom the document
- (or perform whatever other implementation-specific default action is associated with this event type).</p>
-
- <p class="note"><strong>Note:</strong> In some <a class="def" href="#glossary-user-agent">user agents</a>, or with some input devices, the speed that the wheel has been
- turned can affect the <a href="#glossary-delta">delta</a> values, with a faster speed producing a higher <a href="#glossary-delta">delta</a> value.</p>
- </dd>
- </dl>
- </div>
- </section> <!-- events-wheelevents -->
-
- <section id="events-inputevents">
- <h3>Input Event Types</h3>
- <p>Input events are sent as notifications whenever the DOM is being updated.</p>
-
- <section id="interface-InputEvent">
- <h4>Interface InputEvent</h4>
-
- <p class="intro-dom">Introduced in DOM Level 3</p>
-
- <dl class="idl" title="[Constructor(DOMString typeArg, optional InputEventInit inputEventInitDict)] interface InputEvent : UIEvent">
- <dt>readonly attribute DOMString data</dt>
- <dd>
- <p><code>data</code> holds the value of the characters generated by an input method.
- This MAY be a single Unicode character or a non-empty sequence of Unicode characters
- [<cite><a class="normative" href="#references-Unicode">Unicode</a></cite>].
- Characters SHOULD be normalized as defined by the Unicode normalization form <em>NFC</em>,
- defined in [<cite><a class="normative" href="#references-UnicodeNormalization">UAX #15</a></cite>].
- This attribute MAY contain the <a class="def" href="#glossary-empty-string">empty string</a>.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
- MUST be <code>""</code> (the empty string).
- </p>
- </dd>
-
- <dt>readonly attribute boolean isComposing</dt>
- <dd>
- <p><code>true</code> if the input event occurs as part of a composition session, i.e., after a
- <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a>
- event and before the corresponding
- <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>
- event.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this
- attribute MUST be <code>false</code>.
- </p>
- </dd>
-
- </dl>
-
- <dl class="idl" title="dictionary InputEventInit : UIEventInit">
- <dt>DOMString data = ""</dt>
- <dd>
- <p>Initializes the <code>data</code> attribute of the InputEvent object.
- </p>
- </dd>
-
- <dt>boolean isComposing = false</dt>
- <dd>
- <p>Initializes the <code>isComposing</code> attribute of the InputEvent object.
- </p>
- </dd>
- </dl>
-
- </section> <!-- interface-InputEvent -->
-
- <section id="events-inputevent-event-order">
- <h4>Input Event Order</h4>
-
- <p>The input events defined in this specification MUST occur in a set order relative to one another.
- </p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td colspan="2"><em>DOM element is updated</em></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
- <td></td>
- </tr>
- </table>
-
- </section> <!-- events-inputevent-event-order -->
-
- <p>The Input event types are listed below.</p>
-
- <!-- beforeinput -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-beforeinput"><dfn><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>beforeinput</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-InputEvent"><code>InputEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code> (specifically: control types such as <code>HTMLInputElement</code>, etc.) or any <code>Element</code> with
- <code>contenteditable</code> attribute enabled.</td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>Update the DOM element</td>
+ <td>Start a new composition session when a <a class="def" href="#glossary-text-composition-system">text composition system</a> is enabled</td>
</tr>
<tr>
<th>Context<br/>(trusted events)</th>
<td>
<ul>
<li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> that is about to be updated</li>
+ focused element processing the composition</li>
<li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
<a class="def" href="#glossary-window"><code>Window</code></a></li>
<li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
<code>0</code></li>
- <li><a href="#widl-InputEvent-data"><code class="attribute-name">InputEvent.data</code></a>:
- the string containing the data that will be added to the element,
- which MAY be the <a class="def" href="#glossary-empty-string">empty string</a> if the content has been deleted</li>
- <li><a href="#widl-InputEvent-isComposing"><code class="attribute-name">InputEvent.isComposing</code></a>:
- <code>true</code> if this event is dispatched during a <a href="#keys-dead">dead key</a> sequence or while an
- <a href="#glossary-ime">input method editor</a> is active (such that
- <a href="#events-compositionevents">composition events</a> are being dispatched); <code>false</code> otherwise.</li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when the DOM is about to be updated.</p>
- </dd>
- </dl>
- </div><!-- beforeinput -->
-
- <!-- input -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-input"><dfn><a class="eventtype" href="#event-type-input"><code>input</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>input</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-InputEvent"><code>InputEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code> (specifically: control types such as <code>HTMLInputElement</code>, etc.) or any <code>Element</code> with
- <code>contenteditable</code> attribute enabled.</td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- <a class="def" href="#glossary-event-target">event target</a> that was just updated</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-InputEvent-data"><code class="attribute-name">InputEvent.data</code></a>:
- the string containing the data that was added to the element,
- which MAY be the <a class="def" href="#glossary-empty-string">empty string</a> if the content has been deleted</li>
- <li><a href="#widl-InputEvent-isComposing"><code class="attribute-name">InputEvent.isComposing</code></a>:
- <code>true</code> if this event is dispatched during a <a href="#keys-dead">dead key</a> sequence or while an
- <a href="#glossary-ime">input method editor</a> is active (such that
- <a href="#events-compositionevents">composition events</a> are being dispatched); <code>false</code> otherwise.</li>
+ <li><a href="#widl-CompositionEvent-data"><code class="attribute-name">CompositionEvent.data</code></a>:
+ the original string being edited, otherwise the <a class="def" href="#glossary-empty-string">empty string</a></li>
</ul>
</td>
</tr>
</table>
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event immediately after the DOM has been updated.</p>
- </dd>
- </dl>
- </div><!-- input -->
-
- </section> <!-- events-inputevents -->
-
- <section id="events-keyboardevents">
- <h3>Keyboard Event Types</h3>
-
- <p>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. Refer to
- <a href="#keys">Keyboard events and key values</a> for more details, including
- examples on how Keyboard Events are used in combination with Composition Events.
- Depending on the
- character generation device, keyboard events might not be generated.
- </p>
-
- <p class="note"><strong>Authoring Note:</strong>
- Keyboard events are only one modality of providing textual input.
- For editing scenarios, consider also using the
- <a href="#interface-InputEvent"><code>InputEvent</code></a>
- as an alternate to (or in addition to) keyboard events.
- </p>
-
- <section id="interface-KeyboardEvent">
- <h4>Interface KeyboardEvent</h4>
-
- <p class="intro-dom">Introduced in DOM Level 3</p>
-
- <p>The <a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a> interface
- provides specific contextual information associated with keyboard devices.
- Each keyboard event references a key using a value.
- Keyboard events are commonly directed at the element that has the focus.
- </p>
-
- <p>The <a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a> interface
- provides convenient attributes for some common modifiers keys:
- <a href="#widl-KeyboardEvent-ctrlKey"><code>KeyboardEvent.ctrlKey</code></a>,
- <a href="#widl-KeyboardEvent-shiftKey"><code>KeyboardEvent.shiftKey</code></a>,
- <a href="#widl-KeyboardEvent-altKey"><code>KeyboardEvent.altKey</code></a>,
- <a href="#widl-KeyboardEvent-metaKey"><code>KeyboardEvent.metaKey</code></a>.
- These attributes are equivalent to using the method
- <a href="#widl-KeyboardEvent-getModifierState"><code>KeyboardEvent.getModifierState(keyArg)</code></a>
- with
- <code class="key">'Control'</code>,
- <code class="key">'Shift'</code>,
- <code class="key">'Alt'</code>, or
- <code class="key">'Meta'</code>
- respectively.
- </p>
-
- <p>To create an instance of the <a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a>
- interface, use the
- <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("KeyboardEvent")</code></a>
- method call.
- </p>
-
- <dl class="idl" title="[Constructor(DOMString typeArg, optional KeyboardEventInit keyboardEventInitDict)] interface KeyboardEvent : UIEvent">
- <dt>// KeyLocationCode</dt>
-
- <dt>const unsigned long DOM_KEY_LOCATION_STANDARD = 0x00</dt>
- <dd>
- <p>The key activation MUST NOT be distinguished as the left or right version of the key, and (other than the
- <code class="key">'NumLock'</code> key) did not originate from the numeric keypad (or did not originate
- with a virtual key corresponding to the numeric keypad).</p>
-
- <div class="example">
- <div class="example-title"></div>
- <p>The <code class="key">'Q'</code> key on a PC 101 Key US keyboard.</p>
- <p>The <code class="key">'NumLock'</code> key on a PC 101 Key US keyboard.</p>
- <p>The <code class="key">'1'</code> key on a PC 101 Key US keyboard located in the main section of the keyboard.</p>
- </div>
- </dd>
-
- <dt>const unsigned long DOM_KEY_LOCATION_LEFT = 0x01</dt>
- <dd>
- <p>The key activated originated from the left key location (when there is more than one possible location for this key).</p>
-
- <div class="example">
- <div class="example-title"></div>
- <p>The left <code class="key">'Control'</code> key on a PC 101 Key US keyboard.</p>
- </div>
- </dd>
-
- <dt>const unsigned long DOM_KEY_LOCATION_RIGHT = 0x02</dt>
- <dd>
- <p>The key activation originated from the right key location (when there is more than one possible location for this key).</p>
-
- <div class="example">
- <div class="example-title"></div>
- <p>The right <code class="key">'Shift'</code> key on a PC 101 Key US keyboard.</p>
- </div>
- </dd>
-
- <dt>const unsigned long DOM_KEY_LOCATION_NUMPAD = 0x03</dt>
- <dd>
- <p>The key activation originated on the numeric keypad or with a virtual key corresponding to the numeric
- keypad (when there is more than one possible location for this key). Note that the <code class="key">'NumLock'</code>
- key should always be encoded with a location of
- <a href="#widl-KeyboardEvent-DOM_KEY_LOCATION_STANDARD"><code class="constant-name">DOM_KEY_LOCATION_STANDARD</code></a>.
- </p>
-
- <div class="example">
- <div class="example-title"></div>
- <p>The <code class="key">'1'</code> key on a PC 101 Key US keyboard located on the numeric pad.</p>
- </div>
- </dd>
-
- <dt>readonly attribute DOMString key</dt>
- <dd>
- <p><code>key</code> holds the key value of the key pressed.
- If the value is has a printed representation, it MUST be a non-empty Unicode character
- string, conforming to the <a href="#key-algorithm">algorithm for determining the key value</a> defined in this specification.
- If the value is a control key which has no printed representation, it MUST be one of the key values defined in the
- <a href="#keys-keyvalues">key values set</a>, as determined by the <a href="#key-algorithm">algorithm for determining the key value</a>. Implementations that are
- unable to identify a key MUST use the key value <code class="key">'Unidentified'</code>.</p>
-
- <p class="note"><strong>Note:</strong> The <code>key</code> attribute is not related to the legacy <code>keyCode</code> attribute and does not have the same set of values.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>""</code> (the empty string).</p>
- </dd>
-
- <dt>readonly attribute DOMString code</dt>
- <dd>
- <p><code>code</code> holds a string that identifies the physical key being pressed.
- The value is not affected by the current keyboard layout or modifier state, so a particular
- key will always return the same value.
- </p>
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>""</code> (the empty string).</p>
- </dd>
-
- <dt>readonly attribute unsigned long location</dt>
- <dd>
- <p>The <code>location</code> attribute contains an indication of the location of the key on the device.</p>
-
- <p>This attribute MUST be set to one of the DOM_KEY_LOCATION constants to indicate the location of a key on the device. In case a DOM implementation wishes to provide a new location value, a
- value different from the defined constant values MUST be used.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>0</code>.</p>
- </dd>
-
- <dt>readonly attribute boolean ctrlKey</dt>
- <dd>
- <p><code>true</code> if the <code class="key">'Control'</code> (control) key modifier was active.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
- </dd>
-
- <dt>readonly attribute boolean shiftKey</dt>
- <dd>
- <p><code>true</code> if the shift (<code class="key">'Shift'</code>) key modifier was active.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
- </dd>
-
- <dt>readonly attribute boolean altKey</dt>
- <dd>
- <p><code>true</code> if the <code class="key">'Alt'</code> (alternative) (or <code class="glyph">'Option'</code>) key modifier was active.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
- </dd>
-
- <dt>readonly attribute boolean metaKey</dt>
- <dd>
- <p><code>true</code> if the meta (<code class="key">'Meta'</code>) key modifier was active.</p>
-
- <p class="note"><strong>Note:</strong> The <code class="glyph">'Command'</code> (<code class="glyph">'⌘'</code>) key modifier on Macintosh systems is represented using this key modifier.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
- </dd>
-
- <dt>readonly attribute boolean repeat</dt>
- <dd>
- <p><code>true</code> if the key has been pressed in a sustained manner. Holding down a key MUST result in the repeating the events
- <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>,
- <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a>,
- <a class="eventtype" href="#event-type-input"><code>input</code></a>
- in this order, at a rate determined by the system configuration. For mobile devices which have <em>long-key-press</em>
- behavior, the first key event with a <a href="#widl-KeyboardEvent-repeat"><code>repeat</code></a> attribute value of <code>'true'</code> MUST serve as an
- indication of a <em>long-key-press</em>. The length of time that the key MUST be pressed in order to begin repeating is configuration-dependent.</p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute MUST be <code>false</code>.</p>
- </dd>
-
- <dt>readonly attribute boolean isComposing</dt>
- <dd>
- <p><code>true</code> if the key event occurs as part of a composition session, i.e., after a
- <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a>
- event and before the corresponding
- <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>
- event.
- </p>
-
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this
- attribute MUST be <code>false</code>.
- </p>
- </dd>
-
- <dt>boolean getModifierState()</dt>
- <dd>
- <p>Queries the state of a modifier using a key value.
- See <a href="#keys-modifiers">Modifier keys</a> for a list of valid (case-sensitive) arguments to this method.
- </p>
-
- <dl class="parameters">
- <dt>DOMString keyArg</dt>
- <dd>
- <p>A modifier key value. Valid modifier keys are defined in the
- <a href="DOM3Events-key.html#keys-modifier">Modifier Keys</a> table in
- [<a href="#references-D3E-key">DOM3 key Values</a>].
- </p>
-
- <p>Returns <code>true</code> if it is a modifier key and the modifier is activated, <code>false</code> otherwise.</p>
-
- <p class="note"><strong>Note:</strong> If an application wishes to distinguish between right and left modifiers, this information could be
- deduced using keyboard events and <a href="#widl-KeyboardEvent-location"><code>KeyboardEvent.location</code></a>.</p>
- </dd>
-
- </dl>
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a <a class="def" href="#glossary-text-composition-system">text composition
+ system</a> is enabled and a new composition session is about to begin (or has begun, depending on the <a class="def" href="#glossary-text-composition-system">text composition
+ system</a>) in preparation for composing a passage of text. This event type is device-dependent, and MAY rely upon the capabilities of the text conversion system and how it is
+ mapped into the operating system. When a keyboard is used to feed an input method editor, this event type is generated after a <a class="eventtype"><code>keydown</code></a> event,
+ but speech or handwriting recognition systems MAY send this event type without keyboard events. Some implementations MAY populate the
+ <a href="#widl-CompositionEvent-data"><code>data</code></a> attribute of the <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a> event
+ with the text currently selected in the document (for editing and replacement). Otherwise, the value of the <a href="#widl-CompositionEvent-data"><code>data</code></a>
+ attribute MUST be the <a class="def" href="#glossary-empty-string">empty string</a>.</p>
+
+ <p>This event MUST be dispatched immediately before a <a class="def" href="#glossary-text-composition-system">text composition system</a> begins a new composition session, and
+ before the DOM is modified due to the composition process. The default action of this event is for the <a class="def" href="#glossary-text-composition-system">text
+ composition system</a> to start a new composition session. If this event is canceled, the <a class="def" href="#glossary-text-composition-system">text composition system</a> SHOULD
+ discard the current composition session.</p>
+
+ <p class="note"><strong>Note:</strong> Canceling the <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a> <em>event type</em> is distinct
+ from canceling the <a class="def" href="#glossary-text-composition-system">text composition system</a> itself (e.g., by hitting a cancel button or closing an <a class="def"
+ href="#glossary-ime">IME</a> window).</p>
+
+ <p class="note"><strong>Note:</strong> Some IMEs do not support cancelling an in-progress composition session (e.g., such as GTK which doesn't presently have such an API). In these
+ cases, calling <a href="#widl-Event-preventDefault"><code>preventDefault</code></a> will not stop this event's default action.</p>
</dd>
</dl>
-
- <dl class="idl" title="dictionary KeyboardEventInit : UIEventInit">
- <dt>DOMString key = ""</dt>
- <dd>
- <p>Initializes the <code>key</code> attribute of the KeyboardEvent
- object to the unicode character string representing the meaning of a
- key after taking into account all keyboard modifications (such as
- shift-state). This value is the final effective value of the key.
- If the key is not a printable character, then it should be one of
- the key values defined in
- [<a href="#references-D3E-key">DOM3 key Values</a>].
- </p>
- </dd>
-
- <dt>DOMString code = ""</dt>
- <dd>
- <p>Initializes the <code>code</code> attribute of the KeyboardEvent
- object to the unicode character string representing the key that
- was pressed, ignoring any keyboard modifications such as keyboard
- layout.
- This value should be one of the code values defined in
- [<a href="#references-D3E-code">DOM3 code Values</a>].
- </p>
- </dd>
-
- <dt>unsigned long location = 0</dt>
- <dd>
- <p>Initializes the <code>location</code> attribute of the KeyboardEvent
- object to one of the following location numerical constants:
- </p>
- <ul>
- <li><code>KeyboardEvent.DOM_KEY_LOCATION_STANDARD</code> (numerical value 0)</li>
- <li><code>KeyboardEvent.DOM_KEY_LOCATION_LEFT</code> (numerical value 1)</li>
- <li><code>KeyboardEvent.DOM_KEY_LOCATION_RIGHT</code> (numerical value 2)</li>
- <li><code>KeyboardEvent.DOM_KEY_LOCATION_NUMPAD</code> (numerical value 3)</li>
- </ul>
- </dd>
-
- <dt>boolean ctrlKey = false</dt>
- <dd>
- <p>Initializes the <code>altKey</code> attribute of the KeyboardEvent
- object to <code>true</code> if the <code class="key">'Control'</code>
- (control) key modifier is to be considered active,
- <code>false</code> otherwise.</p>
- </dd>
-
- <dt>boolean shiftKey = false</dt>
- <dd>
- <p>Initializes the <code>shiftKey</code> attribute of the KeyboardEvent
- object to <code>true</code> if the <code class="key">'Shift'</code>
- key modifier is to be considered active, <code>false</code> otherwise.</p>
- </dd>
-
- <dt>boolean altKey = false</dt>
- <dd>
- <p>Initializes the <code>altKey</code> attribute of the KeyboardEvent
- object to <code>true</code> if the <code class="key">'Alt'</code>
- (alternative) (or <code class="glyph">'Option'</code>) key modifier
- is to be considered active, <code>false</code> otherwise.</p>
- </dd>
-
- <dt>boolean metaKey = false</dt>
- <dd>
- <p>Initializes the <code>metaKey</code> attribute of the KeyboardEvent
- object to <code>true</code> if the <code class="key">'Meta'</code>
- key modifier is to be considered active, <code>false</code> otherwise.</p>
- </dd>
-
- <dt>boolean repeat = false</dt>
- <dd>
- <p>Initializes the <code>repeat</code> attribute of the KeyboardEvent
- object. This attribute should be set to <code>true</code> if the the current KeyboardEvent is
- considered part of a repeating sequence of similar events caused
- by the long depression of any single key, <code>false</code> otherwise.
- </p>
- </dd>
-
- <dt>boolean isComposing = false</dt>
- <dd>
- <p>Initializes the <code>isComposing</code> attribute of the KeyboardEvent
- object. This attribute should be set to <code>true</code> if the
- event being constructed occurs as part of a composition sequence,
- <code>false</code> otherwise.
- </p>
- </dd>
- </dl>
-
- </section> <!-- interface-KeyboardEvent -->
-
- <div class="warning">
- <p><strong>Warning!</strong></p>
- <p>Legacy keyboard event implementations include three additional attributes,
- <code>keyCode</code>, <code>charCode</code>, and <code>which</code>.
- The <code>keyCode</code> attribute indicates a numeric value associated with
- a particular key on a computer keyboard,
- while the <code>charCode</code> attribute indicates the
- <acronym title="American Standard Code for Information Interchange">ASCII</acronym>
- value of the character associated with that key (which might be the same as
- the <code>keyCode</code> value) and is applicable only to keys that produce a
- <a class="def" href="#glossary-character-value">character value</a>.
- </p>
- <p>In practice, <code>keyCode</code> and <code>charCode</code> are inconsistent across platforms
- and even the same implementation on different operating systems or using different localizations.
- DOM Level 3 Events does not define values for either
- <code>keyCode</code> or <code>charCode</code>, or behavior for <code>charCode</code>.
- In conforming DOM Level 3 Events implementations, content authors can instead use
- <a href="#widl-KeyboardEvent-key"><code>KeyboardEvent.key</code></a> and
- <a href="#widl-KeyboardEvent-code"><code>KeyboardEvent.code</code></a>.
- </p>
- <p><em>For more information, see the informative appendix on
- <a href="#legacy-key-attributes">Legacy key attributes</a>.</em>
- </p>
- </div>
-
- <p class="note"><strong>Note:</strong>
- For compatibility with existing content, virtual keyboards, such as software keyboards
- on screen-based input devices, are expected to produce the normal range of keyboard
- events, even though they do not possess physical keys.
- </p>
-
- <p class="note"><strong>Note:</strong>
- In some implementations or system configurations, some key events, or their values,
- might be suppressed by the <a class="def" href="#glossary-ime">IME</a> in use.
- </p>
-
- <section id="events-keyboard-event-order">
- <h4>Keyboard Event Order</h4>
- <p>The keyboard events defined in this specification occur in a set order relative
- to one another, for any given key:</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
- <td><em>(only for keys which produce a <a class="def" href="#glossary-character-value">character value</a>)</em></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td><em>Any <a class="def" href="#glossary-default-action">default actions</a> related to this key, such as inserting a
- character in to the DOM.</em></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
- <td><em>(only for keys which have updated the DOM)</em></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td><em>Any events as a result of the key being held for a sustained period (see below).</em></td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
- <td></td>
- </tr>
- </table>
-
- <p>If the key is depressed for a sustained period, the following events MAY repeat
- at an environment-dependent rate: <!-- and the key should seek counseling -->
- </p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
- <td><em>(with <a href="#widl-KeyboardEvent-repeat">repeat</a> attribute set to <code> true</code>)</em></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
- <td><em>(only for keys which produce a <a class="def" href="#glossary-character-value">character value</a>)</em></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td><em>Any <a class="def" href="#glossary-default-action">default actions</a> related to this key, such as inserting a
- character in to the DOM.</em></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
- <td><em>(only for keys which have updated the DOM)</em></td>
- </tr>
- </table>
-
- <p class="note"><strong>Note:</strong>
- Typically, any <a class="def" href="#glossary-default-action">default actions</a>
- associated with any particular key are completed before the
- <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event is dispatched.
- This might delay the <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>
- event slightly (though this is not likely to be a perceptible delay).
- </p>
-
- <p>The <a class="def" href="#glossary-event-target">event target</a> of a key event is
- the currently focused element which is processing the keyboard activity.
- This is often an HTML <code>input</code> element or a textual element which is editable,
- but MAY be an element defined by the
- <a class="def" href="#glossary-host-language">host language</a> to accept keyboard input
- for non-text purposes, such as the activation of an accelerator key or trigger of some
- other behavior. If no suitable element is in focus, the event target will be the HTML
- <a href="#glossary-body-element">body element</a> if available,
- otherwise the <a href="#glossary-root-element">root element</a>.
- </p>
-
- <p class="note"><strong>Note:</strong>
- The <a class="def" href="#glossary-event-target">event target</a> might change between
- different key events.
- For example, a <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>
- event for the <code class="key">'Tab'</code> key
- will likely have a different <a class="def" href="#glossary-event-target">event target</a>
- than the <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>
- event on the same keystroke.
- </p>
- </section> <!-- events-keyboard-event-order -->
-
- <p>The keyboard event types are listed below.</p>
-
- <!-- keydown -->
+ </div>
+
+ <!-- compositionupdate -->
<div class="event-definition">
<dl>
- <dt id="event-type-keydown"><dfn><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></dfn></dt>
+ <dt id="event-type-compositionupdate"><dfn><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></dfn></dt>
<dd>
<table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
<tr>
<th>Type</th>
- <td><strong><code>keydown</code></strong></td>
+ <td><strong><code>compositionupdate</code></strong></td>
</tr>
<tr>
<th>Interface</th>
- <td><a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a></td>
+ <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
</tr>
<tr>
<th>Sync / Async</th>
@@ -5145,109 +6019,65 @@
</tr>
<tr>
<th>Cancelable</th>
- <td>Yes</td>
+ <td>No</td>
</tr>
<tr>
<th>Default action</th>
- <td>Varies:
- <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> and <a class="eventtype" href="#event-type-input"><code>input</code></a> events;
- launch <a class="def" href="#glossary-text-composition-system">text composition system</a>;
- <a class="eventtype" href="#event-type-blur"><code>blur</code></a> and <a class="eventtype" href="#event-type-focus"><code>focus</code></a> events;
- <a class="eventtype" href="#event-type-keypress"><code>keypress</code></a> event;
- <a class="def" href="#glossary-activation-behavior">activation behavior</a>;
- other event</td>
+ <td>None</td>
</tr>
<tr>
<th>Context<br/>(trusted events)</th>
<td>
<ul>
<li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- focused element processing the key event or if no element focused, then the
- <a href="#glossary-body-element">body element</a> if available, otherwise the
- <a href="#glossary-root-element">root element</a></li>
+ focused element processing the composition, <code>null</code> if not accessible</li>
<li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
<a class="def" href="#glossary-window"><code>Window</code></a></li>
<li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
<code>0</code></li>
- <li><a href="#widl-KeyboardEvent-key"><code class="attribute-name">KeyboardEvent.key</code></a>:
- the key value of the key pressed.</li>
- <li><a href="#widl-KeyboardEvent-code"><code class="attribute-name">KeyboardEvent.code</code></a>:
- the code value associated with the key's physical placement on the keyboard.</li>
- <li><a href="#widl-KeyboardEvent-location"><code class="attribute-name">KeyboardEvent.location</code></a>:
- the location of the key on the device.</li>
- <li><a href="#widl-KeyboardEvent-altKey"><code class="attribute-name">KeyboardEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-shiftKey"><code class="attribute-name">KeyboardEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-ctrlKey"><code class="attribute-name">KeyboardEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-metaKey"><code class="attribute-name">KeyboardEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-repeat"><code class="attribute-name">KeyboardEvent.repeat</code></a>:
- <code>true</code> if a key has been depressed long enough to trigger key repetition, otherwise <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-isComposing"><code class="attribute-name">KeyboardEvent.isComposing</code></a>:
- <code>true</code> if the key event occurs as part of a composition session, otherwise <code>false</code></li>
+ <li><a href="#widl-CompositionEvent-data"><code class="attribute-name">CompositionEvent.data</code></a>:
+ the string comprising the current results of the composition session, which MAY be the
+ <a class="def" href="#glossary-empty-string">empty string</a> if the content has been deleted</li>
</ul>
</td>
</tr>
</table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a key is pressed down. The <a class="eventtype" href="#event-type-keydown">
- <code>keydown</code></a> event type is device dependent and relies on the capabilities of the input devices and how they are mapped in the operating system. This
- event type MUST be generated after the <a class="def" href="#glossary-key-mapping">key mapping</a>.
- This event type MUST be dispatched before the
- <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a>,
- <a class="eventtype" href="#event-type-input"><code>input</code></a>,
- and <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>
- events associated with the same key.</p>
-
- <p>The default action of the <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> event depends upon the key:</p>
-
- <ul>
- <li>If the key is associated with a character, the default action MUST be to dispatch
- a <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> event
- followed by an <a class="eventtype" href="#event-type-input"><code>input</code></a>
- event.
- In the case where the key which is associated with multiple characters (such as with a macro or certain sequences of dead keys), the default action MUST
- be to dispatch one set of
- <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> /
- <a class="eventtype" href="#event-type-input"><code>input</code></a>
- events for each character</li>
-
- <li>If the key is associated with a <a class="def" href="#glossary-text-composition-system">text composition system</a>, the default action MUST be to launch that
- system</li>
-
- <li>If the key is the <code class="key">'Tab'</code> key, the default action MUST be to shift the document focus from the currently focused
- element (if any) to the new focused element, as described in <a href="#events-focusevent">Focus Event Types</a></li>
-
- <li>If the key is the <code class="key">'Enter'</code> or <code class="key">' '</code> key and the
- current focus is on a state-changing element, the default action MUST be to dispatch a <a class="eventtype" href="#event-type-click"><code>click</code></a> event,
- and a <a class="eventtype" href="#event-type-DOMActivate"><code>DOMActivate</code></a> event if that event type is supported by the <a class="def" href="#glossary-user-agent">
- user agent</a> (refer to <a href="#event-flow-activation">activation triggers and behavior</a> for more details)</li>
- </ul>
-
- <p>If this event is canceled, the associated event types MUST NOT be dispatched, and the associated actions MUST NOT be performed.</p>
-
- <p class="note"><strong>Note:</strong> The <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and <a class="eventtype" href="#event-type-keyup">
- <code>keyup</code></a> events are traditionally associated with detecting any key, not just those which produce a <a class="def" href="#glossary-character-value">character
- value</a>.</p>
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> SHOULD dispatch this event during a composition session when a
+ <a class="def" href="#glossary-text-composition-system">text composition system</a> updates its active text passage with a
+ new character, which is reflected in the string in <a href="#widl-CompositionEvent-data"><code>CompositionEvent.data</code></a>.
+ </p>
+
+ <p>In <a class="def" href="#glossary-text-composition-system">text composition systems</a> which keep the ongoing composition in sync
+ with the input control, the <a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a> event
+ MUST be dispatched before the control is updated.
+ </p>
+
+ <p>Some <a class="def" href="#glossary-text-composition-system">text composition systems</a> might not expose this information to the DOM,
+ in which case this event will not fire during the composition process.
+ </p>
+
+ <p>If the composition session is canceled, this event will be fired immediately before the
+ <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a> event,
+ and the <a href="#widl-CompositionEvent-data"><code>CompositionEvent.data</code></a> attribute will be set to the
+ <a class="def" href="#glossary-empty-string">empty string</a>.
+ </p>
</dd>
</dl>
</div>
- <!-- keyup -->
+ <!-- compositionend -->
<div class="event-definition">
<dl>
- <dt id="event-type-keyup"><dfn><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></dfn></dt>
+ <dt id="event-type-compositionend"><dfn><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></dfn></dt>
<dd>
<table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
<tr>
<th>Type</th>
- <td><strong><code>keyup</code></strong></td>
+ <td><strong><code>compositionend</code></strong></td>
</tr>
<tr>
<th>Interface</th>
- <td><a href="#interface-KeyboardEvent"><code>KeyboardEvent</code></a></td>
+ <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
</tr>
<tr>
<th>Sync / Async</th>
@@ -5263,7 +6093,7 @@
</tr>
<tr>
<th>Cancelable</th>
- <td>Yes</td>
+ <td>No</td>
</tr>
<tr>
<th>Default action</th>
@@ -5274,814 +6104,34 @@
<td>
<ul>
<li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- focused element processing the key event or if no element focused, then the
- <a href="#glossary-body-element">body element</a> if available, otherwise the
- <a href="#glossary-root-element">root element</a></li>
+ focused element processing the composition</li>
<li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
<a class="def" href="#glossary-window"><code>Window</code></a></li>
<li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
<code>0</code></li>
- <li><a href="#widl-KeyboardEvent-key"><code class="attribute-name">KeyboardEvent.key</code></a>:
- the key value of the key pressed.</li>
- <li><a href="#widl-KeyboardEvent-code"><code class="attribute-name">KeyboardEvent.code</code></a>:
- the code value associated with the key's physical placement on the keyboard.</li>
- <li><a href="#widl-KeyboardEvent-location"><code class="attribute-name">KeyboardEvent.location</code></a>:
- the location of the key on the device.</li>
- <li><a href="#widl-KeyboardEvent-altKey"><code class="attribute-name">KeyboardEvent.altKey</code></a>:
- <code>true</code> if <code class="key">'Alt'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-shiftKey"><code class="attribute-name">KeyboardEvent.shiftKey</code></a>:
- <code>true</code> if <code class="key">'Shift'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-ctrlKey"><code class="attribute-name">KeyboardEvent.ctrlKey</code></a>:
- <code>true</code> if <code class="key">'Control'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-metaKey"><code class="attribute-name">KeyboardEvent.metaKey</code></a>:
- <code>true</code> if <code class="key">'Meta'</code> modifier was active, otherwise <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-repeat"><code class="attribute-name">KeyboardEvent.repeat</code></a>:
- <code>false</code></li>
- <li><a href="#widl-KeyboardEvent-isComposing"><code class="attribute-name">KeyboardEvent.isComposing</code></a>:
- <code>true</code> if the key event occurs as part of a composition session, otherwise <code>false</code></li>
+ <li><a href="#widl-CompositionEvent-data"><code class="attribute-name">CompositionEvent.data</code></a>:
+ the string comprising the final result of the composition session, which MAY be the
+ <a class="def" href="#glossary-empty-string">empty string</a> if the content has been deleted or if the composition process has been canceled</li>
</ul>
</td>
</tr>
</table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a key is released.
- The <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event type is device dependent and relies on the
- capabilities of the input devices and how they are mapped in the operating system.
- This event type MUST be generated after the <a class="def" href="#glossary-key-mapping">key mapping</a>.
- This event type MUST be dispatched after the
- <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>,
- <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a>,
- and <a class="eventtype" href="#event-type-input"><code>input</code></a>
- events associated with the same key.</p>
-
- <p class="note"><strong>Note:</strong> the <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and <a class="eventtype" href="#event-type-keyup">
- <code>keyup</code></a> events are traditionally associated with detecting any key, not just those which produce a <a class="def" href="#glossary-character-value">character
- value</a>.</p>
- </dd>
- </dl>
- </div>
- </section> <!-- events-keyboardevents -->
-
- <section id="events-compositionevents">
- <h3>Composition Event Types</h3>
-
- <p>Composition Events provide a means for inputing text in a supplementary or alternate
- manner than by Keyboard Events, in order to allow the use of characters that
- might not be commonly available on keyboard.
- For example, Composition Events might be used
- to add accents to characters despite their absence from standard US keyboards,
- to build up logograms of many Asian languages from their base components or categories,
- to select word choices from a combination of key presses on a mobile device keyboard,
- or to convert voice commands into text using a speech recognition processor.
- Refer to <a href="#keys">Keyboard events and key values</a> for examples
- on how Composition Events are used in combination with keyboard events.
- </p>
-
- <p>Conceptually, a composition session consists of one
- <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a>
- event, one or more
- <a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a>
- events, and one
- <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>
- event, with the value of the <a href="#widl-CompositionEvent-data"><code>data</code></a>
- attribute persisting between each <q>stage</q> of this event chain during each session.
- </p>
-
- <p class="note"><strong>Note:</strong>
- While a composition session is active, keyboard events can be dispatched to the DOM
- if the keyboard is the input device used with the composition session.
- See the <a href="#event-type-compositionstart"><code>compositionstart</code> event details</a>
- and <a href="#keys-IME">IME section</a> for relevent event ordering.
- </p>
-
- <p>Not all <a class="def" href="#glossary-ime">IME</a> systems or devices expose the necessary
- data to the DOM, so the active composition string (the <q>Reading Window</q>
- or <q>candidate selection menu option</q>) might not be available through this interface,
- in which case the selection MAY be represented by the
- <a class="def" href="#glossary-empty-string">empty string</a>.
- </p>
-
- <section id="interface-CompositionEvent">
- <h4>Interface CompositionEvent</h4>
-
- <p class="intro-dom">Introduced in DOM Level 3</p>
-
- <p>The <code>CompositionEvent</code> interface provides specific contextual information associated with Composition Events.</p>
-
- <p>To create an instance of the <code>CompositionEvent</code> interface, use the <a href="#widl-DocumentEvent-createEvent"><code>DocumentEvent.createEvent("CompositionEvent")</code></a>
- method call.</p>
-
- <dl class="idl" title="[Constructor(DOMString typeArg, optional CompositionEventInit compositionEventInitDict)] interface CompositionEvent : UIEvent">
- <dt>readonly attribute DOMString data</dt>
- <dd>
- <p><code>data</code> holds the value of the characters generated by an input method.
- This MAY be a single Unicode character or a non-empty sequence of Unicode characters
- [<cite><a class="normative" href="#references-Unicode">Unicode</a></cite>].
- Characters SHOULD be normalized as defined by the Unicode normalization form <em>NFC</em>,
- defined in [<cite><a class="normative" href="#references-UnicodeNormalization">UAX #15</a></cite>].
- This attribute MAY be the <a class="def" href="#glossary-empty-string">empty string</a>.
+ <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a
+ <a class="def" href="#glossary-text-composition-system">text composition system</a> completes or cancels the current composition session,
+ and the <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a> event MUST be dispatched after the control is updated.
</p>
- <p>The <a class="def" href="#glossary-un-initialized-value">un-initialized value</a> of this attribute
- MUST be <code>""</code> (the empty string).
- </p>
- </dd>
- </dl>
-
- <dl class="idl" title="dictionary CompositionEventInit : UIEventInit">
- <dt>DOMString data = ""</dt>
- <dd>
- <p>Initializes the <code>data</code> attribute of the CompositionEvent
- object to the characters generated by the IME composition.
+ <p>This event is dispatched immediately after the <a class="def" href="#glossary-text-composition-system">text composition system</a> completes
+ the composition session (e.g., the <a class="def" href="#glossary-ime">IME</a> is closed, minimized, switched out of focus, or otherwise dismissed,
+ and the focus switched back to the <a class="def" href="#glossary-user-agent">user agent</a>).
</p>
</dd>
</dl>
-
- </section> <!-- interface-CompositionEvent -->
-
- <section id="events-composition-event-order">
- <h4>Composition Event Order</h4>
-
- <p>The Composition Events defined in this specification MUST occur in the following set order relative to one another:</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
- <td>Multiple events</td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
- <td></td>
- </tr>
- </table>
- </section> <!-- events-composition-event-order -->
-
- <section id="handwriting">
- <h4>Handwriting Recognition Systems</h4>
- <p>The following example describes a possible sequence of events when composing a text passage <q>text</q> with a handwriting recognition system, such as on a pen
- tablet, as modeled using Composition Events.</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th><a href="#widl-CompositionEvent-data"><code>CompositionEvent<br/>data</code></a></th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
- <td><code>''</code></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td colspan="2"><em>User writes word on tablet surface</em></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
- <td><code>'test'</code></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td colspan="2"><em>User rejects first word-match suggestion, selects different match</em></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
- <td><code>'text'</code></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
- <td><code>'text'</code></td>
- <td></td>
- </tr>
- </table>
- </section> <!-- handwriting -->
-
- <section id="events-composition-event-canceling">
- <h4>Canceling Composition Events</h4>
- <p>If a <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> event is canceled then any
- Composition Events that would have fired as a result of that
- <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> SHOULD not be dispatched:</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
- <td>The <a class="def" href="#glossary-default-action">default action</a> is
- prevented, e.g., by invoking <a href="#widl-Event-preventDefault"><code>Event.preventDefault()</code></a>.
- </td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td><em>No Composition Events are dispatched</em></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
- <td></td>
- </tr>
- </table>
-
- <p>If the initial <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a> event is
- canceled then the text composition session SHOULD be terminated. Regardless of whether or not the composition
- session is terminated, the <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>
- event MUST be sent.</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
- <td>The <a class="def" href="#glossary-default-action">default action</a> is
- prevented, e.g., by invoking <a href="#widl-Event-preventDefault"><code>Event.preventDefault()</code></a>.
- </td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td><em>No Composition Events are dispatched</em></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
- <td></td>
- </tr>
- </table>
- </section> <!-- events-composition-event-canceling -->
-
- <section id="events-composition-event-key-events">
- <h4>Key Events During Composition</h4>
- <p>During the composition session, all <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>
- and <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> events MAY be suppressed.</p>
-
- <section id="events-composition-event-including-key-events">
- <h4>Including Key Events During Composition</h4>
-
- <p>If a <a class="def" href="#glossary-user-agent">user agent</a> does not suppress these events during
- composition, then it MUST set the key event's
- <a href="#widl-KeyboardEvent-isComposing"><code>isComposing</code></a>
- attribute to <code>true</code> for any events that occur during a composition session.
- </p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th class="cell-center"><a href="#widl-KeyboardEvent-isComposing"><code>KeyboardEvent<br/>isComposing</code></a></th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
- <td class="cell-center"><code>false</code></td>
- <td>This is the key event that initiates the composition.</td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
- <td class="cell-center"><code>true</code></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td>...</td>
- <td></td>
- <td>Any key events sent during the composition session MUST have <code>isComposing</code> set to <code>true</code>.</td>
- </tr>
- <tr>
- <td class="cell-number">5.</td>
- <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
- <td class="cell-center"><code>true</code></td>
- <td>This is the key event that exits the composition.</td>
- </tr>
- <tr>
- <td class="cell-number">6.</td>
- <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">7.</td>
- <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
- <td class="cell-center"><code>false</code></td>
- <td></td>
- </tr>
- </table>
-
- </section> <!-- events-composition-event-including-key-events -->
-
- <section id="events-composition-event-suppressing-key-events">
- <h4>Suppressing Key Events During Composition</h4>
-
- <p>If key events are suppressed between
- <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a> and
- <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a>, then the first
- or last key pressed might result in unmatched
- <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and
- <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> events.
- If a <a class="def" href="#glossary-user-agent">user agent</a> suppresses key events during composition,
- then it MUST ensure that all <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and
- <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> events occur in matching pairs.
- </p>
-
- <p>To ensure that the initial <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> has a
- matching <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>, a
- <a class="def" href="#glossary-user-agent">user agent</a> might insert an extra
- <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> to match the
- <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> that initiated a composition session,
- as shown in the following example:
- </p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th class="cell-center"><a href="#widl-KeyboardEvent-isComposing"><code>KeyboardEvent<br/>isComposing</code></a></th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
- <td class="cell-center"><code>false</code></td>
- <td>This is the key event that initiates the composition.</td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">4.</td>
- <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
- <td class="cell-center"><code>true</code></td>
- <td>This event would normally be suppressed because of the ongoing composition session, but it is sent
- to match the previously sent <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a>
- event.</td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td>...</td>
- <td></td>
- <td>Any other key events that occur during the composition session are suppressed.</td>
- </tr>
- <tr>
- <td class="cell-number">5.</td>
- <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
- <td></td>
- <td></td>
- </tr>
- </table>
-
- <p>To ensure that the composition session doesn't end with a dangling
- <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event, a
- <a class="def" href="#glossary-user-agent">user agent</a> can choose either (A) to suppress this
- <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event, or (B) to insert an extra
- <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> event.</p>
-
- <p>An example event sequence where both the
- <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> and
- <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> events have
- been suppressed:</p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th class="cell-center"><a href="#widl-KeyboardEvent-isComposing"><code>KeyboardEvent<br/>isComposing</code></a></th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> for key that exits IME suppressed
- during composition session</em></td>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em>A <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event would normally be sent
- at this time, but it is suppressed to avoid generating an unmatched
- <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a> event.</em></td>
- </tr>
- </table>
-
- <p>An example event sequence where a <a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> has been inserted:
- </p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th class="cell-center"><a href="#widl-KeyboardEvent-isComposing"><code>KeyboardEvent<br/>isComposing</code></a></th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td></td>
- <td><em><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a> for key that exits IME suppressed
- during composition session</em></td>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-keydown"><code>keydown</code></a></td>
- <td class="cell-center"><code>false</code></td>
- <td>This is key event that was suppressed earlier. It is sent now to match the upcoming
- <a class="eventtype" href="#event-type-keyup"><code>keyup</code></a>.</td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-keyup"><code>keyup</code></a></td>
- <td class="cell-center"><code>false</code></td>
- <td></td>
- </tr>
- </table>
-
- </section> <!-- events-composition-event-suppressing-key-events -->
-
- </section> <!-- events-composition-event-key-events -->
-
- <section id="events-composition-event-input-events">
- <h4>Input Events During Composition</h4>
-
- <p>During the composition session, the
- <a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a> MUST be dispatched
- before the <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> and <code>input</code> events are sent.
- </p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td><em>Any DOM updates occur at this point.</em></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
- <td></td>
- </tr>
- </table>
-
- <p class="note"><strong>Note:</strong> Most IMEs do not support canceling updates
- during a composition session.
- </p>
-
- <p>When a composition session is finished, any
- <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a> and
- <a class="eventtype" href="#event-type-input"><code>input</code></a> events MUST be dispatched after the
- <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a> event.
- </p>
-
- <table class="event-sequence-table">
- <tr>
- <td class="cell-number"></td>
- <th>Event Name</th>
- <th>Notes</th>
- </tr>
- <tr>
- <td class="cell-number">1.</td>
- <td><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></td>
- <td></td>
- </tr>
- <tr>
- <td class="cell-number">2.</td>
- <td><a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a></td>
- <td><em>Sent only if we’re about to update the DOM (i.e., the composition was not canceled).
- Canceling this will prevent the DOM update and the
- <a class="eventtype" href="#event-type-input"><code>input</code></a> event.</em></td>
- </tr>
- <tr>
- <td class="cell-number"></td>
- <td></td>
- <td><em>Any DOM updates occur at this point.</em></td>
- </tr>
- <tr>
- <td class="cell-number">3.</td>
- <td><a class="eventtype" href="#event-type-input"><code>input</code></a></td>
- <td><em>Sent only if the DOM was updated.</em></td>
- </tr>
- </table>
-
- <p class="note"><strong>Note:</strong> Some IMEs update the DOM before the
- <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a> event is dispatched.
- In this case, canceling the <a class="eventtype" href="#event-type-beforeinput"><code>beforeinput</code></a>
- event will have no effect (i.e., the <a class="eventtype" href="#event-type-input"><code>input</code></a>
- event will still fire).</p>
-
- </section> <!-- events-composition-event-input-events -->
-
- <section id="events-composition-event-types">
- <h4>Composition Event Types</h4>
- <p>The composition event types are listed below.</p>
-
- <!-- compositionstart -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-compositionstart"><dfn><a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>compositionstart</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>Start a new composition session when a <a class="def" href="#glossary-text-composition-system">text composition system</a> is enabled</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- focused element processing the composition</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-CompositionEvent-data"><code class="attribute-name">CompositionEvent.data</code></a>:
- the original string being edited, otherwise the <a class="def" href="#glossary-empty-string">empty string</a></li>
- </ul>
- </td>
- </tr>
- </table>
-
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a <a class="def" href="#glossary-text-composition-system">text composition
- system</a> is enabled and a new composition session is about to begin (or has begun, depending on the <a class="def" href="#glossary-text-composition-system">text composition
- system</a>) in preparation for composing a passage of text. This event type is device-dependent, and MAY rely upon the capabilities of the text conversion system and how it is
- mapped into the operating system. When a keyboard is used to feed an input method editor, this event type is generated after a <a class="eventtype"><code>keydown</code></a> event,
- but speech or handwriting recognition systems MAY send this event type without keyboard events. Some implementations MAY populate the
- <a href="#widl-CompositionEvent-data"><code>data</code></a> attribute of the <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a> event
- with the text currently selected in the document (for editing and replacement). Otherwise, the value of the <a href="#widl-CompositionEvent-data"><code>data</code></a>
- attribute MUST be the <a class="def" href="#glossary-empty-string">empty string</a>.</p>
-
- <p>This event MUST be dispatched immediately before a <a class="def" href="#glossary-text-composition-system">text composition system</a> begins a new composition session, and
- before the DOM is modified due to the composition process. The default action of this event is for the <a class="def" href="#glossary-text-composition-system">text
- composition system</a> to start a new composition session. If this event is canceled, the <a class="def" href="#glossary-text-composition-system">text composition system</a> SHOULD
- discard the current composition session.</p>
-
- <p class="note"><strong>Note:</strong> Canceling the <a class="eventtype" href="#event-type-compositionstart"><code>compositionstart</code></a> <em>event type</em> is distinct
- from canceling the <a class="def" href="#glossary-text-composition-system">text composition system</a> itself (e.g., by hitting a cancel button or closing an <a class="def"
- href="#glossary-ime">IME</a> window).</p>
-
- <p class="note"><strong>Note:</strong> Some IMEs do not support cancelling an in-progress composition session (e.g., such as GTK which doesn't presently have such an API). In these
- cases, calling <a href="#widl-Event-preventDefault"><code>preventDefault</code></a> will not stop this event's default action.</p>
- </dd>
- </dl>
- </div>
-
- <!-- compositionupdate -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-compositionupdate"><dfn><a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>compositionupdate</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- focused element processing the composition, <code>null</code> if not accessible</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-CompositionEvent-data"><code class="attribute-name">CompositionEvent.data</code></a>:
- the string comprising the current results of the composition session, which MAY be the
- <a class="def" href="#glossary-empty-string">empty string</a> if the content has been deleted</li>
- </ul>
- </td>
- </tr>
- </table>
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> SHOULD dispatch this event during a composition session when a
- <a class="def" href="#glossary-text-composition-system">text composition system</a> updates its active text passage with a
- new character, which is reflected in the string in <a href="#widl-CompositionEvent-data"><code>CompositionEvent.data</code></a>.
- </p>
-
- <p>In <a class="def" href="#glossary-text-composition-system">text composition systems</a> which keep the ongoing composition in sync
- with the input control, the <a class="eventtype" href="#event-type-compositionupdate"><code>compositionupdate</code></a> event
- MUST be dispatched before the control is updated.
- </p>
-
- <p>Some <a class="def" href="#glossary-text-composition-system">text composition systems</a> might not expose this information to the DOM,
- in which case this event will not fire during the composition process.
- </p>
-
- <p>If the composition session is canceled, this event will be fired immediately before the
- <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a> event,
- and the <a href="#widl-CompositionEvent-data"><code>CompositionEvent.data</code></a> attribute will be set to the
- <a class="def" href="#glossary-empty-string">empty string</a>.
- </p>
- </dd>
- </dl>
- </div>
-
- <!-- compositionend -->
- <div class="event-definition">
- <dl>
- <dt id="event-type-compositionend"><dfn><a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a></dfn></dt>
- <dd>
- <table border="0" summary="This table contains information about the semantics of the given event type" cellpadding="2" cellspacing="0">
- <tr>
- <th>Type</th>
- <td><strong><code>compositionend</code></strong></td>
- </tr>
- <tr>
- <th>Interface</th>
- <td><a href="#interface-CompositionEvent"><code>CompositionEvent</code></a></td>
- </tr>
- <tr>
- <th>Sync / Async</th>
- <td>Sync</td>
- </tr>
- <tr>
- <th>Bubbles</th>
- <td>Yes</td>
- </tr>
- <tr>
- <th>Trusted Targets</th>
- <td><code>Element</code></td>
- </tr>
- <tr>
- <th>Cancelable</th>
- <td>No</td>
- </tr>
- <tr>
- <th>Default action</th>
- <td>None</td>
- </tr>
- <tr>
- <th>Context<br/>(trusted events)</th>
- <td>
- <ul>
- <li><a href="#widl-Event-target"><code class="attribute-name">Event.target</code></a>:
- focused element processing the composition</li>
- <li><a href="#widl-UIEvent-view"><code class="attribute-name">UIEvent.view</code></a>:
- <a class="def" href="#glossary-window"><code>Window</code></a></li>
- <li><a href="#widl-UIEvent-detail"><code class="attribute-name">UIEvent.detail</code></a>:
- <code>0</code></li>
- <li><a href="#widl-CompositionEvent-data"><code class="attribute-name">CompositionEvent.data</code></a>:
- the string comprising the final result of the composition session, which MAY be the
- <a class="def" href="#glossary-empty-string">empty string</a> if the content has been deleted or if the composition process has been canceled</li>
- </ul>
- </td>
- </tr>
- </table>
- <p>A <a class="def" href="#glossary-user-agent">user agent</a> MUST dispatch this event when a
- <a class="def" href="#glossary-text-composition-system">text composition system</a> completes or cancels the current composition session,
- and the <a class="eventtype" href="#event-type-compositionend"><code>compositionend</code></a> event MUST be dispatched after the control is updated.
- </p>
-
- <p>This event is dispatched immediately after the <a class="def" href="#glossary-text-composition-system">text composition system</a> completes
- the composition session (e.g., the <a class="def" href="#glossary-ime">IME</a> is closed, minimized, switched out of focus, or otherwise dismissed,
- and the focus switched back to the <a class="def" href="#glossary-user-agent">user agent</a>).
- </p>
- </dd>
- </dl>
- </div>
- </section> <!-- events-composition-event-types -->
- </section> <!-- events-compositionevents -->
-
- </section> <!-- event-definitions -->
-
- </section> <!-- events-module -->
+ </div>
+ </section> <!-- events-composition-event-types -->
+ </section> <!-- events-compositionevents -->
+
+ </section> <!-- event-types -->
<!-- Section 6: Keyboard and key values ========================================================-->
<section id="keys">