1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Date: 2001/11/26 22:34:22 $ $Revision: 1.1.1.1 $ -->
<!--[ Node object description ]-->
<interface name="Node" id="ID-1950641247">
<descr>
<p>The <code>Node</code> interface is the primary datatype for the entire Document Object Model.
It represents a single node in the document tree. While all objects
implementing the <code>Node</code> interface expose methods for dealing with children, not all objects
implementing the <code>Node</code> interface may have children. For example, <code>Text</code> nodes may not have children, and adding children to such nodes results
in a <code>DOMException</code> being raised.</p>
<p>The attributes <code>nodeName</code>, <code>nodeValue</code> and <code>attributes</code> are included as a mechanism to get at node information without casting
down to the specific derived interface. In cases where there is no obvious
mapping of these attributes for a specific <code>nodeType</code> (e.g., <code>nodeValue</code> for an <code>Element</code> or <code>attributes</code> for a <code>Comment</code>), this returns <code>null</code>. Note that the specialized interfaces may contain additional and more
convenient mechanisms to get and set the relevant information.</p>
</descr>
<group id="ID-1841493061" name="NodeType">
<descr>
<p>An integer indicating which type of node this is.</p>
<note>
<p>Numeric codes up to 200 are reserved to W3C for possible future
use.</p>
</note>
</descr>
<constant name="ELEMENT_NODE" type="unsigned short" value="1">
<descr>
<p>The node is an <code>Element</code>.</p>
</descr>
</constant>
<constant name="ATTRIBUTE_NODE" type="unsigned short" value="2">
<descr>
<p>The node is an <code>Attr</code>.</p>
</descr>
</constant>
<constant name="TEXT_NODE" type="unsigned short" value="3">
<descr>
<p>The node is a <code>Text</code> node.</p>
</descr>
</constant>
<constant name="CDATA_SECTION_NODE" type="unsigned short" value="4">
<descr>
<p>The node is a <code>CDATASection</code>.</p>
</descr>
</constant>
<constant name="ENTITY_REFERENCE_NODE" type="unsigned short" value="5">
<descr>
<p>The node is an <code>EntityReference</code>.</p>
</descr>
</constant>
<constant name="ENTITY_NODE" type="unsigned short" value="6">
<descr>
<p>The node is an <code>Entity</code>.</p>
</descr>
</constant>
<constant name="PROCESSING_INSTRUCTION_NODE" type="unsigned short"
value="7">
<descr>
<p>The node is a <code>ProcessingInstruction</code>.</p>
</descr>
</constant>
<constant name="COMMENT_NODE" type="unsigned short" value="8">
<descr>
<p>The node is a <code>Comment</code>.</p>
</descr>
</constant>
<constant name="DOCUMENT_NODE" type="unsigned short" value="9">
<descr>
<p>The node is a <code>Document</code>.</p>
</descr>
</constant>
<constant name="DOCUMENT_TYPE_NODE" type="unsigned short" value="10">
<descr>
<p>The node is a <code>DocumentType</code>.</p>
</descr>
</constant>
<constant name="DOCUMENT_FRAGMENT_NODE" type="unsigned short" value="11">
<descr>
<p>The node is a <code>DocumentFragment</code>.</p>
</descr>
</constant>
<constant name="NOTATION_NODE" type="unsigned short" value="12">
<descr>
<p>The node is a <code>Notation</code>.</p>
</descr>
</constant>
</group>
<p>The values of <code>nodeName</code>, <code>nodeValue</code>, and <code>attributes</code> vary according to the node type as follows:
<table border="1">
<tbody>
<tr>
<td></td>
<td>nodeName</td>
<td>nodeValue</td>
<td>attributes</td>
</tr>
<tr>
<td>Attr</td>
<td>name of attribute</td>
<td>value of attribute</td>
<td>null</td>
</tr>
<tr>
<td>CDATASection</td>
<td>#cdata-section</td>
<td>content of the CDATA Section</td>
<td>null</td>
</tr>
<tr>
<td>Comment</td>
<td>#comment</td>
<td>content of the comment</td>
<td>null</td>
</tr>
<tr>
<td>Document</td>
<td>#document</td>
<td>null</td>
<td>null</td>
</tr>
<tr>
<td>DocumentFragment</td>
<td>#document-fragment</td>
<td>null</td>
<td>null</td>
</tr>
<tr>
<td>DocumentType</td>
<td>document type name</td>
<td>null</td>
<td>null</td>
</tr>
<tr>
<td>Element</td>
<td>tag name</td>
<td>null</td>
<td>NamedNodeMap</td>
</tr>
<tr>
<td>Entity</td>
<td>entity name</td>
<td>null</td>
<td>null</td>
</tr>
<tr>
<td>EntityReference</td>
<td>name of entity referenced</td>
<td>null</td>
<td>null</td>
</tr>
<tr>
<td>Notation</td>
<td>notation name</td>
<td>null</td>
<td>null</td>
</tr>
<tr>
<td>ProcessingInstruction</td>
<td>target</td>
<td>entire content excluding the target</td>
<td>null</td>
</tr>
<tr>
<td>Text</td>
<td>#text</td>
<td>content of the text node</td>
<td>null</td>
</tr>
</tbody>
</table> </p>
<attribute type="DOMString" readonly="yes" name="nodeName" id="ID-F68D095">
<descr>
<p>The name of this node, depending on its type; see the table above.
</p>
</descr>
</attribute>
<attribute type="DOMString" name="nodeValue" id="ID-F68D080">
<descr>
<p>The value of this node, depending on its type; see the table above.
When it is defined to be <code>null</code>, setting it has no effect.</p>
</descr>
<setraises>
<exception name="DOMException">
<descr>
<p>NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.</p>
</descr>
</exception>
</setraises>
<getraises>
<exception name="DOMException">
<descr>
<p>DOMSTRING_SIZE_ERR: Raised when it would return more characters
than fit in a <code>DOMString</code> variable on the implementation platform.</p>
</descr>
</exception>
</getraises>
</attribute>
<attribute type="unsigned short" name="nodeType" readonly="yes"
id="ID-111237558">
<descr>
<p>A code representing the type of the underlying object, as defined
above.</p>
</descr>
</attribute>
<attribute type="Node" readonly="yes" name="parentNode" id="ID-1060184317">
<descr>
<p>The <termref def="dt-parent">parent</termref> of this node. All nodes,
except <code>Attr</code>, <code>Document</code>, <code>DocumentFragment</code>, <code>Entity</code>, and <code>Notation</code> may have a parent. However, if a node has just been created and not yet
added to the tree, or if it has been removed from the tree, this is <code>null</code>.</p>
</descr>
</attribute>
<attribute type="NodeList" readonly="yes" name="childNodes"
id="ID-1451460987">
<descr>
<p>A <code>NodeList</code> that contains all children of this node. If there are no children, this
is a <code>NodeList</code> containing no nodes.</p>
</descr>
</attribute>
<attribute readonly="yes" type="Node" name="firstChild" id="ID-169727388">
<descr>
<p>The first child of this node. If there is no such node, this returns <code>null</code>.</p>
</descr>
</attribute>
<attribute readonly="yes" type="Node" name="lastChild" id="ID-61AD09FB">
<descr>
<p>The last child of this node. If there is no such node, this returns <code>null</code>.</p>
</descr>
</attribute>
<attribute readonly="yes" type="Node" name="previousSibling"
id="ID-640FB3C8">
<descr>
<p>The node immediately preceding this node. If there is no such node,
this returns <code>null</code>.</p>
</descr>
</attribute>
<attribute readonly="yes" type="Node" name="nextSibling" id="ID-6AC54C2F">
<descr>
<p>The node immediately following this node. If there is no such node,
this returns <code>null</code>.</p>
</descr>
</attribute>
<attribute readonly="yes" type="NamedNodeMap" name="attributes"
id="ID-84CF096">
<descr>
<p>A <code>NamedNodeMap</code> containing the attributes of this node (if it is an <code>Element</code>) or <code>null</code> otherwise. </p>
</descr>
</attribute>
<attribute readonly="yes" type="Document" name="ownerDocument"
id="node-ownerDoc" version="DOM Level 2">
<descr>
<p>The <code>Document</code> object associated with this node. This is also the <code>Document</code> object used to create new nodes. When this node is a <code>Document</code> or a <code>DocumentType</code> which is not used with any <code>Document</code> yet, this is <code>null</code>.</p>
</descr>
</attribute>
<method name="insertBefore" id="ID-952280727">
<descr>
<p>Inserts the node <code>newChild</code> before the existing child node <code>refChild</code>. If <code>refChild</code> is <code>null</code>, insert <code>newChild</code> at the end of the list of children.</p>
<p>If <code>newChild</code> is a <code>DocumentFragment</code> object, all of its children are inserted, in the same order, before <code>refChild</code>. If the <code>newChild</code> is already in the tree, it is first removed.</p>
</descr>
<parameters>
<param name="newChild" type="Node" attr="in">
<descr>
<p>The node to insert.</p>
</descr>
</param>
<param name="refChild" type="Node" attr="in">
<descr>
<p>The reference node, i.e., the node before which the new node must
be inserted.</p>
</descr>
</param>
</parameters>
<returns type="Node">
<descr>
<p>The node being inserted.</p>
</descr>
</returns>
<raises>
<exception name="DOMException">
<descr>
<p>HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does
not allow children of the type of the <code>newChild</code> node, or if the node to insert is one of this node's
<termref def="dt-ancestor">ancestors</termref>.</p>
<p>WRONG_DOCUMENT_ERR: Raised if <code>newChild</code> was created from a different document than the one that created this
node.</p>
<p>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if
the parent of the node being inserted is readonly.</p>
<p>NOT_FOUND_ERR: Raised if <code>refChild</code> is not a child of this node.</p>
</descr>
</exception>
</raises>
</method>
<method name="replaceChild" id="ID-785887307">
<descr>
<p>Replaces the child node <code>oldChild</code> with <code>newChild</code> in the list of children, and returns the <code>oldChild</code> node.</p>
<p>If <code>newChild</code> is a <code>DocumentFragment</code> object, <code>oldChild</code> is replaced by all of the <code>DocumentFragment</code> children, which are inserted in the same order. If the <code>newChild</code> is already in the tree, it is first removed.</p>
</descr>
<parameters>
<param name="newChild" type="Node" attr="in">
<descr>
<p>The new node to put in the child list.</p>
</descr>
</param>
<param name="oldChild" type="Node" attr="in">
<descr>
<p>The node being replaced in the list.</p>
</descr>
</param>
</parameters>
<returns type="Node">
<descr>
<p>The node replaced.</p>
</descr>
</returns>
<raises>
<exception name="DOMException">
<descr>
<p>HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does
not allow children of the type of the <code>newChild</code> node, or if the node to put in is one of this node's
<termref def="dt-ancestor">ancestors</termref>.</p>
<p>WRONG_DOCUMENT_ERR: Raised if <code>newChild</code> was created from a different document than the one that created this
node.</p>
<p>NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of
the new node is readonly.</p>
<p>NOT_FOUND_ERR: Raised if <code>oldChild</code> is not a child of this node.</p>
</descr>
</exception>
</raises>
</method>
<method name="removeChild" id="ID-1734834066">
<descr>
<p>Removes the child node indicated by <code>oldChild</code> from the list of children, and returns it.</p>
</descr>
<parameters>
<param name="oldChild" type="Node" attr="in">
<descr>
<p>The node being removed.</p>
</descr>
</param>
</parameters>
<returns type="Node">
<descr>
<p>The node removed.</p>
</descr>
</returns>
<raises>
<exception name="DOMException">
<descr>
<p>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.</p>
<p>NOT_FOUND_ERR: Raised if <code>oldChild</code> is not a child of this node.</p>
</descr>
</exception>
</raises>
</method>
<method name="appendChild" id="ID-184E7107">
<descr>
<p>Adds the node <code>newChild</code> to the end of the list of children of this node. If the <code>newChild</code> is already in the tree, it is first removed.</p>
</descr>
<parameters>
<param name="newChild" type="Node" attr="in">
<descr>
<p>The node to add.</p>
<p>If it is a <code>DocumentFragment</code> object, the entire contents of the document fragment are moved into the
child list of this node</p>
</descr>
</param>
</parameters>
<returns type="Node">
<descr>
<p>The node added.</p>
</descr>
</returns>
<raises>
<exception name="DOMException">
<descr>
<p>HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does
not allow children of the type of the <code>newChild</code> node, or if the node to append is one of this node's
<termref def="dt-ancestor">ancestors</termref>.</p>
<p>WRONG_DOCUMENT_ERR: Raised if <code>newChild</code> was created from a different document than the one that created this
node.</p>
<p>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.</p>
</descr>
</exception>
</raises>
</method>
<method name="hasChildNodes" id="ID-810594187">
<descr>
<p>Returns whether this node has any children.</p>
</descr>
<parameters> <!-- No parameters -->
</parameters>
<returns type="boolean">
<descr>
<p> <code>true</code> if this node has any children, <code>false</code> otherwise.</p>
</descr>
</returns>
<raises> <!-- No exceptions -->
</raises>
</method>
<method name="cloneNode" id="ID-3A0ED0A4">
<descr>
<p>Returns a duplicate of this node, i.e., serves as a generic copy
constructor for nodes. The duplicate node has no parent; (<code>parentNode</code> is <code>null</code>.).</p>
<p>Cloning an <code>Element</code> copies all attributes and their values, including those generated by
the XML processor to represent defaulted attributes, but this method does not
copy any text it contains unless it is a deep clone, since the text is
contained in a child <code>Text</code> node. Cloning an <code>Attribute</code> directly, as opposed to be cloned as part of an <code>Element</code> cloning operation, returns a specified attribute (<code>specified</code> is <code>true</code>). Cloning any other type of node simply returns a copy of this
node.</p>
<p>Note that cloning an immutable subtree results in a mutable copy, but
the children of an <code>EntityReference</code> clone are <termref def="dt-readonly-node">readonly</termref>. In
addition, clones of unspecified <code>Attr</code> nodes are specified. And, cloning <code>Document</code>, <code>DocumentType</code>, <code>Entity</code>, and <code>Notation</code> nodes is implementation dependent.</p>
</descr>
<parameters>
<param name="deep" type="boolean" attr="in">
<descr>
<p>If <code>true</code>, recursively clone the subtree under the specified node; if <code>false</code>, clone only the node itself (and its attributes, if it is an <code>Element</code>). </p>
</descr>
</param>
</parameters>
<returns type="Node">
<descr>
<p>The duplicate node.</p>
</descr>
</returns>
<raises> <!-- No exceptions -->
</raises>
</method>
<!-- ****** DOM Level 2 additions ****** -->
<method id="ID-normalize" name="normalize" version="DOM Level 2">
<descr>
<p>Puts all <code>Text</code> nodes in the full depth of the sub-tree underneath this <code>Node</code>, including attribute nodes, into a "normal" form where only structure
(e.g., elements, comments, processing instructions, CDATA sections, and entity
references) separates <code>Text</code> nodes, i.e., there are neither adjacent <code>Text</code> nodes nor empty <code>Text</code> nodes. This can be used to ensure that the DOM view of a document is
the same as if it were saved and re-loaded, and is useful when operations (such
as XPointer <bibref ref="XPointer"/> lookups) that depend on a particular
document tree structure are to be used.</p>
<note>
<p>In cases where the document contains <code>CDATASections</code>, the normalize operation alone may not be sufficient, since XPointers
do not differentiate between <code>Text</code> nodes and <code>CDATASection</code> nodes.</p>
</note>
</descr>
<parameters> <!-- No parameters -->
</parameters>
<returns type="void">
<descr>
<p></p>
</descr>
</returns>
<raises> <!-- No exceptions -->
</raises>
</method>
<method name="isSupported" id="Level-2-Core-Node-supports"
since="DOM Level 2">
<descr>
<p>Tests whether the DOM implementation implements a specific feature and
that feature is supported by this node.</p>
</descr>
<parameters>
<param name="feature" type="DOMString" attr="in">
<descr>
<p>The name of the feature to test. This is the same name which can
be passed to the method <code>hasFeature</code> on <code>DOMImplementation</code>.</p>
</descr>
</param>
<param name="version" type="DOMString" attr="in">
<descr>
<p>This is the version number of the feature to test. In Level 2,
version 1, this is the string "2.0". If the version is not specified,
supporting any version of the feature will cause the method to return <code>true</code>.</p>
</descr>
</param>
</parameters>
<returns type="boolean">
<descr>
<p>Returns <code>true</code> if the specified feature is supported on this node, <code>false</code> otherwise.</p>
</descr>
</returns>
<raises> <!-- No exceptions -->
</raises>
</method>
<attribute readonly="yes" type="DOMString" name="namespaceURI"
id="ID-NodeNSname" since="DOM Level 2">
<descr>
<p>The <termref def="dt-namespaceURI">namespace URI</termref> of this
node, or <code>null</code> if it is unspecified.</p>
<p>This is not a computed value that is the result of a namespace lookup
based on an examination of the namespace declarations in scope. It is merely
the namespace URI given at creation time.</p>
<p>For nodes of any type other than <code>ELEMENT_NODE</code> and <code>ATTRIBUTE_NODE</code> and nodes created with a DOM Level 1 method, such as <code>createElement</code> from the <code>Document</code> interface, this is always <code>null</code>.</p>
<note>
<p>Per the <emph>Namespaces in XML</emph> Specification
<bibref ref="Namespaces"/> an attribute does not inherit its namespace from the
element it is attached to. If an attribute is not explicitly given a namespace,
it simply has no namespace.</p>
</note>
</descr>
</attribute>
<attribute type="DOMString" name="prefix" id="ID-NodeNSPrefix"
since="DOM Level 2">
<descr>
<p>The <termref def="dt-namespaceprefix">namespace prefix</termref> of
this node, or <code>null</code> if it is unspecified.</p>
<p>Note that setting this attribute, when permitted, changes the <code>nodeName</code> attribute, which holds the <termref def="dt-qualifiedname">qualified
name</termref>, as well as the <code>tagName</code> and <code>name</code> attributes of the <code>Element</code> and <code>Attr</code> interfaces, when applicable.</p>
<p>Note also that changing the prefix of an attribute that is known to
have a default value, does not make a new attribute with the default value and
the original prefix appear, since the <code>namespaceURI</code> and <code>localName</code> do not change.</p>
<p>For nodes of any type other than <code>ELEMENT_NODE</code> and <code>ATTRIBUTE_NODE</code> and nodes created with a DOM Level 1 method, such as <code>createElement</code> from the <code>Document</code> interface, this is always <code>null</code>.</p>
</descr>
<setraises>
<exception name="DOMException">
<descr>
<p>INVALID_CHARACTER_ERR: Raised if the specified prefix contains an
illegal character.</p>
<p>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.</p>
<p>NAMESPACE_ERR: Raised if the specified <code>prefix</code> is malformed, if the <code>namespaceURI</code> of this node is <code>null</code>, if the specified prefix is "xml" and the <code>namespaceURI</code> of this node is different from "<loc href="xml-ns;">xml-ns;</loc>",
if this node is an attribute and the specified prefix is "xmlns" and the <code>namespaceURI</code> of this node is different from "<loc
href="xmlns-ns;">xmlns-ns;</loc>", or if this node is an attribute and the <code>qualifiedName</code> of this node is "xmlns" <bibref ref="Namespaces"/>.</p>
</descr>
</exception>
</setraises>
</attribute>
<attribute readonly="yes" type="DOMString" name="localName"
id="ID-NodeNSLocalN" since="DOM Level 2">
<descr>
<p>Returns the local part of the <termref
def="dt-qualifiedname">qualified name</termref> of this node.</p>
<p>For nodes of any type other than <code>ELEMENT_NODE</code> and <code>ATTRIBUTE_NODE</code> and nodes created with a DOM Level 1 method, such as <code>createElement</code> from the <code>Document</code> interface, this is always <code>null</code>.</p>
</descr>
</attribute>
<method name="hasAttributes" id="ID-NodeHasAttrs" since="DOM Level 2">
<descr>
<p>Returns whether this node (if it is an element) has any
attributes.</p>
</descr>
<parameters> <!-- No parameters -->
</parameters>
<returns type="boolean">
<descr>
<p><code>true</code> if this node has any attributes, <code>false</code> otherwise.</p>
</descr>
</returns>
<raises> <!-- No exceptions -->
</raises>
</method>
</interface>
|