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"> |
10 |
|
|
11 |
<div class="header"> |
<div class="header"> |
12 |
<h1>DOM Document Type Definition Module</h1> |
<h1>DOM Document Type Definition Module</h1> |
13 |
<h2>Working Draft <time datetime=2007-12-01>1 December 2007</time></h2> |
<h2>Working Draft <time datetime=2007-12-03>3 December 2007</time></h2> |
14 |
|
|
15 |
<dl class="versions-uri"> |
<dl class="versions-uri"> |
16 |
<dt>This Version</dt> |
<dt>This Version</dt> |
172 |
aforementioned cases.</p> |
aforementioned cases.</p> |
173 |
</div> |
</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 <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> : <a href="#Node">Node</a> { |
546 |
|
readonly attribute <a href="#ownerDocumentTypeDefinition">ownerDocumentTypeDefinition</a>; |
547 |
|
|
548 |
|
<span class=ed>@@ more</span> |
549 |
|
}</code></pre> |
550 |
|
|
551 |
|
<pre class=ed>** Modifications to [CODE(DOMi)@en[[[Node]]]] members |
552 |
|
|
553 |
|
[3] The getter of the [CODE(DOMa)@en[[[attributes]]]] attribute |
554 |
|
of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object |
555 |
|
[['''MUST''']] return [CODE(IDL)@en[[[null]]]]. |
556 |
|
|
557 |
|
[4] The getter of the [CODE(DOMa)@en[[[baseURI]]]] attribute |
558 |
|
of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object |
559 |
|
[['''MUST''']] return the [CODE(DOMa)@en[[[baseURI]]]] |
560 |
|
of the [CDOE(DOMa)@en[[[ownerDocument]]]] of the |
561 |
|
[CODE(DOMi)@en[[[ElementTypeDefinition]]]] object. |
562 |
|
Note that it might be [CODE(IDL)@en[[[null]]]]. |
563 |
|
|
564 |
|
[1] The getter of the [CODE(DOMa)@en[[[nodeName]]]] attribute |
565 |
|
of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object |
566 |
|
[['''MUST''']] return the name of the element type. |
567 |
|
|
568 |
|
[2] The getters of the [CODE(DOMa)@en[[[nodeValue]]]] |
569 |
|
and [CODE(DOMa)@en[[[textContent]]]] attributes |
570 |
|
of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
571 |
|
object [['''MUST''']] return [CODE(IDL)@en[[[null]]]]. |
572 |
|
|
573 |
|
;; Thus, the setter of these attributes do nothing. |
574 |
|
|
575 |
|
The setter of the [CODE(DOMa)@en[[[textContent]]]] |
576 |
|
attribute of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
577 |
|
object [['''MUST NOT''']] throw a |
578 |
|
[CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]]. |
579 |
|
|
580 |
|
** The [CODE(DOMi)@en[ElementTypeDefinition]] Interface |
581 |
|
|
582 |
|
[5] The |
583 |
|
[DFN@en[[CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]] attribute]] |
584 |
|
of the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
585 |
|
interface is defined in [[manakai//DOM Extensions]>>50].</pre> |
586 |
|
</div> |
587 |
|
|
588 |
|
<div class=section id=section-attributedefinition> |
589 |
|
<h3>The <code>AttributeDefinition</code> Interface</h3> |
590 |
|
|
591 |
|
<pre class=idl><code>interface <dfn id=AttributeDefinition><code>AttributeDefinition</code></dfn> : <a href="#Node">Node</a> { |
592 |
|
<span class=comment>// <a href="#DeclaredValueType">DeclaredValueType</a></span> |
593 |
|
const unsigned short <a href="#NO_TYPE_ATTR">NO_TYPE_ATTR</a> = 0; |
594 |
|
const unsigned short <a href="#CDATA_ATTR">CDATA_ATTR</a> = 1; |
595 |
|
const unsigned short <a href="#ID_ATTR">ID_ATTR</a> = 2; |
596 |
|
const unsigned short <a href="#IDREF_ATTR">IDREF_ATTR</a> = 3; |
597 |
|
const unsigned short <a href="#IDREFS_ATTR">IDREFS_ATTR</a> = 4; |
598 |
|
const unsigned short <a href="#ENTITY_ATTR">ENTITY_ATTR</a> = 5; |
599 |
|
const unsigned short <a href="#ENTITIES_ATTR">ENTITIES_ATTR</a> = 6; |
600 |
|
const unsigned short <a href="#NMTOKEN_ATTR">NMTOKEN_ATTR</a> = 7; |
601 |
|
const unsigned short <a href="#NMTOKENS_ATTR">NMTOKENS_ATTR</a> = 8; |
602 |
|
const unsigned short <a href="#NOTATION_ATTR">NOTATION_ATTR</a> = 9; |
603 |
|
const unsigned short <a href="#ENUMERATION_ATTR">ENUMERATION_ATTR</a> = 10; |
604 |
|
const unsigned short <a href="#UNKNOWN_ATTR">UNKNOWN_ATTR</a> = 11; |
605 |
|
|
606 |
|
readonly attribute <a href="#ElementTypeDefinition">ElementTypeDefinition</a> <a href="#ownerElementTypeDefinition">ownerElementTypeDefinition</a>; |
607 |
|
|
608 |
|
readonly attribute unsigned short <a href="#declaredType">declaredType</a>; |
609 |
|
readonly attribute unsigned short <a href="#defaultType">defaultType</a>; |
610 |
|
|
611 |
|
<span class=ed>...</span> |
612 |
|
}</code></pre> |
613 |
|
|
614 |
|
<pre class=ed>** Modifications to [CODE(DOMi)@en[[[Node]]]] members |
615 |
|
|
616 |
|
[3] The getter of the [CODE(DOMa)@en[[[attributes]]]] attribute |
617 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
618 |
|
[['''MUST''']] return [CODE(IDL)@en[[[null]]]]. |
619 |
|
|
620 |
|
[9] The getter of the [CODE(DOMa)@en[[[baseURI]]]] attribute |
621 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
622 |
|
[['''MUST''']] return the [CODE(DOMa)@en[[[baseURI]]]] |
623 |
|
of the [CDOE(DOMa)@en[[[ownerDocument]]]] of the |
624 |
|
[CODE(DOMi)@en[[[AttributeDefinition]]]] object. |
625 |
|
Note that it might be [CODE(IDL)@en[[[null]]]]. |
626 |
|
|
627 |
|
[1] The getter of the [CODE(DOMa)@en[[[nodeName]]]] attribute |
628 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
629 |
|
[['''MUST''']] return the name of the attribute. |
630 |
|
|
631 |
|
[2] The getter of the [CODE(DOMa)@en[[[nodeValue]]]] attribute |
632 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
633 |
|
[['''MUST''']] return the normalized default value |
634 |
|
of the attribute. |
635 |
|
|
636 |
|
@@ |
637 |
|
|
638 |
|
[4] The getter of the [CODE(DOMa)@en[[[textContent]]]] |
639 |
|
attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]] |
640 |
|
object [['''MUST''']] behave as if it were an |
641 |
|
[CODE(DOMi)@en[[[Attr]]]] object. |
642 |
|
|
643 |
|
The setter of the [CODE(DOMa)@en[[[textContent]]]] attribute |
644 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
645 |
|
[['''MUST''']] behave as if the following algorithm |
646 |
|
is performed: |
647 |
|
= If the [CODE(DOMi)@en[[[AttributeDefinition]]]] |
648 |
|
object is read-only, then throw an |
649 |
|
[CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]]. |
650 |
|
= Remove any child node the node has. |
651 |
|
= If the new value is not empty and not [CODE(IDL)@en[[[null]]]], |
652 |
|
then create a [CODE(DOMi)@en[[[Text]]]] node |
653 |
|
whose [CODE(DOMa)@en[[[data]]]] is the new value |
654 |
|
and append it to the [CODE(DOMi)@en[[[AttributeDefinition]]]]. |
655 |
|
</pre> |
656 |
|
|
657 |
|
<dl> |
658 |
|
<dt><dfn id=ownerElementTypeDefinition class=dom-attr><code>ownerElementTypeDefinition</code></dfn> |
659 |
|
of type |
660 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a>, |
661 |
|
read$B!>(Bonly</dt> |
662 |
|
<dd><p>The |
663 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> to |
664 |
|
which the <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
665 |
|
node belongs.</p> |
666 |
|
|
667 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return an |
668 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> node. |
669 |
|
It <em class=rfc2119>MUST</em> be such a node that whose |
670 |
|
<a href="#attributeDefinitons"><code>attributeDefinitions</code></a> |
671 |
|
attribute contains the <code>NamedNodeMap</code> object that contains |
672 |
|
the <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
673 |
|
node. If there is no such an |
674 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> node, |
675 |
|
then <code>null</code> <em class=rfc2119>MUST</em> be returned.</p> |
676 |
|
<dt><dfn id=declaredType class=dom-attr><code>declaredType</code></dfn> of type |
677 |
|
<code>unsigned short</code></dt> |
678 |
|
<dd><p>The declared type <span class=ed>@@ ref</span> of the attribute. |
679 |
|
It is expected that this attribute contains a value from the definition group |
680 |
|
<a href="#DeclaredValueType"><code>DeclaredValueType</code></a>.</p> |
681 |
|
|
682 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return the |
683 |
|
value associated to this attribute.</p> |
684 |
|
|
685 |
|
<p>On setting, the attribute <em class=rfc2119>MUST</em> raise a |
686 |
|
<code>NO_MODIFICATION_ALLOWED_ERR</code> <span class=ed>@@ ref</span> |
687 |
|
exception if the |
688 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node |
689 |
|
is read$B!>(Bonly <span class=ed>@@ ref</span>. Otherwise, it |
690 |
|
<em class=rfc2119>MUST</em> set the specified value as the value |
691 |
|
associated to this attribute.</p> |
692 |
|
|
693 |
|
<p>If the <code>AttributeDefinition</code> node is created during the process |
694 |
|
to create a <abbr>DOM</abbr> from an <abbr>XML</abbr> document, an |
695 |
|
appropriate value from the |
696 |
|
<a href="#DeclaredValueType"><code>DeclaredValueType</code></a> constant |
697 |
|
group <em class=rfc2119>MUST</em> be set to the attribute.</p> |
698 |
|
|
699 |
|
<!-- DeclaredValueType --> |
700 |
|
<p>The definition group |
701 |
|
<dfn id=DeclaredValueType><code>DeclaredValueType</code></dfn> contains |
702 |
|
integers indicating the declared type of attributes. The definition |
703 |
|
group contains the following constants:</p> |
704 |
|
|
705 |
|
<table> |
706 |
|
<thead> |
707 |
|
<tr><th scope=col>Name<th scope=col>Value<th scope=col>Description</tr> |
708 |
|
</thead> |
709 |
|
<tbody> |
710 |
|
<tr> |
711 |
|
<th scope=row><dfn id=NO_TYPE_ATTR class=dom-const><code>NO_TYPE_ATTR</code> |
712 |
|
<td><code>0</code><td>No value <span class=ed>[INFOSET]</span>.</tr> |
713 |
|
<tr> |
714 |
|
<th scope=row><dfn id=CDATA_ATTR class=dom-const><code>CDATA_ATTR</code> |
715 |
|
<td><code>1</code><td><code>CDATA</code> <span class=ed>[XML]</span>.</tr> |
716 |
|
<tr> |
717 |
|
<th scope=row><dfn id=ID_ATTR class=dom-const><code>ID_ATTR</code> |
718 |
|
<td><code>2</code><td><code>ID</code> <span class=ed>[XML]</span>.</tr> |
719 |
|
<tr> |
720 |
|
<th scope=row><dfn id=IDREF_ATTR class=dom-const><code>IDREF_ATTR</code> |
721 |
|
<td><code>3</code><td><code>IDREF</code> <span class=ed>[XML]</span>.</tr> |
722 |
|
<tr> |
723 |
|
<th scope=row><dfn id=IDREFS_ATTR class=dom-const><code>IDREFS_ATTR</code> |
724 |
|
<td><code>4</code><td><code>IDREFS</code> <span class=ed>[XML]</span>.</tr> |
725 |
|
<tr> |
726 |
|
<th scope=row><dfn id=ENTITY_ATTR class=dom-const><code>ENTITY_ATTR</code> |
727 |
|
<td><code>5</code><td><code>ENTITY</code> <span class=ed>[XML]</span>.</tr> |
728 |
|
<tr> |
729 |
|
<th scope=row><dfn id=ENTITIES_ATTR class=dom-const><code>ENTITIES_ATTR</code> |
730 |
|
<td><code>6</code><td><code>ENTITIES</code> <span class=ed>[XML]</span>.</tr> |
731 |
|
<tr> |
732 |
|
<th scope=row><dfn id=NMTOKEN_ATTR class=dom-const><code>NMTOKEN_ATTR</code> |
733 |
|
<td><code>7</code><td><code>NMTOKEN</code> <span class=ed>[XML]</span>.</tr> |
734 |
|
<tr> |
735 |
|
<th scope=row><dfn id=NMTOKENS_ATTR class=dom-const><code>NMTOKENS_ATTR</code> |
736 |
|
<td><code>8</code><td><code>NMTOKENS</code> <span class=ed>[XML]</span>.</tr> |
737 |
|
<tr> |
738 |
|
<th scope=row><dfn id=NOTATION_ATTR class=dom-const><code>NOTATION_ATTR</code> |
739 |
|
<td><code>9</code><td><code>NOTATION</code> <span class=ed>[XML]</span>.</tr> |
740 |
|
<tr> |
741 |
|
<th scope=row><dfn id=ENUMERATION_ATTR class=dom-const><code>ENUMERATION_ATTR</code> |
742 |
|
<td><code>10</code><td>Enumeration <span class=ed>[XML]</span>.</tr> |
743 |
|
<tr> |
744 |
|
<th scope=row><dfn id=UNKNOWN_ATTR class=dom-const><code>UNKNOWN_ATTR</code> |
745 |
|
<td><code>11</code><td>Unknown, because no declaration for the attribute |
746 |
|
has been read but the [all declaration processed] property |
747 |
|
<span class=ed>[INFOSET]</span> would be false.</tr> |
748 |
|
</tbody> |
749 |
|
</table> |
750 |
|
|
751 |
|
<p>If no attribute type information is available, or if the source |
752 |
|
of the information does not distinguish <q>no value</q> and <q>unknown</q> |
753 |
|
<span class=ed>[INFOSET]</span>, then the value |
754 |
|
<a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a> |
755 |
|
<em class=rfc2119>MUST</em> be used.</p> |
756 |
|
|
757 |
|
<div class="note memo"> |
758 |
|
<p>An <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node |
759 |
|
created by the |
760 |
|
<a href="#createAttributeDefinition"><code>createAttributeDefinition</code></a> |
761 |
|
method has its <a href="#declaredType"><code>declaredType</code></a> attribute |
762 |
|
set to <a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a>.</p> |
763 |
|
</div> |
764 |
|
|
765 |
|
<p>If the source of the information does not distinguish <q>no value</q> |
766 |
|
and/or <q>unknown</q> <span class=ed>[INFOSET]</span> and |
767 |
|
<code>CDATA</code> <span class=ed>[XML]</span>, then the value |
768 |
|
<a href="#CDATA_ATTR"><code>CDATA_ATTR</code></a> <em class=rfc2119>MUST</em> |
769 |
|
be used.</p> |
770 |
|
|
771 |
|
<p>In Perl binding <span class=ed>[PERLBINDING]</span>, the |
772 |
|
<code>Attr</code> nodes <em class=rfc2119>MUST</em> implement the |
773 |
|
<a href="#DeclaredValueType"><code>DeclaredValueType</code></a> |
774 |
|
definition group.</p> |
775 |
|
|
776 |
|
</dd> |
777 |
|
<dt><dfn id=defaultType class=dom-attr><code>defaultType</code></dfn> of |
778 |
|
type <code>unsigned short</code></dt> |
779 |
|
<dd><p>The type of the default for the attribute. It is expected that this |
780 |
|
attribute contains a value from the definition group |
781 |
|
<a href="#DefaultValueType"><code>DefaultValueType</code></a>.</p> |
782 |
|
|
783 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return |
784 |
|
the value associated to this attribute.</p> |
785 |
|
|
786 |
|
<p>On setting, the attribute <em class=rfc2119>MUST</em> raise a |
787 |
|
<code>NO_MODIFICATION_ALLOWED_ERR</code> <span class=ed>@@ ref</span> |
788 |
|
exception if the |
789 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node |
790 |
|
is read$B!>(Bonly <span class=ed>@@ ref</span>. Otherwise, it |
791 |
|
<em class=rfc2119>MUST</em> set the specified value as the value |
792 |
|
associated to this attribute.</p> |
793 |
|
|
794 |
|
<p>If the <code>AttributeDefinition</code> node is created during the process |
795 |
|
to create a <abbr>DOM</abbr> from an <abbr>XML</abbr> document, an |
796 |
|
appropriate value from the |
797 |
|
<a href="#DefaultValueType"><code>DefaultValueType</code></a> definition |
798 |
|
group <em class=rfc2119>MUST</em> be set to the attribute.</p> |
799 |
|
|
800 |
|
<!-- DefaultValueType --> |
801 |
|
<p>The definition group |
802 |
|
<dfn id=DefaultValueType><code>DefaultValueType</code></dfn> |
803 |
|
contains integers indicating the type of the default for the attribute. |
804 |
|
The definition group contains the following constans:</p> |
805 |
|
|
806 |
|
<table> |
807 |
|
<thead> |
808 |
|
<tr><th scope=col>Name<th scope=col>Value<th scope=col>Description</tr> |
809 |
|
</thead> |
810 |
|
<tbody> |
811 |
|
<tr> |
812 |
|
<th scope=row><dfn id=UNKNOWN_DEFAULT class=dom-const><code>UNKNOWN_DEFAULT</code></dfn> |
813 |
|
<td><code>0</code><td>Unknown.</tr> |
814 |
|
<tr> |
815 |
|
<th scope=row><dfn id=FIXED_DEFAULT class=dom-const><code>FIXED_DEFAULT</code></dfn> |
816 |
|
<td><code>1</code><td>Provided explicitly and fixed |
817 |
|
<span class=ed>@@ ref</span> to that value.</tr> |
818 |
|
<tr> |
819 |
|
<th scope=row><dfn id=REQUIRED_DEFAULT class=dom-const><code>REQUIRED_DEFAULT</code></dfn> |
820 |
|
<td><code>2</code><td>No default value and the attribute have to be |
821 |
|
explicitly specified.</tr> |
822 |
|
<tr> |
823 |
|
<th scope=row><dfn id=IMPLIED_DEFAULT class=dom-const><code>IMPLIED_DEFAULT</code></dfn> |
824 |
|
<td><code>3</code><td>Implied <span class=ed>@@ ref</span>.</tr> |
825 |
|
<tr> |
826 |
|
<th scope=row><dfn id=EXPLICIT_DEFAULT class=dom-const><code>EXPLICIT_DEFAULT</code></dfn> |
827 |
|
<td><code>4</code><td>Provided explicitly.</tr> |
828 |
|
</tbody> |
829 |
|
</table> |
830 |
|
|
831 |
|
<p>If the source of the default type does not distinguish |
832 |
|
implied and unknown default types, then the value |
833 |
|
<a href="#IMPLIED_DEFAULT"><code>IMPLIED_DEFAULT</code></a> |
834 |
|
<em class=rfc2119>MUST</em> be used.</p> |
835 |
|
|
836 |
|
<div class="note memo"> |
837 |
|
<p>An <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
838 |
|
node created by the |
839 |
|
<a href="#createAttributeDefinition"><code>createAttributeDefinition</code></a> |
840 |
|
method has its <a href="#defaultType"><code>defaultType</code></a> |
841 |
|
attribute set to |
842 |
|
<a href="#UNKNOWN_DEFAULT"><code>UNKNOWN_DEFAULT</code></a>.</p> |
843 |
|
</div></dd> |
844 |
|
</dl> |
845 |
|
|
846 |
|
</div> |
847 |
|
|
848 |
</div> |
</div> |
849 |
|
|
850 |
|
|