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> |
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"> |
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 |
|
|
129 |
|
<p>If the <code>strictErrorChecking</code> attribute of the |
130 |
|
<code>Document</code> node is <code>false</code>, the methods are |
131 |
|
not required to raise exceptions <span class=ed>[DOM3]</span>.</p> |
132 |
|
</div> |
133 |
|
|
134 |
|
<div class=section id=dom-dtdef> |
135 |
|
<h2><abbr>DOM</abbr> Document Type Definition Module</h2> |
136 |
|
|
137 |
|
<p>The <abbr>DOM</abbr> Document Type Definition module, version 3.0, |
138 |
|
consists of three interfaces:</p> |
139 |
|
<ul> |
140 |
|
<li><a href="#DocumentXDoctype"><code>DocumentXDoctype</code></a></li> |
141 |
|
<li><a href="#DocumentTypeDefinition"><code>DocumentTypeDefinition</code></a></li> |
142 |
|
<li><a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a></li> |
143 |
|
<li><a href="#AttributeDefinition"><code>AttributeDefinition</code></a></li> |
144 |
|
</ul> |
145 |
|
|
146 |
|
<p>In addition, it modifies interfaces |
147 |
|
<a href="#Node"><code>Node</code></a>, |
148 |
|
<a href="#DocumentType"><code>DocumentType</code></a>, |
149 |
|
<a href="#Entity"><code>Entity</code></a>, |
150 |
|
<a href="#EntityReference"><code>EntityReference</code></a>, |
151 |
|
<a href="#Notation"><code>Notation</code></a>, and |
152 |
|
<a href="#ProcessingInstruction"><code>ProcessingInstruction</code></a>.</p> |
153 |
|
|
154 |
|
<div class=section id=features> |
155 |
|
<h3>Feature Name</h3> |
156 |
|
|
157 |
|
<p>In a <abbr>DOM</abbr> implementation that supports the version 3.0 of |
158 |
|
the <abbr>DOM</abbr> Document Type Definition module, the |
159 |
|
<code>hasFeature</code> method of a <code>DOMImplementation</code> object |
160 |
|
<em class=rfc2119>MUST</em> return <code>true</code> when the parameters are |
161 |
|
set to <code>http://suika.fam.cx/www/2006/feature/XDoctype</code> and |
162 |
|
<code>3.0</code> respectively.</p> |
163 |
|
|
164 |
|
<p>In such an implementation, the <code>getFeature</code> method of a |
165 |
|
<code>Document</code> object <em class=rfc2119>MUST</em> return the (at least |
166 |
|
conceptually) same object implementing the |
167 |
|
<a href="#DocumentXDoctype"><code>DocumentXDoctype</code></a> interface when |
168 |
|
the parameters are set to |
169 |
|
<code>http://suika.fam.cx/www/2006/feature/XDoctype</code> and |
170 |
|
<code>3.0</code> respectively. Likewise, any method that takes one or more |
171 |
|
feature names with or without version number, including the methods |
172 |
|
<code>hasFeature</code> and <code>getFeature</code>, |
173 |
|
<em class=rfc2119>MUST</em> behave in a manner consistent with the |
174 |
|
aforementioned cases.</p> |
175 |
|
</div> |
176 |
|
|
177 |
|
<div class=section id=section-node> |
178 |
|
<h3>Modifications to the <code id=Node>Node</code> Interface</h3> |
179 |
|
|
180 |
|
<p>The implementation of the |
181 |
|
<a href="#Node"><code>Node</code></a> interface |
182 |
|
<em class=rfc2119>MUST</em> be modified as following:</p> |
183 |
|
<pre class=idl><code>// Additions to the Node interface |
184 |
|
|
185 |
|
// Additions to the NodeType definition group |
186 |
|
const unsigned short <a href="#ELEMENT_TYPE_DEFINITION_NODE">ELEMENT_TYPE_DEFINITION_NODE</a> = 81001; |
187 |
|
const unsigned short <a href="#ATTRIBUTE_DEFINITION_NODE">ATTRIBUTE_DEFINITION_NODE</a> = 81002; |
188 |
|
</pre> |
189 |
|
|
190 |
|
<p>This specification adds two new types (subinterfaces) of |
191 |
|
<a href="#Node"><code>Node</code></a>: element type definition (node type |
192 |
|
<a href="#ELEMENT_TYPE_DEFINITION_NODE"><code>ELEMENT_TYPE_DEFINITION_NODE</code></a>, |
193 |
|
interface |
194 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a>) and |
195 |
|
attribute definition (node type |
196 |
|
<a href="#ATTRIBUTE_DEFINITION_NODE"><code>ATTRIBUTE_DEFINITION_NODE</code></a>, |
197 |
|
interface |
198 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a>). For |
199 |
|
these kinds of nodes, methods and attributes in the |
200 |
|
<a href="#Node"><code>Node</code></a> interface must behave as following:</p> |
201 |
|
|
202 |
|
<dl> |
203 |
|
<dt><code id=attributes>attributes</code></dt> |
204 |
|
<dd> |
205 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return |
206 |
|
<code>null</code>.</p> |
207 |
|
</dd> |
208 |
|
<dt><code id=baseURI>baseURI</code></dt> |
209 |
|
<dd> |
210 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return the |
211 |
|
value of the <a href="#baseURI"><code>baseURI</code></a> attribute |
212 |
|
of the node in the <code>ownerDocument</code> attribute of the node. |
213 |
|
Note that the value might be <code>null</code>.</p> |
214 |
|
</dd> |
215 |
|
<dt><code id=nodeName>nodeName</code></dt> |
216 |
|
<dd> |
217 |
|
<p>If the node is an |
218 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a>: |
219 |
|
On getting, the attribute <em class=rfc2119>MUST</em> return the |
220 |
|
name of the element type definition represented by the node.</p> |
221 |
|
|
222 |
|
<p>If the node is an |
223 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a>: |
224 |
|
On getting, the attribute <em class=rfc2119>MUST</em> return the |
225 |
|
name of the attribute definition represented by the node.</p> |
226 |
|
</dd> |
227 |
|
<dt><code id=nodeType>nodeType</code></dt> |
228 |
|
<dd> |
229 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return |
230 |
|
<a href="#ELEMENT_TYPE_DEFINITION_NODE"><code>ELEMENT_TYPE_DEFINITION_NODE</code></a> |
231 |
|
(if the node is an |
232 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a>) or |
233 |
|
<a href="#ATTRIBUTE_DEFINITION_NODE"><code>ATTRIBUTE_DEFINITION_NODE</code></a> |
234 |
|
(if the node is an |
235 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a>).</p> |
236 |
|
|
237 |
|
<!-- NodeType --> |
238 |
|
<p>Two constants are added to the <code id=NodeType>NodeType</code> |
239 |
|
definition group of the <a href="#Node"><code>Node</code></a> interface as |
240 |
|
following:</p> |
241 |
|
<table> |
242 |
|
<thead> |
243 |
|
<tr><th scope=col>Name<th scope=col>Value<th scope=col>Description</tr> |
244 |
|
</thead> |
245 |
|
<tbody> |
246 |
|
<tr> |
247 |
|
<th scope=row><dfn id=ELEMENT_TYPE_DEFINITION_NODE class=dom-const><code>ELEMENT_TYPE_DEFINITION_NODE</code></dfn> |
248 |
|
<td><code>81001</code><td>The node is an |
249 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a>.</tr> |
250 |
|
<tr> |
251 |
|
<th scope=row><dfn id=ATTRIBUTE_DEFINITION_NODE class=dom-const><code>ATTRIBUTE_DEFINITION_NODE</code></dfn> |
252 |
|
<td><code>81002</code><td>The node is an |
253 |
|
<a href="#ElementTypeDefinition"><code>AttributeDefinition</code></a>.</tr> |
254 |
|
</tbody> |
255 |
|
</table> |
256 |
|
</dd> |
257 |
|
<dt><code id=nodeValue>nodeValue</code> and |
258 |
|
<code id=textContent>textContent</code></dt> |
259 |
|
<dd> |
260 |
|
<p>If the node is an |
261 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a>: |
262 |
|
On getting, the attributes <em class=rfc2119>MUST</em> return the |
263 |
|
name of the element type.</p> |
264 |
|
|
265 |
|
<div class="note memo"> |
266 |
|
<p>Thus, on setting the attributes does nothing |
267 |
|
<span class=ed>[DOM3]</span>.</p> |
268 |
|
</div> |
269 |
|
|
270 |
|
<p>On setting, the <a href="#textContent"><code>textContent</code></a> |
271 |
|
attribute <em class=rfc2119>MUST NOT</em> raise a |
272 |
|
<code>NO_MODIFICATION_ALLOWED_ERR</code> <span class=ed>@@ ref</span>. |
273 |
|
<span class=ed>@@ I forgot why this requirement is necessary.</span></p> |
274 |
|
|
275 |
|
<p>If the node is an |
276 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a>:</p> |
277 |
|
|
278 |
|
<pre class=ed> |
279 |
|
The getter of the [CODE(DOMa)@en[[[nodeValue]]]] attribute |
280 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
281 |
|
[['''MUST''']] return the normalized default value |
282 |
|
of the attribute. |
283 |
|
|
284 |
|
@@ |
285 |
|
|
286 |
|
[4] The getter of the [CODE(DOMa)@en[[[textContent]]]] |
287 |
|
attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]] |
288 |
|
object [['''MUST''']] behave as if it were an |
289 |
|
[CODE(DOMi)@en[[[Attr]]]] object. |
290 |
|
|
291 |
|
The setter of the [CODE(DOMa)@en[[[textContent]]]] attribute |
292 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
293 |
|
[['''MUST''']] behave as if the following algorithm |
294 |
|
is performed: |
295 |
|
= If the [CODE(DOMi)@en[[[AttributeDefinition]]]] |
296 |
|
object is read-only, then throw an |
297 |
|
[CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]]. |
298 |
|
= Remove any child node the node has. |
299 |
|
= If the new value is not empty and not [CODE(IDL)@en[[[null]]]], |
300 |
|
then create a [CODE(DOMi)@en[[[Text]]]] node |
301 |
|
whose [CODE(DOMa)@en[[[data]]]] is the new value |
302 |
|
and append it to the [CODE(DOMi)@en[[[AttributeDefinition]]]]. |
303 |
|
</pre> |
304 |
|
</dd> |
305 |
|
<dt class=ed>@@ ...</dt> |
306 |
|
</dl> |
307 |
|
|
308 |
|
</div> |
309 |
|
|
310 |
|
<div class=section id=section-documentxdoctype> |
311 |
|
<h3>The <code>DocumentXDoctype</code> Interface</h3> |
312 |
|
|
313 |
|
<p>The <a href="#DocumentXDoctype"><code>DocumentXDoctype</code></a> interface |
314 |
|
<em class=rfc2119>MUST</em> be implemented as following:</p> |
315 |
|
<pre class=idl><code>interface <dfn id=DocumentXDoctype><code>DocumentXDoctype</code></dfn> { |
316 |
|
DocumentType <a href="#createDocumentTypeDefinition">createDocumentTypeDefinition</a> |
317 |
|
(in DOMString <a href="#createDocumentTypeDefinition-name"><var>name</var></a>) |
318 |
|
raises (DOMException); |
319 |
|
<a href="#ElementTypeDefinition">ElementTypeDefinition</a> <a href="#createElementTypeDefinition">createElementTypeDefinition</a> |
320 |
|
(in DOMString <a href="#createElementTypeDefinition-name"><var>name</var></a>) |
321 |
|
raises (DOMException); |
322 |
|
<a href="#AttributeDefinition">AttributeDefinition</a> <a href="#createAttributeDefinition">createAttributeDefinition</a> |
323 |
|
(in DOMString <a href="#createAttributeDefinition-name"><var>name</var></a>) |
324 |
|
raises (DOMException); |
325 |
|
<a href="#Entity">Entity</a> <a href="#createGeneralEntity">createGeneralEntityDefinition</a> |
326 |
|
(in DOMString <a href="#createGeneralEntity-name"><var>name</var></a>) |
327 |
|
raises (DOMException); |
328 |
|
<a href="#Notation">Notation</a> <a href="#createNotation">createNotation</a> |
329 |
|
(in DOMString <a href="#createNotation-name"><var>name</var></a>) |
330 |
|
raises (DOMException); |
331 |
|
}</code></pre> |
332 |
|
|
333 |
|
<div class=ed>@@ cast definition</div> |
334 |
|
|
335 |
|
<dl> |
336 |
|
<dt><dfn id=createDocumentTypeDefinition class=dom-method><code>createDocumentTypeDefinition</code></dfn>, |
337 |
|
method</dt> |
338 |
|
<dd> |
339 |
|
<p>This method creates a <code>DocumentType</code> node with the specified |
340 |
|
name, belonging to the document.</p> |
341 |
|
<p>The <dfn id=createDocumentTypeDefinition-name class=dom-param><var>name</var></dfn> |
342 |
|
parameter is the name of the document type.</p> |
343 |
|
|
344 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
345 |
|
return a <code>DocumentType</code> node with the following attributes:</p> |
346 |
|
<dl> |
347 |
|
<dt><code>attributes</code>, <code>parentNode</code></dt> |
348 |
|
<dd><code>null</code>.</dd> |
349 |
|
<dt><code>elementTypes</code>, <code>generalEntities</code>, and |
350 |
|
<code>notations</code></dt> |
351 |
|
<dd>Empty <code>NamedNodeMap</code> objects.</dd> |
352 |
|
<dt><code>entities</code></dt> |
353 |
|
<dd>The same value as the <code>generalEntities</code> attribute.</dd> |
354 |
|
<dt><code>childNodes</code></dt> |
355 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
356 |
|
<dt><code>internalSubset</code>, <code>publicId</code>, and |
357 |
|
<code>systemId</code></dt> |
358 |
|
<dd>Empty strings.</dd> |
359 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
360 |
|
<dd><code>false</code>.</dd> |
361 |
|
<dt><code>nodeName</code></dt> |
362 |
|
<dd><a href="#createDocumentTypeDefinition-name"><var>name</var></a>.</dd> |
363 |
|
<dt><code>ownerDocument</code></dt> |
364 |
|
<dd>The <code>Document</code> over which the method is invoked.</dd> |
365 |
|
</dl> |
366 |
|
<p>In addition, the method <em class=rfc2119>MUST</em> be marked as |
367 |
|
containing five general entity declarations: <code>amp</code>, |
368 |
|
<code>lt</code>, <code>gt</code>, <code>quot</code>, and |
369 |
|
<code>apos</code>.</p> |
370 |
|
</dd> |
371 |
|
<dt><dfn id=createElementTypeDefinition class=dom-method><code>createElementTypeDefinition</code></dfn>, |
372 |
|
method</dt> |
373 |
|
<dd> |
374 |
|
<p>This method creates a <code>ElementTypeDefinition</code> node with the |
375 |
|
specified name, belonging to the document.</p> |
376 |
|
<p>The <dfn id=createElementTypeDefinition-name class=dom-param><var>name</var></dfn> |
377 |
|
parameter is the name of the element type defined by the element |
378 |
|
type definition.</p> |
379 |
|
|
380 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
381 |
|
return an |
382 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
383 |
|
node with the following attributes:</p> |
384 |
|
<dl> |
385 |
|
<dt><a href="#attributeDefinitions"><code>attributeDefinitions</code></a></dt> |
386 |
|
<dd>An empty <code>NamedNodeMap</code> object.</dd> |
387 |
|
<dt><code>attributes</code>, <code>parentNode</code></dt> |
388 |
|
<dd><code>null</code>.</dd> |
389 |
|
<dt><code>childNodes</code></dt> |
390 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
391 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
392 |
|
<dd><code>false</code>.</dd> |
393 |
|
<dt><code>nodeName</code></dt> |
394 |
|
<dd><a href="#createElementTypeDefinition-name"><var>name</var></a>.</dd> |
395 |
|
<dt><code>ownerDocument</code></dt> |
396 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
397 |
|
<dt><a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a></dt> |
398 |
|
<dd><code>null</code>.</dd> |
399 |
|
<dt class=ed>@@ Ensure all attributes are defined</dt> |
400 |
|
</dl> |
401 |
|
</dd> |
402 |
|
<dt><dfn id=createAttributeDefinition class=dom-method><code>createAttributeDefinition</code></dfn>, |
403 |
|
method</dt> |
404 |
|
<dd> |
405 |
|
<p>This method creates a <code>AttributeDefinition</code> node with the |
406 |
|
specified name, belonging to the document.</p> |
407 |
|
<p>The <dfn id=createAttributeDefinition-name class=dom-param><var>name</var></dfn> |
408 |
|
parameter is the name of the attribute defined by the attribute |
409 |
|
definition.</p> |
410 |
|
|
411 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
412 |
|
return an |
413 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
414 |
|
node with the following attributes:</p> |
415 |
|
<dl> |
416 |
|
<dt><code>allowedTokens</code></dt> |
417 |
|
<dd>An empty <code>DOMStringList</code> object.</dd> |
418 |
|
<dt><code>attributes</code>, |
419 |
|
<a href="#ownerElementTypeDefinition"><code>ownerElementTypeDefinition</code></a>, |
420 |
|
and <code>parentNode</code></dt> |
421 |
|
<dd><code>null</code>.</dd> |
422 |
|
<dt><code>childNodes</code></dt> |
423 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
424 |
|
<dt><code>declaredType</code></dt> |
425 |
|
<dd><a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a>.</dd> |
426 |
|
<dt><code>defaultType</code></dt> |
427 |
|
<dd><a href="#UNKNOWN_DEFAULT"><code>UNKNOWN_DEFAULT</code></a>.</dd> |
428 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
429 |
|
<dd><code>false</code>.</dd> |
430 |
|
<dt><code>nodeName</code></dt> |
431 |
|
<dd><a href="#createAttributeDefinition-name"><var>name</var></a>.</dd> |
432 |
|
<dt><code>ownerDocument</code></dt> |
433 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
434 |
|
<dt class=ed>@@ Ensure all attributes are defined</dt> |
435 |
|
</dl> |
436 |
|
|
437 |
|
<div class=ed> |
438 |
|
<p>@@ Should we keep these statements?: |
439 |
|
However, if the <cfg::cfg|xml-id> configuration |
440 |
|
parameter is set to <code>true</code> and the <var>name</var> |
441 |
|
is <code>xml:id</code>, then the [CODE(DOMa)@en[[[declaredType]]]] |
442 |
|
attribute is set to <code>ID_ATTR</code>. |
443 |
|
[CODE(DOMa)@en[[[defaultType]]]]?</p> |
444 |
|
</div> |
445 |
|
</dd> |
446 |
|
<dt><dfn id=createGeneralEntity class=dom-method><code>createGeneralEntity</code></dfn>, |
447 |
|
method</dt> |
448 |
|
<dd> |
449 |
|
<p>This method creates a <a href="#Entity"><code>Entity</code></a> node |
450 |
|
with the specified name, which represents a general entity, belonging to |
451 |
|
the document.</p> |
452 |
|
<p>The <dfn id=createGeneralEntity-name class=dom-param><var>name</var></dfn> |
453 |
|
parameter is the name of the general entity.</p> |
454 |
|
|
455 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and return |
456 |
|
an <a href="#Entity"><code>Entity</code></a> node with the following |
457 |
|
attributes:</p> |
458 |
|
<dl> |
459 |
|
<dt><code>attributes</code>, <code>notationName</code>, |
460 |
|
<a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a>, |
461 |
|
and <code>parentNode</code></dt> |
462 |
|
<dd><code>null</code>.</dd> |
463 |
|
<dt><code>childNodes</code></dt> |
464 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
465 |
|
<dt><code>manakaiDeclarationBaseURI</code>, |
466 |
|
<code>manakaiEntityBaseURI</code>, and |
467 |
|
<code>manakaiEntityURI</code> <span class=ed>@@ ref</span></dt> |
468 |
|
<dd>No explicit value is set.</dd> |
469 |
|
<dt><code>manakaiHasReplacementTree</code> and |
470 |
|
<code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
471 |
|
<dd><code>false</code>.</dd> |
472 |
|
<dt><code>nodeName</code></dt> |
473 |
|
<dd><a href="#createGeneralEntity-name"><var>name</var></a>.</dd> |
474 |
|
<dd> |
475 |
|
<div class="note memo"> |
476 |
|
<p>It is not an error for |
477 |
|
<a href="#createGeneralEntity-name"><var>name</var></a> matching |
478 |
|
to the name of one of predefined general parsed entities in |
479 |
|
<abbr>XML</abbr> or <abbr>HTML</abbr>. For example, |
480 |
|
<a href="#createGeneralEntity-name"><var>name</var></a> might be |
481 |
|
<code>amp</code>, resulting in an |
482 |
|
<a href="#Entity"><code>Entity</code></a> node |
483 |
|
with its <code>nodeName</code> attribute set to <code>amp</code>.</p> |
484 |
|
</div> |
485 |
|
</dd> |
486 |
|
<dt><code>ownerDocument</code></dt> |
487 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
488 |
|
<dt><code>publicId</code>, and <code>systemId</code></dt> |
489 |
|
<dd><code>null</code>.</dd> |
490 |
|
<dd class=ed>@@ publicId and systemId should be empty string?</dd> |
491 |
|
<dt class=ed>@@ Ensure all attributes are defined</dd> |
492 |
|
</dl> |
493 |
|
</dd> |
494 |
|
<dt><dfn id=createNotation class=dom-method><code>createNotation</code></dfn>, |
495 |
|
method</dt> |
496 |
|
<dd> |
497 |
|
<p>This method creates a <code>Notation</code> node with the |
498 |
|
specified name, belonging to the document.</p> |
499 |
|
<p>The <dfn id=createNotation-name class=dom-param><var>name</var></dfn> |
500 |
|
parameter is the name of the notation.</p> |
501 |
|
|
502 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and return |
503 |
|
a <code>Notation</code> node with the following attributes:</p> |
504 |
|
<dl> |
505 |
|
<dt><code>attributes</code>, |
506 |
|
<a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a>, |
507 |
|
and <code>parentNode</code></dt> |
508 |
|
<dd><code>null</code>.</dd> |
509 |
|
<dt><code>childNodes</code></dt> |
510 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
511 |
|
<dt><code>manakaiDeclarationBaseURI</code></dt> |
512 |
|
<dd>No explicit value is set.</dd> |
513 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
514 |
|
<dd><code>false</code>.</dd> |
515 |
|
<dt><code>nodeName</code></dt> |
516 |
|
<dd><a href="#createNotation-name"><var>name</var></a>.</dd> |
517 |
|
<dt><code>ownerDocument</code></dt> |
518 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
519 |
|
<dt><code>publicId</code> and <code>systemId</code></dt> |
520 |
|
<dd><code>null</code>.</dd> |
521 |
|
<dd class=ed>@@ publicId and systemId should be empty string?</dd> |
522 |
|
<dt class=ed>@@ Ensure all attributes are defined</dt> |
523 |
|
</dl> |
524 |
|
</dd> |
525 |
|
</dl> |
526 |
|
|
527 |
|
<p>These methods <em class=rfc2119>MUST</em> raise an |
528 |
|
<code>INVALID_CHARACTER_ERR</code> exception <span class=ed>@@ ref</span> |
529 |
|
if <var>name</var> is <em>not</em> a legal <code>Name</code> according to |
530 |
|
the <abbr>XML</abbr> version in use, as specified in the |
531 |
|
<code>xmlVersion</code> attribute of the <code>Document</code> node.</p> |
532 |
|
|
533 |
|
<div class="note memo"> |
534 |
|
<p>Non$B!>(B<abbr>XML</abbr> case is intentionally left unspecified for now, |
535 |
|
since <abbr>DOM3</abbr> specification <span class=ed>@@ ref</span> does not |
536 |
|
define it for <code>Document</code> methods.</p> |
537 |
|
|
538 |
|
<p><var>name</var> does not have to be a namespace qualified name.</p> |
539 |
|
</div> |
540 |
|
|
541 |
|
</div> |
542 |
|
|
543 |
|
|
544 |
|
<div class=section id=section-documenttype> |
545 |
|
<h3>Modifications to the <code id=DocumentType>DocumentType</code> |
546 |
|
Interface</h3> |
547 |
|
|
548 |
|
<p>A <a href="#DocumentType"><code>DocumentType</code></a> interface |
549 |
|
<em class=rfc2119>MAY</em> contain zero or more |
550 |
|
<a href="#ProcessingInstruction"><code>ProcessingInstruction</code></a> |
551 |
|
nodes in the <code>NodeList</code> object contained in the |
552 |
|
<code>childNodes</code> attribute of the |
553 |
|
<a href="#DocumentType"><code>DocumentType</code></a> node.</p> |
554 |
|
|
555 |
|
<p>If the <a href="#DocumentType"><code>DocumentType</code></a> node is created |
556 |
|
during the process to create a <abbr>DOM</abbr> from an <abbr>XML</abbr> |
557 |
|
document, the <code>NodeList</code> object in the <code>childNodes</code> |
558 |
|
object <em class=rfc2119>MUST</em> contains the |
559 |
|
<a href="#ProcessingInstruction"><code>ProcessingInstruction</code></a> |
560 |
|
nodes representing the processing instructions in the document type |
561 |
|
definition of the document processed <span class=ed>@@ ref</span> by |
562 |
|
the <abbr>XML</abbr> processor. If the |
563 |
|
<a href="#DocumentType"><code>DocumentType</code></a> node is marked |
564 |
|
as read$B!>(Bonly, then all the child nodes <em class=rfc2119>MUST</em> |
565 |
|
also be marked as read$B!>(Bonly.</p> |
566 |
|
|
567 |
|
<p>If a <a href="#DocumentType"><code>DocumentType</code></a> node is created |
568 |
|
from a document type declaration information item <span class=ed>@@ ref</span>, |
569 |
|
the <code>NodeList</code> object in the <code>childNodes</code> attribute |
570 |
|
of the node <em class=rfc2119>MUST</em> contain the |
571 |
|
<a href="#ProcessingInstruction"><code>ProcessingInstruction</code></a> nodes |
572 |
|
created from the processing instruction information items in the list in the |
573 |
|
[children] property of the document type declaration item in the same |
574 |
|
order.</p> |
575 |
|
|
576 |
|
<p>If a <a href="#DocumentType"><code>DocumentType</code></a> node is mapped to |
577 |
|
a document type declaration information item, the list in the [children] |
578 |
|
property <em class=rfc2119>MUST</em> contain the processng instruction |
579 |
|
information items created from the |
580 |
|
<a href="#ProcessingInstruction"><code>ProcessingInstruction</code></a> nodes |
581 |
|
in the <code>NodeList</code> object in the <code>childNodes</code> attribute |
582 |
|
of the <a href="#DocumentType"><code>DocumentType</code></a> node.</p> |
583 |
|
|
584 |
|
<p>The implementation of the |
585 |
|
<a href="#DocumentType"><code>DocumentType</code></a> interface |
586 |
|
<em class=rfc2119>MUST</em> be modified as following:</p> |
587 |
|
<pre class=idl><code>// Modifications to the DocumentType interface |
588 |
|
attribute DOMString <a href="#publicId">publicId</a>; |
589 |
|
attribute DOMString <a href="#systemId">systemId</a>; |
590 |
|
|
591 |
|
attribute DOMString <a href="#internalSubset">internalSubset</a>; |
592 |
|
</code></pre> |
593 |
|
|
594 |
|
<p>The <code id=publicId>publicId</code> attribute and the |
595 |
|
<code id=systemId>systemId</code> attribute of |
596 |
|
<a href="#DocumentType"><code>DocumentType</code></a>, |
597 |
|
<a href="#Entity"><code>Entity</code></a>, and |
598 |
|
<a href="#Notation"><code>Notation</code></a> interfaces are no longer |
599 |
|
read$B!>(Bonly.</p> |
600 |
|
|
601 |
|
<p>On setting, the attribute <em class=rfc2119>MUST</em> raise a |
602 |
|
<code>NO_MODIFICATION_ALLOWED_ERR</code> <span class=ed>@@ ref</span> |
603 |
|
exception if the node is read$B!>(Bonly <span class=ed>@@ ref</span>. |
604 |
|
Otherwise, it <em class=rfc2119>MUST</em> set the specified value as the value |
605 |
|
associated to the attribute. No normalization, relative reference resolution, |
606 |
|
or lexical validation is performed. <span class=ed>@@ If the new |
607 |
|
value is <code>null</code>, ...</span></p> |
608 |
|
|
609 |
|
<div class="note memo"> |
610 |
|
<p>Setting an invalid identifier might make the node unserializable. |
611 |
|
Setting a public identifier while leaveing system identifier unspecified |
612 |
|
would also make the <a href="#DocumentType"><code>DocumentType</code></a> |
613 |
|
or <a href="#Entity"><code>Entity</code></a> node unserializable.</p> |
614 |
|
</div> |
615 |
|
|
616 |
|
<div class=ed> |
617 |
|
<p>ISSUE: In HTML5, Firefox 1.5, and Opera 9, not specifying public or system identifier results in empty strings.</p> |
618 |
|
</div> |
619 |
|
|
620 |
|
<p>The <code id=internalSubset>internalSubset</code> attribute of the |
621 |
|
<a href="#DocumentType"><code>DocumentType</code></a> interface is no longer |
622 |
|
read$B!>(Bonly.</p> |
623 |
|
|
624 |
|
<p>On setting, the attribute <em class=rfc2119>MUST</em> raise a |
625 |
|
<code>NO_MODIFICATION_ALLOWED_ERR</code> <span class=ed>@@ ref</span> |
626 |
|
exception if the node is read$B!>(Bonly <span class=ed>@@ ref</span>. |
627 |
|
Otherwise, it <em class=rfc2119>MUST</em> set the specified value as the value |
628 |
|
associated to the attribute. No normalization, or lexical validation is |
629 |
|
performed. <span class=ed>@@ If the new value is <code>null</code>, |
630 |
|
...</span></p> |
631 |
|
|
632 |
|
</div> |
633 |
|
|
634 |
|
<div class=section id=section-documenttypedefinition> |
635 |
|
<h3>The <code>DocumentTypeDefinition</code> Interface</h3> |
636 |
|
|
637 |
|
<div class="note memo"> |
638 |
|
<p>This interface is a separated interface from the |
639 |
|
<a href="#DocumentType"><code>DocumentType</code></a>, not a set of extensions |
640 |
|
to the <a href="#DocumentType"><code>DocumentType</code></a>, |
641 |
|
for the historical reason.</p> |
642 |
|
</div> |
643 |
|
|
644 |
|
<p>The |
645 |
|
<a href="#DocumentTypeDefinition"><code>DocumentTypeDefinition</code></a> |
646 |
|
interface <em class=rfc2119>MUST</em> be implemented as following:</p> |
647 |
|
<pre class=idl><code>interface <dfn id=DocumentTypeDefinition><code>DocumentTypeDefinition</code></dfn> { |
648 |
|
readonly attribute NamedNodeMap <a href="#elementTypes">elementTypes</a>; |
649 |
|
readonly attribute NamedNodeMap <a href="#generalEntities">generalEntities</a>; |
650 |
|
readonly attribute NamedNodeMap <a href="#notations">notations</a>; |
651 |
|
|
652 |
|
<a href="#ElementTypeDefinition">ElementTypeDefinition</a> <a href="#getElementTypeDefinitionNode">getElementTypeDefinitionNode</a> |
653 |
|
(in DOMString <a href="#getElementTypeDefinitionNode-name"><var>name</var></a>); |
654 |
|
<a href="#Entity">Entity</a> <a href="#getGeneralEntityNode">getGeneralEntityNode</a> |
655 |
|
(in DOMString <a href="#getGeneralEntityNode-name"><var>name</var></a>); |
656 |
|
<a href="#Notation">Notation</a> <a href="#getNotationNode">getNotationNode</a> |
657 |
|
(in DOMString <a href="#getNotationNode-name"><var>name</var></a>); |
658 |
|
|
659 |
|
void <a href="#setElementTypeDefinitionNode">setElementTypeDefinitionNode</a> |
660 |
|
(in DOMString <a href="#setElementTypeDefinitionNode-node"><var>node</var></a>) |
661 |
|
raises (DOMException); |
662 |
|
void <a href="#setGeneralEntityNode">setGeneralEntityNode</a> |
663 |
|
(in DOMString <a href="#setGeneralEntityNode-node"><var>node</var></a>) |
664 |
|
raises (DOMException); |
665 |
|
void <a href="#setNotationNode">setNotationNode</a> |
666 |
|
(in DOMString <a href="#setNotationNode-node"><var>node</var></a>) |
667 |
|
raises (DOMException); |
668 |
|
}</code></pre> |
669 |
|
|
670 |
|
<pre class=ed> |
671 |
|
[1] In an implementation that supports the |
672 |
|
[CODE(URI)@en[[[http://suika.fam.cx/www/2006/feature/XDoctype]]]] |
673 |
|
feature, a [CODE(DOMi)@en[[[DocumentType]]]] node |
674 |
|
must implement the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] |
675 |
|
interface. See [[DOM XML Document Type Definition]>>3] for |
676 |
|
details. |
677 |
|
</pre> |
678 |
|
|
679 |
|
<dl> |
680 |
|
<dt><dfn id=elementTypes class=dom-attr><code>elementTypes</code></dfn> of |
681 |
|
type <code>NamedNodeMap</code>, read$B!>(Bonly</dt> |
682 |
|
<dd><p>A live <code>NamedNodeMap</code> object that contains all the element |
683 |
|
type definitions belonging to the <code>DocumentType</code> node.</p> |
684 |
|
|
685 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return the |
686 |
|
<code>NamedNodeMap</code> object that contains all the |
687 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
688 |
|
nodes belonging to the <code>DocumentType</code> node. The |
689 |
|
<code>NamedNodeMap</code> object <em class=rfc2119>MUST</em> be read$B!>(Bonly |
690 |
|
if and only if the node is read$B!>(Bonly. The <code>NamedNodeMap</code> |
691 |
|
object <em class=rfc2119>MUST</em> be live and the same object |
692 |
|
<em class=rfc2119>MUST</em> be returned for any invocation.</p> |
693 |
|
|
694 |
|
<p>If the <code>DocumentType</code> node is created during the process |
695 |
|
to create a <abbr>DOM</abbr> from an <abbr>XML</abbr> document, the following |
696 |
|
requirements are applied: The <code>NamedNodeMap</code> object in the |
697 |
|
<a href="#elementTypes"><code>elementType</code></a> attribute |
698 |
|
<em class=rfc2119>MUST</em> be so transformed that the object contains |
699 |
|
the <code>ElementTypeDefinition</code> nodes for the element types |
700 |
|
whose name is presented as the <code>Name</code> of the element type or |
701 |
|
attribute definition list declarations processed by the <abbr>XML</abbr> |
702 |
|
processor. If there is more than one element type declarations for an |
703 |
|
element type, then the declarations other than the first one |
704 |
|
<em class=rfc2119>MUST</em> be ignored for the purpose of constructing the |
705 |
|
<code>NamedNodeMap</code> object.</p></dd> |
706 |
|
<dt><dfn id=generalEntities class=dom-attr><code>generalEntities</code></dfn> |
707 |
|
of type <code>NamedNodeMap</code>, read$B!>(Bonly</dt> |
708 |
|
<dd><p>A live <code>NamedNodeMap</code> object that contains all the general |
709 |
|
entities belonging to the <code>DocumentType</code> node.</p> |
710 |
|
|
711 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return the |
712 |
|
same value as the <code>entities</code> attribute (defined in the |
713 |
|
<code>DocumentType</code> interface) of the same node.</p> |
714 |
|
|
715 |
|
<div class="note memo"> |
716 |
|
<p>This attribute is part of the interface for historical reason.</p> |
717 |
|
</div></dd> |
718 |
|
<!-- |
719 |
|
All entities declared in the document type definition |
720 |
|
contained in or referenced from the document entity |
721 |
|
might not be exposed through this collection, depending |
722 |
|
on the information provided by the XML processor for |
723 |
|
the DOM implementation. In particular, it might not |
724 |
|
contain any entity if entity references are expanded |
725 |
|
at the parse time. An implementation [['''MUST NOT''']] |
726 |
|
expose an [CODE(DOMi)@en[[[Entity]]]] node whose [CODE(DOMa)@en[[[nodeName]]]] |
727 |
|
is equal to the name of one of five predefined general entities in |
728 |
|
XML through the collection as the result of parsing of an XML |
729 |
|
document that has no error. Duplicate entity declarations are also discarded. |
730 |
|
|
731 |
|
The attribute [['''MUST''']] return the [CODE(DOMi)@en[[[NamedNodeMap]]]] |
732 |
|
object that contains all the [CODE(DOMi)@en[[[Entity]]]] nodes |
733 |
|
representing general entities belong to the node. The returned |
734 |
|
[CODE(DOMi)@en[[[NamedNodeMap]]]] object [['''MUST''']] be read-only if and only if |
735 |
|
the node is read-only. Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live |
736 |
|
and therefore any change of read-only flag on the node is immediately |
737 |
|
reflected by that of the object. |
738 |
|
--> |
739 |
|
<dt><dfn id=notations class=dom-attr><code>notations</code></dfn> of type |
740 |
|
<code>notations</code>, read$B!>(Bonly</code> |
741 |
|
<dd><p>A live <code>NamedNodeMap</code> object that contains all the |
742 |
|
notations belonging to the <code>DocumentType</code> node.</p> |
743 |
|
|
744 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return the |
745 |
|
same value as the <code>notations</code> attribute (defined in the |
746 |
|
<code>DocumentType</code> interface) of the same node.</p> |
747 |
|
|
748 |
|
<div class="note memo"> |
749 |
|
<p>This attribute is part of the interface for historical reason.</p> |
750 |
|
<p>Implementations are not required to implement the |
751 |
|
<code>notations</code> attribute twice (for <code>DocumentType</code> |
752 |
|
and <code>DocumentTypeDefinition</code> interfaces); they share exactly |
753 |
|
same definition.</p> |
754 |
|
</div></dd> |
755 |
|
<!-- |
756 |
|
If the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] node is |
757 |
|
created from an XML document, duplicate notation declarations, if any, in DTD |
758 |
|
[['''MUST NOT''']] result in a node in the [CODE(DOMi)@en[[[NamedNodeMap]]]] |
759 |
|
object and only the first declaration [['''MUST''']] be |
760 |
|
made available as a [CODE(DOMi)@en[[[Notation]]]] node. |
761 |
|
|
762 |
|
;; This definition is based on one for the |
763 |
|
[CODE(DOMa)@en[[[notations]]]] attribute of the |
764 |
|
[CODE(DOMi)@en[[[DocumentType]]]] interface in DOM XML module. |
765 |
|
Since duplication is violation to the Validity Constraint, |
766 |
|
XML parsers might vary on how notations are notified to |
767 |
|
the application. In particular, [CODE(InfoProp)@en[[[notations]]]] |
768 |
|
property of the document information item in XML Information Set |
769 |
|
is so defined that in case ''any'' notation is declared for |
770 |
|
multiple times then the property has no value. |
771 |
|
|
772 |
|
The attribute [['''MUST''']] return the [CODE(DOMi)@en[[[NamedNodeMap]]]] |
773 |
|
object that contains all the [CODE(DOMi)@en[[[Notation]]]] nodes |
774 |
|
representing notations belong to the node. The returned |
775 |
|
[CODE(DOMi)@en[[[NamedNodeMap]]]] object [['''MUST''']] be read-only if and only if |
776 |
|
the node is read-only. Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live |
777 |
|
and therefore any change of read-only flag on the node is immediately |
778 |
|
reflected by that of the object. |
779 |
|
--> |
780 |
|
|
781 |
|
<dt class=ed>@@ other members... |
782 |
|
</dl> |
783 |
|
|
784 |
|
<div class=ed> |
785 |
|
<p>A future version of this interface might define the |
786 |
|
<code>parameterEntities</code> and getter/setter for parameter entities. |
787 |
|
</div> |
788 |
|
|
789 |
|
</div> |
790 |
|
|
791 |
|
<div class=section id=section-elementtypedefinition> |
792 |
|
<h3>The <code>ElementTypeDefinition</code> Interface</h3> |
793 |
|
|
794 |
|
<p>The nodes of type |
795 |
|
<a href="#ELEMENT_TYPE_DEFINITION_NODE"><code>ELEMENT_TYPE_DEFINITION_NODE</code></a> |
796 |
|
represents an element type definition. Such a node implements the |
797 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
798 |
|
interface, which extends the <a href="#Node"><code>Node</code></a> |
799 |
|
interface.</p> |
800 |
|
|
801 |
|
<p>An element type definition represents a definition of the element type. |
802 |
|
It is corresponding to the element type declaration in <abbr>DTD</abbr>. |
803 |
|
However, an |
804 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> node |
805 |
|
does not represent the element type definition in <abbr>DTD</abbr> itself. |
806 |
|
Even if there are more than one element type declarations for an element type |
807 |
|
in <abbr>DTD</abbr>, the result <abbr>DOM</abbr> will contain only an |
808 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
809 |
|
node for that element type. In addition, if there are attribute definition |
810 |
|
declarations for an element type, even when there is no element type |
811 |
|
declaration for that element type, the <abbr>DOM</abbr> will contain an |
812 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
813 |
|
node for that element type.</p> |
814 |
|
|
815 |
|
<p>The <a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
816 |
|
interface <em class=rfc2119>MUST</em> be implemented as following:</p> |
817 |
|
<pre class=idl><code>interface <dfn id=ElementTypeDefinition><code>ElementTypeDefinition</code></dfn> : <a href="#Node">Node</a> { |
818 |
|
readonly attribute <a href="#ownerDocumentTypeDefinition">ownerDocumentTypeDefinition</a>; |
819 |
|
|
820 |
|
<span class=ed>@@ more</span> |
821 |
|
}</code></pre> |
822 |
|
|
823 |
|
<pre class=ed> |
824 |
|
[DFN@en[[CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]] attribute]] |
825 |
|
of the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
826 |
|
interface is defined in [[manakai//DOM Extensions]>>50].</pre> |
827 |
</div> |
</div> |
828 |
|
|
829 |
|
<div class=section id=section-attributedefinition> |
830 |
|
<h3>The <code>AttributeDefinition</code> Interface</h3> |
831 |
|
|
832 |
|
<p>The nodes of type |
833 |
|
<a href="#ATTRIBUTE_DEFINITION_NODE"><code>ATTRIBUTE_DEFINITION_NODE</code></a> |
834 |
|
represents an attribute definition. Such a node implements the |
835 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> interface, |
836 |
|
which extends the <a href="#Node"><code>Node</code></a> interface.</p> |
837 |
|
|
838 |
|
<p>An attribute definition represents a definition of the attribute |
839 |
|
associated to an element type. It is corresponding to the attribute definition |
840 |
|
in the attribute list declaration in <abbr>DTD</abbr>. However, an |
841 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node does |
842 |
|
not represent the attribute definition in <abbr>DTD</abbr> itself. Even if |
843 |
|
there are more than one attribute definitions for an attribute of an element |
844 |
|
type in <abbr>DTD</abbr>, the result <abbr>DOM</abbr> will contain only an |
845 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node for |
846 |
|
that attribute.</p> |
847 |
|
|
848 |
|
<p>The <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
849 |
|
interface <em class=rfc2119>MUST</em> be implemented as following:</p> |
850 |
|
<pre class=idl><code>interface <dfn id=AttributeDefinition><code>AttributeDefinition</code></dfn> : <a href="#Node">Node</a> { |
851 |
|
<span class=comment>// <a href="#DeclaredValueType">DeclaredValueType</a></span> |
852 |
|
const unsigned short <a href="#NO_TYPE_ATTR">NO_TYPE_ATTR</a> = 0; |
853 |
|
const unsigned short <a href="#CDATA_ATTR">CDATA_ATTR</a> = 1; |
854 |
|
const unsigned short <a href="#ID_ATTR">ID_ATTR</a> = 2; |
855 |
|
const unsigned short <a href="#IDREF_ATTR">IDREF_ATTR</a> = 3; |
856 |
|
const unsigned short <a href="#IDREFS_ATTR">IDREFS_ATTR</a> = 4; |
857 |
|
const unsigned short <a href="#ENTITY_ATTR">ENTITY_ATTR</a> = 5; |
858 |
|
const unsigned short <a href="#ENTITIES_ATTR">ENTITIES_ATTR</a> = 6; |
859 |
|
const unsigned short <a href="#NMTOKEN_ATTR">NMTOKEN_ATTR</a> = 7; |
860 |
|
const unsigned short <a href="#NMTOKENS_ATTR">NMTOKENS_ATTR</a> = 8; |
861 |
|
const unsigned short <a href="#NOTATION_ATTR">NOTATION_ATTR</a> = 9; |
862 |
|
const unsigned short <a href="#ENUMERATION_ATTR">ENUMERATION_ATTR</a> = 10; |
863 |
|
const unsigned short <a href="#UNKNOWN_ATTR">UNKNOWN_ATTR</a> = 11; |
864 |
|
|
865 |
|
<span class=comment>// <a href="#DefaultValueType">DefaultValueType</a></span> |
866 |
|
const unsigned short <a href="#UNKNOWN_DEFAULT">UNKNOWN_DEFAULT</a> = 0; |
867 |
|
const unsigned short <a href="#FIXED_DEFAULT">FIXED_DEFAULT</a> = 1; |
868 |
|
const unsigned short <a href="#REQUIRED_DEFAULT">REQUIRED_DEFAULT</a> = 2; |
869 |
|
const unsigned short <a href="#IMPLIED_DEFAULT">IMPLIED_DEFAULT</a> = 3; |
870 |
|
const unsigned short <a href="#EXPLICIT_DEFAULT">EXPLICIT_DEFAULT</a> = 4; |
871 |
|
|
872 |
|
readonly attribute <a href="#ElementTypeDefinition">ElementTypeDefinition</a> <a href="#ownerElementTypeDefinition">ownerElementTypeDefinition</a>; |
873 |
|
|
874 |
|
readonly attribute unsigned short <a href="#declaredType">declaredType</a>; |
875 |
|
readonly attribute unsigned short <a href="#defaultType">defaultType</a>; |
876 |
|
|
877 |
|
<span class=ed>...</span> |
878 |
|
}</code></pre> |
879 |
|
|
880 |
|
<dl> |
881 |
|
<dt><dfn id=ownerElementTypeDefinition class=dom-attr><code>ownerElementTypeDefinition</code></dfn> |
882 |
|
of type |
883 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a>, |
884 |
|
read$B!>(Bonly</dt> |
885 |
|
<dd><p>The |
886 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> to |
887 |
|
which the <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
888 |
|
node belongs.</p> |
889 |
|
|
890 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return an |
891 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> node. |
892 |
|
It <em class=rfc2119>MUST</em> be such a node that whose |
893 |
|
<a href="#attributeDefinitons"><code>attributeDefinitions</code></a> |
894 |
|
attribute contains the <code>NamedNodeMap</code> object that contains |
895 |
|
the <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
896 |
|
node. If there is no such an |
897 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> node, |
898 |
|
then <code>null</code> <em class=rfc2119>MUST</em> be returned.</p> |
899 |
|
<dt><dfn id=declaredType class=dom-attr><code>declaredType</code></dfn> of type |
900 |
|
<code>unsigned short</code></dt> |
901 |
|
<dd><p>The declared type <span class=ed>@@ ref</span> of the attribute. |
902 |
|
It is expected that this attribute contains a value from the definition group |
903 |
|
<a href="#DeclaredValueType"><code>DeclaredValueType</code></a>.</p> |
904 |
|
|
905 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return the |
906 |
|
value associated to this attribute.</p> |
907 |
|
|
908 |
|
<p>On setting, the attribute <em class=rfc2119>MUST</em> raise a |
909 |
|
<code>NO_MODIFICATION_ALLOWED_ERR</code> <span class=ed>@@ ref</span> |
910 |
|
exception if the |
911 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node |
912 |
|
is read$B!>(Bonly <span class=ed>@@ ref</span>. Otherwise, it |
913 |
|
<em class=rfc2119>MUST</em> set the specified value as the value |
914 |
|
associated to this attribute.</p> |
915 |
|
|
916 |
|
<p>If the <code>AttributeDefinition</code> node is created during the process |
917 |
|
to create a <abbr>DOM</abbr> from an <abbr>XML</abbr> document, an |
918 |
|
appropriate value from the |
919 |
|
<a href="#DeclaredValueType"><code>DeclaredValueType</code></a> constant |
920 |
|
group <em class=rfc2119>MUST</em> be set to the attribute.</p> |
921 |
|
|
922 |
|
<!-- DeclaredValueType --> |
923 |
|
<p>The definition group |
924 |
|
<dfn id=DeclaredValueType><code>DeclaredValueType</code></dfn> contains |
925 |
|
integers indicating the declared type of attributes. The definition |
926 |
|
group contains the following constants:</p> |
927 |
|
|
928 |
|
<table> |
929 |
|
<thead> |
930 |
|
<tr><th scope=col>Name<th scope=col>Value<th scope=col>Description</tr> |
931 |
|
</thead> |
932 |
|
<tbody> |
933 |
|
<tr> |
934 |
|
<th scope=row><dfn id=NO_TYPE_ATTR class=dom-const><code>NO_TYPE_ATTR</code> |
935 |
|
<td><code>0</code><td>No value <span class=ed>[INFOSET]</span>.</tr> |
936 |
|
<tr> |
937 |
|
<th scope=row><dfn id=CDATA_ATTR class=dom-const><code>CDATA_ATTR</code> |
938 |
|
<td><code>1</code><td><code>CDATA</code> <span class=ed>[XML]</span>.</tr> |
939 |
|
<tr> |
940 |
|
<th scope=row><dfn id=ID_ATTR class=dom-const><code>ID_ATTR</code> |
941 |
|
<td><code>2</code><td><code>ID</code> <span class=ed>[XML]</span>.</tr> |
942 |
|
<tr> |
943 |
|
<th scope=row><dfn id=IDREF_ATTR class=dom-const><code>IDREF_ATTR</code> |
944 |
|
<td><code>3</code><td><code>IDREF</code> <span class=ed>[XML]</span>.</tr> |
945 |
|
<tr> |
946 |
|
<th scope=row><dfn id=IDREFS_ATTR class=dom-const><code>IDREFS_ATTR</code> |
947 |
|
<td><code>4</code><td><code>IDREFS</code> <span class=ed>[XML]</span>.</tr> |
948 |
|
<tr> |
949 |
|
<th scope=row><dfn id=ENTITY_ATTR class=dom-const><code>ENTITY_ATTR</code> |
950 |
|
<td><code>5</code><td><code>ENTITY</code> <span class=ed>[XML]</span>.</tr> |
951 |
|
<tr> |
952 |
|
<th scope=row><dfn id=ENTITIES_ATTR class=dom-const><code>ENTITIES_ATTR</code> |
953 |
|
<td><code>6</code><td><code>ENTITIES</code> <span class=ed>[XML]</span>.</tr> |
954 |
|
<tr> |
955 |
|
<th scope=row><dfn id=NMTOKEN_ATTR class=dom-const><code>NMTOKEN_ATTR</code> |
956 |
|
<td><code>7</code><td><code>NMTOKEN</code> <span class=ed>[XML]</span>.</tr> |
957 |
|
<tr> |
958 |
|
<th scope=row><dfn id=NMTOKENS_ATTR class=dom-const><code>NMTOKENS_ATTR</code> |
959 |
|
<td><code>8</code><td><code>NMTOKENS</code> <span class=ed>[XML]</span>.</tr> |
960 |
|
<tr> |
961 |
|
<th scope=row><dfn id=NOTATION_ATTR class=dom-const><code>NOTATION_ATTR</code> |
962 |
|
<td><code>9</code><td><code>NOTATION</code> <span class=ed>[XML]</span>.</tr> |
963 |
|
<tr> |
964 |
|
<th scope=row><dfn id=ENUMERATION_ATTR class=dom-const><code>ENUMERATION_ATTR</code> |
965 |
|
<td><code>10</code><td>Enumeration <span class=ed>[XML]</span>.</tr> |
966 |
|
<tr> |
967 |
|
<th scope=row><dfn id=UNKNOWN_ATTR class=dom-const><code>UNKNOWN_ATTR</code> |
968 |
|
<td><code>11</code><td>Unknown, because no declaration for the attribute |
969 |
|
has been read but the [all declaration processed] property |
970 |
|
<span class=ed>[INFOSET]</span> would be false.</tr> |
971 |
|
</tbody> |
972 |
|
</table> |
973 |
|
|
974 |
|
<p>If no attribute type information is available, or if the source |
975 |
|
of the information does not distinguish <q>no value</q> and <q>unknown</q> |
976 |
|
<span class=ed>[INFOSET]</span>, then the value |
977 |
|
<a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a> |
978 |
|
<em class=rfc2119>MUST</em> be used.</p> |
979 |
|
|
980 |
|
<div class="note memo"> |
981 |
|
<p>An <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node |
982 |
|
created by the |
983 |
|
<a href="#createAttributeDefinition"><code>createAttributeDefinition</code></a> |
984 |
|
method has its <a href="#declaredType"><code>declaredType</code></a> attribute |
985 |
|
set to <a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a>.</p> |
986 |
|
</div> |
987 |
|
|
988 |
|
<p>If the source of the information does not distinguish <q>no value</q> |
989 |
|
and/or <q>unknown</q> <span class=ed>[INFOSET]</span> and |
990 |
|
<code>CDATA</code> <span class=ed>[XML]</span>, then the value |
991 |
|
<a href="#CDATA_ATTR"><code>CDATA_ATTR</code></a> <em class=rfc2119>MUST</em> |
992 |
|
be used.</p> |
993 |
|
|
994 |
|
<p>In Perl binding <span class=ed>[PERLBINDING]</span>, the |
995 |
|
<code>Attr</code> nodes <em class=rfc2119>MUST</em> implement the |
996 |
|
<a href="#DeclaredValueType"><code>DeclaredValueType</code></a> |
997 |
|
definition group.</p> |
998 |
|
|
999 |
|
</dd> |
1000 |
|
<dt><dfn id=defaultType class=dom-attr><code>defaultType</code></dfn> of |
1001 |
|
type <code>unsigned short</code></dt> |
1002 |
|
<dd><p>The type of the default for the attribute. It is expected that this |
1003 |
|
attribute contains a value from the definition group |
1004 |
|
<a href="#DefaultValueType"><code>DefaultValueType</code></a>.</p> |
1005 |
|
|
1006 |
|
<p>On getting, the attribute <em class=rfc2119>MUST</em> return |
1007 |
|
the value associated to this attribute.</p> |
1008 |
|
|
1009 |
|
<p>On setting, the attribute <em class=rfc2119>MUST</em> raise a |
1010 |
|
<code>NO_MODIFICATION_ALLOWED_ERR</code> <span class=ed>@@ ref</span> |
1011 |
|
exception if the |
1012 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node |
1013 |
|
is read$B!>(Bonly <span class=ed>@@ ref</span>. Otherwise, it |
1014 |
|
<em class=rfc2119>MUST</em> set the specified value as the value |
1015 |
|
associated to this attribute.</p> |
1016 |
|
|
1017 |
|
<p>If the |
1018 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> node is |
1019 |
|
created during the process to create a <abbr>DOM</abbr> from an |
1020 |
|
<abbr>XML</abbr> document, an appropriate value from the |
1021 |
|
<a href="#DefaultValueType"><code>DefaultValueType</code></a> definition |
1022 |
|
group <em class=rfc2119>MUST</em> be set to the attribute.</p> |
1023 |
|
|
1024 |
|
<!-- DefaultValueType --> |
1025 |
|
<p>The definition group |
1026 |
|
<dfn id=DefaultValueType><code>DefaultValueType</code></dfn> |
1027 |
|
contains integers indicating the type of the default for the attribute. |
1028 |
|
The definition group contains the following constans:</p> |
1029 |
|
|
1030 |
|
<table> |
1031 |
|
<thead> |
1032 |
|
<tr><th scope=col>Name<th scope=col>Value<th scope=col>Description</tr> |
1033 |
|
</thead> |
1034 |
|
<tbody> |
1035 |
|
<tr> |
1036 |
|
<th scope=row><dfn id=UNKNOWN_DEFAULT class=dom-const><code>UNKNOWN_DEFAULT</code></dfn> |
1037 |
|
<td><code>0</code><td>Unknown.</tr> |
1038 |
|
<tr> |
1039 |
|
<th scope=row><dfn id=FIXED_DEFAULT class=dom-const><code>FIXED_DEFAULT</code></dfn> |
1040 |
|
<td><code>1</code><td>Provided explicitly and fixed |
1041 |
|
<span class=ed>@@ ref</span> to that value.</tr> |
1042 |
|
<tr> |
1043 |
|
<th scope=row><dfn id=REQUIRED_DEFAULT class=dom-const><code>REQUIRED_DEFAULT</code></dfn> |
1044 |
|
<td><code>2</code><td>No default value and the attribute have to be |
1045 |
|
explicitly specified.</tr> |
1046 |
|
<tr> |
1047 |
|
<th scope=row><dfn id=IMPLIED_DEFAULT class=dom-const><code>IMPLIED_DEFAULT</code></dfn> |
1048 |
|
<td><code>3</code><td>Implied <span class=ed>@@ ref</span>.</tr> |
1049 |
|
<tr> |
1050 |
|
<th scope=row><dfn id=EXPLICIT_DEFAULT class=dom-const><code>EXPLICIT_DEFAULT</code></dfn> |
1051 |
|
<td><code>4</code><td>Provided explicitly.</tr> |
1052 |
|
</tbody> |
1053 |
|
</table> |
1054 |
|
|
1055 |
|
<p>If the source of the default type does not distinguish |
1056 |
|
implied and unknown default types, then the value |
1057 |
|
<a href="#IMPLIED_DEFAULT"><code>IMPLIED_DEFAULT</code></a> |
1058 |
|
<em class=rfc2119>MUST</em> be used.</p> |
1059 |
|
|
1060 |
|
<div class="note memo"> |
1061 |
|
<p>An <a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
1062 |
|
node created by the |
1063 |
|
<a href="#createAttributeDefinition"><code>createAttributeDefinition</code></a> |
1064 |
|
method has its <a href="#defaultType"><code>defaultType</code></a> |
1065 |
|
attribute set to |
1066 |
|
<a href="#UNKNOWN_DEFAULT"><code>UNKNOWN_DEFAULT</code></a>.</p> |
1067 |
|
</div></dd> |
1068 |
|
</dl> |
1069 |
|
|
1070 |
|
</div> |
1071 |
|
|
1072 |
|
</div> |
1073 |
|
|
1074 |
|
|
1075 |
|
|
1076 |
|
|
1077 |
|
|
1078 |
<div id="references" class="section reference"> |
<div id="references" class="section reference"> |