173 |
</div> |
</div> |
174 |
|
|
175 |
<div class=section id=section-documentxdoctype> |
<div class=section id=section-documentxdoctype> |
176 |
<h2>The <code>DocumentXDoctype</code> Interface</h2> |
<h3>The <code>DocumentXDoctype</code> Interface</h3> |
177 |
|
|
178 |
<pre class=idl><code>interface <dfn id=DocumentXDoctype><code>DocumentXDoctype</code></dfn> { |
<pre class=idl><code>interface <dfn id=DocumentXDoctype><code>DocumentXDoctype</code></dfn> { |
179 |
DocumentType <a href="#createDocumentTypeDefinition">createDocumentTypeDefinition</a> |
DocumentType <a href="#createDocumentTypeDefinition">createDocumentTypeDefinition</a> |
239 |
<p>The <dfn id=createElementTypeDefinition-name class=dom-param><var>name</var></dfn> |
<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 |
parameter is the name of the element type defined by the element |
241 |
type definition.</p> |
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> |
</dd> |
265 |
<dt><dfn id=createAttributeDefinition class=dom-method><code>createAttributeDefinition</code></dfn>, |
<dt><dfn id=createAttributeDefinition class=dom-method><code>createAttributeDefinition</code></dfn>, |
266 |
method</dt> |
method</dt> |
270 |
<p>The <dfn id=createAttributeDefinition-name class=dom-param><var>name</var></dfn> |
<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 |
parameter is the name of the attribute defined by the attribute |
272 |
definition.</p> |
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> |
</dd> |
309 |
<dt><dfn id=createGeneralEntity class=dom-method><code>createGeneralEntity</code></dfn>, |
<dt><dfn id=createGeneralEntity class=dom-method><code>createGeneralEntity</code></dfn>, |
310 |
method</dt> |
method</dt> |
311 |
<dd> |
<dd> |
312 |
<p>This method creates a <code>Entity</code> node with the |
<p>This method creates a <a href="#Entity"><code>Entity</code></a> node |
313 |
specified name, which represents a general entity, belonging to the |
with the specified name, which represents a general entity, belonging to |
314 |
document.</p> |
the document.</p> |
315 |
<p>The <dfn id=createGeneralEntity-name class=dom-param><var>name</var></dfn> |
<p>The <dfn id=createGeneralEntity-name class=dom-param><var>name</var></dfn> |
316 |
parameter is the name of the general entity.</p> |
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> |
</dd> |
357 |
<dt><dfn id=createNotation class=dom-method><code>createNotation</code></dfn>, |
<dt><dfn id=createNotation class=dom-method><code>createNotation</code></dfn>, |
358 |
method</dt> |
method</dt> |
361 |
specified name, belonging to the document.</p> |
specified name, belonging to the document.</p> |
362 |
<p>The <dfn id=createNotation-name class=dom-param><var>name</var></dfn> |
<p>The <dfn id=createNotation-name class=dom-param><var>name</var></dfn> |
363 |
parameter is the name of the notation.</p> |
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> |
</dd> |
388 |
</dl> |
</dl> |
389 |
|
|
390 |
<pre class=ed> |
<p>These methods <em class=rfc2119>MUST</em> raise an |
391 |
|
<code>INVALID_CHARACTER_ERR</code> exception <span class=ed>@@ ref</span> |
392 |
[8] |
if <var>name</var> is <em>not</em> a legal <code>Name</code> according to |
393 |
The [CODE(DOMm)@en[[[createElementTypeDefinition]]]] |
the <abbr>XML</abbr> version in use, as specified in the |
394 |
method [['''MUST''']] create an |
<code>xmlVersion</code> attribute of the <code>Document</code> node.</p> |
395 |
[CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
|
396 |
object with the following attribute values: |
<div class="note memo"> |
397 |
- [CODE(DOMa)@en[[[attributeDefinitions]]]]: |
<p>Non$B!>(B<abbr>XML</abbr> case is intentionally left unspecified for now, |
398 |
An empty [CODE(DOMi)@en[[[NamedNodeMap]]]]. |
since <abbr>DOM3</abbr> specification <span class=ed>@@ ref</span> does not |
399 |
- [CODE(DOMa)@en[[[attributes]]]], |
define it for <code>Document</code> methods.</p> |
400 |
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
|
401 |
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
<p><var>name</var> does not have to be a namespace qualified name.</p> |
402 |
[CODE(DOMi)@en[[[NodeList]]]]. |
|
403 |
- [CODE(DOMa)@en[[[manakaiReadOnly]]]]: |
<p>If the <code>strictErrorChecking</code> attribute of the |
404 |
[CODE(IDL)@en[[[false]]]]. |
<code>Document</code> node is <code>false</code>, the methods are |
405 |
- [CODE(DOMa)@en[[[nodeName]]]]: [CODE(DOMp)@en[[[name]]]]. |
not required to raise the exception <span class=ed>[DOM3]</span>.</p> |
406 |
- [CODE(DOMa)@en[[[ownerDocument]]]]: The |
</div> |
|
[CODE(DOMi)@en[[[Document]]]] node on which the method |
|
|
is invoked. |
|
|
- [CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]]: |
|
|
[CODE(IDL)@en[[[null]]]]. |
|
|
|
|
|
@@ Ensure all attributes are defined |
|
|
|
|
|
[9] The [CODE(DOMm)@en[[[createAttributeDefinition]]]] |
|
|
method [['''MUST''']] create an |
|
|
[CODE(DOMi)@en[[[AttributeDefinition]]]] |
|
|
object with the following attribute values: |
|
|
- [CODE(DOMa)@en[[[allowedTokens]]]]: |
|
|
An empty [CODE(DOMi)@en[[[DOMStringList]]]]. |
|
|
- [CODE(DOMa)@en[[[attributes]]]], |
|
|
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
|
|
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
|
|
[CODE(DOMi)@en[[[NodeList]]]]. |
|
|
- [CODE(DOMa)@en[[[declaredType]]]]: |
|
|
[CODE(DOMc)@en[[[NO_TYPE_ATTR]]]]. |
|
|
- [CODE(DOMa)@en[[[defaultType]]]]: |
|
|
[CODE(DOMc)@en[[[UNKNOWN_DEFAULT]]]]. |
|
|
- [CODE(DOMa)@en[[[manakaiReadOnly]]]]: |
|
|
[CODE(IDL)@en[[[false]]]]. |
|
|
- [CODE(DOMa)@en[[[nodeName]]]]: [CODE(DOMp)@en[[[name]]]]. |
|
|
- [CODE(DOMa)@en[[[ownerDocument]]]]: The |
|
|
[CODE(DOMi)@en[[[Document]]]] node on which the method |
|
|
is invoked. |
|
|
- [CODE(DOMa)@en[[[ownerElementTypeDefinition]]]]: |
|
|
[CODE(IDL)@en[[[null]]]]. |
|
|
|
|
|
@@ Ensure all attributes are defined |
|
|
|
|
|
@@ Should we keep these statements?: |
|
|
However, if the <cfg::cfg|xml-id> configuration |
|
|
parameter is set to <DOM::true> and the <P::name> |
|
|
is <XA::xml:id>, then the [CODE(DOMa)@en[[[declaredType]]]] |
|
|
attribute is set to |
|
|
<C::AttributeDefinition.ID_ATTR>. |
|
|
[CODE(DOMa)@en[[[defaultType]]]]? |
|
|
|
|
|
[11] The [CODE(DOMm)@en[[[createGeneralEntity]]]] |
|
|
method [['''MUST''']] create an [CODE(DOMi)@en[[[Entity]]]] |
|
|
node with the following attribute values: |
|
|
- [CODE(DOMa)@en[[[attributes]]]], |
|
|
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
|
|
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
|
|
[CODE(DOMi)@en[[[NodeList]]]]. |
|
|
- [CODE(DOMa)@en[[[manakaiDeclarationBaseURI]]]]: |
|
|
No explicit value is set. |
|
|
- [CODE(DOMa)@en[[[manakaiEntityBaseURI]]]]: |
|
|
No explicit value is set. |
|
|
- [CODE(DOMa)@en[[[manakaiEntityURI]]]]: |
|
|
No explicit value is set. |
|
|
- [CODE(DOMa)@en[[[manakaiHasReplacementTree]]]]: |
|
|
[CODE(IDL)@en[[[false]]]]. |
|
|
- [CODE(DOMa)@en[[[manakaiReadOnly]]]]: |
|
|
[CODE(IDL)@en[[[false]]]]. |
|
|
- [CODE(DOMa)@en[[[nodeName]]]]: [CODE(DOMp)@en[[[name]]]]. |
|
|
- [CODE(DOMa)@en[[[notationName]]]]: [CODE(DOM)@en[[[null]]]]. |
|
|
- [CODE(DOMa)@en[[[ownerDocument]]]]: The |
|
|
[CODE(DOMi)@en[[[Document]]]] node on which the method |
|
|
is invoked. |
|
|
- [CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]]: |
|
|
[CODE(IDL)@en[[[null]]]]. |
|
|
- [CODE(DOMa)@en[[[publicId]]]]: [CODE(DOM)@en[[[null]]]]. |
|
|
- [CODE(DOMa)@en[[[systemId]]]]: [CODE(DOM)@en[[[null]]]]. |
|
|
|
|
|
@@ Ensure all attributes are defined |
|
|
|
|
|
@@ publicId and systemId should be empty string? |
|
|
|
|
|
[13] The [CODE(DOMm)@en[[[createNotation]]]] |
|
|
method [['''MUST''']] create a [CODE(DOMi)@en[[[Notation]]]] |
|
|
node with the following attribute values: |
|
|
- [CODE(DOMa)@en[[[attributes]]]], |
|
|
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
|
|
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
|
|
[CODE(DOMi)@en[[[NodeList]]]]. |
|
|
- [CODE(DOMa)@en[[[manakaiDeclarationBaseURI]]]]: |
|
|
No explicit value is set. |
|
|
- [CODE(DOMa)@en[[[manakaiReadOnly]]]]: |
|
|
[CODE(IDL)@en[[[false]]]]. |
|
|
- [CODE(DOMa)@en[[[nodeName]]]]: [CODE(DOMp)@en[[[name]]]]. |
|
|
- [CODE(DOMa)@en[[[ownerDocument]]]]: The |
|
|
[CODE(DOMi)@en[[[Document]]]] node on which the method |
|
|
is invoked. |
|
|
- [CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]]: |
|
|
[CODE(IDL)@en[[[null]]]]. |
|
|
- [CODE(DOMa)@en[[[publicId]]]]: [CODE(DOM)@en[[[null]]]]. |
|
|
- [CODE(DOMa)@en[[[systemId]]]]: [CODE(DOM)@en[[[null]]]]. |
|
|
|
|
|
@@ Ensure all attributes are defined |
|
|
|
|
|
[7] |
|
|
These method [['''MUST''']] raise an |
|
|
[CODE(DOMi)@en[[[INVALID_CHARACTER_ERR]]]] |
|
|
[CODE(DOMi)@en[[[DOMException]]]] |
|
|
if the [CODE(DOMp)@en[[[name]]]] is not a legal |
|
|
name according to the XML version in use as |
|
|
specified in the [CODE(DOMa)@en[[[xmlVersion]]]] |
|
|
attribute of the [CODE(DOMi)@en[[[Document]]]] node. |
|
|
|
|
|
;; Non-XML case is intentionally left unspecified for now |
|
|
since DOM3 does not define it. |
|
|
|
|
|
;; [CODE(DOMp)@en[[[name]]]] does not have to |
|
|
be a namespace qualified name. |
|
|
|
|
|
;; Note also that it is not an error for the |
|
|
[CODE(DOMp)@en[[[name]]]] parameter value |
|
|
to match to the name of one of predefined general |
|
|
parsed entities in XML or HTML. |
|
|
|
|
|
;; If the [CODE(DOMa)@en[[[strictErrorChecking]]]] attribute |
|
|
is set to [CODE(IDL)@en[[[false]]]], then the implementation |
|
|
is not required to raise this exception. |
|
|
|
|
|
Otherwise, these method [['''MUST''']] return |
|
|
the newly created node. |
|
|
</pre> |
|
407 |
|
|
408 |
</div> |
</div> |
409 |
|
|
410 |
<div class=section id=section-documenttypedefinition> |
<div class=section id=section-documenttypedefinition> |
411 |
<h2>The <code>DocumentTypeDefinition</code> Interface</h2> |
<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> |
543 |
<h2>The <code>ElementTypeDefinition</code> Interface</h2> |
<h3>The <code>ElementTypeDefinition</code> Interface</h3> |
544 |
|
|
545 |
<pre class=idl><code>interface <dfn id=ElementTypeDefinition><code>ElementTypeDefinition</code></dfn> { |
<pre class=idl><code>interface <dfn id=ElementTypeDefinition><code>ElementTypeDefinition</code></dfn> { |
546 |
|
|
584 |
</div> |
</div> |
585 |
|
|
586 |
<div class=section id=section-attributedefinition> |
<div class=section id=section-attributedefinition> |
587 |
<h2>The <code>AttributeDefinition</code> Interface</h2> |
<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 |