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"> |
172 |
aforementioned cases.</p> |
aforementioned cases.</p> |
173 |
</div> |
</div> |
174 |
|
|
175 |
|
<div class=section id=section-documentxdoctype> |
176 |
|
<h2>The <code>DocumentXDoctype</code> Interface</h2> |
177 |
|
|
178 |
|
<pre class=idl><code>interface <dfn id=DocumentXDoctype><code>DocumentXDoctype</code></dfn> { |
179 |
|
DocumentType <a href="#createDocumentTypeDefinition">createDocumentTypeDefinition</a> |
180 |
|
(in DOMString <a href="#createDocumentTypeDefinition-name"><var>name</var></a>) |
181 |
|
raises (DOMException); |
182 |
|
ElementTypeDefinition <a href="#createElementTypeDefinition">createElementTypeDefinition</a> |
183 |
|
(in DOMString <a href="#createElementTypeDefinition-name"><var>name</var></a>) |
184 |
|
raises (DOMException); |
185 |
|
AttributeDefinition <a href="#createAttributeDefinition">createAttributeDefinition</a> |
186 |
|
(in DOMString <a href="#createAttributeDefinition-name"><var>name</var></a>) |
187 |
|
raises (DOMException); |
188 |
|
Entity <a href="#createGeneralEntity">createGeneralEntityDefinition</a> |
189 |
|
(in DOMString <a href="#createGeneralEntity-name"><var>name</var></a>) |
190 |
|
raises (DOMException); |
191 |
|
Notation <a href="#createNotation">createNotation</a> |
192 |
|
(in DOMString <a href="#createNotation-name"><var>name</var></a>) |
193 |
|
raises (DOMException); |
194 |
|
}</code></pre> |
195 |
|
|
196 |
|
<div class=ed>@@ cast definition</div> |
197 |
|
|
198 |
|
<dl> |
199 |
|
<dt><dfn id=createDocumentTypeDefinition class=dom-method><code>createDocumentTypeDefinition</code></dfn>, |
200 |
|
method</dt> |
201 |
|
<dd> |
202 |
|
<p>This method creates a <code>DocumentType</code> node with the specified |
203 |
|
name, belonging to the document.</p> |
204 |
|
<p>The <dfn id=createDocumentTypeDefinition-name class=dom-param><var>name</var></dfn> |
205 |
|
parameter is the name of the document type.</p> |
206 |
|
|
207 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
208 |
|
return a <code>DocumentType</code> node with the following attributes:</p> |
209 |
|
<dl> |
210 |
|
<dt><code>attributes</code>, <code>parentNode</code></dt> |
211 |
|
<dd><code>null</code>.</dd> |
212 |
|
<dt><code>elementTypes</code>, <code>generalEntities</code>, and |
213 |
|
<code>notations</code></dt> |
214 |
|
<dd>Empty <code>NamedNodeMap</code> objects.</dd> |
215 |
|
<dt><code>entities</code></dt> |
216 |
|
<dd>The same value as the <code>generalEntities</code> attribute.</dd> |
217 |
|
<dt><code>childNodes</code></dt> |
218 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
219 |
|
<dt><code>internalSubset</code>, <code>publicId</code>, and |
220 |
|
<code>systemId</code></dt> |
221 |
|
<dd>Empty strings.</dd> |
222 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
223 |
|
<dd><code>false</code>.</dd> |
224 |
|
<dt><code>nodeName</code></dt> |
225 |
|
<dd><a href="#createDocumentTypeDefinition-name"><var>name</var></a>.</dd> |
226 |
|
<dt><code>ownerDocument</code></dt> |
227 |
|
<dd>The <code>Document</code> over which the method is invoked.</dd> |
228 |
|
</dl> |
229 |
|
<p>In addition, the method <em class=rfc2119>MUST</em> be marked as |
230 |
|
containing five general entity declarations: <code>amp</code>, |
231 |
|
<code>lt</code>, <code>gt</code>, <code>quot</code>, and |
232 |
|
<code>apos</code>.</p> |
233 |
|
</dd> |
234 |
|
<dt><dfn id=createElementTypeDefinition class=dom-method><code>createElementTypeDefinition</code></dfn>, |
235 |
|
method</dt> |
236 |
|
<dd> |
237 |
|
<p>This method creates a <code>ElementTypeDefinition</code> node with the |
238 |
|
specified name, belonging to the document.</p> |
239 |
|
<p>The <dfn id=createElementTypeDefinition-name class=dom-param><var>name</var></dfn> |
240 |
|
parameter is the name of the element type defined by the element |
241 |
|
type definition.</p> |
242 |
|
|
243 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
244 |
|
return an |
245 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
246 |
|
node with the following attributes:</p> |
247 |
|
<dl> |
248 |
|
<dt><a href="#attributeDefinitions"><code>attributeDefinitions</code></a></dt> |
249 |
|
<dd>An empty <code>NamedNodeMap</code> object.</dd> |
250 |
|
<dt><code>attributes</code>, <code>parentNode</code></dt> |
251 |
|
<dd><code>null</code>.</dd> |
252 |
|
<dt><code>childNodes</code></dt> |
253 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
254 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
255 |
|
<dd><code>false</code>.</dd> |
256 |
|
<dt><code>nodeName</code></dt> |
257 |
|
<dd><a href="#createElementTypeDefinition-name"><var>name</var></a>.</dd> |
258 |
|
<dt><code>ownerDocument</code></dt> |
259 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
260 |
|
<dt><a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a></dt> |
261 |
|
<dd><code>null</code>.</dd> |
262 |
|
<dt class=ed>@@ Ensure all attributes are defined</dt> |
263 |
|
</dl> |
264 |
|
</dd> |
265 |
|
<dt><dfn id=createAttributeDefinition class=dom-method><code>createAttributeDefinition</code></dfn>, |
266 |
|
method</dt> |
267 |
|
<dd> |
268 |
|
<p>This method creates a <code>AttributeDefinition</code> node with the |
269 |
|
specified name, belonging to the document.</p> |
270 |
|
<p>The <dfn id=createAttributeDefinition-name class=dom-param><var>name</var></dfn> |
271 |
|
parameter is the name of the attribute defined by the attribute |
272 |
|
definition.</p> |
273 |
|
|
274 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
275 |
|
return an |
276 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
277 |
|
node with the following attributes:</p> |
278 |
|
<dl> |
279 |
|
<dt><code>allowedTokens</code></dt> |
280 |
|
<dd>An empty <code>DOMStringList</code> object.</dd> |
281 |
|
<dt><code>attributes</code>, |
282 |
|
<a href="#ownerElementTypeDefinition"><code>ownerElementTypeDefinition</code></a>, |
283 |
|
and <code>parentNode</code></dt> |
284 |
|
<dd><code>null</code>.</dd> |
285 |
|
<dt><code>childNodes</code></dt> |
286 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
287 |
|
<dt><code>declaredType</code></dt> |
288 |
|
<dd><a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a>.</dd> |
289 |
|
<dt><code>defaultType</code></dt> |
290 |
|
<dd><a href="#UNKNOWN_DEFAULT"><code>UNKNOWN_DEFAULT</code></a>.</dd> |
291 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
292 |
|
<dd><code>false</code>.</dd> |
293 |
|
<dt><code>nodeName</code></dt> |
294 |
|
<dd><a href="#createAttributeDefinition-name"><var>name</var></a>.</dd> |
295 |
|
<dt><code>ownerDocument</code></dt> |
296 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
297 |
|
<dt class=ed>@@ Ensure all attributes are defined</dt> |
298 |
|
</dl> |
299 |
|
|
300 |
|
<div class=ed> |
301 |
|
<p>@@ Should we keep these statements?: |
302 |
|
However, if the <cfg::cfg|xml-id> configuration |
303 |
|
parameter is set to <code>true</code> and the <var>name</var> |
304 |
|
is <code>xml:id</code>, then the [CODE(DOMa)@en[[[declaredType]]]] |
305 |
|
attribute is set to <code>ID_ATTR</code>. |
306 |
|
[CODE(DOMa)@en[[[defaultType]]]]?</p> |
307 |
|
</div> |
308 |
|
</dd> |
309 |
|
<dt><dfn id=createGeneralEntity class=dom-method><code>createGeneralEntity</code></dfn>, |
310 |
|
method</dt> |
311 |
|
<dd> |
312 |
|
<p>This method creates a <code>Entity</code> node with the |
313 |
|
specified name, which represents a general entity, belonging to the |
314 |
|
document.</p> |
315 |
|
<p>The <dfn id=createGeneralEntity-name class=dom-param><var>name</var></dfn> |
316 |
|
parameter is the name of the general entity.</p> |
317 |
|
</dd> |
318 |
|
<dt><dfn id=createNotation class=dom-method><code>createNotation</code></dfn>, |
319 |
|
method</dt> |
320 |
|
<dd> |
321 |
|
<p>This method creates a <code>Notation</code> node with the |
322 |
|
specified name, belonging to the document.</p> |
323 |
|
<p>The <dfn id=createNotation-name class=dom-param><var>name</var></dfn> |
324 |
|
parameter is the name of the notation.</p> |
325 |
|
</dd> |
326 |
|
</dl> |
327 |
|
|
328 |
|
<pre class=ed> |
329 |
|
[11] The [CODE(DOMm)@en[[[createGeneralEntity]]]] |
330 |
|
method [['''MUST''']] create an [CODE(DOMi)@en[[[Entity]]]] |
331 |
|
node with the following attribute values: |
332 |
|
- [CODE(DOMa)@en[[[attributes]]]], |
333 |
|
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
334 |
|
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
335 |
|
[CODE(DOMi)@en[[[NodeList]]]]. |
336 |
|
- [CODE(DOMa)@en[[[manakaiDeclarationBaseURI]]]]: |
337 |
|
No explicit value is set. |
338 |
|
- [CODE(DOMa)@en[[[manakaiEntityBaseURI]]]]: |
339 |
|
No explicit value is set. |
340 |
|
- [CODE(DOMa)@en[[[manakaiEntityURI]]]]: |
341 |
|
No explicit value is set. |
342 |
|
- [CODE(DOMa)@en[[[manakaiHasReplacementTree]]]]: |
343 |
|
[CODE(IDL)@en[[[false]]]]. |
344 |
|
- [CODE(DOMa)@en[[[manakaiReadOnly]]]]: |
345 |
|
[CODE(IDL)@en[[[false]]]]. |
346 |
|
- [CODE(DOMa)@en[[[nodeName]]]]: [CODE(DOMp)@en[[[name]]]]. |
347 |
|
- [CODE(DOMa)@en[[[notationName]]]]: [CODE(DOM)@en[[[null]]]]. |
348 |
|
- [CODE(DOMa)@en[[[ownerDocument]]]]: The |
349 |
|
[CODE(DOMi)@en[[[Document]]]] node on which the method |
350 |
|
is invoked. |
351 |
|
- [CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]]: |
352 |
|
[CODE(IDL)@en[[[null]]]]. |
353 |
|
- [CODE(DOMa)@en[[[publicId]]]]: [CODE(DOM)@en[[[null]]]]. |
354 |
|
- [CODE(DOMa)@en[[[systemId]]]]: [CODE(DOM)@en[[[null]]]]. |
355 |
|
|
356 |
|
@@ Ensure all attributes are defined |
357 |
|
|
358 |
|
@@ publicId and systemId should be empty string? |
359 |
|
|
360 |
|
[13] The [CODE(DOMm)@en[[[createNotation]]]] |
361 |
|
method [['''MUST''']] create a [CODE(DOMi)@en[[[Notation]]]] |
362 |
|
node with the following attribute values: |
363 |
|
- [CODE(DOMa)@en[[[attributes]]]], |
364 |
|
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
365 |
|
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
366 |
|
[CODE(DOMi)@en[[[NodeList]]]]. |
367 |
|
- [CODE(DOMa)@en[[[manakaiDeclarationBaseURI]]]]: |
368 |
|
No explicit value is set. |
369 |
|
- [CODE(DOMa)@en[[[manakaiReadOnly]]]]: |
370 |
|
[CODE(IDL)@en[[[false]]]]. |
371 |
|
- [CODE(DOMa)@en[[[nodeName]]]]: [CODE(DOMp)@en[[[name]]]]. |
372 |
|
- [CODE(DOMa)@en[[[ownerDocument]]]]: The |
373 |
|
[CODE(DOMi)@en[[[Document]]]] node on which the method |
374 |
|
is invoked. |
375 |
|
- [CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]]: |
376 |
|
[CODE(IDL)@en[[[null]]]]. |
377 |
|
- [CODE(DOMa)@en[[[publicId]]]]: [CODE(DOM)@en[[[null]]]]. |
378 |
|
- [CODE(DOMa)@en[[[systemId]]]]: [CODE(DOM)@en[[[null]]]]. |
379 |
|
|
380 |
|
@@ Ensure all attributes are defined |
381 |
|
|
382 |
|
[7] |
383 |
|
These method [['''MUST''']] raise an |
384 |
|
[CODE(DOMi)@en[[[INVALID_CHARACTER_ERR]]]] |
385 |
|
[CODE(DOMi)@en[[[DOMException]]]] |
386 |
|
if the [CODE(DOMp)@en[[[name]]]] is not a legal |
387 |
|
name according to the XML version in use as |
388 |
|
specified in the [CODE(DOMa)@en[[[xmlVersion]]]] |
389 |
|
attribute of the [CODE(DOMi)@en[[[Document]]]] node. |
390 |
|
|
391 |
|
;; Non-XML case is intentionally left unspecified for now |
392 |
|
since DOM3 does not define it. |
393 |
|
|
394 |
|
;; [CODE(DOMp)@en[[[name]]]] does not have to |
395 |
|
be a namespace qualified name. |
396 |
|
|
397 |
|
;; Note also that it is not an error for the |
398 |
|
[CODE(DOMp)@en[[[name]]]] parameter value |
399 |
|
to match to the name of one of predefined general |
400 |
|
parsed entities in XML or HTML. |
401 |
|
|
402 |
|
;; If the [CODE(DOMa)@en[[[strictErrorChecking]]]] attribute |
403 |
|
is set to [CODE(IDL)@en[[[false]]]], then the implementation |
404 |
|
is not required to raise this exception. |
405 |
|
|
406 |
|
Otherwise, these method [['''MUST''']] return |
407 |
|
the newly created node. |
408 |
|
</pre> |
409 |
|
|
410 |
|
</div> |
411 |
|
|
412 |
|
<div class=section id=section-documenttypedefinition> |
413 |
|
<h2>The <code>DocumentTypeDefinition</code> Interface</h2> |
414 |
|
|
415 |
|
<pre class=idl><code>interface <dfn id=DocumentTypeDefinition><code>DocumentTypeDefinition</code></dfn> { |
416 |
|
|
417 |
|
}</code></pre> |
418 |
|
|
419 |
|
<pre class=ed> |
420 |
|
[1] In an implementation that supports the |
421 |
|
[CODE(URI)@en[[[http://suika.fam.cx/www/2006/feature/XDoctype]]]] |
422 |
|
feature, a [CODE(DOMi)@en[[[DocumentType]]]] node |
423 |
|
must implement the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] |
424 |
|
interface. See [[DOM XML Document Type Definition]>>3] for |
425 |
|
details. |
426 |
|
|
427 |
|
|
428 |
|
** Children |
429 |
|
|
430 |
|
[2] The [DFN@en[[CODE(DOMa)@en[[[elementTypes]]]] attribute]] |
431 |
|
of the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] interface |
432 |
|
is a live [CODE(DOMi)@en[[[NamedNodeMap]]]] object that |
433 |
|
contains all element types belongs to the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] |
434 |
|
node. The type of the attribute is [CODE(DOMi)@en[[[NamedNodeMap]]]]. |
435 |
|
The attribute is read-only. |
436 |
|
|
437 |
|
What are contained in this collection depends on how |
438 |
|
the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] node was created. If the |
439 |
|
node was created as the result of parsing of an XML document, |
440 |
|
it [['''MUST''']] contain all element types whose element type and / or |
441 |
|
attribute definition list declaration are encountered by and provided for the DOM |
442 |
|
implementation from the XML processor. Note that the XML processor might not |
443 |
|
provide a part of or entire such information depending on the configuration. |
444 |
|
If more than one declarations for an element type or an attribute is available |
445 |
|
at the time of the definition node construction, then declarations other than |
446 |
|
the first ones [['''MUST''']] be discarded. |
447 |
|
|
448 |
|
The attribute [['''MUST''']] return the [CODE(DOMi)@en[[[NamedNodeMap]]]] |
449 |
|
object that contains all the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] nodes |
450 |
|
belong to the node. The returned [CODE(DOMi)@en[[[NamedNodeMap]]]] object |
451 |
|
[['''MUST''']] be read-only if and only if the node is read-only. |
452 |
|
Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live |
453 |
|
and therefore any change of read-only flag on the node is immediately |
454 |
|
reflected by that of the object. |
455 |
|
|
456 |
|
[3] The [DFN@en[[CODE(DOMa)@en[[[generalEntities]]]] attribute]] |
457 |
|
of the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] interface |
458 |
|
is a live [CODE(DOMi)@en[[[NamedNodeMap]]]] object that contains all the |
459 |
|
general entities belong to the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] node. |
460 |
|
The type of the attribute is [CODE(DOMi)@en[[[NamedNodeMap]]]]. |
461 |
|
The attribute is read-only. |
462 |
|
|
463 |
|
All entities declared in the document type definition |
464 |
|
contained in or referenced from the document entity |
465 |
|
might not be exposed through this collection, depending |
466 |
|
on the information provided by the XML processor for |
467 |
|
the DOM implementation. In particular, it might not |
468 |
|
contain any entity if entity references are expanded |
469 |
|
at the parse time. An implementation [['''MUST NOT''']] |
470 |
|
expose an [CODE(DOMi)@en[[[Entity]]]] node whose [CODE(DOMa)@en[[[nodeName]]]] |
471 |
|
is equal to the name of one of five predefined general entities in |
472 |
|
XML through the collection as the result of parsing of an XML |
473 |
|
document that has no error. Duplicate entity declarations are also discarded. |
474 |
|
|
475 |
|
The attribute [['''MUST''']] return the [CODE(DOMi)@en[[[NamedNodeMap]]]] |
476 |
|
object that contains all the [CODE(DOMi)@en[[[Entity]]]] nodes |
477 |
|
representing general entities belong to the node. The returned |
478 |
|
[CODE(DOMi)@en[[[NamedNodeMap]]]] object [['''MUST''']] be read-only if and only if |
479 |
|
the node is read-only. Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live |
480 |
|
and therefore any change of read-only flag on the node is immediately |
481 |
|
reflected by that of the object. |
482 |
|
|
483 |
|
The attribute [['''MUST''']] return the same value as the |
484 |
|
[CODE(DOMa)@en[[[entites]]]] attribute of the |
485 |
|
[CODE(DOMi)@en[[[DocumentType]]]] interface on the same node. |
486 |
|
|
487 |
|
[4] The [DFN@en[[CODE(DOMa)@en[[[notations]]]] attribute]] |
488 |
|
of the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] interface |
489 |
|
is a live [CODE(DOMi)@en[[[NamedNodeMap]]]] object that contains |
490 |
|
all the notations belong to the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] |
491 |
|
node. The type of the attribute is [CODE(DOMi)@en[[[NamedNodeMap]]]]. |
492 |
|
The attribute is read-only. |
493 |
|
|
494 |
|
If the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] node is |
495 |
|
created from an XML document, duplicate notation declarations, if any, in DTD |
496 |
|
[['''MUST NOT''']] result in a node in the [CODE(DOMi)@en[[[NamedNodeMap]]]] |
497 |
|
object and only the first declaration [['''MUST''']] be |
498 |
|
made available as a [CODE(DOMi)@en[[[Notation]]]] node. |
499 |
|
|
500 |
|
;; This definition is based on one for the |
501 |
|
[CODE(DOMa)@en[[[notations]]]] attribute of the |
502 |
|
[CODE(DOMi)@en[[[DocumentType]]]] interface in DOM XML module. |
503 |
|
Since duplication is violation to the Validity Constraint, |
504 |
|
XML parsers might vary on how notations are notified to |
505 |
|
the application. In particular, [CODE(InfoProp)@en[[[notations]]]] |
506 |
|
property of the document information item in XML Information Set |
507 |
|
is so defined that in case ''any'' notation is declared for |
508 |
|
multiple times then the property has no value. |
509 |
|
|
510 |
|
The attribute [['''MUST''']] return the [CODE(DOMi)@en[[[NamedNodeMap]]]] |
511 |
|
object that contains all the [CODE(DOMi)@en[[[Notation]]]] nodes |
512 |
|
representing notations belong to the node. The returned |
513 |
|
[CODE(DOMi)@en[[[NamedNodeMap]]]] object [['''MUST''']] be read-only if and only if |
514 |
|
the node is read-only. Note that the [CODE(DOMi)@en[[[NamedNodeMap]]]] object is live |
515 |
|
and therefore any change of read-only flag on the node is immediately |
516 |
|
reflected by that of the object. |
517 |
|
|
518 |
|
A DOM implementation is not required to implement the |
519 |
|
[CODE(DOMa)@en[[[notations]]]] attribute twice |
520 |
|
for the [CODE(DOMi)@en[[[DocumentType]]]] and |
521 |
|
the [CODE(DOMi)@en[[[DocumentTypeDefinition]]]] interfaces; |
522 |
|
the latter is defined to contain the same value as the former. |
523 |
|
|
524 |
|
|
525 |
|
** Open Issues (informative) |
526 |
|
|
527 |
|
[5] A future version of the interface might define the |
528 |
|
[CODE(DOMa)@en[[[parameterEntities]]]] attribute and |
529 |
|
getter/setter for parameter entities. |
530 |
|
</pre> |
531 |
|
</div> |
532 |
|
|
533 |
|
<div class=section id=section-elementtypedefinition> |
534 |
|
<h2>The <code>ElementTypeDefinition</code> Interface</h2> |
535 |
|
|
536 |
|
<pre class=idl><code>interface <dfn id=ElementTypeDefinition><code>ElementTypeDefinition</code></dfn> { |
537 |
|
|
538 |
|
}</code></pre> |
539 |
|
|
540 |
|
<pre class=ed>** Modifications to [CODE(DOMi)@en[[[Node]]]] members |
541 |
|
|
542 |
|
[3] The getter of the [CODE(DOMa)@en[[[attributes]]]] attribute |
543 |
|
of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object |
544 |
|
[['''MUST''']] return [CODE(IDL)@en[[[null]]]]. |
545 |
|
|
546 |
|
[4] The getter of the [CODE(DOMa)@en[[[baseURI]]]] attribute |
547 |
|
of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object |
548 |
|
[['''MUST''']] return the [CODE(DOMa)@en[[[baseURI]]]] |
549 |
|
of the [CDOE(DOMa)@en[[[ownerDocument]]]] of the |
550 |
|
[CODE(DOMi)@en[[[ElementTypeDefinition]]]] object. |
551 |
|
Note that it might be [CODE(IDL)@en[[[null]]]]. |
552 |
|
|
553 |
|
[1] The getter of the [CODE(DOMa)@en[[[nodeName]]]] attribute |
554 |
|
of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] object |
555 |
|
[['''MUST''']] return the name of the element type. |
556 |
|
|
557 |
|
[2] The getters of the [CODE(DOMa)@en[[[nodeValue]]]] |
558 |
|
and [CODE(DOMa)@en[[[textContent]]]] attributes |
559 |
|
of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
560 |
|
object [['''MUST''']] return [CODE(IDL)@en[[[null]]]]. |
561 |
|
|
562 |
|
;; Thus, the setter of these attributes do nothing. |
563 |
|
|
564 |
|
The setter of the [CODE(DOMa)@en[[[textContent]]]] |
565 |
|
attribute of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
566 |
|
object [['''MUST NOT''']] throw a |
567 |
|
[CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]]. |
568 |
|
|
569 |
|
** The [CODE(DOMi)@en[ElementTypeDefinition]] Interface |
570 |
|
|
571 |
|
[5] The |
572 |
|
[DFN@en[[CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]] attribute]] |
573 |
|
of the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
574 |
|
interface is defined in [[manakai//DOM Extensions]>>50].</pre> |
575 |
|
</div> |
576 |
|
|
577 |
|
<div class=section id=section-attributedefinition> |
578 |
|
<h2>The <code>AttributeDefinition</code> Interface</h2> |
579 |
|
|
580 |
|
<pre class=idl><code>interface <dfn id=AttributeDefinition><code>AttributeDefinition</code></dfn> { |
581 |
|
|
582 |
|
}</code></pre> |
583 |
|
|
584 |
|
<pre class=ed>** Modifications to [CODE(DOMi)@en[[[Node]]]] members |
585 |
|
|
586 |
|
[3] The getter of the [CODE(DOMa)@en[[[attributes]]]] attribute |
587 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
588 |
|
[['''MUST''']] return [CODE(IDL)@en[[[null]]]]. |
589 |
|
|
590 |
|
[9] The getter of the [CODE(DOMa)@en[[[baseURI]]]] attribute |
591 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
592 |
|
[['''MUST''']] return the [CODE(DOMa)@en[[[baseURI]]]] |
593 |
|
of the [CDOE(DOMa)@en[[[ownerDocument]]]] of the |
594 |
|
[CODE(DOMi)@en[[[AttributeDefinition]]]] object. |
595 |
|
Note that it might be [CODE(IDL)@en[[[null]]]]. |
596 |
|
|
597 |
|
[1] The getter of the [CODE(DOMa)@en[[[nodeName]]]] attribute |
598 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
599 |
|
[['''MUST''']] return the name of the attribute. |
600 |
|
|
601 |
|
[2] The getter of the [CODE(DOMa)@en[[[nodeValue]]]] attribute |
602 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
603 |
|
[['''MUST''']] return the normalized default value |
604 |
|
of the attribute. |
605 |
|
|
606 |
|
@@ |
607 |
|
|
608 |
|
[4] The getter of the [CODE(DOMa)@en[[[textContent]]]] |
609 |
|
attribute of an [CODE(DOMi)@en[[[AttributeDefinition]]]] |
610 |
|
object [['''MUST''']] behave as if it were an |
611 |
|
[CODE(DOMi)@en[[[Attr]]]] object. |
612 |
|
|
613 |
|
The setter of the [CODE(DOMa)@en[[[textContent]]]] attribute |
614 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
615 |
|
[['''MUST''']] behave as if the following algorithm |
616 |
|
is performed: |
617 |
|
= If the [CODE(DOMi)@en[[[AttributeDefinition]]]] |
618 |
|
object is read-only, then throw an |
619 |
|
[CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]]. |
620 |
|
= Remove any child node the node has. |
621 |
|
= If the new value is not empty and not [CODE(IDL)@en[[[null]]]], |
622 |
|
then create a [CODE(DOMi)@en[[[Text]]]] node |
623 |
|
whose [CODE(DOMa)@en[[[data]]]] is the new value |
624 |
|
and append it to the [CODE(DOMi)@en[[[AttributeDefinition]]]]. |
625 |
|
|
626 |
|
** Definition groups |
627 |
|
|
628 |
|
[6] The |
629 |
|
[DFN@en[definition group [CODE(DOM)@en[[[DeclaredValueType]]]]]] |
630 |
|
contains integers indicating the type of |
631 |
|
attribute value: |
632 |
|
,[CODE(DOMc)@en[[[NO_TYPE_ATTR]]]],[CODE(IDL)[[[0]]]],The attribute value type corresponding to [[no value]] in XML Information Set. |
633 |
|
,[CODE(DOMc)@en[[[CDATA_ATTR]]]],[CODE(IDL)[[[1]]]],The attribute value type is [CODE(XML)@en[[[CDATA]]]]. |
634 |
|
,[CODE(DOMc)@en[[[ID_ATTR]]]],[CODE(IDL)[[[2]]]],The attribute value type is [CODE(XML)@en[[[ID]]]]. |
635 |
|
,[CODE(DOMc)@en[[[IDREF_ATTR]]]],[CODE(IDL)[[[3]]]],The attribute value type is [CODE(XML)@en[[[IDREF]]]]. |
636 |
|
,[CODE(DOMc)@en[[[IDREFS_ATTR]]]],[CODE(IDL)[[[4]]]],The attribute value type is [CODE(XML)@en[[[IDREFS]]]]. |
637 |
|
,[CODE(DOMc)@en[[[ENTITY_ATTR]]]],[CODE(IDL)[[[5]]]],The attribute value type is [CODE(XML)@en[[[ENTITY]]]]. |
638 |
|
,[CODE(DOMc)@en[[[ENTITIES_ATTR]]]],[CODE(IDL)[[[6]]]],The attribute value type is [CODE(XML)@en[[[ENTITIES]]]]. |
639 |
|
,[CODE(DOMc)@en[[[NMTOKEN_ATTR]]]],[CODE(IDL)[[[7]]]],The attribute value type is [CODE(XML)@en[[[NMTOKEN]]]]. |
640 |
|
,[CODE(DOMc)@en[[[NMTOKENS_ATTR]]]],[CODE(IDL)[[[8]]]],The attribute value type is [CODE(XML)@en[[[NMTOKENS]]]]. |
641 |
|
,[CODE(DOMc)@en[[[NOTATION_ATTR]]]],[CODE(IDL)[[[9]]]],The attribute value type is [CODE(XML)@en[[[NOTATION]]]]. |
642 |
|
,[CODE(DOMc)@en[[[ENUMERATION_ATTR]]]],[CODE(IDL)[[[10]]]],The attribute value is enumeration type. |
643 |
|
,[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." |
644 |
|
|
645 |
|
The type of these constants are |
646 |
|
[CODE(IDL)@en[[[unsigned]] [[short]]]]. |
647 |
|
|
648 |
|
If no attribute type information is provided, |
649 |
|
or if the source of that information does not |
650 |
|
distinguish [[no value]] and [[unknown]] as in |
651 |
|
XML Information Set, then the |
652 |
|
[CODE(DOMc)@en[[[NO_TYPE_ATTR]]]] value |
653 |
|
[['''MUST''']] be used. |
654 |
|
|
655 |
|
;; A newly created [CODE(DOMi)@en[[[AttributeDefinition]]]] |
656 |
|
object by [CODE(DOMm)@en[[[createAttributeDefinition]]]] |
657 |
|
method has [CODE(DOMa)@en[[[declaredType]]]] attribute |
658 |
|
set to [CODE(DOMc)@en[[[NO_TYPE_ATTR]]]]. |
659 |
|
|
660 |
|
If the source of the attribute type information |
661 |
|
does not distinguish [[no value]] and / or [[unknown]] |
662 |
|
and [CODE(XML)@en[[[CDATA]]]], then the |
663 |
|
[CODE(DOMc)@en[[[CDATA_ATTR]]]] value [['''MUST''']] |
664 |
|
be used. |
665 |
|
|
666 |
|
[11] |
667 |
|
In Perl binding, the objects implementing the |
668 |
|
[CODE(DOMi)@en[[[Attr]]]] interface [['''MUST''']] |
669 |
|
also implement the [CODE(DOM)@en[[[DeclaredValueType]]]] |
670 |
|
constant group. |
671 |
|
|
672 |
|
[7] The |
673 |
|
[DFN@en[definition group [CODE(DOM)@en[[[DefaultValueType]]]]]] |
674 |
|
contains integers indicating the type of |
675 |
|
default attribute value: |
676 |
|
,[CODE(DOMc)@en[[[UNKNOWN_DEFAULT]]]],[CODE(IDL)[[[0]]]],The default value is unknown. |
677 |
|
,[CODE(DOMc)@en[[[FIXED_DEFAULT]]]],[CODE(IDL)[[[1]]]],The default value is provided and the attribute is [CODE(XML)@en[#[[FIXED]]]] to that value. |
678 |
|
,[CODE(DOMc)@en[[[REQUIRED_DEFAULT]]]],[CODE(IDL)[[[2]]]],An attribute specification is [CODE(XML)@en[#[[REQUIRED]]]] for the attribute. |
679 |
|
,[CODE(DOMc)@en[[[IMPLIED_DEFAULT]]]],[CODE(IDL)[[[3]]]],The default value is [CODE(XML)@en[#[[IMPLIED]]]]. |
680 |
|
,[CODE(DOMc)@en[[[EXPLICIT_DEFAULT]]]],[CODE(IDL)[[[4]]]],The default value is provided but the attribute is not fixed to it. |
681 |
|
|
682 |
|
The type of these constants are |
683 |
|
[CODE(IDL)@en[[[unsigned]] [[short]]]]. |
684 |
|
|
685 |
|
If the source of the attribute default value type |
686 |
|
does not distinguish the [CODE(XML)@en[#[[IMPLIED]]]] |
687 |
|
default and unknown default, then the |
688 |
|
[CODE(DOMc)@en[[[IMPLIED_DEFAULT]]]] value |
689 |
|
[['''MUST''']] be used. |
690 |
|
|
691 |
|
;; A newly created [CODE(DOMi)@en[[[AttributeDefinition]]]] |
692 |
|
object by [CODE(DOMm)@en[[[createAttributeDefinition]]]] |
693 |
|
method has [CODE(DOMa)@en[[[declaredType]]]] attribute |
694 |
|
set to [CODE(DOMc)@en[[[NO_TYPE_ATTR]]]]. |
695 |
|
|
696 |
|
** Tree-relationship Attributes |
697 |
|
|
698 |
|
[10] |
699 |
|
The |
700 |
|
[DFN@en[[CODE(DOMa)@en[[[ownerElementTypeDefinition]]]] attribute]] |
701 |
|
of the [CODE(DOMi)@en[[[AttributeDefinition]]]] interface |
702 |
|
is read-only and of type |
703 |
|
[CODE(DOMi)@en[[[ElementTypeDefinition]]]]. |
704 |
|
It is the [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node |
705 |
|
which the [CODE(DOMi)@en[[[AttributeDefinition]]]] node |
706 |
|
belong to. |
707 |
|
|
708 |
|
If the [CODE(DOMi)@en[[[AttributeDefinition]]]] node |
709 |
|
is included in the [CODE(DOMa)@en[[[attributeDefinitions]]]] |
710 |
|
list of an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node, |
711 |
|
then the attribute [['''MUST''']] return the |
712 |
|
[CODE(DOMi)@en[[[ElementTypeDefinition]]]] node. |
713 |
|
Otherwise, it [['''MUST''']] return [CODE(DOM)@en[[[null]]]]. |
714 |
|
|
715 |
|
;; This attribute is analogue to the |
716 |
|
[CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]] attribute |
717 |
|
for [CODE(DOMi)@en[[[ElementTypeDefinition]]]], |
718 |
|
[CODE(DOMi)@en[[[Entity]]]], and [CODE(DOMi)@en[[[Notation]]]] |
719 |
|
nodes, or the [CODE(DOMa)@en[[[ownerElement]]]] |
720 |
|
attribute for [CODE(DOMi)@en[[[Attr]]]] nodes. |
721 |
|
|
722 |
|
** Attributes |
723 |
|
|
724 |
|
[5] |
725 |
|
The [DFN@en[[CODE(DOMa)@en[[[declaredType]]]] attribute]] |
726 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
727 |
|
represents the type of the attribute value. |
728 |
|
|
729 |
|
This attribute is read-write. |
730 |
|
The type of the attribute is |
731 |
|
[CODE(IDL)@en[[[unsigned]] [[short]]]]. It is expected |
732 |
|
that this attribute has a value from the definition group |
733 |
|
[CODE(DOM)@en[[[DeclaredValueType]]]]. |
734 |
|
|
735 |
|
The getter [['''MUST''']] return a value associated |
736 |
|
to this attribute. |
737 |
|
|
738 |
|
The setter [['''MUST''']] |
739 |
|
throw a [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]] |
740 |
|
[CODE(DOMi)@en[[[DOMException]]]] if the |
741 |
|
[CODE(DOMi)@en[[[AttributeDefinition]]]] object is read-only. |
742 |
|
Otherwise, the setter [['''MUST''']] set the specified |
743 |
|
value as the value associated to this attribute. |
744 |
|
|
745 |
|
If a parser create an [CODE(DOMi)@en[[[AttributeDefinition]]]] |
746 |
|
object, then it [['''MUST''']] set a value |
747 |
|
from the [CODE(DOM)@en[[[DeclaredValueType]]]] |
748 |
|
definition group. |
749 |
|
|
750 |
|
[8] |
751 |
|
The [DFN@en[[CODE(DOMa)@en[[[defaultType]]]] attribute]] |
752 |
|
of an [CODE(DOMi)@en[[[AttributeDefinition]]]] object |
753 |
|
represents the type of the attribute default value. |
754 |
|
|
755 |
|
This attribute is read-write. |
756 |
|
The type of the attribute is |
757 |
|
[CODE(IDL)@en[[[unsigned]] [[short]]]]. It is expected |
758 |
|
that this attribute has a value from the definition group |
759 |
|
[CODE(DOM)@en[[[DefaultValueType]]]]. |
760 |
|
|
761 |
|
The getter [['''MUST''']] return a value associated |
762 |
|
to this attribute. |
763 |
|
|
764 |
|
The setter [['''MUST''']] |
765 |
|
throw a [CODE(DOMc)@en[[[NO_MODIFICATION_ALLOWED_ERR]]]] |
766 |
|
[CODE(DOMi)@en[[[DOMException]]]] if the |
767 |
|
[CODE(DOMi)@en[[[AttributeDefinition]]]] object is read-only. |
768 |
|
Otherwise, the setter [['''MUST''']] set the specified |
769 |
|
value as the value associated to this attribute. |
770 |
|
|
771 |
|
If a parser create an [CODE(DOMi)@en[[[AttributeDefinition]]]] |
772 |
|
object, then it [['''MUST''']] set a value |
773 |
|
from the [CODE(DOM)@en[[[DefaultValueType]]]] |
774 |
|
definition group.</pre> |
775 |
|
</div> |
776 |
|
|
777 |
</div> |
</div> |
778 |
|
|
779 |
|
|