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> |
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> |
}</code></pre> |
195 |
|
|
196 |
<pre class=ed> |
<div class=ed>@@ cast definition</div> |
|
* The [CODE(DOMi)@en[DocumentXDoctype]] Interface Specification |
|
|
|
|
|
[1] [[manakai//DOM Extensions]] > New Interfaces > |
|
|
[[DOM XML Document Type Definition]] module > |
|
|
The [CODE(DOMi)@en[[[DocumentXDoctype]]]] Interface |
|
|
|
|
|
[2] |
|
|
@@ cast |
|
|
|
|
|
** Constructors |
|
|
|
|
|
[3] The |
|
|
[DFN@en[[CODE(DOMm)@en[[[createDocumentTypeDefinition]]]] method]] |
|
|
returns a [CODE(DOMi)@en[[[DocumentType]]]] node |
|
|
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
|
|
It creates a [CODE(DOMi)@en[[[DocumentType]]]] node |
|
|
of the given name, belonging to the document. |
|
|
|
|
|
[3] The |
|
|
[DFN@en[[CODE(DOMm)@en[[[createElementTypeDefinition]]]] method]] |
|
|
returns an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node |
|
|
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
|
|
It creates an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node |
|
|
of the given name, belonging to the document. |
|
|
|
|
|
[4] The |
|
|
[DFN@en[[CODE(DOMm)@en[[[createAttributeDefinition]]]] method]] |
|
|
returns an [CODE(DOMi)@en[[[AttributeDefinition]]]] node |
|
|
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
|
|
It creates an [CODE(DOMi)@en[[[AttributeDefinition]]]] node |
|
|
of the given name, belonging to the document. |
|
|
|
|
|
[10] The |
|
|
[DFN@en[[CODE(DOMm)@en[[[createGeneralEntity]]]] method]] |
|
|
returns an [CODE(DOMi)@en[[[Entity]]]] node |
|
|
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
|
|
It creates an [CODE(DOMi)@en[[[Entity]]]] node, |
|
|
which represents a general entity, |
|
|
of the given name, belonging to the document. |
|
|
|
|
|
[12] The |
|
|
[DFN@en[[CODE(DOMm)@en[[[createNotation]]]] method]] |
|
|
returns a [CODE(DOMi)@en[[[Notation]]]] node |
|
|
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
|
|
It creates a [CODE(DOMi)@en[[[Notation]]]] node |
|
|
of the given name, belonging to the document. |
|
|
|
|
|
[5] |
|
|
These method take a parameter [CODE(DOMp)@en[[[name]]]], |
|
|
of type [CODE(DOMi)@en[[[DOMString]]]]. It is |
|
|
the document type name, element type name, |
|
|
or attribute name of the node to be created. |
|
|
|
|
|
[6] |
|
|
The [CODE(DOMm)@en[[[createDocumentTypeDefinition]]]] |
|
|
method [['''MUST''']] create a [CODE(DOMi)@en[[[DocumentType]]]] |
|
|
object with the following attribute values: |
|
|
- [CODE(DOMa)@en[[[attributes]]]], |
|
|
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
|
|
- [CODE(DOMa)@en[[[elementTypes]]]], |
|
|
[CODE(DOMa)@en[[[generalEntities]]]], |
|
|
[CODE(DOMa)@en[[[notations]]]]: Empty |
|
|
[CODE(DOMi)@en[[[NamedNodeMap]]]]s. |
|
|
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
|
|
[CODE(DOMi)@en[[[NodeList]]]]. |
|
|
- [CODE(DOMa)@en[[[entities]]]]: The same |
|
|
[CODE(DOMi)@en[[[NamedNodeMap]]]] as |
|
|
[CODE(DOMa)@en[[[generalEntities]]]]. |
|
|
- [CODE(DOMa)@en[[[internalSubset]]]], |
|
|
[CODE(DOMa)@en[[[publicId]]]], [CODE(DOMa)@en[[[systemId]]]]: |
|
|
Empty strings. |
|
|
- [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. |
|
|
|
|
|
In addition, it [['''MUST''']] be marked as containing |
|
|
five general entity declarations for XML predefined |
|
|
entities, i.e. [CODE(XML)@en[[[amp]]]], [CODE(XML)@en[[[lt]]]], |
|
|
[CODE(XML)@en[[[gt]]]], [CODE(XML)@en[[[quot]]]], and |
|
|
[CODE(XML)@en[[[apos]]]]. |
|
|
|
|
|
[8] |
|
|
The [CODE(DOMm)@en[[[createElementTypeDefinition]]]] |
|
|
method [['''MUST''']] create an |
|
|
[CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
|
|
object with the following attribute values: |
|
|
- [CODE(DOMa)@en[[[attributeDefinitions]]]]: |
|
|
An empty [CODE(DOMi)@en[[[NamedNodeMap]]]]. |
|
|
- [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[[[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]]]]. |
|
|
|
|
|
@@ 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. |
|
197 |
|
|
198 |
Otherwise, these method [['''MUST''']] return |
<dl> |
199 |
the newly created node. |
<dt><dfn id=createDocumentTypeDefinition class=dom-method><code>createDocumentTypeDefinition</code></dfn>, |
200 |
</pre> |
method</dt> |
201 |
|
<dd> |
202 |
|
<p>This method creates a <code>DocumentType</code> node with the specified |
203 |
|
name, belonging to the document.</p> |
204 |
|
<p>The <dfn id=createDocumentTypeDefinition-name class=dom-param><var>name</var></dfn> |
205 |
|
parameter is the name of the document type.</p> |
206 |
|
|
207 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
208 |
|
return a <code>DocumentType</code> node with the following attributes:</p> |
209 |
|
<dl> |
210 |
|
<dt><code>attributes</code>, <code>parentNode</code></dt> |
211 |
|
<dd><code>null</code>.</dd> |
212 |
|
<dt><code>elementTypes</code>, <code>generalEntities</code>, and |
213 |
|
<code>notations</code></dt> |
214 |
|
<dd>Empty <code>NamedNodeMap</code> objects.</dd> |
215 |
|
<dt><code>entities</code></dt> |
216 |
|
<dd>The same value as the <code>generalEntities</code> attribute.</dd> |
217 |
|
<dt><code>childNodes</code></dt> |
218 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
219 |
|
<dt><code>internalSubset</code>, <code>publicId</code>, and |
220 |
|
<code>systemId</code></dt> |
221 |
|
<dd>Empty strings.</dd> |
222 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
223 |
|
<dd><code>false</code>.</dd> |
224 |
|
<dt><code>nodeName</code></dt> |
225 |
|
<dd><a href="#createDocumentTypeDefinition-name"><var>name</var></a>.</dd> |
226 |
|
<dt><code>ownerDocument</code></dt> |
227 |
|
<dd>The <code>Document</code> over which the method is invoked.</dd> |
228 |
|
</dl> |
229 |
|
<p>In addition, the method <em class=rfc2119>MUST</em> be marked as |
230 |
|
containing five general entity declarations: <code>amp</code>, |
231 |
|
<code>lt</code>, <code>gt</code>, <code>quot</code>, and |
232 |
|
<code>apos</code>.</p> |
233 |
|
</dd> |
234 |
|
<dt><dfn id=createElementTypeDefinition class=dom-method><code>createElementTypeDefinition</code></dfn>, |
235 |
|
method</dt> |
236 |
|
<dd> |
237 |
|
<p>This method creates a <code>ElementTypeDefinition</code> node with the |
238 |
|
specified name, belonging to the document.</p> |
239 |
|
<p>The <dfn id=createElementTypeDefinition-name class=dom-param><var>name</var></dfn> |
240 |
|
parameter is the name of the element type defined by the element |
241 |
|
type definition.</p> |
242 |
|
|
243 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
244 |
|
return an |
245 |
|
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
246 |
|
node with the following attributes:</p> |
247 |
|
<dl> |
248 |
|
<dt><a href="#attributeDefinitions"><code>attributeDefinitions</code></a></dt> |
249 |
|
<dd>An empty <code>NamedNodeMap</code> object.</dd> |
250 |
|
<dt><code>attributes</code>, <code>parentNode</code></dt> |
251 |
|
<dd><code>null</code>.</dd> |
252 |
|
<dt><code>childNodes</code></dt> |
253 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
254 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
255 |
|
<dd><code>false</code>.</dd> |
256 |
|
<dt><code>nodeName</code></dt> |
257 |
|
<dd><a href="#createElementTypeDefinition-name"><var>name</var></a>.</dd> |
258 |
|
<dt><code>ownerDocument</code></dt> |
259 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
260 |
|
<dt><a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a></dt> |
261 |
|
<dd><code>null</code>.</dd> |
262 |
|
<dt class=ed>@@ Ensure all attributes are defined</dt> |
263 |
|
</dl> |
264 |
|
</dd> |
265 |
|
<dt><dfn id=createAttributeDefinition class=dom-method><code>createAttributeDefinition</code></dfn>, |
266 |
|
method</dt> |
267 |
|
<dd> |
268 |
|
<p>This method creates a <code>AttributeDefinition</code> node with the |
269 |
|
specified name, belonging to the document.</p> |
270 |
|
<p>The <dfn id=createAttributeDefinition-name class=dom-param><var>name</var></dfn> |
271 |
|
parameter is the name of the attribute defined by the attribute |
272 |
|
definition.</p> |
273 |
|
|
274 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
275 |
|
return an |
276 |
|
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
277 |
|
node with the following attributes:</p> |
278 |
|
<dl> |
279 |
|
<dt><code>allowedTokens</code></dt> |
280 |
|
<dd>An empty <code>DOMStringList</code> object.</dd> |
281 |
|
<dt><code>attributes</code>, |
282 |
|
<a href="#ownerElementTypeDefinition"><code>ownerElementTypeDefinition</code></a>, |
283 |
|
and <code>parentNode</code></dt> |
284 |
|
<dd><code>null</code>.</dd> |
285 |
|
<dt><code>childNodes</code></dt> |
286 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
287 |
|
<dt><code>declaredType</code></dt> |
288 |
|
<dd><a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a>.</dd> |
289 |
|
<dt><code>defaultType</code></dt> |
290 |
|
<dd><a href="#UNKNOWN_DEFAULT"><code>UNKNOWN_DEFAULT</code></a>.</dd> |
291 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
292 |
|
<dd><code>false</code>.</dd> |
293 |
|
<dt><code>nodeName</code></dt> |
294 |
|
<dd><a href="#createAttributeDefinition-name"><var>name</var></a>.</dd> |
295 |
|
<dt><code>ownerDocument</code></dt> |
296 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
297 |
|
<dt class=ed>@@ Ensure all attributes are defined</dt> |
298 |
|
</dl> |
299 |
|
|
300 |
|
<div class=ed> |
301 |
|
<p>@@ Should we keep these statements?: |
302 |
|
However, if the <cfg::cfg|xml-id> configuration |
303 |
|
parameter is set to <code>true</code> and the <var>name</var> |
304 |
|
is <code>xml:id</code>, then the [CODE(DOMa)@en[[[declaredType]]]] |
305 |
|
attribute is set to <code>ID_ATTR</code>. |
306 |
|
[CODE(DOMa)@en[[[defaultType]]]]?</p> |
307 |
|
</div> |
308 |
|
</dd> |
309 |
|
<dt><dfn id=createGeneralEntity class=dom-method><code>createGeneralEntity</code></dfn>, |
310 |
|
method</dt> |
311 |
|
<dd> |
312 |
|
<p>This method creates a <a href="#Entity"><code>Entity</code></a> node |
313 |
|
with the specified name, which represents a general entity, belonging to |
314 |
|
the document.</p> |
315 |
|
<p>The <dfn id=createGeneralEntity-name class=dom-param><var>name</var></dfn> |
316 |
|
parameter is the name of the general entity.</p> |
317 |
|
|
318 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and return |
319 |
|
an <a href="#Entity"><code>Entity</code></a> node with the following |
320 |
|
attributes:</p> |
321 |
|
<dl> |
322 |
|
<dt><code>attributes</code>, <code>notationName</code>, |
323 |
|
<a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a>, |
324 |
|
and <code>parentNode</code></dt> |
325 |
|
<dd><code>null</code>.</dd> |
326 |
|
<dt><code>childNodes</code></dt> |
327 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
328 |
|
<dt><code>manakaiDeclarationBaseURI</code>, |
329 |
|
<code>manakaiEntityBaseURI</code>, and |
330 |
|
<code>manakaiEntityURI</code> <span class=ed>@@ ref</span></dt> |
331 |
|
<dd>No explicit value is set.</dd> |
332 |
|
<dt><code>manakaiHasReplacementTree</code> and |
333 |
|
<code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
334 |
|
<dd><code>false</code>.</dd> |
335 |
|
<dt><code>nodeName</code></dt> |
336 |
|
<dd><a href="#createGeneralEntity-name"><var>name</var></a>.</dd> |
337 |
|
<dd> |
338 |
|
<div class="note memo"> |
339 |
|
<p>It is not an error for |
340 |
|
<a href="#createGeneralEntity-name"><var>name</var></a> matching |
341 |
|
to the name of one of predefined general parsed entities in |
342 |
|
<abbr>XML</abbr> or <abbr>HTML</abbr>. For example, |
343 |
|
<a href="#createGeneralEntity-name"><var>name</var></a> might be |
344 |
|
<code>amp</code>, resulting in an |
345 |
|
<a href="#Entity"><code>Entity</code></a> node |
346 |
|
with its <code>nodeName</code> attribute set to <code>amp</code>.</p> |
347 |
|
</div> |
348 |
|
</dd> |
349 |
|
<dt><code>ownerDocument</code></dt> |
350 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
351 |
|
<dt><code>publicId</code>, and <code>systemId</code></dt> |
352 |
|
<dd><code>null</code>.</dd> |
353 |
|
<dd class=ed>@@ publicId and systemId should be empty string?</dd> |
354 |
|
<dt class=ed>@@ Ensure all attributes are defined</dd> |
355 |
|
</dl> |
356 |
|
</dd> |
357 |
|
<dt><dfn id=createNotation class=dom-method><code>createNotation</code></dfn>, |
358 |
|
method</dt> |
359 |
|
<dd> |
360 |
|
<p>This method creates a <code>Notation</code> node with the |
361 |
|
specified name, belonging to the document.</p> |
362 |
|
<p>The <dfn id=createNotation-name class=dom-param><var>name</var></dfn> |
363 |
|
parameter is the name of the notation.</p> |
364 |
|
|
365 |
|
<p>When invoked, the method <em class=rfc2119>MUST</em> create and return |
366 |
|
a <code>Notation</code> node with the following attributes:</p> |
367 |
|
<dl> |
368 |
|
<dt><code>attributes</code>, |
369 |
|
<a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a>, |
370 |
|
and <code>parentNode</code></dt> |
371 |
|
<dd><code>null</code>.</dd> |
372 |
|
<dt><code>childNodes</code></dt> |
373 |
|
<dd>An empty <code>NodeList</code> object.</dd> |
374 |
|
<dt><code>manakaiDeclarationBaseURI</code></dt> |
375 |
|
<dd>No explicit value is set.</dd> |
376 |
|
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
377 |
|
<dd><code>false</code>.</dd> |
378 |
|
<dt><code>nodeName</code></dt> |
379 |
|
<dd><a href="#createNotation-name"><var>name</var></a>.</dd> |
380 |
|
<dt><code>ownerDocument</code></dt> |
381 |
|
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
382 |
|
<dt><code>publicId</code> and <code>systemId</code></dt> |
383 |
|
<dd><code>null</code>.</dd> |
384 |
|
<dd class=ed>@@ publicId and systemId should be empty string?</dd> |
385 |
|
<dt class=ed>@@ Ensure all attributes are defined</dt> |
386 |
|
</dl> |
387 |
|
</dd> |
388 |
|
</dl> |
389 |
|
|
390 |
|
<p>These methods <em class=rfc2119>MUST</em> raise an |
391 |
|
<code>INVALID_CHARACTER_ERR</code> exception <span class=ed>@@ ref</span> |
392 |
|
if <var>name</var> is <em>not</em> a legal <code>Name</code> according to |
393 |
|
the <abbr>XML</abbr> version in use, as specified in the |
394 |
|
<code>xmlVersion</code> attribute of the <code>Document</code> node.</p> |
395 |
|
|
396 |
|
<div class="note memo"> |
397 |
|
<p>Non$B!>(B<abbr>XML</abbr> case is intentionally left unspecified for now, |
398 |
|
since <abbr>DOM3</abbr> specification <span class=ed>@@ ref</span> does not |
399 |
|
define it for <code>Document</code> methods.</p> |
400 |
|
|
401 |
|
<p><var>name</var> does not have to be a namespace qualified name.</p> |
402 |
|
|
403 |
|
<p>If the <code>strictErrorChecking</code> attribute of the |
404 |
|
<code>Document</code> node is <code>false</code>, the methods are |
405 |
|
not required to raise the exception <span class=ed>[DOM3]</span>.</p> |
406 |
|
</div> |
407 |
|
|
408 |
</div> |
</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 |
|
|