/[suikacvs]/markup/xml/domdtdef/domdtdef-work.en.html
Suika

Diff of /markup/xml/domdtdef/domdtdef-work.en.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.2 by wakaba, Sun Dec 2 04:25:43 2007 UTC revision 1.9 by wakaba, Sun Dec 2 10:44:42 2007 UTC
# Line 3  Line 3 
3  <head>  <head>
4  <title>DOM Document Type Definition Module</title>  <title>DOM Document Type Definition Module</title>
5  <link rel="stylesheet" href="http://suika.fam.cx/www/style/html/spec">  <link rel="stylesheet" href="http://suika.fam.cx/www/style/html/spec">
6    <link rel="stylesheet" href="http://suika.fam.cx/www/style/def/dom">
7  <link rel="license" href="http://suika.fam.cx/c/gnu/fdl">  <link rel="license" href="http://suika.fam.cx/c/gnu/fdl">
8  </head>  </head>
9  <body class="has-abstract">  <body class="has-abstract">
# Line 83  normative version.</p> Line 84  normative version.</p>
84  <p>This is a work-in-progress specification for DOM Document Type  <p>This is a work-in-progress specification for DOM Document Type
85  Definition module, as implemented by manakai and  Definition module, as implemented by manakai and
86  <a href="http://suika.fam.cx/gate/2005/sw/DOM%20XML%20Document%20Type%20Definition">partially documented in the SuikaWiki</a>.</p>  <a href="http://suika.fam.cx/gate/2005/sw/DOM%20XML%20Document%20Type%20Definition">partially documented in the SuikaWiki</a>.</p>
   
 <p>...</p>  
87  </div>  </div>
88    
89    <p>The <dfn id=term-dom-dtdef><abbr>DOM</abbr> Document Type Definition</dfn>
90    module is a set of <abbr>DOM</abbr> interfaces, including both new
91    interfaces and modifications to existing <abbr>DOM</abbr> interfaces,
92    over which <abbr>DOM</abbr> applications are able to access to the
93    definitions of the document type.</p>
94    
95    <p>Interfaces defined in this specification are partially modeled from
96    early drafts of <abbr>DOM</abbr> level 1 <span class=ed>@@ ref</span>,
97    <abbr>DOM</abbr> Abstract Schema level 3 <span class=ed>@@ ref</span>, and
98    <abbr>XML</abbr> Schema <abbr>API</abbr>, but are not compatible with
99    any of them as a whole.</p>
100  </div>  </div>
101    
102  <div class="section" id="terminology">  <div class="section" id="terminology">
# Line 110  else in this specification is normative. Line 120  else in this specification is normative.
120  <p><span class=ed>Algorithm is normative but non-normative</span>.  <p><span class=ed>Algorithm is normative but non-normative</span>.
121  In addition, the order in which <a href="#errors">errors</a> are  In addition, the order in which <a href="#errors">errors</a> are
122  raised is undefined.</p>  raised is undefined.</p>
123    
124    <p class=ed><var>A</var> object is an object implementing <var>A</var>
125    interface.</p>
126    
127    <p class=ed>@@ ref to DOM Binding Spec</p>
128  </div>  </div>
129    
130    <div class=section id=dom-dtdef>
131    <h2><abbr>DOM</abbr> Document Type Definition Module</h2>
132    
133    <p>The <abbr>DOM</abbr> Document Type Definition module, version 3.0,
134    consists of three interfaces:</p>
135    <ul>
136    <li><a href="#DocumentXDoctype"><code>DocumentXDoctype</code></a></li>
137    <li><a href="#DocumentTypeDefinition"><code>DocumentTypeDefinition</code></a></li>
138    <li><a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a></li>
139    <li><a href="#AttributeDefinition"><code>AttributeDefinition</code></a></li>
140    </ul>
141    
142    <p>In addition, it adds methods, attributes, and/or constants to interfaces
143    <a href="#Node"><code>Node</code></a>,
144    <a href="#Entity"><code>Entity</code></a>,
145    <a href="#EntityReference"><code>EntityReference</code></a>, and
146    <a href="#Notation"><code>Notation</code></a>.
147    It modifies semantics of some of methods and attributes in
148    <a href="#Node"><code>Node</code></a> and
149    <a href="#ProcessingInstruction"><code>ProcessingInstruction</code></a>
150    interfaces, for the support of new interfaces.</p>
151    
152    <div class=section id=features>
153    <h3>Feature Name</h3>
154    
155    <p>In a <abbr>DOM</abbr> implementation that supports the version 3.0 of
156    the <abbr>DOM</abbr> Document Type Definition module, the
157    <code>hasFeature</code> method of a <code>DOMImplementation</code> object
158    <em class=rfc2119>MUST</em> return <code>true</code> when the parameters are
159    set to <code>http://suika.fam.cx/www/2006/feature/XDoctype</code> and
160    <code>3.0</code> respectively.</p>
161    
162    <p>In such an implementation, the <code>getFeature</code> method of a
163    <code>Document</code> object <em class=rfc2119>MUST</em> return the (at least
164    conceptually) same object implementing the
165    <a href="#DocumentXDoctype"><code>DocumentXDoctype</code></a> interface when
166    the parameters are set to
167    <code>http://suika.fam.cx/www/2006/feature/XDoctype</code> and
168    <code>3.0</code> respectively.  Likewise, any method that takes one or more
169    feature names with or without version number, including the methods
170    <code>hasFeature</code> and <code>getFeature</code>,
171    <em class=rfc2119>MUST</em> behave in a manner consistent with the
172    aforementioned cases.</p>
173    </div>
174    
175    <div class=section id=section-documentxdoctype>
176    <h3>The <code>DocumentXDoctype</code> Interface</h3>
177    
178    <pre class=idl><code>interface <dfn id=DocumentXDoctype><code>DocumentXDoctype</code></dfn> {
179      DocumentType <a href="#createDocumentTypeDefinition">createDocumentTypeDefinition</a>
180        (in DOMString <a href="#createDocumentTypeDefinition-name"><var>name</var></a>)
181        raises (DOMException);
182      ElementTypeDefinition <a href="#createElementTypeDefinition">createElementTypeDefinition</a>
183        (in DOMString <a href="#createElementTypeDefinition-name"><var>name</var></a>)
184        raises (DOMException);
185      AttributeDefinition <a href="#createAttributeDefinition">createAttributeDefinition</a>
186        (in DOMString <a href="#createAttributeDefinition-name"><var>name</var></a>)
187        raises (DOMException);
188      Entity <a href="#createGeneralEntity">createGeneralEntityDefinition</a>
189        (in DOMString <a href="#createGeneralEntity-name"><var>name</var></a>)
190        raises (DOMException);
191      Notation <a href="#createNotation">createNotation</a>
192        (in DOMString <a href="#createNotation-name"><var>name</var></a>)
193        raises (DOMException);
194    }</code></pre>
195    
196    <div class=ed>@@ cast definition</div>
197    
198    <dl>
199    <dt><dfn id=createDocumentTypeDefinition class=dom-method><code>createDocumentTypeDefinition</code></dfn>,
200    method</dt>
201      <dd>
202        <p>This method creates a <code>DocumentType</code> node with the specified
203        name, belonging to the document.</p>
204        <p>The <dfn id=createDocumentTypeDefinition-name class=dom-param><var>name</var></dfn>
205        parameter is the name of the document type.</p>
206    
207        <p>When invoked, the method <em class=rfc2119>MUST</em> create and
208        return a <code>DocumentType</code> node with the following attributes:</p>
209        <dl>
210        <dt><code>attributes</code>, <code>parentNode</code></dt>
211          <dd><code>null</code>.</dd>
212        <dt><code>elementTypes</code>, <code>generalEntities</code>, and
213        <code>notations</code></dt>
214          <dd>Empty <code>NamedNodeMap</code> objects.</dd>
215        <dt><code>entities</code></dt>
216          <dd>The same value as the <code>generalEntities</code> attribute.</dd>
217        <dt><code>childNodes</code></dt>
218          <dd>An empty <code>NodeList</code> object.</dd>
219        <dt><code>internalSubset</code>, <code>publicId</code>, and
220        <code>systemId</code></dt>
221          <dd>Empty strings.</dd>
222        <dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt>
223          <dd><code>false</code>.</dd>
224        <dt><code>nodeName</code></dt>
225          <dd><a href="#createDocumentTypeDefinition-name"><var>name</var></a>.</dd>
226        <dt><code>ownerDocument</code></dt>
227          <dd>The <code>Document</code> over which the method is invoked.</dd>
228        </dl>
229        <p>In addition, the method <em class=rfc2119>MUST</em> be marked as
230        containing five general entity declarations: <code>amp</code>,
231        <code>lt</code>, <code>gt</code>, <code>quot</code>, and
232        <code>apos</code>.</p>
233      </dd>
234    <dt><dfn id=createElementTypeDefinition class=dom-method><code>createElementTypeDefinition</code></dfn>,
235    method</dt>
236      <dd>
237        <p>This method creates a <code>ElementTypeDefinition</code> node with the
238        specified name, belonging to the document.</p>
239        <p>The <dfn id=createElementTypeDefinition-name class=dom-param><var>name</var></dfn>
240        parameter is the name of the element type defined by the element
241        type definition.</p>
242    
243        <p>When invoked, the method <em class=rfc2119>MUST</em> create and
244        return an
245        <a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a>
246        node with the following attributes:</p>
247        <dl>
248        <dt><a href="#attributeDefinitions"><code>attributeDefinitions</code></a></dt>
249          <dd>An empty <code>NamedNodeMap</code> object.</dd>
250        <dt><code>attributes</code>, <code>parentNode</code></dt>
251          <dd><code>null</code>.</dd>
252        <dt><code>childNodes</code></dt>
253          <dd>An empty <code>NodeList</code> object.</dd>
254        <dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt>
255          <dd><code>false</code>.</dd>
256        <dt><code>nodeName</code></dt>
257          <dd><a href="#createElementTypeDefinition-name"><var>name</var></a>.</dd>
258        <dt><code>ownerDocument</code></dt>
259          <dd>The <code>Document</code> node over which the method is invoked.</dd>
260        <dt><a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a></dt>
261          <dd><code>null</code>.</dd>
262        <dt class=ed>@@ Ensure all attributes are defined</dt>
263        </dl>
264      </dd>
265    <dt><dfn id=createAttributeDefinition class=dom-method><code>createAttributeDefinition</code></dfn>,
266    method</dt>
267      <dd>
268        <p>This method creates a <code>AttributeDefinition</code> node with the
269        specified name, belonging to the document.</p>
270        <p>The <dfn id=createAttributeDefinition-name class=dom-param><var>name</var></dfn>
271        parameter is the name of the attribute defined by the attribute
272        definition.</p>
273    
274        <p>When invoked, the method <em class=rfc2119>MUST</em> create and
275        return an
276        <a href="#AttributeDefinition"><code>AttributeDefinition</code></a>
277        node with the following attributes:</p>
278        <dl>
279        <dt><code>allowedTokens</code></dt>
280          <dd>An empty <code>DOMStringList</code> object.</dd>
281        <dt><code>attributes</code>,
282        <a href="#ownerElementTypeDefinition"><code>ownerElementTypeDefinition</code></a>,
283        and <code>parentNode</code></dt>
284          <dd><code>null</code>.</dd>
285        <dt><code>childNodes</code></dt>
286          <dd>An empty <code>NodeList</code> object.</dd>
287        <dt><code>declaredType</code></dt>
288          <dd><a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a>.</dd>
289        <dt><code>defaultType</code></dt>
290          <dd><a href="#UNKNOWN_DEFAULT"><code>UNKNOWN_DEFAULT</code></a>.</dd>
291        <dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt>
292          <dd><code>false</code>.</dd>
293        <dt><code>nodeName</code></dt>
294          <dd><a href="#createAttributeDefinition-name"><var>name</var></a>.</dd>
295        <dt><code>ownerDocument</code></dt>
296          <dd>The <code>Document</code> node over which the method is invoked.</dd>
297        <dt class=ed>@@ Ensure all attributes are defined</dt>
298        </dl>
299    
300        <div class=ed>
301        <p>@@ Should we keep these statements?:
302    However, if the &lt;cfg::cfg|xml-id> configuration
303    parameter is set to <code>true</code> and the <var>name</var>
304    is <code>xml:id</code>, then the [CODE(DOMa)@en[[[declaredType]]]]
305    attribute is set to <code>ID_ATTR</code>.
306    [CODE(DOMa)@en[[[defaultType]]]]?</p>
307        </div>
308      </dd>
309    <dt><dfn id=createGeneralEntity class=dom-method><code>createGeneralEntity</code></dfn>,
310    method</dt>
311      <dd>
312        <p>This method creates a <a href="#Entity"><code>Entity</code></a> node
313        with the specified name, which represents a general entity, belonging to
314        the document.</p>
315        <p>The <dfn id=createGeneralEntity-name class=dom-param><var>name</var></dfn>
316        parameter is the name of the general entity.</p>
317    
318        <p>When invoked, the method <em class=rfc2119>MUST</em> create and return
319        an <a href="#Entity"><code>Entity</code></a> node with the following
320        attributes:</p>
321        <dl>
322        <dt><code>attributes</code>, <code>notationName</code>,
323        <a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a>,
324        and <code>parentNode</code></dt>
325          <dd><code>null</code>.</dd>
326        <dt><code>childNodes</code></dt>
327          <dd>An empty <code>NodeList</code> object.</dd>
328        <dt><code>manakaiDeclarationBaseURI</code>,
329        <code>manakaiEntityBaseURI</code>, and
330        <code>manakaiEntityURI</code> <span class=ed>@@ ref</span></dt>
331          <dd>No explicit value is set.</dd>
332        <dt><code>manakaiHasReplacementTree</code> and
333        <code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt>
334          <dd><code>false</code>.</dd>
335        <dt><code>nodeName</code></dt>
336          <dd><a href="#createGeneralEntity-name"><var>name</var></a>.</dd>
337          <dd>
338            <div class="note memo">
339              <p>It is not an error for
340              <a href="#createGeneralEntity-name"><var>name</var></a> matching
341              to the name of one of predefined general parsed entities in
342              <abbr>XML</abbr> or <abbr>HTML</abbr>.  For example,
343              <a href="#createGeneralEntity-name"><var>name</var></a> might be
344              <code>amp</code>, resulting in an
345              <a href="#Entity"><code>Entity</code></a> node
346              with its <code>nodeName</code> attribute set to <code>amp</code>.</p>
347            </div>
348          </dd>
349        <dt><code>ownerDocument</code></dt>
350          <dd>The <code>Document</code> node over which the method is invoked.</dd>
351        <dt><code>publicId</code>, and <code>systemId</code></dt>
352          <dd><code>null</code>.</dd>
353          <dd class=ed>@@ publicId and systemId should be empty string?</dd>
354        <dt class=ed>@@ Ensure all attributes are defined</dd>
355        </dl>
356      </dd>
357    <dt><dfn id=createNotation class=dom-method><code>createNotation</code></dfn>,
358    method</dt>
359      <dd>
360        <p>This method creates a <code>Notation</code> node with the
361        specified name, belonging to the document.</p>
362        <p>The <dfn id=createNotation-name class=dom-param><var>name</var></dfn>
363        parameter is the name of the notation.</p>
364    
365        <p>When invoked, the method <em class=rfc2119>MUST</em> create and return
366        a <code>Notation</code> node with the following attributes:</p>
367        <dl>
368        <dt><code>attributes</code>,
369        <a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a>,
370        and <code>parentNode</code></dt>
371          <dd><code>null</code>.</dd>
372        <dt><code>childNodes</code></dt>
373          <dd>An empty <code>NodeList</code> object.</dd>
374        <dt><code>manakaiDeclarationBaseURI</code></dt>
375          <dd>No explicit value is set.</dd>
376        <dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt>
377          <dd><code>false</code>.</dd>
378        <dt><code>nodeName</code></dt>
379          <dd><a href="#createNotation-name"><var>name</var></a>.</dd>
380        <dt><code>ownerDocument</code></dt>
381          <dd>The <code>Document</code> node over which the method is invoked.</dd>
382        <dt><code>publicId</code> and <code>systemId</code></dt>
383          <dd><code>null</code>.</dd>
384          <dd class=ed>@@ publicId and systemId should be empty string?</dd>
385        <dt class=ed>@@ Ensure all attributes are defined</dt>
386        </dl>
387      </dd>
388    </dl>
389    
390    <p>These methods <em class=rfc2119>MUST</em> raise an
391    <code>INVALID_CHARACTER_ERR</code> exception <span class=ed>@@ ref</span>
392    if <var>name</var> is <em>not</em> a legal <code>Name</code> according to
393    the <abbr>XML</abbr> version in use, as specified in the
394    <code>xmlVersion</code> attribute of the <code>Document</code> node.</p>
395    
396    <div class="note memo">
397    <p>Non$B!>(B<abbr>XML</abbr> case is intentionally left unspecified for now,
398    since <abbr>DOM3</abbr> specification <span class=ed>@@ ref</span> does not
399    define it for <code>Document</code> methods.</p>
400    
401    <p><var>name</var> does not have to be a namespace qualified name.</p>
402    
403    <p>If the <code>strictErrorChecking</code> attribute of the
404    <code>Document</code> node is <code>false</code>, the methods are
405    not required to raise the exception <span class=ed>[DOM3]</span>.</p>
406    </div>
407    
408    </div>
409    
410    <div class=section id=section-documenttypedefinition>
411    <h3>The <code>DocumentTypeDefinition</code> Interface</h3>
412    
413    <pre class=idl><code>interface <dfn id=DocumentTypeDefinition><code>DocumentTypeDefinition</code></dfn> {
414      readonly attribute NamedNodeMap <a href="#elementTypes">elementTypes</a>;
415      readonly attribute NamedNodeMap <a href="#generalEntities">generalEntities</a>;
416      readonly attribute NamedNodeMap <a href="#notations">notations</a>;
417    
418      <span class=ed>more members come here...</span>
419    }</code></pre>
420    
421    <pre class=ed>
422    [1] In an implementation that supports the
423    [CODE(URI)@en[[[http://suika.fam.cx/www/2006/feature/XDoctype]]]]
424    feature, a [CODE(DOMi)@en[[[DocumentType]]]] node
425    must implement the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]]
426    interface.  See [[DOM XML Document Type Definition]>>3] for
427    details.
428    </pre>
429    
430    <dl>
431    <dt><dfn id=elementTypes class=dom-attr><code>elementTypes</code></dfn> of
432    type <code>NamedNodeMap</code>, read$B!>(Bonly</dt>
433      <dd><p>A live <code>NamedNodeMap</code> object that contains all the element
434      type definitions belonging to the <code>DocumentType</code> node.</p>
435    
436      <p>On getting, the attribute <em class=rfc2119>MUST</em> return the
437      <code>NamedNodeMap</code> object that contains all the
438      <a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a>
439      nodes belonging to the <code>DocumentType</code> node.  The
440      <code>NamedNodeMap</code> object <em class=rfc2119>MUST</em> be read$B!>(Bonly
441      if and only if the node is read$B!>(Bonly.  The <code>NamedNodeMap</code>
442      object <em class=rfc2119>MUST</em> be live and the same object
443      <em class=rfc2119>MUST</em> be returned for any invocation.</p>
444    
445      <p>If the <code>DocumentType</code> node is created during the process
446      to create a <abbr>DOM</abbr> from an <abbr>XML</abbr> document, the following
447      requirements are applied:  The <code>NamedNodeMap</code> object in the
448      <a href="#elementTypes"><code>elementType</code></a> attribute
449      <em class=rfc2119>MUST</em> be so transformed that the object contains
450      the <code>ElementTypeDefinition</code> nodes for the element types
451      whose name is presented as the <code>Name</code> of the element type or
452      attribute definition list declarations processed by the <abbr>XML</abbr>
453      processor.  If there is more than one element type declarations for an
454      element type, then the declarations other than the first one
455      <em class=rfc2119>MUST</em> be ignored for the purpose of constructing the
456      <code>NamedNodeMap</code> object.</p></dd>
457    <dt><dfn id=generalEntities class=dom-attr><code>generalEntities</code></dfn>
458    of type <code>NamedNodeMap</code>, read$B!>(Bonly</dt>
459      <dd><p>A live <code>NamedNodeMap</code> object that contains all the general
460      entities belonging to the <code>DocumentType</code> node.</p>
461      
462      <p>On getting, the attribute <em class=rfc2119>MUST</em> return the
463      same value as the <code>entities</code> attribute (defined in the
464      <code>DocumentType</code> interface) of the same node.</p>
465    
466      <div class="note memo">
467        <p>This attribute is part of the interface for historical reason.</p>
468      </div></dd>
469    <!--
470    All entities declared in the document type definition
471    contained in or referenced from the document entity
472    might not be exposed through this collection, depending
473    on the information provided by the XML processor for
474    the DOM implementation.  In particular, it might not
475    contain any entity if entity references are expanded
476    at the parse time.  An implementation [['''MUST NOT''']]
477    expose an [CODE(DOMi)@en[[[Entity]]]] node whose [CODE(DOMa)@en[[[nodeName]]]]
478    is equal to the name of one of five predefined general entities in
479    XML through the collection as the result of parsing of an XML
480    document that has no error.  Duplicate entity declarations are also discarded.
481    
482    The attribute [['''MUST''']] return the [CODE(DOMi)@en[[[NamedNodeMap]]]]
483    object that contains all the [CODE(DOMi)@en[[[Entity]]]] nodes
484    representing general entities belong to the node.  The returned
485    [CODE(DOMi)@en[[[NamedNodeMap]]]] object [['''MUST''']] be read-only if and only if
486    the node is read-only. Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live
487    and therefore any change of read-only flag on the node is immediately
488    reflected by that of the object.
489    -->
490    <dt><dfn id=notations class=dom-attr><code>notations</code></dfn> of type
491    <code>notations</code>, read$B!>(Bonly</code>
492      <dd><p>A live <code>NamedNodeMap</code> object that contains all the
493      notations belonging to the <code>DocumentType</code> node.</p>
494      
495      <p>On getting, the attribute <em class=rfc2119>MUST</em> return the
496      same value as the <code>notations</code> attribute (defined in the
497      <code>DocumentType</code> interface) of the same node.</p>
498    
499      <div class="note memo">
500        <p>This attribute is part of the interface for historical reason.</p>
501        <p>Implementations are not required to implement the
502        <code>notations</code> attribute twice (for <code>DocumentType</code>
503        and <code>DocumentTypeDefinition</code> interfaces); they share exactly
504        same definition.</p>
505      </div></dd>
506    <!--
507    If the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] node is
508    created from an XML document, duplicate notation declarations, if any, in DTD
509    [['''MUST NOT''']] result in a node in the [CODE(DOMi)@en[[[NamedNodeMap]]]]
510    object and only the first declaration [['''MUST''']] be
511    made available as a [CODE(DOMi)@en[[[Notation]]]] node.
512    
513    ;; This definition is based on one for the
514    [CODE(DOMa)@en[[[notations]]]] attribute of the
515    [CODE(DOMi)@en[[[DocumentType]]]] interface in DOM XML module.
516    Since duplication is violation to the Validity Constraint,
517    XML parsers might vary on how notations are notified to
518    the application.  In particular, [CODE(InfoProp)@en[[[notations]]]]
519    property of the document information item in XML Information Set
520    is so defined that in case ''any'' notation is declared for
521    multiple times then the property has no value.
522    
523    The attribute [['''MUST''']] return the [CODE(DOMi)@en[[[NamedNodeMap]]]]
524    object that contains all the [CODE(DOMi)@en[[[Notation]]]] nodes
525    representing notations belong to the node.  The returned
526    [CODE(DOMi)@en[[[NamedNodeMap]]]] object [['''MUST''']] be read-only if and only if
527    the node is read-only. Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live
528    and therefore any change of read-only flag on the node is immediately
529    reflected by that of the object.
530    -->
531    
532    <dt class=ed>@@ other members...
533    </dl>
534    
535    <div class=ed>
536    <p>A future version of this interface might define the
537    <code>parameterEntities</code> and getter/setter for parameter entities.
538    </div>
539    
540    </div>
541    
542    <div class=section id=section-elementtypedefinition>
543    <h3>The <code>ElementTypeDefinition</code> Interface</h3>
544    
545    <pre class=idl><code>interface <dfn id=ElementTypeDefinition><code>ElementTypeDefinition</code></dfn> {
546      
547    }</code></pre>
548    
549    <pre class=ed>** Modifications to [CODE(DOMi)@en[[[Node]]]] members
550    
551    [3] The getter of the [CODE(DOMa)@en[[[attributes]]]] attribute
552    of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object
553    [['''MUST''']] return [CODE(IDL)@en[[[null]]]].
554    
555    [4] The getter of the [CODE(DOMa)@en[[[baseURI]]]] attribute
556    of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object
557    [['''MUST''']] return the [CODE(DOMa)@en[[[baseURI]]]]
558    of the [CDOE(DOMa)@en[[[ownerDocument]]]] of the
559    [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object.
560    Note that it might be [CODE(IDL)@en[[[null]]]].
561    
562    [1] The getter of the [CODE(DOMa)@en[[[nodeName]]]] attribute
563    of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object
564    [['''MUST''']] return the name of the element type.
565    
566    [2] The getters of the [CODE(DOMa)@en[[[nodeValue]]]]
567    and [CODE(DOMa)@en[[[textContent]]]] attributes
568    of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]]
569    object [['''MUST''']] return [CODE(IDL)@en[[[null]]]].
570    
571    ;; Thus, the setter of these attributes do nothing.
572    
573    The setter of the [CODE(DOMa)@en[[[textContent]]]]
574    attribute of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]]
575    object [['''MUST NOT''']] throw a
576    [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]].
577    
578    ** The [CODE(DOMi)@en[ElementTypeDefinition]] Interface
579    
580    [5] The
581    [DFN@en[[CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]] attribute]]
582    of the [CODE(DOMi)@en[[[ElementTypeDefinition]]]]
583    interface is defined in [[manakai//DOM Extensions]>>50].</pre>
584    </div>
585    
586    <div class=section id=section-attributedefinition>
587    <h3>The <code>AttributeDefinition</code> Interface</h3>
588    
589    <pre class=idl><code>interface <dfn id=AttributeDefinition><code>AttributeDefinition</code></dfn> {
590      <span class=comment>// <a href="#DeclaredValueType">DeclaredValueType</a></span>
591      const unsigned short <a href="#NO_TYPE_ATTR">NO_TYPE_ATTR</a> = 0;
592      const unsigned short <a href="#CDATA_ATTR">CDATA_ATTR</a> = 1;
593      const unsigned short <a href="#ID_ATTR">ID_ATTR</a> = 2;
594      const unsigned short <a href="#IDREF_ATTR">IDREF_ATTR</a> = 3;
595      const unsigned short <a href="#IDREFS_ATTR">IDREFS_ATTR</a> = 4;
596      const unsigned short <a href="#ENTITY_ATTR">ENTITY_ATTR</a> = 5;
597      const unsigned short <a href="#ENTITIES_ATTR">ENTITIES_ATTR</a> = 6;
598      const unsigned short <a href="#NMTOKEN_ATTR">NMTOKEN_ATTR</a> = 7;
599      const unsigned short <a href="#NMTOKENS_ATTR">NMTOKENS_ATTR</a> = 8;
600      const unsigned short <a href="#NOTATION_ATTR">NOTATION_ATTR</a> = 9;
601      const unsigned short <a href="#ENUMERATION_ATTR">ENUMERATION_ATTR</a> = 10;
602      const unsigned short <a href="#UNKNOWN_ATTR">UNKNOWN_ATTR</a> = 11;
603      
604      <span class=ed>...</span>
605    }</code></pre>
606    
607    <pre class=ed>** Modifications to [CODE(DOMi)@en[[[Node]]]] members
608    
609    [3] The getter of the [CODE(DOMa)@en[[[attributes]]]] attribute
610    of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object
611    [['''MUST''']] return [CODE(IDL)@en[[[null]]]].
612    
613    [9] The getter of the [CODE(DOMa)@en[[[baseURI]]]] attribute
614    of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object
615    [['''MUST''']] return the [CODE(DOMa)@en[[[baseURI]]]]
616    of the [CDOE(DOMa)@en[[[ownerDocument]]]] of the
617    [CODE(DOMi)@en[[[AttributeDefinition]]]] object.
618    Note that it might be [CODE(IDL)@en[[[null]]]].
619    
620    [1] The getter of the [CODE(DOMa)@en[[[nodeName]]]] attribute
621    of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object
622    [['''MUST''']] return the name of the attribute.
623    
624    [2] The getter of the [CODE(DOMa)@en[[[nodeValue]]]] attribute
625    of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object
626    [['''MUST''']] return the normalized default value
627    of the attribute.
628    
629    @@
630    
631    [4] The getter of the [CODE(DOMa)@en[[[textContent]]]]
632    attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]]
633    object [['''MUST''']] behave as if it were an
634    [CODE(DOMi)@en[[[Attr]]]] object.
635    
636    The setter of the [CODE(DOMa)@en[[[textContent]]]] attribute
637    of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object
638    [['''MUST''']] behave as if the following algorithm
639    is performed:
640    = If the [CODE(DOMi)@en[[[AttributeDefinition]]]]
641    object is read-only, then throw an
642    [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]].
643    = Remove any child node the node has.
644    = If the new value is not empty and not [CODE(IDL)@en[[[null]]]],
645    then create a [CODE(DOMi)@en[[[Text]]]] node
646    whose [CODE(DOMa)@en[[[data]]]] is the new value
647    and append it to the [CODE(DOMi)@en[[[AttributeDefinition]]]].
648    </pre>
649    
650    <p>The definition group
651    <dfn id=DeclaredValueType><code>DeclaredValueType</code></dfn> contains
652    integers indicating the declared type of attributes.</p>
653    
654    <table>
655    <thead>
656    <tr><th scope=col>Name<th scope=col>Value<th scope=col>Description</tr>
657    </thead>
658    <tbody>
659    <tr>
660    <th scope=row><dfn id=NO_TYPE_ATTR class=dom-const><code>NO_TYPE_ATTR</code>
661    <td><code>0</code><td>No value <span class=ed>[INFOSET]</span>.</tr>
662    <tr>
663    <th scope=row><dfn id=CDATA_ATTR class=dom-const><code>CDATA_ATTR</code>
664    <td><code>1</code><td><code>CDATA</code> <span class=ed>[XML]</span>.</tr>
665    <tr>
666    <th scope=row><dfn id=ID_ATTR class=dom-const><code>ID_ATTR</code>
667    <td><code>2</code><td><code>ID</code> <span class=ed>[XML]</span>.</tr>
668    <tr>
669    <th scope=row><dfn id=IDREF_ATTR class=dom-const><code>IDREF_ATTR</code>
670    <td><code>3</code><td><code>IDREF</code> <span class=ed>[XML]</span>.</tr>
671    <tr>
672    <th scope=row><dfn id=IDREFS_ATTR class=dom-const><code>IDREFS_ATTR</code>
673    <td><code>4</code><td><code>IDREFS</code> <span class=ed>[XML]</span>.</tr>
674    <tr>
675    <th scope=row><dfn id=ENTITY_ATTR class=dom-const><code>ENTITY_ATTR</code>
676    <td><code>5</code><td><code>ENTITY</code> <span class=ed>[XML]</span>.</tr>
677    <tr>
678    <th scope=row><dfn id=ENTITIES_ATTR class=dom-const><code>ENTITIES_ATTR</code>
679    <td><code>6</code><td><code>ENTITIES</code> <span class=ed>[XML]</span>.</tr>
680    <tr>
681    <th scope=row><dfn id=NMTOKEN_ATTR class=dom-const><code>NMTOKEN_ATTR</code>
682    <td><code>7</code><td><code>NMTOKEN</code> <span class=ed>[XML]</span>.</tr>
683    <tr>
684    <th scope=row><dfn id=NMTOKENS_ATTR class=dom-const><code>NMTOKENS_ATTR</code>
685    <td><code>8</code><td><code>NMTOKENS</code> <span class=ed>[XML]</span>.</tr>
686    <tr>
687    <th scope=row><dfn id=NOTATION_ATTR class=dom-const><code>NOTATION_ATTR</code>
688    <td><code>9</code><td><code>NOTATION</code> <span class=ed>[XML]</span>.</tr>
689    <tr>
690    <th scope=row><dfn id=ENUMERATION_ATTR class=dom-const><code>ENUMERATION_ATTR</code>
691    <td><code>10</code><td>Enumeration <span class=ed>[XML]</span>.</tr>
692    <tr>
693    <th scope=row><dfn id=UNKNOWN_ATTR class=dom-const><code>UNKNOWN_ATTR</code>
694    <td><code>11</code><td>Unknown, because no declaration for the attribute
695    has been read but the [all declaration processed] property
696    <span class=ed>[INFOSET]</span> would be false.</tr>
697    </tbody>
698    </table>
699    
700    <p>If no attribute type information is available, or if the source
701    of the information does not distinguish <q>no value</q> and <q>unknown</q>
702    <span class=ed>[INFOSET]</span>, then the value
703    <a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a>
704    <em class=rfc2119>MUST</em> be used.</p>
705    
706    <div class="note memo">
707    <p>An <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node
708    created by the
709    <a href="#createAttributeDefinition"><code>createAttributeDefinition</code></a>
710    method has its <a href="#declaredType"><code>declaredType</code></a> attribute
711    set to <a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a>.</p>
712    </div>
713    
714    <p>If the source of the information does not distinguish <q>no value</q>
715    and/or <code>unknown</code> <span class=ed>[INFOSET]</span> and
716    <code>CDATA</code> <span class=ed>[XML]</span>, then the value
717    <a href="#CDATA_ATTR"><code>CDATA_ATTR</code></a> <em class=rfc2119>MUST</em>
718    be used.</p>
719    
720    <p>In Perl binding <span class=ed>[PERLBINDING]</span>, the
721    <code>Attr</code> nodes <em class=rfc2119>MUST</em> implement the
722    <a href="#DeclaredValueType"><code>DeclaredValueType</code></a>
723    constant group.</p>
724    
725    <pre class=ed>
726    [7] The
727    [DFN@en[definition group [CODE(DOM)@en[[[DefaultValueType]]]]]]
728    contains integers indicating the type of
729    default attribute value:
730    ,[CODE(DOMc)@en[[[UNKNOWN_DEFAULT]]]],[CODE(IDL)[[[0]]]],The default value is unknown.
731    ,[CODE(DOMc)@en[[[FIXED_DEFAULT]]]],[CODE(IDL)[[[1]]]],The default value is provided and the attribute is [CODE(XML)@en[#[[FIXED]]]] to that value.
732    ,[CODE(DOMc)@en[[[REQUIRED_DEFAULT]]]],[CODE(IDL)[[[2]]]],An attribute specification is [CODE(XML)@en[#[[REQUIRED]]]] for the attribute.
733    ,[CODE(DOMc)@en[[[IMPLIED_DEFAULT]]]],[CODE(IDL)[[[3]]]],The default value is [CODE(XML)@en[#[[IMPLIED]]]].
734    ,[CODE(DOMc)@en[[[EXPLICIT_DEFAULT]]]],[CODE(IDL)[[[4]]]],The default value is provided but the attribute is not fixed to it.
735    
736    The type of these constants are
737    [CODE(IDL)@en[[[unsigned]] [[short]]]].
738    
739    If the source of the attribute default value type
740    does not distinguish the [CODE(XML)@en[#[[IMPLIED]]]]
741    default and unknown default, then the
742    [CODE(DOMc)@en[[[IMPLIED_DEFAULT]]]] value
743    [['''MUST''']] be used.
744    
745    ;; A newly created [CODE(DOMi)@en[[[AttributeDefinition]]]]
746    object by [CODE(DOMm)@en[[[createAttributeDefinition]]]]
747    method has [CODE(DOMa)@en[[[declaredType]]]] attribute
748    set to [CODE(DOMc)@en[[[NO_TYPE_ATTR]]]].
749    
750    ** Tree-relationship Attributes
751    
752    [10]
753    The
754    [DFN@en[[CODE(DOMa)@en[[[ownerElementTypeDefinition]]]] attribute]]
755    of the [CODE(DOMi)@en[[[AttributeDefinition]]]] interface
756    is read-only and of type
757    [CODE(DOMi)@en[[[ElementTypeDefinition]]]].
758    It is the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node
759    which the [CODE(DOMi)@en[[[AttributeDefinition]]]] node
760    belong to.
761    
762    If the [CODE(DOMi)@en[[[AttributeDefinition]]]] node
763    is included in the [CODE(DOMa)@en[[[attributeDefinitions]]]]
764    list of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node,
765    then the attribute [['''MUST''']] return the
766    [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node.
767    Otherwise, it [['''MUST''']] return [CODE(DOM)@en[[[null]]]].
768    
769    ;; This attribute is analogue to the
770    [CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]] attribute
771    for [CODE(DOMi)@en[[[ElementTypeDefinition]]]],
772    [CODE(DOMi)@en[[[Entity]]]], and [CODE(DOMi)@en[[[Notation]]]]
773    nodes, or the [CODE(DOMa)@en[[[ownerElement]]]]
774    attribute for [CODE(DOMi)@en[[[Attr]]]] nodes.
775    
776    ** Attributes
777    
778    [5]
779    The [DFN@en[[CODE(DOMa)@en[[[declaredType]]]] attribute]]
780    of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object
781    represents the type of the attribute value.
782    
783    This attribute is read-write.
784    The type of the attribute is
785    [CODE(IDL)@en[[[unsigned]] [[short]]]].  It is expected
786    that this attribute has a value from the definition group
787    [CODE(DOM)@en[[[DeclaredValueType]]]].
788    
789    The getter [['''MUST''']] return a value associated
790    to this attribute.
791    
792    The setter [['''MUST''']]
793    throw a [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]]
794    [CODE(DOMi)@en[[[DOMException]]]] if the
795    [CODE(DOMi)@en[[[AttributeDefinition]]]] object is read-only.
796    Otherwise, the setter [['''MUST''']] set the specified
797    value as the value associated to this attribute.
798    
799    If a parser create an [CODE(DOMi)@en[[[AttributeDefinition]]]]
800    object, then it [['''MUST''']] set a value
801    from the [CODE(DOM)@en[[[DeclaredValueType]]]]
802    definition group.
803    
804    [8]
805    The [DFN@en[[CODE(DOMa)@en[[[defaultType]]]] attribute]]
806    of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object
807    represents the type of the attribute default value.
808    
809    This attribute is read-write.
810    The type of the attribute is
811    [CODE(IDL)@en[[[unsigned]] [[short]]]].  It is expected
812    that this attribute has a value from the definition group
813    [CODE(DOM)@en[[[DefaultValueType]]]].
814    
815    The getter [['''MUST''']] return a value associated
816    to this attribute.
817    
818    The setter [['''MUST''']]
819    throw a [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]]
820    [CODE(DOMi)@en[[[DOMException]]]] if the
821    [CODE(DOMi)@en[[[AttributeDefinition]]]] object is read-only.
822    Otherwise, the setter [['''MUST''']] set the specified
823    value as the value associated to this attribute.
824    
825    If a parser create an [CODE(DOMi)@en[[[AttributeDefinition]]]]
826    object, then it [['''MUST''']] set a value
827    from the [CODE(DOM)@en[[[DefaultValueType]]]]
828    definition group.</pre>
829    </div>
830    
831    </div>
832    
833    
834    
835    
836    
837  <div id="references" class="section reference">  <div id="references" class="section reference">
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.9
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24