moved constants for EventException into interface definition; removed 'optional' keyword from IDL, indicated optional parameters in prose; cleaned up markup
authorschepers
Wed, 25 May 2011 07:56:40 +0900
changeset 324 e12b561d7721
parent 323 8c3422731898
child 325 4edab5c10930
moved constants for EventException into interface definition; removed 'optional' keyword from IDL, indicated optional parameters in prose; cleaned up markup
html/DOM3-Events.html
--- a/html/DOM3-Events.html	Tue May 17 22:19:02 2011 +0900
+++ b/html/DOM3-Events.html	Wed May 25 07:56:40 2011 +0900
@@ -25,16 +25,16 @@
       </p>
       <h1 id="Overview-title">Document Object Model (DOM) Level 3 Events Specification</h1>
 <!-- @-->
-      <h2 id="Overview-W3C-doctype">W3C Editor's Draft <time datetime="2011-05-17">17 May 2011</time></h2>
+      <h2 id="Overview-W3C-doctype">W3C Editor's Draft <time datetime="2011-05-24">24 May 2011</time></h2>
       <dl>
         <dt>This version:</dt>
-        <dd><a href="http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html?rev=1.197">http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html?rev=1.197</a></dd>
+        <dd><a href="http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html?rev=1.198">http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html?rev=1.198</a></dd>
 
         <dt>Latest stable version:</dt>
         <dd><a href="http://www.w3.org/TR/DOM-Level-3-Events">http://www.w3.org/TR/DOM-Level-3-Events</a></dd>
 
         <dt>Previous version:</dt>
-        <dd><a href="http://dev.w3.org/cvsweb/~checkout~/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html?rev=1.196">http://dev.w3.org/cvsweb/~checkout~/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html?rev=1.196</a></dd>
+        <dd><a href="http://dev.w3.org/cvsweb/~checkout~/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html?rev=1.197">http://dev.w3.org/cvsweb/~checkout~/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html?rev=1.197</a></dd>
 
         <dt>Editor's Draft:</dt>
         <dd><a href="http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html">http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html</a></dd>
@@ -1093,10 +1093,10 @@
   // Modified in DOM Level 3:
   void               <a href="#events-EventTarget-addEventListener">addEventListener</a>(in DOMString type, 
                                       in <a href="#events-EventListener">EventListener</a> listener, 
-                                      in boolean useCapture <em>[optional]</em>);
+                                      in boolean useCapture);
   void               <a href="#events-EventTarget-removeEventListener">removeEventListener</a>(in DOMString type, 
                                          in <a href="#events-EventListener">EventListener</a> listener, 
-                                         in boolean useCapture <em>[optional]</em>);
+                                         in boolean useCapture);
   boolean            <a href="#events-EventTarget-dispatchEvent">dispatchEvent</a>(in <a href="#events-Event">Event</a> evt)
                                    raises(<a href="#events-EventException">EventException</a>, 
                                    DOMException);
@@ -1126,17 +1126,15 @@
                             <dd>
                               <p>The <code>listener</code> parameter must be an object which implements the <a href="#events-EventListener"><code>EventListener</code></a> interface, such as a reference to a .</p>
                               
-                              <p>The <code>listener</code> parameter must be either an object that implements the <a href="#events-EventListener"><code>EventListener</code></a> interface, or a function.  If <code>listener</code> is a function then it is used as the callback for the event. Otherwise, if <code>listener</code> implements EventTarget, then its `handleEvent` method
-                              | is used as the callback.
-                              </p>
+                              <p>The <code>listener</code> parameter must be either an object that implements the <a href="#events-EventListener"><code>EventListener</code></a> interface, or a function.  If <code>listener</code> is a function then it must be used as the callback for the event; otherwise, if <code>listener</code> implements <a href="#events-EventTarget"><code>EventTarget</code></a>, then its <a href="#events-EventListener-handleEvent">handleEvent</a> method must be used as the callback.</p>
                               <p>The <code>listener</code> parameter takes an object defined by the author which implements the <a href="#events-EventListener"><code>EventListener</code></a> interface and contains the method to be called when the event occurs.</p>
                               <p class="note" id="addEventListener_function"><strong>Note:</strong>  The <code>listener</code> may be a reference to a function object or an inline function object literal.</p>
                             </dd>
                             
-                            <dt><a id="addEventListener_useCapture"><code class="parameter-name">useCapture</code></a> of type <code>boolean</code>, <em>[optional]</em></dt>
+                            <dt><a id="addEventListener_useCapture"><code class="parameter-name">useCapture</code></a> of type <code>boolean</code></dt>
                             <dd>
                               <p>If true, <code>useCapture</code> indicates that the user wishes to add the event listener for the <a class="def" href="#glossary-capture-phase">capture</a> and <a class="def" href="#glossary-target-phase">target</a> phases only, i.e., this event listener will not be triggered during the <a class="def" href="#glossary-bubbling-phase">bubbling</a> phase.  If <code>false</code>, the event listener must only be triggered during the <a class="def" href="#glossary-target-phase">target</a> and <a class="def" href="#glossary-bubbling-phase">bubbling</a> phases.</p>
-                              <p>If not provided, the <a href="#events-EventTarget-addEventListener">EventTarget.addEventListener</a> method must behave as if <a id="addEventListener_useCapture"><code class="parameter-name">useCapture</code></a> were specified to be <code>false</code>.</p>
+                              <p>This parameter may be optional, on an implementation-specific basis.  If not provided, the <a href="#events-EventTarget-addEventListener">EventTarget.addEventListener</a> method must behave as if <a id="addEventListener_useCapture"><code class="parameter-name">useCapture</code></a> were specified to be <code>false</code>.  See the non-normative <a id="webidl-events-EventTarget" href="#webidl-events-EventTarget">Interface EventTarget</a> WebIDL definition for a formal description.</p>
                               <p class="note" id="addEventListener_useCapture-java"><strong>Note:</strong>  For programming languages which do not allow optional method parameters, such as Java, the implementation may provide two <a href="#events-EventTarget-addEventListener">EventTarget.addEventListener</a> methods, one with 2 parameters, and one with 3 parameters.</p>
                               <p class="note" id="addEventListener_useCapture-author"><strong>Authoring Note:</strong>  The <a id="addEventListener_useCapture"><code class="parameter-name">useCapture</code></a> parameter was required in DOM2 Events [<a href="#references-DOM2Events">DOM2 Events</a>], and omitting this parameter may cause an error in older implementations.</p>
                             </dd>
@@ -1166,10 +1164,10 @@
                             <dd><p>Specifies the <a href="#events-event-type-type"><code>Event.type</code></a> for which the user registered the event listener.</p></dd>
                             <dt><code class="parameter-name">listener</code> of type <a href="#events-EventListener"><code>EventListener</code></a></dt>
                             <dd><p>The <a href="#events-EventListener"><code>EventListener</code></a> to be removed.</p></dd>
-                            <dt><code class="parameter-name">useCapture</code> of type <code>boolean</code>, <em>[optional]</em></dt>
+                            <dt><code class="parameter-name">useCapture</code> of type <code>boolean</code></dt>
                             <dd>
                               <p>Specifies whether the <a href="#events-EventListener"><code>EventListener</code></a> being removed was registered for the capture phase or not. If a listener was registered twice, once for the capture and target phases and once for the target and bubbling phases, each must be removed separately. Removal of an event listener registered for the capture and target phases does not affect the same event listener registered for the target and bubbling phases, and vice versa.</p>
-                              <p>If not provided, the <a href="#events-EventTarget-removeEventListener">EventTarget.removeEventListener</a> method must behave as if <a id="removeEventListener_useCapture"><code class="parameter-name">useCapture</code></a> were specified to be <code>false</code>, including the removal of event listeners which had an <a href="#events-EventTarget-addEventListener">EventTarget.addEventListener</a> <a id="addEventListener_useCapture"><code class="parameter-name">useCapture</code></a> value of <code>false</code>.</p>
+                              <p>This parameter may be optional, on an implementation-specific basis.  If not provided, the <a href="#events-EventTarget-removeEventListener">EventTarget.removeEventListener</a> method must behave as if <a id="removeEventListener_useCapture"><code class="parameter-name">useCapture</code></a> were specified to be <code>false</code>, including the removal of event listeners which had an <a href="#events-EventTarget-addEventListener">EventTarget.addEventListener</a> <a id="addEventListener_useCapture"><code class="parameter-name">useCapture</code></a> value of <code>false</code>.  See the non-normative <a id="webidl-events-EventTarget" href="#webidl-events-EventTarget">Interface EventTarget</a> WebIDL definition for a formal description</p>
                               <p class="note" id="removeEventListener_useCapture-java"><strong>Note:</strong>  For programming languages which do not allow optional method parameters, such as Java, the implementation may provide two <a href="#events-EventTarget-removeEventListener">EventTarget.removeEventListener</a> methods, one with 2 parameters, and one with 3 parameters.</p>
                               <p class="note" id="removeEventListener_useCapture-author"><strong>Authoring Note:</strong>  The <a id="removeEventListener_useCapture"><code class="parameter-name">useCapture</code></a> parameter was required in DOM2 Events [<a href="#references-DOM2Events">DOM2 Events</a>], and omitting this parameter may cause an error in older implementations.</p>
                             </dd>
@@ -1284,13 +1282,14 @@
                 <pre class="idl" id="idl-interface-EventException"><code>
 // Introduced in DOM Level 2:
 exception <a href="#events-EventException">EventException</a> {
-  unsigned short          code;
+  // EventExceptionCode
+  const unsigned short      <a href="#events-UNSPECIFIED_EVENT_TYPE_ERR">UNSPECIFIED_EVENT_TYPE_ERR</a>     = 0;
+  // Introduced in DOM Level 3:
+  const unsigned short      <a href="#events-DISPATCH_REQUEST_ERR">DISPATCH_REQUEST_ERR</a>           = 1;
+
+  // Introduced in DOM Level 2:
+  unsigned short            code;
 };
-
-// EventExceptionCode
-const unsigned short      <a href="#events-UNSPECIFIED_EVENT_TYPE_ERR">UNSPECIFIED_EVENT_TYPE_ERR</a>     = 0;
-// Introduced in DOM Level 3:
-const unsigned short      <a href="#events-DISPATCH_REQUEST_ERR">DISPATCH_REQUEST_ERR</a>           = 1;
                 </code></pre>
               </dd>