411 |
<h3>The <code>DocumentTypeDefinition</code> Interface</h3> |
<h3>The <code>DocumentTypeDefinition</code> Interface</h3> |
412 |
|
|
413 |
<pre class=idl><code>interface <dfn id=DocumentTypeDefinition><code>DocumentTypeDefinition</code></dfn> { |
<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> |
}</code></pre> |
420 |
|
|
421 |
<pre class=ed> |
<pre class=ed> |
425 |
must implement the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] |
must implement the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] |
426 |
interface. See [[DOM XML Document Type Definition]>>3] for |
interface. See [[DOM XML Document Type Definition]>>3] for |
427 |
details. |
details. |
428 |
|
</pre> |
429 |
|
|
430 |
|
<dl> |
431 |
** Children |
<dt><dfn id=elementTypes class=dom-attr><code>elementTypes</code></dfn> of |
432 |
|
type <code>NamedNodeMap</code>, read$B!>(Bonly</dt> |
433 |
[2] The [DFN@en[[CODE(DOMa)@en[[[elementTypes]]]] attribute]] |
<dd><p>A live <code>NamedNodeMap</code> object that contains all the element |
434 |
of the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] interface |
type definitions belonging to the <code>DocumentType</code> node.</p> |
435 |
is a live [CODE(DOMi)@en[[[NamedNodeMap]]]] object that |
|
436 |
contains all element types belongs to the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] |
<p>On getting, the attribute <em class=rfc2119>MUST</em> return the |
437 |
node. The type of the attribute is [CODE(DOMi)@en[[[NamedNodeMap]]]]. |
<code>NamedNodeMap</code> object that contains all the |
438 |
The attribute is read-only. |
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
439 |
|
nodes belonging to the <code>DocumentType</code> node. The |
440 |
What are contained in this collection depends on how |
<code>NamedNodeMap</code> object <em class=rfc2119>MUST</em> be read$B!>(Bonly |
441 |
the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] node was created. If the |
if and only if the node is read$B!>(Bonly. The <code>NamedNodeMap</code> |
442 |
node was created as the result of parsing of an XML document, |
object <em class=rfc2119>MUST</em> be live and the same object |
443 |
it [['''MUST''']] contain all element types whose element type and / or |
<em class=rfc2119>MUST</em> be returned for any invocation.</p> |
444 |
attribute definition list declaration are encountered by and provided for the DOM |
|
445 |
implementation from the XML processor. Note that the XML processor might not |
<p>If the <code>DocumentType</code> node is created during the process |
446 |
provide a part of or entire such information depending on the configuration. |
to create a <abbr>DOM</abbr> from an <abbr>XML</abbr> document, the following |
447 |
If more than one declarations for an element type or an attribute is available |
requirements are applied: The <code>NamedNodeMap</code> object in the |
448 |
at the time of the definition node construction, then declarations other than |
<a href="#elementTypes"><code>elementType</code></a> attribute |
449 |
the first ones [['''MUST''']] be discarded. |
<em class=rfc2119>MUST</em> be so transformed that the object contains |
450 |
|
the <code>ElementTypeDefinition</code> nodes for the element types |
451 |
The attribute [['''MUST''']] return the [CODE(DOMi)@en[[[NamedNodeMap]]]] |
whose name is presented as the <code>Name</code> of the element type or |
452 |
object that contains all the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] nodes |
attribute definition list declarations processed by the <abbr>XML</abbr> |
453 |
belong to the node. The returned [CODE(DOMi)@en[[[NamedNodeMap]]]] object |
processor. If there is more than one element type declarations for an |
454 |
[['''MUST''']] be read-only if and only if the node is read-only. |
element type, then the declarations other than the first one |
455 |
Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live |
<em class=rfc2119>MUST</em> be ignored for the purpose of constructing the |
456 |
and therefore any change of read-only flag on the node is immediately |
<code>NamedNodeMap</code> object.</p></dd> |
457 |
reflected by that of the object. |
<dt><dfn id=generalEntities class=dom-attr><code>generalEntities</code></dfn> |
458 |
|
of type <code>NamedNodeMap</code>, read$B!>(Bonly</dt> |
459 |
[3] The [DFN@en[[CODE(DOMa)@en[[[generalEntities]]]] attribute]] |
<dd><p>A live <code>NamedNodeMap</code> object that contains all the general |
460 |
of the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] interface |
entities belonging to the <code>DocumentType</code> node.</p> |
461 |
is a live [CODE(DOMi)@en[[[NamedNodeMap]]]] object that contains all the |
|
462 |
general entities belong to the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] node. |
<p>On getting, the attribute <em class=rfc2119>MUST</em> return the |
463 |
The type of the attribute is [CODE(DOMi)@en[[[NamedNodeMap]]]]. |
same value as the <code>entities</code> attribute (defined in the |
464 |
The attribute is read-only. |
<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 |
All entities declared in the document type definition |
471 |
contained in or referenced from the document entity |
contained in or referenced from the document entity |
472 |
might not be exposed through this collection, depending |
might not be exposed through this collection, depending |
486 |
the node is read-only. Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live |
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 |
and therefore any change of read-only flag on the node is immediately |
488 |
reflected by that of the object. |
reflected by that of the object. |
489 |
|
--> |
490 |
The attribute [['''MUST''']] return the same value as the |
<dt><dfn id=notations class=dom-attr><code>notations</code></dfn> of type |
491 |
[CODE(DOMa)@en[[[entites]]]] attribute of the |
<code>notations</code>, read$B!>(Bonly</code> |
492 |
[CODE(DOMi)@en[[[DocumentType]]]] interface on the same node. |
<dd><p>A live <code>NamedNodeMap</code> object that contains all the |
493 |
|
notations belonging to the <code>DocumentType</code> node.</p> |
494 |
[4] The [DFN@en[[CODE(DOMa)@en[[[notations]]]] attribute]] |
|
495 |
of the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] interface |
<p>On getting, the attribute <em class=rfc2119>MUST</em> return the |
496 |
is a live [CODE(DOMi)@en[[[NamedNodeMap]]]] object that contains |
same value as the <code>notations</code> attribute (defined in the |
497 |
all the notations belong to the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] |
<code>DocumentType</code> interface) of the same node.</p> |
498 |
node. The type of the attribute is [CODE(DOMi)@en[[[NamedNodeMap]]]]. |
|
499 |
The attribute is read-only. |
<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 |
If the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] node is |
508 |
created from an XML document, duplicate notation declarations, if any, in DTD |
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]]]] |
[['''MUST NOT''']] result in a node in the [CODE(DOMi)@en[[[NamedNodeMap]]]] |
527 |
the node is read-only. Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live |
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 |
and therefore any change of read-only flag on the node is immediately |
529 |
reflected by that of the object. |
reflected by that of the object. |
530 |
|
--> |
531 |
|
|
532 |
A DOM implementation is not required to implement the |
<dt class=ed>@@ other members... |
533 |
[CODE(DOMa)@en[[[notations]]]] attribute twice |
</dl> |
|
for the [CODE(DOMi)@en[[[DocumentType]]]] and |
|
|
the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] interfaces; |
|
|
the latter is defined to contain the same value as the former. |
|
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 |
|
|
|
** Open Issues (informative) |
|
|
|
|
|
[5] A future version of the interface might define the |
|
|
[CODE(DOMa)@en[[[parameterEntities]]]] attribute and |
|
|
getter/setter for parameter entities. |
|
|
</pre> |
|
540 |
</div> |
</div> |
541 |
|
|
542 |
<div class=section id=section-elementtypedefinition> |
<div class=section id=section-elementtypedefinition> |
587 |
<h3>The <code>AttributeDefinition</code> Interface</h3> |
<h3>The <code>AttributeDefinition</code> Interface</h3> |
588 |
|
|
589 |
<pre class=idl><code>interface <dfn id=AttributeDefinition><code>AttributeDefinition</code></dfn> { |
<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> |
}</code></pre> |
606 |
|
|
607 |
<pre class=ed>** Modifications to [CODE(DOMi)@en[[[Node]]]] members |
<pre class=ed>** Modifications to [CODE(DOMi)@en[[[Node]]]] members |
645 |
then create a [CODE(DOMi)@en[[[Text]]]] node |
then create a [CODE(DOMi)@en[[[Text]]]] node |
646 |
whose [CODE(DOMa)@en[[[data]]]] is the new value |
whose [CODE(DOMa)@en[[[data]]]] is the new value |
647 |
and append it to the [CODE(DOMi)@en[[[AttributeDefinition]]]]. |
and append it to the [CODE(DOMi)@en[[[AttributeDefinition]]]]. |
648 |
|
</pre> |
649 |
|
|
650 |
** Definition groups |
<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 |
[6] The |
<p>If the source of the information does not distinguish <q>no value</q> |
715 |
[DFN@en[definition group [CODE(DOM)@en[[[DeclaredValueType]]]]]] |
and/or <code>unknown</code> <span class=ed>[INFOSET]</span> and |
716 |
contains integers indicating the type of |
<code>CDATA</code> <span class=ed>[XML]</span>, then the value |
717 |
attribute value: |
<a href="#CDATA_ATTR"><code>CDATA_ATTR</code></a> <em class=rfc2119>MUST</em> |
718 |
,[CODE(DOMc)@en[[[NO_TYPE_ATTR]]]],[CODE(IDL)[[[0]]]],The attribute value type corresponding to [[no value]] in XML Information Set. |
be used.</p> |
719 |
,[CODE(DOMc)@en[[[CDATA_ATTR]]]],[CODE(IDL)[[[1]]]],The attribute value type is [CODE(XML)@en[[[CDATA]]]]. |
|
720 |
,[CODE(DOMc)@en[[[ID_ATTR]]]],[CODE(IDL)[[[2]]]],The attribute value type is [CODE(XML)@en[[[ID]]]]. |
<p>In Perl binding <span class=ed>[PERLBINDING]</span>, the |
721 |
,[CODE(DOMc)@en[[[IDREF_ATTR]]]],[CODE(IDL)[[[3]]]],The attribute value type is [CODE(XML)@en[[[IDREF]]]]. |
<code>Attr</code> nodes <em class=rfc2119>MUST</em> implement the |
722 |
,[CODE(DOMc)@en[[[IDREFS_ATTR]]]],[CODE(IDL)[[[4]]]],The attribute value type is [CODE(XML)@en[[[IDREFS]]]]. |
<a href="#DeclaredValueType"><code>DeclaredValueType</code></a> |
723 |
,[CODE(DOMc)@en[[[ENTITY_ATTR]]]],[CODE(IDL)[[[5]]]],The attribute value type is [CODE(XML)@en[[[ENTITY]]]]. |
constant group.</p> |
|
,[CODE(DOMc)@en[[[ENTITIES_ATTR]]]],[CODE(IDL)[[[6]]]],The attribute value type is [CODE(XML)@en[[[ENTITIES]]]]. |
|
|
,[CODE(DOMc)@en[[[NMTOKEN_ATTR]]]],[CODE(IDL)[[[7]]]],The attribute value type is [CODE(XML)@en[[[NMTOKEN]]]]. |
|
|
,[CODE(DOMc)@en[[[NMTOKENS_ATTR]]]],[CODE(IDL)[[[8]]]],The attribute value type is [CODE(XML)@en[[[NMTOKENS]]]]. |
|
|
,[CODE(DOMc)@en[[[NOTATION_ATTR]]]],[CODE(IDL)[[[9]]]],The attribute value type is [CODE(XML)@en[[[NOTATION]]]]. |
|
|
,[CODE(DOMc)@en[[[ENUMERATION_ATTR]]]],[CODE(IDL)[[[10]]]],The attribute value is enumeration type. |
|
|
,[CODE(DOMc)@en[[[UNKNOWN_ATTR]]]],[CODE(IDL)[[[11]]]],"The attribute value type is unknown, because no declaration for the attribute has been read but not [CODE(InfoProp)@en[[[all declarations processed]]]] property would be false." |
|
|
|
|
|
The type of these constants are |
|
|
[CODE(IDL)@en[[[unsigned]] [[short]]]]. |
|
|
|
|
|
If no attribute type information is provided, |
|
|
or if the source of that information does not |
|
|
distinguish [[no value]] and [[unknown]] as in |
|
|
XML Information Set, then the |
|
|
[CODE(DOMc)@en[[[NO_TYPE_ATTR]]]] value |
|
|
[['''MUST''']] be used. |
|
|
|
|
|
;; A newly created [CODE(DOMi)@en[[[AttributeDefinition]]]] |
|
|
object by [CODE(DOMm)@en[[[createAttributeDefinition]]]] |
|
|
method has [CODE(DOMa)@en[[[declaredType]]]] attribute |
|
|
set to [CODE(DOMc)@en[[[NO_TYPE_ATTR]]]]. |
|
|
|
|
|
If the source of the attribute type information |
|
|
does not distinguish [[no value]] and / or [[unknown]] |
|
|
and [CODE(XML)@en[[[CDATA]]]], then the |
|
|
[CODE(DOMc)@en[[[CDATA_ATTR]]]] value [['''MUST''']] |
|
|
be used. |
|
|
|
|
|
[11] |
|
|
In Perl binding, the objects implementing the |
|
|
[CODE(DOMi)@en[[[Attr]]]] interface [['''MUST''']] |
|
|
also implement the [CODE(DOM)@en[[[DeclaredValueType]]]] |
|
|
constant group. |
|
724 |
|
|
725 |
|
<pre class=ed> |
726 |
[7] The |
[7] The |
727 |
[DFN@en[definition group [CODE(DOM)@en[[[DefaultValueType]]]]]] |
[DFN@en[definition group [CODE(DOM)@en[[[DefaultValueType]]]]]] |
728 |
contains integers indicating the type of |
contains integers indicating the type of |