#[1]copyright [2]glossary [3]Start [4]author [5]help
[1] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/copyright-notice.html
[2] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/glossary.html
[3] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/Overview.html
[4] mailto:www-dom@w3.org
[5] http://www.w3.org/DOM/
[6]W3C
[6] http://www.w3.org/
Document Object Model (DOM) Level 3 Core Specification
Version 1.0
W3C Candidate Recommendation 07 November 2003
This version:
[7]http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107
[7] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107
Latest version:
[8]http://www.w3.org/TR/DOM-Level-3-Core
[8] http://www.w3.org/TR/DOM-Level-3-Core
Previous version:
[9]http://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030609
[9] http://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030609
Editors:
Arnaud Le Hors, IBM
Philippe Le Hégaret, W3C
Lauren Wood, SoftQuad, Inc. (WG Chair emerita, for DOM Level 1
and 2)
Gavin Nicol, Inso EPS (for DOM Level 1)
Jonathan Robie, Texcel Research and Software AG (for DOM Level
1)
Mike Champion, Arbortext and Software AG (for DOM Level 1 from
November 20, 1997)
Steve Byrne, JavaSoft (for DOM Level 1 until November 19, 1997)
This document is also available in these non-normative formats:
[10]XML file, [11]plain text, [12]PostScript file, [13]PDF file,
[14]single HTML file, and [15]ZIP file.
[10] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/xml-source.xml
[11] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/DOM3-Core.txt
[12] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/DOM3-Core.ps
[13] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/DOM3-Core.pdf
[14] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/DOM3-Core.html
[15] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/DOM3-Core.zip
[16]Copyright ©2003 [17]W3C^® ([18]MIT, [19]ERCIM, [20]Keio), All
Rights Reserved. W3C [21]liability, [22]trademark, [23]document use
and [24]software licensing rules apply.
[16] http://www.w3.org/Consortium/Legal/ipr-notice#Copyright
[17] http://www.w3.org/
[18] http://www.lcs.mit.edu/
[19] http://www.ercim.org/
[20] http://www.keio.ac.jp/
[21] http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer
[22] http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks
[23] http://www.w3.org/Consortium/Legal/copyright-documents
[24] http://www.w3.org/Consortium/Legal/copyright-software
_________________________________________________________________
Abstract
This specification defines the Document Object Model Core Level 3, a
platform- and language-neutral interface that allows programs and
scripts to dynamically access and update the content, structure and
style of documents. The Document Object Model Core Level 3 builds on
the Document Object Model Core Level 2 [25]DOM Level 2 Core].
Status of this document
This section describes the status of this document at the time of its
publication. Other documents may supersede this document. A list of
current W3C publications and the latest revision of this technical
report can be found in the [26]W3C technical reports index at
http://www.w3.org/TR/.
[26] http://www.w3.org/TR/
This document contains the Document Object Model Level 3 Core
specification and is a [27]Candidate Recommendation Working Draft for
review by W3C members and other interested parties. It is based on the
feedback during the [28]Last Call period. The DOM Working Group
expects to request that the Director advance this specification to
Proposed Recommendation after the DOM Working Group documents two
interoperable implementations of at least one normative binding. Basic
tests of functionalities provided in this specification will be
produced and used in this effort. The two implementations must be
produced by different organizations. Implementation feedbacks are
welcome until 30 November 2003 and have to be sent to the public
mailing list [29]www-dom@w3.org ([30]public archive).
[27] http://www.w3.org/2003/06/Process-20030618/tr.html#RecsCR
[28] http://www.w3.org/2003/06/09-dom-core-issues/issues.html
[29] mailto:www-dom@w3.org
[30] http://lists.w3.org/Archives/Public/www-dom/
Individuals or organizations are also invited to send a message to the
public mailing list if they intend to produce an implementation of
this module. The [31]implementation report is available.
[31] http://www.w3.org/2003/10/DOM-Level-3-Core-implementations.html
Given the lack of implementation commitments regarding character
normalization, the DOM Working Group considers it "at risk". This
affects the "check-character-normalization" and "normalize-characters"
parameters defined in the DOMConfiguration interface. The Working
Group may remove the parameters before requesting Proposed
Recommendation status.
Publication as a Candidate Recommendation does not imply endorsement
by the W3C Membership. This is a draft document and may be updated,
replaced or obsoleted by other documents at any time. It is
inappropriate to cite this document as other than work in progress.
This document has been produced as part of the [32]W3C DOM Activity.
The authors of this document are the DOM Working Group members.
[32] http://www.w3.org/DOM/Activity.html
Patent disclosures relevant to this specification may be found on the
Working Group's [33]patent disclosure page.
[33] http://www.w3.org/2002/08/02-DOM-Disclosures.html
Table of contents
* [34]Expanded Table of Contents
* [35]W3C Copyright Notices and Licenses
* [36]What is the Document Object Model?
* [37]1. Document Object Model Core
* [38]Appendix A: Changes
* [39]Appendix B: Namespaces Algorithms
* [40]Appendix C: Infoset mapping
* [41]Appendix D: Configuration Settings
* [42]Appendix E: Accessing code point boundaries
* [43]Appendix F: IDL Definitions
* [44]Appendix G: Java Language Binding
* [45]Appendix H: ECMAScript Language Binding
* [46]Appendix I: Acknowledgements
* [47]Glossary
* [48]References
* [49]Index
07 November 2003
Expanded Table of Contents
* [50]Expanded Table of Contents
* [51]W3C Copyright Notices and Licenses
+ [52]W3C^® Document Copyright Notice and License
+ [53]W3C^® Software Copyright Notice and License
+ [54]W3C^® Short Software Notice
* [55]What is the Document Object Model?
+ [56]Introduction
+ [57]What the Document Object Model is
+ [58]What the Document Object Model is not
+ [59]Where the Document Object Model came from
+ [60]Entities and the DOM Core
+ [61]DOM Architecture
+ [62]Conformance
+ [63]DOM Interfaces and DOM Implementations
* [64]1 Document Object Model Core
+ [65]1.1 Overview of the DOM Core Interfaces
o [66]1.1.1 The DOM Structure Model
o [67]1.1.2 Memory Management
o [68]1.1.3 Naming Conventions
o [69]1.1.4 Inheritance vs. Flattened Views of the API
+ [70]1.2 Basic types
o [71]1.2.1 The DOMString type
o [72]1.2.2 The DOMTimeStamp type
o [73]1.2.3 The DOMUserData type
o [74]1.2.4 The DOMObject type
+ [75]1.3 General considerations
o [76]1.3.1 String comparisons in the DOM
o [77]1.3.2 DOM URIs
o [78]1.3.3 XML Namespaces
o [79]1.3.4 Base URIs
o [80]1.3.5 Mixed DOM implementations
o [81]1.3.6 DOM Features
o [82]1.3.7 Bootstrapping
+ [83]1.4 Fundamental Interfaces: Core module
+ [84]1.5 Extended Interfaces: XML module
* [85]Appendix A: Changes
+ [86]A.1 New sections
+ [87]A.2 Changes to DOM Level 2 Core interfaces and exceptions
+ [88]A.3 New DOM features
+ [89]A.4 New types
+ [90]A.5 New interfaces
+ [91]A.6 Objects
* [92]Appendix B: Namespaces Algorithms
+ [93]B.1 Namespace normalization
o [94]B.1.1 Scope of a binding
o [95]B.1.2 Conflicting namespace declaration
+ [96]B.2 Namespace Prefix Lookup
+ [97]B.3 Default Namespace Lookup
+ [98]B.4 Namespace URI Lookup
* [99]Appendix C: Infoset mapping
+ [100]C.1 Document node mapping
o [101]C.1.1 Infoset to Document node
o [102]C.1.2 Document node to Infoset
+ [103]C.2 Element node mapping
o [104]C.2.1 Infoset to Element node
o [105]C.2.2 Element node to Infoset
+ [106]C.3 Attr node mapping
o [107]C.3.1 Infoset to Attr node
o [108]C.3.2 Attr node to Infoset
+ [109]C.4 ProcessingInstruction node mapping
o [110]C.4.1 Infoset to ProcessingInstruction node
o [111]C.4.2 ProcessingInstruction node to Infoset
+ [112]C.5 EntityReference node mapping
o [113]C.5.1 Infoset to EntityReference node
o [114]C.5.2 EntityReference node to Infoset
+ [115]C.6 Text and CDATASection nodes mapping
o [116]C.6.1 Infoset to Text node
o [117]C.6.2 Text and CDATASection nodes to Infoset
+ [118]C.7 Comment node mapping
o [119]C.7.1 Infoset to Comment node
o [120]C.7.2 Comment node to Infoset
+ [121]C.8 DocumentType node mapping
o [122]C.8.1 Infoset to DocumentType node
o [123]C.8.2 DocumentType node to Infoset
+ [124]C.9 Entity node mapping
o [125]C.9.1 Infoset to Entity node
o [126]C.9.2 Entity node to Infoset
+ [127]C.10 Notation node mapping
o [128]C.10.1 Infoset to Notation node
o [129]C.10.2 Notation node to Infoset
* [130]Appendix D: Configuration Settings
+ [131]D.1 Configuration Scenarios
* [132]Appendix E: Accessing code point boundaries
+ [133]E.1 Introduction
+ [134]E.2 Methods
* [135]Appendix F: IDL Definitions
* [136]Appendix G: Java Language Binding
+ [137]G.1 Java Binding Extension
+ [138]G.2 Other Core interfaces
* [139]Appendix H: ECMAScript Language Binding
+ [140]H.1 ECMAScript Binding Extension
+ [141]H.2 Other Core interfaces
* [142]Appendix I: Acknowledgements
+ [143]I.1 Production Systems
* [144]Glossary
* [145]References
+ [146]1 Normative references
+ [147]2 Informative references
* [148]Index
07 November 2003
W3C Copyright Notices and Licenses
Copyright © 2003 [149]World Wide Web Consortium, ([150]Massachusetts
Institute of Technology, [151]European Research Consortium for
Informatics and Mathematics, [152]Keio University). All Rights
Reserved.
[149] http://www.w3.org/
[150] http://www.lcs.mit.edu/
[151] http://www.ercim.org/
[152] http://www.keio.ac.jp/
This document is published under the [153]W3C^® Document Copyright
Notice and License. The bindings within this document are published
under the [154]W3C^® Software Copyright Notice and License. The
software license requires "Notice of any changes or modifications to
the W3C files, including the date changes were made." Consequently,
modified versions of the DOM bindings must document that they do not
conform to the W3C standard; in the case of the IDL definitions, the
pragma prefix can no longer be 'w3c.org'; in the case of the Java
language binding, the package names can no longer be in the 'org.w3c'
package.
_________________________________________________________________
W3C^® Document Copyright Notice and License
Note: This section is a copy of the W3C^® Document Notice and License
and could be found at
[155]http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021
231.
[155] http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231
Copyright © 2003 [156]World Wide Web Consortium, ([157]Massachusetts
Institute of Technology, [158]European Research Consortium for
Informatics and Mathematics, [159]Keio University). All Rights
Reserved.
[156] http://www.w3.org/
[157] http://www.lcs.mit.edu/
[158] http://www.ercim.org/
[159] http://www.keio.ac.jp/
http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231
Public documents on the W3C site are provided by the copyright holders
under the following license. By using and/or copying this document, or
the W3C document from which this statement is linked, you (the
licensee) agree that you have read, understood, and will comply with
the following terms and conditions:
Permission to copy, and distribute the contents of this document, or
the W3C document from which this statement is linked, in any medium
for any purpose and without fee or royalty is hereby granted, provided
that you include the following on ALL copies of the document, or
portions thereof, that you use:
1. A link or URL to the original W3C document.
2. The pre-existing copyright notice of the original author, or if it
doesn't exist, a notice (hypertext is preferred, but a textual
representation is permitted) of the form: "Copyright ©
[$date-of-document] [160]World Wide Web Consortium,
([161]Massachusetts Institute of Technology, [162]European
Research Consortium for Informatics and Mathematics, [163]Keio
University). All Rights Reserved.
[164]http://www.w3.org/Consortium/Legal/2002/copyright-documents-2
0021231"
3. If it exists, the STATUS of the W3C document.
[160] http://www.w3.org/
[161] http://www.lcs.mit.edu/
[162] http://www.ercim.org/
[163] http://www.keio.ac.jp/
[164] http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231
When space permits, inclusion of the full text of this NOTICE should
be provided. We request that authorship attribution be provided in any
software, documents, or other items or products that you create
pursuant to the implementation of the contents of this document, or
any portion thereof.
No right to create modifications or derivatives of W3C documents is
granted pursuant to this license. However, if additional requirements
(documented in the [165]Copyright FAQ) are satisfied, the right to
create modifications or derivatives is sometimes granted by the W3C to
individuals complying with those requirements.
[165] http://www.w3.org/Consortium/Legal/IPR-FAQ
THIS DOCUMENT IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO
REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THE DOCUMENT
ARE SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF SUCH
CONTENTS WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
TRADEMARKS OR OTHER RIGHTS.
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL
OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE DOCUMENT OR THE
PERFORMANCE OR IMPLEMENTATION OF THE CONTENTS THEREOF.
The name and trademarks of copyright holders may NOT be used in
advertising or publicity pertaining to this document or its contents
without specific, written prior permission. Title to copyright in this
document will at all times remain with copyright holders.
_________________________________________________________________
W3C^® Software Copyright Notice and License
Note: This section is a copy of the W3C^® Software Copyright Notice
and License and could be found at
[166]http://www.w3.org/Consortium/Legal/2002/copyright-software-200212
31
[166] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
Copyright © 2003 [167]World Wide Web Consortium, ([168]Massachusetts
Institute of Technology, [169]European Research Consortium for
Informatics and Mathematics, [170]Keio University). All Rights
Reserved.
[167] http://www.w3.org/
[168] http://www.lcs.mit.edu/
[169] http://www.ercim.org/
[170] http://www.keio.ac.jp/
http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
This work (and included software, documentation such as READMEs, or
other related items) is being provided by the copyright holders under
the following license. By obtaining, using and/or copying this work,
you (the licensee) agree that you have read, understood, and will
comply with the following terms and conditions.
Permission to copy, modify, and distribute this software and its
documentation, with or without modification, for any purpose and
without fee or royalty is hereby granted, provided that you include
the following on ALL copies of the software and documentation or
portions thereof, including modifications:
1. The full text of this NOTICE in a location viewable to users of
the redistributed or derivative work.
2. Any pre-existing intellectual property disclaimers, notices, or
terms and conditions. If none exist, the [171]W3C^® Short Software
Notice should be included (hypertext is preferred, text is
permitted) within the body of any redistributed or derivative
code.
3. Notice of any changes or modifications to the files, including the
date changes were made. (We recommend you provide URIs to the
location from which the code is derived.)
THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT
HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR
DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
TRADEMARKS OR OTHER RIGHTS.
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL
OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR
DOCUMENTATION.
The name and trademarks of copyright holders may NOT be used in
advertising or publicity pertaining to the software without specific,
written prior permission. Title to copyright in this software and any
associated documentation will at all times remain with copyright
holders.
W3C^® Short Software Notice
Note: This section is a copy of the W3C^® Short Software Notice and
could be found at
[172]http://www.w3.org/Consortium/Legal/2002/copyright-software-short-
notice-20021231
[172] http://www.w3.org/Consortium/Legal/2002/copyright-software-short-notice-20021231
Copyright © 2003 [173]World Wide Web Consortium, ([174]Massachusetts
Institute of Technology, [175]European Research Consortium for
Informatics and Mathematics, [176]Keio University). All Rights
Reserved.
[173] http://www.w3.org/
[174] http://www.lcs.mit.edu/
[175] http://www.ercim.org/
[176] http://www.keio.ac.jp/
Copyright © [$date-of-software] [177]World Wide Web Consortium,
([178]Massachusetts Institute of Technology, [179]European Research
Consortium for Informatics and Mathematics, [180]Keio University). All
Rights Reserved. This work is distributed under the W3C^® Software
License [$1\47] in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.
[177] http://www.w3.org/
[178] http://www.lcs.mit.edu/
[179] http://www.ercim.org/
[180] http://www.keio.ac.jp/
[$1\47]
http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
07 November 2003
What is the Document Object Model?
Editors:
Philippe Le Hégaret, W3C
Lauren Wood, SoftQuad Software Inc. (for DOM Level 2)
Jonathan Robie, Texcel (for DOM Level 1)
Introduction
The Document Object Model (DOM) is an application programming
interface ([181]API) for valid [182]HTML and well-formed [183]XML
documents. It defines the logical structure of documents and the way a
document is accessed and manipulated. In the DOM specification, the
term "document" is used in the broad sense - increasingly, XML is
being used as a way of representing many different kinds of
information that may be stored in diverse systems, and much of this
would traditionally be seen as data rather than as documents.
Nevertheless, XML presents this data as documents, and the DOM may be
used to manage this data.
With the Document Object Model, programmers can build documents,
navigate their structure, and add, modify, or delete elements and
content. Anything found in an HTML or XML document can be accessed,
changed, deleted, or added using the Document Object Model, with a few
exceptions - in particular, the DOM [184]interfaces for the XML
internal and external subsets have not yet been specified.
As a W3C specification, one important objective for the Document
Object Model is to provide a standard programming interface that can
be used in a wide variety of environments and [185]applications. The
DOM is designed to be used with any programming language. In order to
provide a precise, language-independent specification of the DOM
interfaces, we have chosen to define the specifications in Object
Management Group (OMG) IDL [186]OMG IDL], as defined in the CORBA
2.3.1 specification [187]CORBA]. In addition to the OMG IDL
specification, we provide [188]language bindings for Java [189]Java]
and ECMAScript [190]ECMAScript] (an industry-standard scripting
language based on JavaScript [191]JavaScript] and JScript
[192]JScript]). Because of language binding restrictions, a mapping
has to be applied between the OMG IDL and the programming language in
used. For example, while the DOM uses IDL attributes in the definition
of interfaces, Java does not allow interfaces to contain attributes:
// example 1: removing the first child of an element using ECMAScript
mySecondTrElement.removeChild(mySecondTrElement.firstChild);
// example 2: removing the first child of an element using Java
mySecondTrElement.removeChild(mySecondTrElement.getFirstChild());
Note: OMG IDL is used only as a language-independent and
implementation-neutral way to specify [193]interfaces. Various other
IDLs could have been used ([194]COM], [195]Java IDL], [196]MIDL],
...). In general, IDLs are designed for specific computing
environments. The Document Object Model can be implemented in any
computing environment, and does not require the object binding
runtimes generally associated with such IDLs.
What the Document Object Model is
The DOM is a programming [197]API for documents. It is based on an
object structure that closely resembles the structure of the documents
it [198]models. For instance, consider this table, taken from an XHTML
document:
Shady Grove |
Aeolian |
Over the River, Charlie |
Dorian |
A graphical representation of the DOM of the example table, with
whitespaces in element content (often abusively called "ignorable
whitespace") removed, is:
graphical representation of the DOM of the example table
Figure: graphical representation of the DOM of the example table
[199]SVG 1.0 version]
[199] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/images/table
An example of DOM manipulation using ECMAScript would be:
// access the tbody element from the table element
var myTbodyElement = myTableElement.firstChild;
// access its second tr element
// The list of children starts at 0 (and not 1).
var mySecondTrElement = myTbodyElement.childNodes[$1\47];
// remove its first td element
mySecondTrElement.removeChild(mySecondTrElement.firstChild);
// change the text content of the remaining td element
mySecondTrElement.firstChild.firstChild.data = "Peter";
In the DOM, documents have a logical structure which is very much like
a tree; to be more precise, which is like a "forest" or "grove", which
can contain more than one tree. Each document contains zero or one
doctype nodes, one document element node, and zero or more comments or
processing instructions; the document element serves as the root of
the element tree for the document. However, the DOM does not specify
that documents must be implemented as a tree or a grove, nor does it
specify how the relationships among objects be implemented. The DOM is
a logical model that may be implemented in any convenient manner. In
this specification, we use the term structure model to describe the
tree-like representation of a document. We also use the term "tree"
when referring to the arrangement of those information items which can
be reached by using "tree-walking" methods; (this does not include
attributes). One important property of DOM structure models is
structural isomorphism: if any two Document Object Model
implementations are used to create a representation of the same
document, they will create the same structure model, in accordance
with the XML Information Set [200]XML Information Set].
Note: There may be some variations depending on the parser being used
to build the DOM. For instance, the DOM may not contain white spaces
in element content if the parser discards them.
The name "Document Object Model" was chosen because it is an
"[201]object model" in the traditional object oriented design sense:
documents are modeled using objects, and the model encompasses not
only the structure of a document, but also the behavior of a document
and the objects of which it is composed. In other words, the nodes in
the above diagram do not represent a data structure, they represent
objects, which have functions and identity. As an object model, the
DOM identifies:
* the interfaces and objects used to represent and manipulate a
document
* the semantics of these interfaces and objects - including both
behavior and attributes
* the relationships and collaborations among these interfaces and
objects
The structure of SGML documents has traditionally been represented by
an abstract [202]data model, not by an object model. In an abstract
[203]data model, the model is centered around the data. In object
oriented programming languages, the data itself is encapsulated in
objects that hide the data, protecting it from direct external
manipulation. The functions associated with these objects determine
how the objects may be manipulated, and they are part of the object
model.
What the Document Object Model is not
This section is designed to give a more precise understanding of the
DOM by distinguishing it from other systems that may seem to be like
it.
* The Document Object Model is not a binary specification. DOM
programs written in the same language binding will be source code
compatible across platforms, but the DOM does not define any form
of binary interoperability.
* The Document Object Model is not a way of persisting objects to
XML or HTML. Instead of specifying how objects may be represented
in XML, the DOM specifies how XML and HTML documents are
represented as objects, so that they may be used in object
oriented programs.
* The Document Object Model is not a set of data structures; it is
an [204]object model that specifies interfaces. Although this
document contains diagrams showing parent/child relationships,
these are logical relationships defined by the programming
interfaces, not representations of any particular internal data
structures.
* The Document Object Model does not define what information in a
document is relevant or how information in a document is
structured. For XML, this is specified by the XML Information Set
[205]XML Information Set]. The DOM is simply an [206]API to this
information set.
* The Document Object Model, despite its name, is not a competitor
to the Component Object Model [207]COM]. COM, like CORBA, is a
language independent way to specify interfaces and objects; the
DOM is a set of interfaces and objects designed for managing HTML
and XML documents. The DOM may be implemented using
language-independent systems like COM or CORBA; it may also be
implemented using language-specific bindings like the Java or
ECMAScript bindings specified in this document.
Where the Document Object Model came from
The DOM originated as a specification to allow JavaScript scripts and
Java programs to be portable among Web browsers. "Dynamic HTML" was
the immediate ancestor of the Document Object Model, and it was
originally thought of largely in terms of browsers. However, when the
DOM Working Group was formed at W3C, it was also joined by vendors in
other domains, including HTML or XML editors and document
repositories. Several of these vendors had worked with SGML before XML
was developed; as a result, the DOM has been influenced by SGML Groves
and the HyTime standard. Some of these vendors had also developed
their own object models for documents in order to provide an API for
SGML/XML editors or document repositories, and these object models
have also influenced the DOM.
Entities and the DOM Core
In the fundamental DOM interfaces, there are no objects representing
entities. Numeric character references, and references to the
pre-defined entities in HTML and XML, are replaced by the single
character that makes up the entity's replacement. For example, in:
This is a dog & a cat
the "&" will be replaced by the character "&", and the text in the
P element will form a single continuous sequence of characters. Since
numeric character references and pre-defined entities are not
recognized as such in CDATA sections, or in the SCRIPT and STYLE
elements in HTML, they are not replaced by the single character they
appear to refer to. If the example above were enclosed in a CDATA
section, the "&" would not be replaced by "&"; neither would the
be recognized as a start tag. The representation of general
entities, both internal and external, are defined within the extended
(XML) interfaces of [208]Document Object Model Core.
Note: When a DOM representation of a document is serialized as XML or
HTML text, applications will need to check each character in text data
to see if it needs to be escaped using a numeric or pre-defined
entity. Failing to do so could result in invalid HTML or XML. Also,
[209]implementations should be aware of the fact that serialization
into a character encoding ("charset") that does not fully cover ISO
10646 may fail if there are characters in markup or CDATA sections
that are not present in the encoding.
DOM Architecture
The DOM specifications provide a set of APIs that forms the DOM API.
Each DOM specification defines one or more modules and each module is
associated with one feature name. For example, the DOM Core
specification (this specification) defines two modules:
* The Core module, which contains the fundamental interfaces that
must be implemented by all DOM conformant implementations, is
associated with the feature name "Core";
* The XML module, which contains the interfaces that must be
implemented by all conformant XML 1.0 [210]XML 1.0] (and higher)
DOM implementations, is associated with the feature name "XML".
The following representation contains all DOM modules, represented
using their feature names, defined along the DOM specifications:
A view of the DOM Architecture
Figure: A view of the DOM Architecture [211]SVG 1.0 version]
[211] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/images/dom-architecture
A DOM implementation can then implement one (i.e. only the Core
module) or more modules depending on the host application. A Web user
agent is very likely to implement the "MouseEvents" module, while a
server-side application will have no use of this module and will
probably not implement it.
Conformance
This section explains the different levels of conformance to DOM Level
3. DOM Level 3 consists of 16 modules. It is possible to conform to
DOM Level 3, or to a DOM Level 3 module.
An implementation is DOM Level 3 conformant if it supports the Core
module defined in this document (see [212]Fundamental Interfaces: Core
module). An implementation conforms to a DOM Level 3 module if it
supports all the interfaces for that module and the associated
semantics.
Here is the complete list of DOM Level 3.0 modules and the features
used by them. Feature names are case-insensitive.
Core module
defines the feature [213]"Core".
XML module
Defines the feature [214]"XML".
Events module
defines the feature [215]"Events" in [216]DOM Level 3 Events].
[215] http://www.w3.org/TR/DOM-Level-3-Events/events.html
User interface Events module
defines the feature [217]"UIEvents" in [218]DOM Level 3
Events].
[217] http://www.w3.org/TR/DOM-Level-3-Events/events.html
Mouse Events module
defines the feature [219]"MouseEvents" in [220]DOM Level 3
Events].
[219] http://www.w3.org/TR/DOM-Level-3-Events/events.html
Text Events module
defines the feature [221]"TextEvents" in [222]DOM Level 3
Events].
[221] http://www.w3.org/TR/DOM-Level-3-Events/events.html
Keyboard Events module
defines the feature [223]"KeyboardEvents" in [224]DOM Level 3
Events].
[223] http://www.w3.org/TR/DOM-Level-3-Events/events.html
Mutation Events module
defines the feature [225]"MutationEvents" in [226]DOM Level 3
Events].
[225] http://www.w3.org/TR/DOM-Level-3-Events/events.html
Mutation name Events module
defines the feature [227]"MutationNameEvents" in [228]DOM
Level 3 Events].
[227] http://www.w3.org/TR/DOM-Level-3-Events/events.html
HTML Events module
defines the feature [229]"HTMLEvents" in [230]DOM Level 3
Events].
[229] http://www.w3.org/TR/DOM-Level-3-Events/events.html
Load and Save module
defines the feature [231]"LS" in [232]DOM Level 3 Load and
Save].
[231] http://www.w3.org/TR/DOM-Level-3-LS/load-save.html
Asynchronous load module
defines the feature [233]"LS-Async" in [234]DOM Level 3 Load
and Save].
[233] http://www.w3.org/TR/DOM-Level-3-LS/load-save.html
DocumentLS module
defines the feature [235]"DocumentLS" in [236]DOM Level 3 Load
and Save].
[235] http://www.w3.org/TR/DOM-Level-3-LS/load-save.html
ElementLS module
defines the feature [237]"ElementLS" in [238]DOM Level 3 Load
and Save].
[237] http://www.w3.org/TR/DOM-Level-3-LS/load-save.html
Validation module
defines the feature [239]"Validation" in [240]DOM Level 3
Validation].
[239] http://www.w3.org/TR/DOM-Level-3-Val/validation.html
XPath module
defines the feature [241]"XPath" in [242]DOM Level 3 XPath].
[241] http://www.w3.org/TR/DOM-Level-3-XPath/xpath.html
A DOM implementation must not return true to the
[243]DOMImplementation.hasFeature(feature, version) [244]method of the
[245]DOMImplementation interface for that feature unless the
implementation conforms to that module. The version number for all
features used in DOM Level 3.0 is "3.0".
DOM Interfaces and DOM Implementations
The DOM specifies interfaces which may be used to manage XML or HTML
documents. It is important to realize that these interfaces are an
abstraction - much like "abstract base classes" in C++, they are a
means of specifying a way to access and manipulate an application's
internal representation of a document. Interfaces do not imply a
particular concrete implementation. Each DOM application is free to
maintain documents in any convenient representation, as long as the
interfaces shown in this specification are supported. Some DOM
implementations will be existing programs that use the DOM interfaces
to access software written long before the DOM specification existed.
Therefore, the DOM is designed to avoid implementation dependencies;
in particular,
1. Attributes defined in the IDL do not imply concrete objects which
must have specific data members - in the language bindings, they
are translated to a pair of get()/set() functions, not to a data
member. Read-only attributes have only a get() function in the
language bindings.
2. DOM applications may provide additional interfaces and objects not
found in this specification and still be considered DOM
conformant.
3. Because we specify interfaces and not the actual objects that are
to be created, the DOM cannot know what constructors to call for
an implementation. In general, DOM users call the createX()
methods on the Document class to create document structures, and
DOM implementations create their own internal representations of
these structures in their implementations of the createX()
functions.
The Level 2 interfaces were extended to provide both Level 2 and Level
3 functionality.
DOM implementations in languages other than Java or ECMAScript may
choose bindings that are appropriate and natural for their language
and run time environment. For example, some systems may need to create
a Document3 class which inherits from a Document class and contains
the new methods and attributes.
DOM Level 3 does not specify multithreading mechanisms.
07 November 2003
1. Document Object Model Core
Editors:
Arnaud Le Hors, IBM
Philippe Le Hégaret, W3C
Gavin Nicol, Inso EPS (for DOM Level 1)
Lauren Wood, SoftQuad, Inc. (for DOM Level 1)
Mike Champion, Arbortext and Software AG (for DOM Level 1 from
November 20, 1997)
Steve Byrne, JavaSoft (for DOM Level 1 until November 19, 1997)
Table of contents
* [246]1.1 Overview of the DOM Core Interfaces
+ [247]1.1.1 The DOM Structure Model
+ [248]1.1.2 Memory Management
+ [249]1.1.3 Naming Conventions
+ [250]1.1.4 Inheritance vs. Flattened Views of the API
* [251]1.2 Basic types
+ [252]1.2.1 The DOMString type
o [253]DOMString
+ [254]1.2.2 The DOMTimeStamp type
o [255]DOMTimeStamp
+ [256]1.2.3 The DOMUserData type
o [257]DOMUserData
+ [258]1.2.4 The DOMObject type
o [259]DOMObject
* [260]1.3 General considerations
+ [261]1.3.1 String comparisons in the DOM
+ [262]1.3.2 DOM URIs
+ [263]1.3.3 XML Namespaces
+ [264]1.3.4 Base URIs
+ [265]1.3.5 Mixed DOM implementations
+ [266]1.3.6 DOM Features
+ [267]1.3.7 Bootstrapping
* [268]1.4 Fundamental Interfaces: Core module
+ [269]DOMException, [270]ExceptionCode, [271]DOMStringList,
[272]NameList, [273]DOMImplementationList,
[274]DOMImplementationSource, [275]DOMImplementation,
[276]DocumentFragment, [277]Document, [278]Node,
[279]NodeList, [280]NamedNodeMap, [281]CharacterData,
[282]Attr, [283]Element, [284]Text, [285]Comment,
[286]TypeInfo, [287]UserDataHandler, [288]DOMError,
[289]DOMErrorHandler, [290]DOMLocator, [291]DOMConfiguration
* [292]1.5 Extended Interfaces: XML module
+ [293]CDATASection, [294]DocumentType, [295]Notation,
[296]Entity, [297]EntityReference, [298]ProcessingInstruction
This specification defines a set of objects and interfaces for
accessing and manipulating document objects. The functionality
specified (the Core functionality) is sufficient to allow software
developers and Web script authors to access and manipulate parsed HTML
[299]HTML 4.01] and XML [300]XML 1.0] content inside conforming
products. The DOM Core [301]API also allows creation and population of
a [302]Document object using only DOM API calls. A solution for
loading a [303]Document and saving it persistently is proposed in
[304]DOM Level 3 Load and Save].
1.1 Overview of the DOM Core Interfaces
1.1.1 The DOM Structure Model
The DOM presents documents as a hierarchy of [305]Node objects that
also implement other, more specialized interfaces. Some types of nodes
may have [306]child nodes of various types, and others are leaf nodes
that cannot have anything below them in the document structure. For
XML and HTML, the node types, and which node types they may have as
children, are as follows:
* [307]Document -- [308]Element (maximum of one),
[309]ProcessingInstruction, [310]Comment, [311]DocumentType
(maximum of one)
* [312]DocumentFragment -- [313]Element, [314]ProcessingInstruction,
[315]Comment, [316]Text, [317]CDATASection, [318]EntityReference
* [319]DocumentType -- no children
* [320]EntityReference -- [321]Element, [322]ProcessingInstruction,
[323]Comment, [324]Text, [325]CDATASection, [326]EntityReference
* [327]Element -- [328]Element, [329]Text, [330]Comment,
[331]ProcessingInstruction, [332]CDATASection,
[333]EntityReference
* [334]Attr -- [335]Text, [336]EntityReference
* [337]ProcessingInstruction -- no children
* [338]Comment -- no children
* [339]Text -- no children
* [340]CDATASection -- no children
* [341]Entity -- [342]Element, [343]ProcessingInstruction,
[344]Comment, [345]Text, [346]CDATASection, [347]EntityReference
* [348]Notation -- no children
The DOM also specifies a [349]NodeList interface to handle ordered
lists of [350]Nodes, such as the children of a [351]Node, or the
[352]elements returned by the
[353]Element.getElementsByTagNameNS(namespaceURI, localName) method,
and also a [354]NamedNodeMap interface to handle unordered sets of
nodes referenced by their name attribute, such as the attributes of an
[355]Element. [356]NodeList and [357]NamedNodeMap objects in the DOM
are live; that is, changes to the underlying document structure are
reflected in all relevant [358]NodeList and [359]NamedNodeMap objects.
For example, if a DOM user gets a [360]NodeList object containing the
children of an [361]Element, then subsequently adds more children to
that [362]element (or removes children, or modifies them), those
changes are automatically reflected in the [363]NodeList, without
further action on the user's part. Likewise, changes to a [364]Node in
the tree are reflected in all references to that [365]Node in
[366]NodeList and [367]NamedNodeMap objects.
Finally, the interfaces [368]Text, [369]Comment, and [370]CDATASection
all inherit from the [371]CharacterData interface.
1.1.2 Memory Management
Most of the APIs defined by this specification are interfaces rather
than classes. That means that an implementation need only expose
methods with the defined names and specified operation, not implement
classes that correspond directly to the interfaces. This allows the
DOM APIs to be implemented as a thin veneer on top of legacy
applications with their own data structures, or on top of newer
applications with different class hierarchies. This also means that
ordinary constructors (in the Java or C++ sense) cannot be used to
create DOM objects, since the underlying objects to be constructed may
have little relationship to the DOM interfaces. The conventional
solution to this in object-oriented design is to define factory
methods that create instances of objects that implement the various
interfaces. Objects implementing some interface "X" are created by a
"createX()" method on the [372]Document interface; this is because all
DOM objects live in the context of a specific Document.
The Core DOM APIs are designed to be compatible with a wide range of
languages, including both general-user scripting languages and the
more challenging languages used mostly by professional programmers.
Thus, the DOM APIs need to operate across a variety of memory
management philosophies, from language bindings that do not expose
memory management to the user at all, through those (notably Java)
that provide explicit constructors but provide an automatic garbage
collection mechanism to automatically reclaim unused memory, to those
(especially C/C++) that generally require the programmer to explicitly
allocate object memory, track where it is used, and explicitly free it
for re-use. To ensure a consistent API across these platforms, the DOM
does not address memory management issues at all, but instead leaves
these for the implementation. Neither of the explicit language
bindings defined by the DOM API (for [373]ECMAScript and Java) require
any memory management methods, but DOM bindings for other languages
(especially C or C++) may require such support. These extensions will
be the responsibility of those adapting the DOM API to a specific
language, not the DOM Working Group.
1.1.3 Naming Conventions
While it would be nice to have attribute and method names that are
short, informative, internally consistent, and familiar to users of
similar APIs, the names also should not clash with the names in legacy
APIs supported by DOM implementations. Furthermore, both OMG IDL
[374]OMG IDL] and ECMAScript [375]ECMAScript] have significant
limitations in their ability to disambiguate names from different
namespaces that make it difficult to avoid naming conflicts with
short, familiar names. So, DOM names tend to be long and descriptive
in order to be unique across all environments.
The Working Group has also attempted to be internally consistent in
its use of various terms, even though these may not be common
distinctions in other APIs. For example, the DOM API uses the method
name "remove" when the method changes the structural model, and the
method name "delete" when the method gets rid of something inside the
structure model. The thing that is deleted is not returned. The thing
that is removed may be returned, when it makes sense to return it.
1.1.4 Inheritance vs. Flattened Views of the API
The DOM Core [376]APIs present two somewhat different sets of
interfaces to an XML/HTML document: one presenting an "object
oriented" approach with a hierarchy of [377]inheritance, and a
"simplified" view that allows all manipulation to be done via the
[378]Node interface without requiring casts (in Java and other C-like
languages) or query interface calls in [379]COM environments. These
operations are fairly expensive in Java and COM, and the DOM may be
used in performance-critical environments, so we allow significant
functionality using just the [380]Node interface. Because many other
users will find the [381]inheritance hierarchy easier to understand
than the "everything is a [382]Node" approach to the DOM, we also
support the full higher-level interfaces for those who prefer a more
object-oriented [383]API.
In practice, this means that there is a certain amount of redundancy
in the [384]API. The Working Group considers the "[385]inheritance"
approach the primary view of the API, and the full set of
functionality on [386]Node to be "extra" functionality that users may
employ, but that does not eliminate the need for methods on other
interfaces that an object-oriented analysis would dictate. (Of course,
when the O-O analysis yields an attribute or method that is identical
to one on the [387]Node interface, we don't specify a completely
redundant one.) Thus, even though there is a generic
[388]Node.nodeName attribute on the [389]Node interface, there is
still a [390]Element.tagName attribute on the [391]Element interface;
these two attributes must contain the same value, but the it is
worthwhile to support both, given the different constituencies the DOM
[392]API must satisfy.
1.2 Basic types
To ensure interoperability, this specification specifies the following
basic types used in various DOM modules. Even though the DOM uses the
basic types in the interfaces, bindings may use different types and
normative bindings are only given for Java and ECMAScript in this
specification.
1.2.1 The [393]DOMString type
The [394]DOMString type is used to store [395]Unicode] characters as
a code unit string as defined in section 3.4 of [396]CharModel].
Applications must encode the characters using UTF-16 as defined in
[397]Unicode] and Amendment 1 of [398]ISO/IEC 10646].
Characters are fully-normalized according to the rules defined in
[399]CharModel] supplemented by the definitions of relevant
constructs from [400]Section 2.13 of [401]XML 1.1] if:
* the parameter "[402]normalize-characters" was set to true while
loading the document or the document was certified as defined in
[403]XML 1.1];
* the parameter "[404]normalize-characters" was st to true while
using the method [405]Document.normalizeDocument(), or while using
the method [406]Node.normalize();
[400] http://www.w3.org/TR/2003/PR-xml11-20031105/#sec-normalization-checking
Note that, with the exceptions of [407]Document.normalizeDocument()
and [408]Node.normalize(), manipulating characters using DOM methods
does not guarantee to preserve a fully-normalized text.
Type Definition DOMString
A [409]DOMString is a sequence of [410]16-bit units.
IDL Definition
valuetype [411]DOMString sequence;
The UTF-16 encoding was chosen because of its widespread industry
practice. Note that for both HTML and XML, the document character set
(and therefore the notation of numeric character references) is based
on UCS [412]ISO/IEC 10646]. A single numeric character reference in a
source document may therefore in some cases correspond to two 16-bit
units in a [413]DOMString (a high surrogate and a low surrogate). For
issues related to string comparisons, refer to [414]String comparisons
in the DOM.
For Java and ECMAScript, [415]DOMString is bound to the String type
because both languages also use UTF-16 as their encoding.
Note: As of August 2000, the OMG IDL specification ([416]OMG IDL])
included a wstring type. However, that definition did not meet the
interoperability criteria of the DOM [417]API since it relied on
negotiation to decide the width and encoding of a character.
1.2.2 The [418]DOMTimeStamp type
The [419]DOMTimeStamp type is used to store an absolute or relative
time.
Type Definition DOMTimeStamp
A [420]DOMTimeStamp represents a number of milliseconds.
IDL Definition
typedef unsigned long long [421]DOMTimeStamp;
For Java, [422]DOMTimeStamp is bound to the long type. For ECMAScript,
[423]DOMTimeStamp is bound to the Date type because the range of the
integer type is too small.
1.2.3 The [424]DOMUserData type
The [425]DOMUserData type is used to store application data.
Type Definition DOMUserData
A [426]DOMUserData represents a reference to application data.
IDL Definition
typedef any [427]DOMUserData;
For Java, [428]DOMUserData is bound to the Object type. For
ECMAScript, [429]DOMUserData is bound to any type.
1.2.4 The [430]DOMObject type
The [431]DOMObject type is used to represent an object.
Type Definition DOMObject
A [432]DOMObject represents an object reference.
IDL Definition
typedef Object [433]DOMObject;
For Java and ECMAScript, [434]DOMObject is bound to the Object type.
1.3 General considerations
1.3.1 String comparisons in the DOM
The DOM has many interfaces that imply string matching. For XML,
string comparisons are case-sensitive and performed with a binary
[435]comparison of the [436]16-bit units of the [437]DOMStrings.
However, for case-insensitive markup languages, such as HTML 4.01 or
earlier, these comparisons are case-insensitive where appropriate.
Note that HTML processors often perform specific case normalizations
(canonicalization) of the markup before the DOM structures are built.
This is typically using uppercase for [438]element names and lowercase
for attribute names. For this reason, applications should also compare
element and attribute names returned by the DOM implementation in a
case-insensitive manner.
The character normalization, as defined in [439]CharModel], is
assumed to happen at serialization time. The DOM Level 3 Load and Save
module [440]DOM Level 3 Load and Save] provides a serialization
mechanism (see the DOMSerializer interface, section 2.3.1) and uses
the [441]DOMConfiguration parameters "[442]normalize-characters" and
"[443]check-character-normalization" to assure that text is
fully-normalized (see [444]CharModel], section 4.2.3). Other
serialization mechanisms built on top of the DOM Level 3 Core also
have to assure that text is fully-normalized.
1.3.2 DOM URIs
The DOM specification relies on [445]DOMString values as resource
identifiers, such that the following conditions are met:
1. An absolute identifier absolutely identifies a resource on the
Web;
2. Simple string equality establishes equality of absolute resource
identifiers, and no other equivalence of resource identifiers is
considered significant to the DOM specification;
3. A relative identifier is easily detected and made absolute
relative to an absolute identifier;
4. Retrieval of content of a resource may be accomplished where
required.
The term "absolute URI" refers to a complete resource identifier and
the term "relative URI" refers to an incomplete resource identifier.
Within the DOM specifications, these identifiers are called URIs,
"Uniform Resource Identifiers", but this is meant abstractly. The DOM
implementation does not necessarily process its URIs according to the
URI specification [446]IETF RFC 2396]. Generally the particular form
of these identifiers must be ignored.
When is not possible to completely ignore the type of a DOM URI,
either because a relative identifier must be made absolute or because
content must be retrieved, the DOM implementation must at least
support identifier types appropriate to the content being processed.
[447]HTML 4.01], [448]XML 1.0], and associated namespace
specification [449]XML Namespaces] rely on [450]IETF RFC 2396] to
determine permissable characters and resolving relative URIs. Other
specifications such as namespaces in XML 1.1 [451]XML Namespaces 1.1]
may rely on alternative resource identifier types that may, for
example, include non-ASCII characters, necessitating support for
alternative resource identifier types where required by applicable
specifications.
1.3.3 XML Namespaces
DOM Level 2 and 3 support XML namespaces [452]XML Namespaces] by
augmenting several interfaces of the DOM Level 1 Core to allow
creating and manipulating [453]elements and attributes associated to a
namespace. When [454]XML 1.1] is in use (see
[455]Document.xmlVersion), DOM Level 3 also supports [456]XML
Namespaces 1.1].
As far as the DOM is concerned, special attributes used for declaring
XML namespaces are still exposed and can be manipulated just like any
other attribute. However, nodes are permanently bound to
[457]namespace URIs as they get created. Consequently, moving a node
within a document, using the DOM, in no case results in a change of
its [458]namespace prefix or namespace URI. Similarly, creating a node
with a namespace prefix and namespace URI, or changing the namespace
prefix of a node, does not result in any addition, removal, or
modification of any special attributes for declaring the appropriate
XML namespaces. Namespace validation is not enforced; the DOM
application is responsible. In particular, since the mapping between
prefixes and namespace URIs is not enforced, in general, the resulting
document cannot be serialized naively. For example, applications may
have to declare every namespace in use when serializing a document.
In general, the DOM implementation (and higher) doesn't perform any
URI normalization or canonicalization. The URIs given to the DOM are
assumed to be valid (e.g., characters such as white spaces are
properly escaped), and no lexical checking is performed. Absolute URI
references are treated as strings and [459]compared literally. How
relative namespace URI references are treated is undefined. To ensure
interoperability only absolute namespace URI references (i.e., URI
references beginning with a scheme name and a colon) should be used.
Applications should use the value null as the namespaceURI parameter
for methods if they wish to have no namespace. In programming
languages where empty strings can be differentiated from null, empty
strings, when given as a namespace URI, are converted to null. This is
true even though the DOM does no lexical checking of URIs.
Note: [460]Element.setAttributeNS(null, ...) puts the attribute in the
per-element-type partitions as defined in [461]XML Namespace
Partitions in [462]XML Namespaces].
[461] http://www.w3.org/TR/1999/REC-xml-names-19990114
Note: In the DOM, all namespace declaration attributes are by
definition bound to the namespace URI:
"[463]http://www.w3.org/2000/xmlns/". These are the attributes whose
[464]namespace prefix or [465]qualified name is "xmlns" as introduced
in [466]XML Namespaces 1.1].
[463] http://www.w3.org/2000/xmlns/
In a document with no namespaces, the [467]child list of an
[468]EntityReference node is always the same as that of the
corresponding [469]Entity. This is not true in a document where an
entity contains unbound [470]namespace prefixes. In such a case, the
[471]descendants of the corresponding [472]EntityReference nodes may
be bound to different [473]namespace URIs, depending on where the
entity references are. Also, because, in the DOM, nodes always remain
bound to the same namespace URI, moving such [474]EntityReference
nodes can lead to documents that cannot be serialized. This is also
true when the DOM Level 1 method
[475]Document.createEntityReference(name) is used to create entity
references that correspond to such entities, since the
[476]descendants of the returned [477]EntityReference are unbound. The
DOM Level 2 does not support any mechanism to resolve namespace
prefixes. For all of these reasons, use of such entities and entity
references should be avoided or used with extreme care. A future Level
of the DOM may include some additional support for handling these.
The "NS" methods, such as [478]Document.createElementNS(namespaceURI,
qualifiedName) and [479]Document.createAttributeNS(namespaceURI,
qualifiedName), are meant to be used by namespace aware applications.
Simple applications that do not use namespaces can use the DOM Level 1
methods, such as [480]Document.createElement(tagName) and
[481]Document.createAttribute(name). Elements and attributes created
in this way do not have any namespace prefix, namespace URI, or local
name.
Note: DOM Level 1 methods are namespace ignorant. Therefore, while it
is safe to use these methods when not dealing with namespaces, using
them and the new ones at the same time should be avoided. DOM Level 1
methods solely identify attribute nodes by their [482]Node.nodeName.
On the contrary, the DOM Level 2 methods related to namespaces,
identify attribute nodes by their [483]Node.namespaceURI and
[484]Node.localName. Because of this fundamental difference, mixing
both sets of methods can lead to unpredictable results. In particular,
using [485]Element.setAttributeNS(namespaceURI, qualifiedName, value),
an [486]element may have two attributes (or more) that have the same
[487]Node.nodeName, but different [488]Node.namespaceURIs. Calling
[489]Element.getAttribute(name) with that nodeName could then return
any of those attributes. The result depends on the implementation.
Similarly, using [490]Element.setAttributeNode(newAttr), one can set
two attributes (or more) that have different [491]Node.nodeNames but
the same [492]Node.prefix and [493]Node.namespaceURI. In this case
[494]Element.getAttributeNodeNS(namespaceURI, localName) will return
either attribute, in an implementation dependent manner. The only
guarantee in such cases is that all methods that access a named item
by its nodeName will access the same item, and all methods which
access a node by its URI and local name will access the same node. For
instance, [495]Element.setAttribute(name, value) and
[496]Element.setAttributeNS(namespaceURI, qualifiedName, value) affect
the node that [497]Element.getAttribute(name) and
[498]Element.getAttributeNS(namespaceURI, localName), respectively,
return.
1.3.4 Base URIs
The DOM Level 3 adds support for the [base URI] property defined in
[499]XML Information Set] by providing a new attribute on the
[500]Node interface that exposes this information. However, unlike the
[501]Node.namespaceURI attribute, the [502]Node.baseURI attribute is
not a static piece of information that every node carries. Instead, it
is a value that is dynamically computed according to [503]XML Base].
This means its value depends on the location of the node in the tree
and moving the node from one place to another in the tree may affect
its value. Other changes, such as adding or changing an xml:base
attribute on the node being queried or one of its ancestors may also
affect its value.
One consequence of this it that when external entity references are
expanded while building a [504]Document one may need to add, or
change, an xml:base attribute to the [505]Element nodes originally
contained in the entity being expanded so that the [506]Node.baseURI
returns the correct value. In the case of [507]ProcessingInstruction
nodes originally contained in the entity being expanded the
information is lost. [508]DOM Level 3 Load and Save] handles elements
as described here and generates a warning in the latter case.
1.3.5 Mixed DOM implementations
As new XML vocabularies are developed, those defining the vocabularies
are also beginning to define specialized APIs for manipulating XML
instances of those vocabularies. This is usually done by extending the
DOM to provide interfaces and methods that perform operations
frequently needed their users. For example, the MathML [509]MathML
[ 2.0] and SVG [510]SVG 1.0] specifications have developed DOM
extensions to allow users to manipulate instances of these
vocabularies using semantics appropriate to images and mathematics,
respectively, as well as the generic DOM XML semantics. Instances of
SVG or MathML are often embedded in XML documents conforming to a
different schema such as XHTML.
While the Namespaces in XML specification [511]XML Namespaces]
provides a mechanism for integrating these documents at the syntax
level, it has become clear that the DOM Level 2 Recommendation
[512]DOM Level 2 Core] is not rich enough to cover all the issues
that have been encountered in having these different DOM
implementations be used together in a single application. DOM Level 3
deals with the requirements brought about by embedding fragments
written according to a specific markup language (the embedded
component) in a document where the rest of the markup is not written
according to that specific markup language (the host document). It
does not deal with fragments embedded by reference or linking.
A DOM implementation supporting DOM Level 3 Core should be able to
collaborate with subcomponents implementing specific DOMs to assemble
a compound document that can be traversed and manipulated via DOM
interfaces as if it were a seamless whole.
The normal typecast operation on an object should support the
interfaces expected by legacy code for a given document type.
Typecasting techniques may not be adequate for selecting between
multiple DOM specializations of an object which were combined at run
time, because they may not all be part of the same object as defined
by the binding's object model. Conflicts are most obvious with the
[513]Document object, since it is shared as owner by the rest of the
document. In a homogeneous document, elements rely on the Document for
specialized services and construction of specialized nodes. In a
heterogeneous document, elements from different modules expect
different services and APIs from the same [514]Document object, since
there can only be one owner and root of the document hierarchy.
1.3.6 DOM Features
Each DOM module defines one or more features, as listed in the
conformance section ([515]Conformance). Features are case-insensitive
and are also defined for a specific set of versions. For example, this
specification defines the features "Core" and "XML", for the version
"3.0". Versions "1.0" and "2.0" can also be used for features defined
in the corresponding DOM Levels. To avoid possible conflicts, as a
convention, names referring to features defined outside the DOM
specification should be made unique. Applications could then request
for features to be supported by a DOM implementation using the methods
[516]DOMImplementationSource.getDOMImplementation(features) or
[517]DOMImplementationSource.getDOMImplementationList(features), check
the features supported by a DOM implementation using the method
[518]DOMImplementation.hasFeature(feature, version), or by a specific
node using [519]Node.isSupported(feature, version). Note that when
using the methods that take a feature and a version as parameters,
applications can use null or empty string for the version parameter if
they don't wish to specify a particular version for the specified
feature.
Up to the DOM Level 2 modules, all interfaces, that were an extension
of existing ones, were accessible using binding-specific casting
mechanisms if the feature associated to the extension was supported.
For example, an instance of the EventTarget interface could be
obtained from an instance of the [520]Node interface if the feature
"Events" was supported by the node.
As discussed [521]Mixed DOM implementations, DOM Level 3 Core should
be able to collaborate with subcomponents implementing specific DOMs.
For that effect, the methods
[522]DOMImplementation.getFeature(feature, version) and
[523]Node.getFeature(feature, version) were introduced. In the case of
[524]DOMImplementation.hasFeature(feature, version) and
[525]Node.isSupported(feature, version), if a plus sign "+" is
prepended to any feature name, implementations are considered in which
the specified feature may not be directly castable but would require
discovery through [526]DOMImplementation.getFeature(feature, version)
and [527]Node.getFeature(feature, version). Without a plus, only
features whose interfaces are directly castable are considered.
// example 1, without prepending the "+"
if (myNode.isSupported("Events", "3.0")) {
EventTarget evt = (EventTarget) myNode;
// ...
}
// example 2, with the "+"
if (myNode.isSupported("+Events", "3.0")) {
// (the plus sign "+" is irrelevant for the getFeature method itself
// and is ignored by this method anyway)
EventTarget evt = (EventTarget) myNode.getFeature("Events", "3.0");
// ...
}
1.3.7 Bootstrapping
Because previous versions of the DOM specification only defined a set
of interfaces, applications had to rely on some implementation
dependent code to start from. However, hard-coding the application to
a specific implementation prevents the application from running on
other implementations and from using the most-suitable implementation
of the environment. At the same time, implementations may also need to
load modules or perform other setup to efficiently adapt to different
and sometimes mutually-exclusive feature sets.
To solve these problems this specification introduces a
DOMImplementationRegistry object with a function that lets an
application find implementations, based on the specific features it
requires. How this object is found and what it exactly looks like is
not defined here, because this cannot be done in a
language-independent manner. Instead, each language binding defines
its own way of doing this. See [528]Java Language Binding and
[529]ECMAScript Language Binding for specifics.
In all cases, though, the DOMImplementationRegistry provides a
getDOMImplementation method accepting a features string, which is
passed to every known [530]DOMImplementationSource until a suitable
[531]DOMImplementation is found and returned. The
DOMImplementationRegistry also provides a getDOMImplementationList
method accepting a features string, which is passed to every known
[532]DOMImplementationSource, and returns a list of suitable
[533]DOMImplementations. Those two methods are the same as the ones
found on the [534]DOMImplementationSource interface.
Any number of [535]DOMImplementationSource objects can be registered.
A source may return one or more [536]DOMImplementation singletons or
construct new [537]DOMImplementation objects, depending upon whether
the requested features require specialized state in the
[538]DOMImplementation object.
1.4 Fundamental Interfaces: Core module
The interfaces within this section are considered fundamental, and
must be fully implemented by all conforming implementations of the
DOM, including all HTML DOM implementations [539]DOM Level 2 HTML],
unless otherwise specified.
A DOM application may use the
[540]DOMImplementation.hasFeature(feature, version) method with
parameter values "Core" and "3.0" (respectively) to determine whether
or not this module is supported by the implementation. Any
implementation that conforms to DOM Level 3 or a DOM Level 3 module
must conform to the Core module. Please refer to additional
information about [541]conformance in this specification. The DOM
Level 3 Core module is backward compatible with the DOM Level 2 Core
[542]DOM Level 2 Core] module, i.e. a DOM Level 3 Core implementation
who returns true for "Core" with the version number "3.0" must also
return true for this feature when the version number is "2.0", "" or,
null.
[541] http://www.w3.org/TR/DOM-Level-3-Core/introduction.html#ID-Conformance
Exception DOMException
DOM operations only raise exceptions in "exceptional"
circumstances, i.e., when an operation is impossible to perform
(either for logical reasons, because data is lost, or because
the implementation has become unstable). In general, DOM
methods return specific error values in ordinary processing
situations, such as out-of-bound errors when using
[543]NodeList.
Implementations should raise other exceptions under other
circumstances. For example, implementations should raise an
implementation-dependent exception if a null argument is passed
when null was not expected.
Some languages and object systems do not support the concept of
exceptions. For such systems, error conditions may be indicated
using native error reporting mechanisms. For some bindings, for
example, methods may return error codes similar to those listed
in the corresponding method descriptions.
IDL Definition
exception [544]DOMException {
unsigned short code;
};
// ExceptionCode
const unsigned short [545]INDEX_SIZE_ERR = 1;
const unsigned short [546]DOMSTRING_SIZE_ERR = 2;
const unsigned short [547]HIERARCHY_REQUEST_ERR = 3;
const unsigned short [548]WRONG_DOCUMENT_ERR = 4;
const unsigned short [549]INVALID_CHARACTER_ERR = 5;
const unsigned short [550]NO_DATA_ALLOWED_ERR = 6;
const unsigned short [551]NO_MODIFICATION_ALLOWED_ERR = 7;
const unsigned short [552]NOT_FOUND_ERR = 8;
const unsigned short [553]NOT_SUPPORTED_ERR = 9;
const unsigned short [554]INUSE_ATTRIBUTE_ERR = 10;
// Introduced in DOM Level 2:
const unsigned short [555]INVALID_STATE_ERR = 11;
// Introduced in DOM Level 2:
const unsigned short [556]SYNTAX_ERR = 12;
// Introduced in DOM Level 2:
const unsigned short [557]INVALID_MODIFICATION_ERR = 13;
// Introduced in DOM Level 2:
const unsigned short [558]NAMESPACE_ERR = 14;
// Introduced in DOM Level 2:
const unsigned short [559]INVALID_ACCESS_ERR = 15;
// Introduced in DOM Level 3:
const unsigned short [560]VALIDATION_ERR = 16;
// Introduced in DOM Level 3:
const unsigned short [561]TYPE_MISMATCH_ERR = 17;
Definition group ExceptionCode
An integer indicating the type of error generated.
Note: Other numeric codes are reserved for W3C for
possible future use.
Defined Constants
DOMSTRING_SIZE_ERR
If the specified range of text does not fit
into a [562]DOMString.
HIERARCHY_REQUEST_ERR
If any [563]Node is inserted somewhere it
doesn't belong.
INDEX_SIZE_ERR
If index or size is negative, or greater than
the allowed value.
INUSE_ATTRIBUTE_ERR
If an attempt is made to add an attribute
that is already in use elsewhere/
INVALID_ACCESS_ERR, introduced in DOM Level 2.
If a parameter or an operation is not
supported by the underlying object.
INVALID_CHARACTER_ERR
If an invalid or illegal character is
specified, such as in a name.
INVALID_MODIFICATION_ERR, introduced in DOM Level 2.
If an attempt is made to modify the type of
the underlying object.
INVALID_STATE_ERR, introduced in DOM Level 2.
If an attempt is made to use an object that
is not, or is no longer, usable.
NAMESPACE_ERR, introduced in DOM Level 2.
If an attempt is made to create or change an
object in a way which is incorrect with
regard to namespaces.
NOT_FOUND_ERR
If an attempt is made to reference a
[564]Node in a context where it does not
exist.
NOT_SUPPORTED_ERR
If the implementation does not support the
requested type of object or operation.
NO_DATA_ALLOWED_ERR
If data is specified for a [565]Node which
does not support data.
NO_MODIFICATION_ALLOWED_ERR
If an attempt is made to modify an object
where modifications are not allowed.
SYNTAX_ERR, introduced in DOM Level 2.
If an invalid or illegal string is specified.
TYPE_MISMATCH_ERR, introduced in DOM Level 3.
If the type of an object is incompatible with
the expected type of the parameter associated
to the object.
VALIDATION_ERR, introduced in DOM Level 3.
If a call to a method such as insertBefore or
removeChild would make the [566]Node invalid
with respect to [567]"partial validity", this
exception would be raised and the operation
would not be done. This code is used in
[568]DOM Level 3 Validation]. Refer to this
specification for further information.
WRONG_DOCUMENT_ERR
If a [569]Node is used in a different
document than the one that created it (that
doesn't support it).
Interface DOMStringList (introduced in DOM Level 3)
The DOMStringList interface provides the abstraction of an
ordered collection of [570]DOMString values, without defining
or constraining how this collection is implemented. The items
in the DOMStringList are accessible via an integral index,
starting from 0.
IDL Definition
// Introduced in DOM Level 3:
interface [571]DOMStringList {
[572]DOMString [573]item(in unsigned long index);
readonly attribute unsigned long [574]length;
boolean [575]contains(in [576]DOMString str);
};
Attributes
length of type unsigned long, readonly
The number of [577]DOMStrings in the list. The
range of valid child node indices is 0 to length-1
inclusive.
Methods
contains
Test if a string is part of this DOMStringList.
Parameters
str of type [578]DOMString
The string to look for.
Return Value
boolean
true if the string has been found, false otherwise.
No Exceptions
item
Returns the indexth item in the collection. If
index is greater than or equal to the number of
[579]DOMStrings in the list, this returns null.
Parameters
index of type unsigned long
Index into the collection.
Return Value
[580]DOMString
The [581]DOMString at the indexth position in the DOMStringList, or
null if that is not a valid index.
No Exceptions
Interface NameList (introduced in DOM Level 3)
The NameList interface provides the abstraction of an ordered
collection of parallel pairs of name and namespace values
(which could be null values), without defining or constraining
how this collection is implemented. The items in the NameList
are accessible via an integral index, starting from 0.
IDL Definition
// Introduced in DOM Level 3:
interface [582]NameList {
[583]DOMString [584]getName(in unsigned long index);
[585]DOMString [586]getNamespaceURI(in unsigned long index);
readonly attribute unsigned long [587]length;
boolean [588]contains(in [589]DOMString name);
boolean [590]containsNS(in [591]DOMString namespaceURI,
in [592]DOMString name);
};
Attributes
length of type unsigned long, readonly
The number of pairs (name and namespaceURI) in the
list. The range of valid child node indices is 0 to
length-1 inclusive.
Methods
contains
Test if a name is part of this NameList.
Parameters
name of type [593]DOMString
The name to look for.
Return Value
boolean
true if the name has been found, false otherwise.
No Exceptions
containsNS
Test if the pair namespaceURI/name is part of this
NameList.
Parameters
namespaceURI of type [594]DOMString
The namespace URI to look for.
name of type [595]DOMString
The name to look for.
Return Value
boolean
true if the pair namespaceURI/name has been found, false otherwise.
No Exceptions
getName
Returns the indexth name item in the collection.
Parameters
index of type unsigned long
Index into the collection.
Return Value
[596]DOMString
The name at the indexth position in the NameList, or null if there is
no name for the specified index or if the index is out of range.
No Exceptions
getNamespaceURI
Returns the indexth namespaceURI item in the
collection.
Parameters
index of type unsigned long
Index into the collection.
Return Value
[597]DOMString
The namespace URI at the indexth position in the NameList, or null if
there is no name for the specified index or if the index is out of
range.
No Exceptions
Interface DOMImplementationList (introduced in DOM Level 3)
The DOMImplementationList interface provides the abstraction of
an ordered collection of DOM implementations, without defining
or constraining how this collection is implemented. The items
in the DOMImplementationList are accessible via an integral
index, starting from 0.
IDL Definition
// Introduced in DOM Level 3:
interface [598]DOMImplementationList {
[599]DOMImplementation [600]item(in unsigned long index);
readonly attribute unsigned long [601]length;
};
Attributes
length of type unsigned long, readonly
The number of [602]DOMImplementations in the list.
The range of valid child node indices is 0 to
length-1 inclusive.
Methods
item
Returns the indexth item in the collection. If
index is greater than or equal to the number of
[603]DOMImplementations in the list, this returns
null.
Parameters
index of type unsigned long
Index into the collection.
Return Value
[604]DOMImplementation
The [605]DOMImplementation at the indexth position in the
DOMImplementationList, or null if that is not a valid index.
No Exceptions
Interface DOMImplementationSource (introduced in DOM Level 3)
This interface permits a DOM implementer to supply one or more
implementations, based upon requested features and versions, as
specified in [606]DOM Features. Each implemented
DOMImplementationSource object is listed in the
binding-specific list of available sources so that its
[607]DOMImplementation objects are made available.
IDL Definition
// Introduced in DOM Level 3:
interface [608]DOMImplementationSource {
[609]DOMImplementation [610]getDOMImplementation(in [611]DOMString features)
;
[612]DOMImplementationList [613]getDOMImplementationList(in [614]DOMString fe
atures);
};
Methods
getDOMImplementation
A method to request the first DOM implementation
that supports the specified features.
Parameters
features of type [615]DOMString
A string that specifies which features and
versions are required. This is a space
separated list in which each feature is
specified by its name optionally followed by
a space and a version number.
This method returns the first item of the
list returned by getDOMImplementationList.
As an example, the string "XML 3.0 Traversal
+Events 2.0" will request a DOM
implementation that supports the module "XML"
for its 3.0 version, a module that support of
the "Traversal" module for any version, and
the module "Events" for its 2.0 version. The
module "Events" must be accessible using the
method [616]Node.getFeature() and
[617]DOMImplementation.getFeature().
Return Value
[618]DOMImplementation
The first DOM implementation that support the desired features, or
null if this source has none.
No Exceptions
getDOMImplementationList
A method to request a list of DOM implementations
that support the specified features and versions,
as specified in [619]DOM Features.
Parameters
features of type [620]DOMString
A string that specifies which features and
versions are required. This is a space
separated list in which each feature is
specified by its name optionally followed by
a space and a version number. This is
something like: "XML 3.0 Traversal +Events
2.0"
Return Value
[621]DOMImplementationList
A list of DOM implementations that support the desired features.
No Exceptions
Interface DOMImplementation
The DOMImplementation interface provides a number of methods
for performing operations that are independent of any
particular instance of the document object model.
IDL Definition
interface [622]DOMImplementation {
boolean [623]hasFeature(in [624]DOMString feature,
in [625]DOMString version);
// Introduced in DOM Level 2:
[626]DocumentType [627]createDocumentType(in [628]DOMString qualifiedNa
me,
in [629]DOMString publicId,
in [630]DOMString systemId)
raises([631]DOMException);
// Introduced in DOM Level 2:
[632]Document [633]createDocument(in [634]DOMString namespaceURI,
in [635]DOMString qualifiedName,
in [636]DocumentType doctype)
raises([637]DOMException);
// Introduced in DOM Level 3:
[638]DOMObject [639]getFeature(in [640]DOMString feature,
in [641]DOMString version);
};
Methods
createDocument introduced in DOM Level 2
Creates a DOM Document object of the specified type
with its document element.
Note that based on the [642]DocumentType given to
create the document, the implementation may
instantiate specialized [643]Document objects that
support additional features than the "Core", such
as "HTML" [644]DOM Level 2 HTML]. On the other
hand, setting the [645]DocumentType after the
document was created makes this very unlikely to
happen. Alternatively, specialized [646]Document
creation methods, such as createHTMLDocument
[647]DOM Level 2 HTML], can be used to obtain
specific types of [648]Document objects.
Parameters
namespaceURI of type [649]DOMString
The [650]namespace URI of the document
element to create or null.
qualifiedName of type [651]DOMString
The [652]qualified name of the document
element to be created or null.
doctype of type [653]DocumentType
The type of document to be created or null.
When doctype is not null, its
[654]Node.ownerDocument attribute is set to
the document being created.
Return Value
[655]Document
A new [656]Document object with its document element. If the
NamespaceURI, qualifiedName, and doctype are null, the returned
[657]Document is empty with no document element.
Exceptions
[658]DOMException
INVALID_CHARACTER_ERR: Raised if the specified qualified name contains
an illegal character according to [659]XML 1.0].
NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the
qualifiedName has a prefix and the namespaceURI is null, or if the
qualifiedName is null and the namespaceURI is different from null, or
if the qualifiedName has a prefix that is "xml" and the namespaceURI
is different from "[660]http://www.w3.org/XML/1998/namespace"
[661]XML Namespaces], or if the DOM implementation does not support
the "XML" feature but a non-null namespace URI was provided, since
namespaces were defined by XML.
WRONG_DOCUMENT_ERR: Raised if doctype has already been used with a
different document or was created from a different implementation.
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [662]HTML 4.01]).
[660] http://www.w3.org/XML/1998/namespace
createDocumentType introduced in DOM Level 2
Creates an empty [663]DocumentType node. Entity
declarations and notations are not made available.
Entity reference expansions and default attribute
additions do not occur..
Parameters
qualifiedName of type [664]DOMString
The [665]qualified name of the document type
to be created.
publicId of type [666]DOMString
The external subset public identifier.
systemId of type [667]DOMString
The external subset system identifier.
Return Value
[668]DocumentType
A new [669]DocumentType node with [670]Node.ownerDocument set to null.
Exceptions
[671]DOMException
INVALID_CHARACTER_ERR: Raised if the specified qualified name contains
an illegal character according to [672]XML 1.0].
NAMESPACE_ERR: Raised if the qualifiedName is malformed.
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [673]HTML 4.01]).
getFeature introduced in DOM Level 3
This method returns a specialized object which
implements the specialized APIs of the specified
feature and version, as specified in [674]DOM
Features. The specialized object may also be
obtained by using binding-specific casting methods
but is not necessarily expected to, as discussed in
[675]Mixed DOM implementations. This method also
allow the implementation to provide specialized
objects which do not support the DOMImplementation
interface.
Parameters
feature of type [676]DOMString
The name of the feature requested. Note that
any plus sign "+" prepended to the name of
the feature will be ignored since it is not
significant in the context of this method.
version of type [677]DOMString
This is the version number of the feature to
test.
Return Value
[678]DOMObject
Returns an object which implements the specialized APIs of the
specified feature and version, if any, or null if there is no object
which implements interfaces associated with that feature. If the
[679]DOMObject returned by this method implements the
DOMImplementation interface, it must delegate to the primary core
DOMImplementation and not return results inconsistent with the primary
core DOMImplementation such as hasFeature, getFeature, etc.
No Exceptions
hasFeature
Test if the DOM implementation implements a
specific feature and version, as specified in
[680]DOM Features.
Parameters
feature of type [681]DOMString
The name of the feature to test.
version of type [682]DOMString
This is the version number of the feature to
test.
Return Value
boolean
true if the feature is implemented in the specified version, false
otherwise.
No Exceptions
Interface DocumentFragment
DocumentFragment is a "lightweight" or "minimal" [683]Document
object. It is very common to want to be able to extract a
portion of a document's tree or to create a new fragment of a
document. Imagine implementing a user command like cut or
rearranging a document by moving fragments around. It is
desirable to have an object which can hold such fragments and
it is quite natural to use a Node for this purpose. While it is
true that a [684]Document object could fulfill this role, a
[685]Document object can potentially be a heavyweight object,
depending on the underlying implementation. What is really
needed for this is a very lightweight object. DocumentFragment
is such an object.
Furthermore, various operations -- such as inserting nodes as
children of another [686]Node -- may take DocumentFragment
objects as arguments; this results in all the child nodes of
the DocumentFragment being moved to the child list of this
node.
The children of a DocumentFragment node are zero or more nodes
representing the tops of any sub-trees defining the structure
of the document. DocumentFragment nodes do not need to be
[687]well-formed XML documents (although they do need to follow
the rules imposed upon well-formed XML parsed entities, which
can have multiple top nodes). For example, a DocumentFragment
might have only one child and that child node could be a
[688]Text node. Such a structure model represents neither an
HTML document nor a well-formed XML document.
When a DocumentFragment is inserted into a [689]Document (or
indeed any other [690]Node that may take children) the children
of the DocumentFragment and not the DocumentFragment itself are
inserted into the [691]Node. This makes the DocumentFragment
very useful when the user wishes to create nodes that are
[692]siblings; the DocumentFragment acts as the parent of these
nodes so that the user can use the standard methods from the
[693]Node interface, such as [694]Node.insertBefore and
[695]Node.appendChild.
IDL Definition
interface [696]DocumentFragment : [697]Node {
};
Interface Document
The Document interface represents the entire HTML or XML
document. Conceptually, it is the [698]root of the document
tree, and provides the primary access to the document's data.
Since elements, text nodes, comments, processing instructions,
etc. cannot exist outside the context of a Document, the
Document interface also contains the factory methods needed to
create these objects. The [699]Node objects created have a
ownerDocument attribute which associates them with the Document
within whose context they were created.
IDL Definition
interface [700]Document : [701]Node {
// Modified in DOM Level 3:
readonly attribute [702]DocumentType [703]doctype;
readonly attribute [704]DOMImplementation [705]implementation;
readonly attribute [706]Element [707]documentElement;
[708]Element [709]createElement(in [710]DOMString tagName)
raises([711]DOMException);
[712]DocumentFragment [713]createDocumentFragment();
[714]Text [715]createTextNode(in [716]DOMString data);
[717]Comment [718]createComment(in [719]DOMString data);
[720]CDATASection [721]createCDATASection(in [722]DOMString data)
raises([723]DOMException);
[724]ProcessingInstruction [725]createProcessingInstruction(in [726]DOMString
target,
in [727]DOMString data)
raises([728]DOMException);
[729]Attr [730]createAttribute(in [731]DOMString name)
raises([732]DOMException);
[733]EntityReference [734]createEntityReference(in [735]DOMString name)
raises([736]DOMException);
[737]NodeList [738]getElementsByTagName(in [739]DOMString tagname);
// Introduced in DOM Level 2:
[740]Node [741]importNode(in [742]Node importedNode,
in boolean deep)
raises([743]DOMException);
// Introduced in DOM Level 2:
[744]Element [745]createElementNS(in [746]DOMString namespaceURI,
in [747]DOMString qualifiedName)
raises([748]DOMException);
// Introduced in DOM Level 2:
[749]Attr [750]createAttributeNS(in [751]DOMString namespaceURI
,
in [752]DOMString qualifiedName)
raises([753]DOMException);
// Introduced in DOM Level 2:
[754]NodeList [755]getElementsByTagNameNS(in [756]DOMString namespa
ceURI,
in [757]DOMString localName);
// Introduced in DOM Level 2:
[758]Element [759]getElementById(in [760]DOMString elementId);
// Introduced in DOM Level 3:
readonly attribute [761]DOMString [762]inputEncoding;
// Introduced in DOM Level 3:
readonly attribute [763]DOMString [764]xmlEncoding;
// Introduced in DOM Level 3:
attribute boolean [765]xmlStandalone;
// raises([766]DOMException) on setting
// Introduced in DOM Level 3:
attribute [767]DOMString [768]xmlVersion;
// raises([769]DOMException) on setting
// Introduced in DOM Level 3:
attribute boolean [770]strictErrorChecking;
// Introduced in DOM Level 3:
attribute [771]DOMString [772]documentURI;
// Introduced in DOM Level 3:
[773]Node [774]adoptNode(in [775]Node source)
raises([776]DOMException);
// Introduced in DOM Level 3:
readonly attribute [777]DOMConfiguration [778]domConfig;
// Introduced in DOM Level 3:
void [779]normalizeDocument();
// Introduced in DOM Level 3:
[780]Node [781]renameNode(in [782]Node n,
in [783]DOMString namespaceURI,
in [784]DOMString qualifiedName)
raises([785]DOMException);
};
Attributes
doctype of type [786]DocumentType, readonly, modified in
DOM Level 3
The Document Type Declaration (see
[787]DocumentType) associated with this document.
For HTML documents as well as XML documents without
a document type declaration this returns null.
This provides direct access to the
[788]DocumentType node, child node of this
Document. This node can be set at document creation
time and later changed through the use of child
nodes manipulation methods, such as
[789]Node.insertBefore, or [790]Node.replaceChild.
Note, however, that while some implementations may
instantiate different types of Document objects
supporting additional features than the "Core",
such as "HTML" [791]DOM Level 2 HTML], based on
the [792]DocumentType specified at creation time,
changing it afterwards is very unlikely to result
in a change of the features supported.
documentElement of type [793]Element, readonly
This is a [794]convenience attribute that allows
direct access to the child node that is the
[795]document element of the document.
documentURI of type [796]DOMString, introduced in DOM Level
3
The location of the document or null if undefined
or if the Document was created using
[797]DOMImplementation.createDocument. No lexical
checking is performed when setting this attribute;
this could result in a null value returned when
using [798]Node.baseURI.
Beware that when the Document supports the feature
"HTML" [799]DOM Level 2 HTML], the href attribute
of the HTML BASE element takes precedence over this
attribute when computing [800]Node.baseURI.
domConfig of type [801]DOMConfiguration, readonly,
introduced in DOM Level 3
The configuration used when
[802]Document.normalizeDocument() is invoked.
implementation of type [803]DOMImplementation, readonly
The [804]DOMImplementation object that handles this
document. A DOM application may use objects from
multiple implementations.
inputEncoding of type [805]DOMString, readonly, introduced
in DOM Level 3
An attribute specifying the encoding used for this
document at the time of the parsing. This is null
when it is not known, such as when the Document was
created in memory.
strictErrorChecking of type boolean, introduced in DOM
Level 3
An attribute specifying whether error checking is
enforced or not. When set to false, the
implementation is free to not test every possible
error case normally defined on DOM operations, and
not raise any [806]DOMException on DOM operations
or report errors while using
[807]Document.normalizeDocument(). In case of
error, the behavior is undefined. This attribute is
true by default.
xmlEncoding of type [808]DOMString, readonly, introduced in
DOM Level 3
An attribute specifying, as part of the [809]XML
declaration, the encoding of this document. This is
null when unspecified.
[809] http://www.w3.org/TR/2000/REC-xml-20001006#NT-XMLDecl
xmlStandalone of type boolean, introduced in DOM Level 3
An attribute specifying, as part of the [810]XML
declaration, whether this document is standalone.
This is false when unspecified.
[810] http://www.w3.org/TR/2000/REC-xml-20001006#NT-XMLDecl
Note: No verification is done on the value when
setting this attribute. Applications should use
[811]Document.normalizeDocument() with the
"[812]validate" parameter to verify if the value
matches the [813]validity constraint for standalone
document declaration as defined in [814]XML 1.0].
[813] http://www.w3.org/TR/2000/REC-xml-20001006#sec-rmd
Exceptions on setting
[815]DOMException
NOT_SUPPORTED_ERR: Raised if this document does not support the "XML"
feature.
xmlVersion of type [816]DOMString, introduced in DOM Level
3
An attribute specifying, as part of the [817]XML
declaration, the version number of this document.
If there is no declaration and if this document
supports the "XML" feature, the value is "1.0". If
this document does not support the "XML" feature,
the value is always null. Changing this attribute
will affect methods that check for illegal
characters in XML names. Application should invoke
[818]Document.normalizeDocument() in order to check
for illegal characters in the [819]Nodes that are
already part of this Document.
DOM applications may use the
[820]DOMImplementation.hasFeature(feature, version)
method with parameter values "XMLVersion" and "1.0"
(respectively) to determine if an implementation
supports [821]XML 1.0]. DOM applications may use
the same method with parameter values "XMLVersion"
and "1.1" (respectively) to determine if an
implementation supports [822]XML 1.1]. In both
cases, in order to support XML, an implementation
must also support the "XML" feature defined in this
specification. Document objects supporting a
version of the "XMLVersion" feature must not raise
a [823]NOT_SUPPORTED_ERR exception for the same
version number when using [824]Document.xmlVersion.
Exceptions on setting
[817] http://www.w3.org/TR/2000/REC-xml-20001006#NT-XMLDecl
[825]DOMException
NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not
supported by this Document or if this document does not support the
"XML" feature.
Methods
adoptNode introduced in DOM Level 3
Attempts to adopt a node from another document to
this document. If supported, it changes the
ownerDocument of the source node, its children, as
well as the attached attribute nodes if there are
any. If the source node has a parent it is first
removed from the child list of its parent. This
effectively allows moving a subtree from one
document to another (unlike importNode() which
create a copy of the source node instead of moving
it). When it fails, applications should use
[826]Document.importNode() instead. The following
list describes the specifics for each type of node.
ATTRIBUTE_NODE
The ownerElement attribute is set to null and
the specified flag is set to true on the
adopted [827]Attr. The descendants of the
source [828]Attr are recursively adopted.
DOCUMENT_FRAGMENT_NODE
The descendants of the source node are
recursively adopted.
DOCUMENT_NODE
Document nodes cannot be adopted.
DOCUMENT_TYPE_NODE
[829]DocumentType nodes cannot be adopted.
ELEMENT_NODE
Specified attribute nodes of the source
element are adopted. Default attributes are
discarded, though if the document being
adopted into defines default attributes for
this element name, those are assigned. The
descendants of the source element are
recursively adopted.
ENTITY_NODE
[830]Entity nodes cannot be adopted.
ENTITY_REFERENCE_NODE
Only the [831]EntityReference node itself is
adopted, the descendants are discarded, since
the source and destination documents might
have defined the entity differently. If the
document being imported into provides a
definition for this entity name, its value is
assigned.
NOTATION_NODE
[832]Notation nodes cannot be adopted.
PROCESSING_INSTRUCTION_NODE, TEXT_NODE,
CDATA_SECTION_NODE, COMMENT_NODE
These nodes can all be adopted. No specifics.
Note: Since it does not create new nodes unlike the
[833]Document.importNode() method, this method does
not raise an [834]INVALID_CHARACTER_ERR exception,
and applications should use the
[835]Document.normalizeDocument() method to check
if an imported name contain an illegal character
according to the XML version in use.
Parameters
source of type [836]Node
The node to move into this document.
Return Value
[837]Node
The adopted node, or null if this operation fails, such as when the
source node comes from a different implementation.
Exceptions
[838]DOMException
NOT_SUPPORTED_ERR: Raised if the source node is of type DOCUMENT,
DOCUMENT_TYPE.
NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly.
createAttribute
Creates an [839]Attr of the given name. Note that
the [840]Attr instance can then be set on an
[841]Element using the setAttributeNode method.
To create an attribute with a [842]qualified name
and [843]namespace URI, use the createAttributeNS
method.
Parameters
name of type [844]DOMString
The name of the attribute.
Return Value
[845]Attr
A new [846]Attr object with the nodeName attribute set to name, and
localName, prefix, and namespaceURI set to null. The value of the
attribute is the empty string.
Exceptions
[847]DOMException
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use specified in the
[848]Document.xmlVersion attribute.
createAttributeNS introduced in DOM Level 2
Creates an attribute of the given [849]qualified
name and [850]namespace URI.
Per [851]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
namespaceURI of type [852]DOMString
The [853]namespace URI of the attribute to
create.
qualifiedName of type [854]DOMString
The [855]qualified name of the attribute to
instantiate.
Return Value
[856]Attr
A new [857]Attr object with the following attributes:
Attribute Value
[858]Node.nodeName qualifiedName
[859]Node.namespaceURI namespaceURI
[860]Node.prefix prefix, extracted from qualifiedName, or null if
there is no prefix
[861]Node.localName [862]local name, extracted from qualifiedName
[863]Attr.name qualifiedName
[864]Node.nodeValue the empty string
Exceptions
[865]DOMException
INVALID_CHARACTER_ERR: Raised if the specified qualifiedName contains
an illegal character according to the XML version in use specified in
the [866]Document.xmlVersion attribute.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed
[867]qualified name, if the qualifiedName has a prefix and the
namespaceURI is null, if the qualifiedName has a prefix that is "xml"
and the namespaceURI is different from
"[868]http://www.w3.org/XML/1998/namespace", if the qualifiedName or
its prefix is "xmlns" and the namespaceURI is different from
"[869]http://www.w3.org/2000/xmlns/", or if the namespaceURI is
"[870]http://www.w3.org/2000/xmlns/" and neither the qualifiedName nor
its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not
support the "XML" feature, since namespaces were defined by XML.
[868] http://www.w3.org/XML/1998/namespace
[869] http://www.w3.org/2000/xmlns/
[870] http://www.w3.org/2000/xmlns/
createCDATASection
Creates a [871]CDATASection node whose value is the
specified string.
Parameters
data of type [872]DOMString
The data for the [873]CDATASection contents.
Return Value
[874]CDATASection
The new [875]CDATASection object.
Exceptions
[876]DOMException
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
createComment
Creates a [877]Comment node given the specified
string.
Parameters
data of type [878]DOMString
The data for the node.
Return Value
[879]Comment
The new [880]Comment object.
No Exceptions
createDocumentFragment
Creates an empty [881]DocumentFragment object.
Return Value
[882]DocumentFragment
A new [883]DocumentFragment.
No Parameters
No Exceptions
createElement
Creates an element of the type specified. Note that
the instance returned implements the [884]Element
interface, so attributes can be specified directly
on the returned object.
In addition, if there are known attributes with
default values, [885]Attr nodes representing them
are automatically created and attached to the
element.
To create an element with a [886]qualified name and
[887]namespace URI, use the createElementNS method.
Parameters
tagName of type [888]DOMString
The name of the element type to instantiate.
For XML, this is case-sensitive, otherwise it
depends on the case-sensitivity of the markup
language in use. In that case, the name is
mapped to the canonical form of that markup
by the DOM implementation.
Return Value
[889]Element
A new [890]Element object with the nodeName attribute set to tagName,
and localName, prefix, and namespaceURI set to null.
Exceptions
[891]DOMException
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use specified in the
[892]Document.xmlVersion attribute.
createElementNS introduced in DOM Level 2
Creates an element of the given [893]qualified name
and [894]namespace URI.
Per [895]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
namespaceURI of type [896]DOMString
The [897]namespace URI of the element to
create.
qualifiedName of type [898]DOMString
The [899]qualified name of the element type
to instantiate.
Return Value
[900]Element
A new [901]Element object with the following attributes:
Attribute Value
[902]Node.nodeName qualifiedName
[903]Node.namespaceURI namespaceURI
[904]Node.prefix prefix, extracted from qualifiedName, or null if
there is no prefix
[905]Node.localName [906]local name, extracted from qualifiedName
[907]Element.tagName qualifiedName
Exceptions
[908]DOMException
INVALID_CHARACTER_ERR: Raised if the specified qualifiedName contains
an illegal character according to the XML version in use specified in
the [909]Document.xmlVersion attribute.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed
[910]qualified name, if the qualifiedName has a prefix and the
namespaceURI is null, or if the qualifiedName has a prefix that is
"xml" and the namespaceURI is different from
"[911]http://www.w3.org/XML/1998/namespace" [912]XML Namespaces], or
if the qualifiedName or its prefix is "xmlns" and the namespaceURI is
different from "[913]http://www.w3.org/2000/xmlns/", or if the
namespaceURI is "[914]http://www.w3.org/2000/xmlns/" and neither the
qualifiedName nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not
support the "XML" feature, since namespaces were defined by XML.
[911] http://www.w3.org/XML/1998/namespace
[913] http://www.w3.org/2000/xmlns/
[914] http://www.w3.org/2000/xmlns/
createEntityReference
Creates an [915]EntityReference object. In
addition, if the referenced entity is known, the
child list of the [916]EntityReference node is made
the same as that of the corresponding [917]Entity
node.
Note: If any descendant of the [918]Entity node has
an unbound [919]namespace prefix, the corresponding
descendant of the created [920]EntityReference node
is also unbound; (its namespaceURI is null). The
DOM Level 2 and 3 do not support any mechanism to
resolve namespace prefixes in this case.
Parameters
name of type [921]DOMString
The name of the entity to reference.
Unlike [922]Document.createElementNS or
[923]Document.createAttributeNS, no namespace
well-formed checking is done on the entity
name. Applications should invoke
[924]Document.normalizeDocument() with the
parameter "[925]namespaces" set to true in
order to ensure that the entity name is
namespace well-formed.
Return Value
[926]EntityReference
The new [927]EntityReference object.
Exceptions
[928]DOMException
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use specified in the
[929]Document.xmlVersion attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
createProcessingInstruction
Creates a [930]ProcessingInstruction node given the
specified name and data strings.
Parameters
target of type [931]DOMString
The target part of the processing
instruction.
Unlike [932]Document.createElementNS or
[933]Document.createAttributeNS, no namespace
well-formed checking is done on the target
name. Applications should invoke
[934]Document.normalizeDocument() with the
parameter "[935]namespaces" set to true in
order to ensure that the target name is
namespace well-formed.
data of type [936]DOMString
The data for the node.
Return Value
[937]ProcessingInstruction
The new [938]ProcessingInstruction object.
Exceptions
[939]DOMException
INVALID_CHARACTER_ERR: Raised if the specified target contains an
illegal character according to the XML version in use specified in the
[940]Document.xmlVersion attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
createTextNode
Creates a [941]Text node given the specified
string.
Parameters
data of type [942]DOMString
The data for the node.
Return Value
[943]Text
The new [944]Text object.
No Exceptions
getElementById introduced in DOM Level 2
Returns the [945]Element that has an ID attribute
with the given value. If no such element exists,
this returns null. If more than one element has an
ID attribute with that value, what is returned is
undefined.
The DOM implementation is expected to use the
attribute [946]Attr.isId to determine if an
attribute is of type ID.
Note: Attributes with the name "ID" or "id" are not
of type ID unless so defined.
Parameters
elementId of type [947]DOMString
The unique id value for an element.
Return Value
[948]Element
The matching element or null if there is none.
No Exceptions
getElementsByTagName
Returns a [949]NodeList of all the [950]Elements in
[951]document order with a given tag name and are
contained in the document.
Parameters
tagname of type [952]DOMString
The name of the tag to match on. The special
value "*" matches all tags. For XML, the
tagname parameter is case-sensitive,
otherwise it depends on the case-sensitivity
of the markup language in use.
Return Value
[953]NodeList
A new [954]NodeList object containing all the matched [955]Elements.
No Exceptions
getElementsByTagNameNS introduced in DOM Level 2
Returns a [956]NodeList of all the [957]Elements
with a given [958]local name and [959]namespace URI
in [960]document order.
Parameters
namespaceURI of type [961]DOMString
The [962]namespace URI of the elements to
match on. The special value "*" matches all
namespaces.
localName of type [963]DOMString
The [964]local name of the elements to match
on. The special value "*" matches all local
names.
Return Value
[965]NodeList
A new [966]NodeList object containing all the matched [967]Elements.
No Exceptions
importNode introduced in DOM Level 2
Imports a node from another document to this
document, without altering or removing the source
node from the original document; this method
creates a new copy of the source node. The returned
node has no parent; (parentNode is null).
For all nodes, importing a node creates a node
object owned by the importing document, with
attribute values identical to the source node's
nodeName and nodeType, plus the attributes related
to namespaces (prefix, localName, and
namespaceURI). As in the cloneNode operation, the
source node is not altered. User data associated to
the imported node is not carried over. However, if
any [968]UserDataHandlers has been specified along
with the associated data these handlers will be
called with the appropriate parameters before this
method returns.
Additional information is copied as appropriate to
the nodeType, attempting to mirror the behavior
expected if a fragment of XML or HTML source was
copied from one document to another, recognizing
that the two documents may have different DTDs in
the XML case. The following list describes the
specifics for each type of node.
ATTRIBUTE_NODE
The ownerElement attribute is set to null and
the specified flag is set to true on the
generated [969]Attr. The [970]descendants of
the source [971]Attr are recursively imported
and the resulting nodes reassembled to form
the corresponding subtree.
Note that the deep parameter has no effect on
[972]Attr nodes; they always carry their
children with them when imported.
DOCUMENT_FRAGMENT_NODE
If the deep option was set to true, the
[973]descendants of the source
[974]DocumentFragment are recursively
imported and the resulting nodes reassembled
under the imported [975]DocumentFragment to
form the corresponding subtree. Otherwise,
this simply generates an empty
[976]DocumentFragment.
DOCUMENT_NODE
Document nodes cannot be imported.
DOCUMENT_TYPE_NODE
[977]DocumentType nodes cannot be imported.
ELEMENT_NODE
Specified attribute nodes of the source
element are imported, and the generated
[978]Attr nodes are attached to the generated
[979]Element. Default attributes are not
copied, though if the document being imported
into defines default attributes for this
element name, those are assigned. If the
importNode deep parameter was set to true,
the [980]descendants of the source element
are recursively imported and the resulting
nodes reassembled to form the corresponding
subtree.
ENTITY_NODE
[981]Entity nodes can be imported, however in
the current release of the DOM the
[982]DocumentType is readonly. Ability to add
these imported nodes to a [983]DocumentType
will be considered for addition to a future
release of the DOM.
On import, the publicId, systemId, and
notationName attributes are copied. If a deep
import is requested, the [984]descendants of
the the source [985]Entity are recursively
imported and the resulting nodes reassembled
to form the corresponding subtree.
ENTITY_REFERENCE_NODE
Only the [986]EntityReference itself is
copied, even if a deep import is requested,
since the source and destination documents
might have defined the entity differently. If
the document being imported into provides a
definition for this entity name, its value is
assigned.
NOTATION_NODE
[987]Notation nodes can be imported, however
in the current release of the DOM the
[988]DocumentType is readonly. Ability to add
these imported nodes to a [989]DocumentType
will be considered for addition to a future
release of the DOM.
On import, the publicId and systemId
attributes are copied.
Note that the deep parameter has no effect on
this type of nodes since they cannot have any
children.
PROCESSING_INSTRUCTION_NODE
The imported node copies its target and data
values from those of the source node.
Note that the deep parameter has no effect on
this type of nodes since they cannot have any
children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
These three types of nodes inheriting from
[990]CharacterData copy their data and length
attributes from those of the source node.
Note that the deep parameter has no effect on
these types of nodes since they cannot have
any children.
Parameters
importedNode of type [991]Node
The node to import.
deep of type boolean
If true, recursively import the subtree under
the specified node; if false, import only the
node itself, as explained above. This has no
effect on nodes that cannot have any
children, and on [992]Attr, and
[993]EntityReference nodes.
Return Value
[994]Node
The imported node that belongs to this Document.
Exceptions
[995]DOMException
NOT_SUPPORTED_ERR: Raised if the type of node being imported is not
supported.
INVALID_CHARACTER_ERR: Raised if one the imported names contain an
illegal character according to the XML version in use specified in the
[996]Document.xmlVersion attribute. This may happen when importing an
XML 1.1 [997]XML 1.1] element into an XML 1.0 document, for instance.
normalizeDocument introduced in DOM Level 3
This method acts as if the document was going
through a save and load cycle, putting the document
in a "normal" form. As a consequence, this method
updates the replacement tree of
[998]EntityReference nodes and normalizes [999]Text
nodes, as defined in the method
[1000]Node.normalize().
Otherwise, the actual result depends on the
features being set on the Document.xmlConfig object
and governing what operations actually take place.
Noticeably this method could also make the document
[1001]namespace well-formed according to the
algorithm described in [1002]Namespace
normalization, check the character normalization,
remove the [1003]CDATASection nodes, etc. See
[1004]DOMConfiguration for details.
// Keep in the document the information defined
// in the XML Information Set (Java example)
DOMConfiguration docConfig = myDocument.getDomConfig();
docConfig.setParameter("infoset", Boolean.TRUE);
myDocument.normalizeDocument();
Mutation events, when supported, are generated to
reflect the changes occurring on the document.
If errors occur during the invocation of this
method, such as an attempt to update a
[1005]read-only node or a [1006]Node.nodeName
contains an invalid character according to the XML
version in use, errors or warnings
([1007]DOMError.SEVERITY_ERROR or
[1008]DOMError.SEVERITY_WARNING) will be reported
using the [1009]DOMErrorHandler object associated
with the "[1010]error-handler" parameter. Note this
method might also report fatal errors
([1011]DOMError.SEVERITY_FATAL_ERROR) if an
implementation cannot recover from an error.
No Parameters
No Return Value
No Exceptions
renameNode introduced in DOM Level 3
Rename an existing node of type ELEMENT_NODE or
ATTRIBUTE_NODE.
When possible this simply changes the name of the
given node, otherwise this creates a new node with
the specified name and replaces the existing node
with the new node as described below.
If simply changing the name of the given node is
not possible, the following operations are
performed: a new node is created, any registered
event listener is registered on the new node, any
user data attached to the old node is removed from
that node, the old node is removed from its parent
if it has one, the children are moved to the new
node, if the renamed node is an [1012]Element its
attributes are moved to the new node, the new node
is inserted at the position the old node used to
have in its parent's child nodes list if it has
one, the user data that was attached to the old
node is attached to the new node.
When the node being renamed is an [1013]Element
only the specified attributes are moved, default
attributes originated from the DTD are updated
according to the new element name. In addition, the
implementation may update default attributes from
other schemas. Applications should use
[1014]Document.normalizeDocument() to guarantee
these attributes are up-to-date.
When the node being renamed is an [1015]Attr that
is attached to an [1016]Element, the node is first
removed from the [1017]Element attributes map.
Then, once renamed, either by modifying the
existing node or creating a new one as described
above, it is put back.
In addition,
# a user data event NODE_RENAMED is fired,
# when the implementation supports the feature
"MutationNameEvents", each mutation operation
involved in this method fires the appropriate
event, and in the end the event
{http://www.w3.org/2001/xml-events,
DOMElementNameChanged} or
{http://www.w3.org/2001/xml-events,
DOMAttributeNameChanged} is fired.
Parameters
n of type [1018]Node
The node to rename.
namespaceURI of type [1019]DOMString
The new [1020]namespace URI.
qualifiedName of type [1021]DOMString
The new [1022]qualified name.
Return Value
[1023]Node
The renamed node. This is either the specified node or the new node
that was created to replace the specified node.
Exceptions
[1024]DOMException
NOT_SUPPORTED_ERR: Raised when the type of the specified node is
neither ELEMENT_NODE nor ATTRIBUTE_NODE, or if the implementation does
not support the renaming of the [1025]document element.
INVALID_CHARACTER_ERR: Raised if the new qualified name contains an
illegal character according to the XML version in use specified in the
[1026]Document.xmlVersion attribute.
WRONG_DOCUMENT_ERR: Raised when the specified node was created from a
different document than this document.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed
[1027]qualified name, if the qualifiedName has a prefix and the
namespaceURI is null, or if the qualifiedName has a prefix that is
"xml" and the namespaceURI is different from
"[1028]http://www.w3.org/XML/1998/namespace" [1029]XML Namespaces].
Also raised, when the node being renamed is an attribute, if the
qualifiedName, or its prefix, is "xmlns" and the namespaceURI is
different from "[1030]http://www.w3.org/2000/xmlns/".
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use specified in the
[1031]Document.xmlVersion attribute.
[1028] http://www.w3.org/XML/1998/namespace
[1030] http://www.w3.org/2000/xmlns/
Interface Node
The Node 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 Node
interface expose methods for dealing with children, not all
objects implementing the Node interface may have children. For
example, [1032]Text nodes may not have children, and adding
children to such nodes results in a [1033]DOMException being
raised.
The attributes nodeName, nodeValue and attributes 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 nodeType
(e.g., nodeValue for an [1034]Element or attributes for a
[1035]Comment), this returns null. Note that the specialized
interfaces may contain additional and more convenient
mechanisms to get and set the relevant information.
IDL Definition
interface [1036]Node {
// NodeType
const unsigned short [1037]ELEMENT_NODE = 1;
const unsigned short [1038]ATTRIBUTE_NODE = 2;
const unsigned short [1039]TEXT_NODE = 3;
const unsigned short [1040]CDATA_SECTION_NODE = 4;
const unsigned short [1041]ENTITY_REFERENCE_NODE = 5;
const unsigned short [1042]ENTITY_NODE = 6;
const unsigned short [1043]PROCESSING_INSTRUCTION_NODE = 7;
const unsigned short [1044]COMMENT_NODE = 8;
const unsigned short [1045]DOCUMENT_NODE = 9;
const unsigned short [1046]DOCUMENT_TYPE_NODE = 10;
const unsigned short [1047]DOCUMENT_FRAGMENT_NODE = 11;
const unsigned short [1048]NOTATION_NODE = 12;
readonly attribute [1049]DOMString [1050]nodeName;
attribute [1051]DOMString [1052]nodeValue;
// raises([1053]DOMException) on settin
g
// raises([1054]DOMException) on retrie
val
readonly attribute unsigned short [1055]nodeType;
readonly attribute [1056]Node [1057]parentNode;
readonly attribute [1058]NodeList [1059]childNodes;
readonly attribute [1060]Node [1061]firstChild;
readonly attribute [1062]Node [1063]lastChild;
readonly attribute [1064]Node [1065]previousSibling;
readonly attribute [1066]Node [1067]nextSibling;
readonly attribute [1068]NamedNodeMap [1069]attributes;
// Modified in DOM Level 2:
readonly attribute [1070]Document [1071]ownerDocument;
// Modified in DOM Level 3:
[1072]Node [1073]insertBefore(in [1074]Node newChild,
in [1075]Node refChild)
raises([1076]DOMException);
// Modified in DOM Level 3:
[1077]Node [1078]replaceChild(in [1079]Node newChild,
in [1080]Node oldChild)
raises([1081]DOMException);
// Modified in DOM Level 3:
[1082]Node [1083]removeChild(in [1084]Node oldChild)
raises([1085]DOMException);
[1086]Node [1087]appendChild(in [1088]Node newChild)
raises([1089]DOMException);
boolean [1090]hasChildNodes();
[1091]Node [1092]cloneNode(in boolean deep);
// Modified in DOM Level 3:
void [1093]normalize();
// Introduced in DOM Level 2:
boolean [1094]isSupported(in [1095]DOMString feature,
in [1096]DOMString version);
// Introduced in DOM Level 2:
readonly attribute [1097]DOMString [1098]namespaceURI;
// Introduced in DOM Level 2:
attribute [1099]DOMString [1100]prefix;
// raises([1101]DOMException) on settin
g
// Introduced in DOM Level 2:
readonly attribute [1102]DOMString [1103]localName;
// Introduced in DOM Level 2:
boolean [1104]hasAttributes();
// Introduced in DOM Level 3:
readonly attribute [1105]DOMString [1106]baseURI;
// DocumentPosition
const unsigned short [1107]DOCUMENT_POSITION_DISCONNECTED = 0x01;
const unsigned short [1108]DOCUMENT_POSITION_PRECEDING = 0x02;
const unsigned short [1109]DOCUMENT_POSITION_FOLLOWING = 0x04;
const unsigned short [1110]DOCUMENT_POSITION_CONTAINS = 0x08;
const unsigned short [1111]DOCUMENT_POSITION_CONTAINED_BY = 0x10;
const unsigned short [1112]DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0
x20;
// Introduced in DOM Level 3:
unsigned short [1113]compareDocumentPosition(in [1114]Node other)
raises([1115]DOMException);
// Introduced in DOM Level 3:
attribute [1116]DOMString [1117]textContent;
// raises([1118]DOMException) on settin
g
// raises([1119]DOMException) on retrie
val
// Introduced in DOM Level 3:
boolean [1120]isSameNode(in [1121]Node other);
// Introduced in DOM Level 3:
[1122]DOMString [1123]lookupPrefix(in [1124]DOMString namespaceURI);
// Introduced in DOM Level 3:
boolean [1125]isDefaultNamespace(in [1126]DOMString namespaceURI);
// Introduced in DOM Level 3:
[1127]DOMString [1128]lookupNamespaceURI(in [1129]DOMString prefix);
// Introduced in DOM Level 3:
boolean [1130]isEqualNode(in [1131]Node arg);
// Introduced in DOM Level 3:
[1132]DOMObject [1133]getFeature(in [1134]DOMString feature,
in [1135]DOMString version);
// Introduced in DOM Level 3:
[1136]DOMUserData [1137]setUserData(in [1138]DOMString key,
in [1139]DOMUserData data,
in [1140]UserDataHandler handler);
// Introduced in DOM Level 3:
[1141]DOMUserData [1142]getUserData(in [1143]DOMString key);
};
Definition group NodeType
An integer indicating which type of node this is.
Note: Numeric codes up to 200 are reserved to W3C for
possible future use.
Defined Constants
ATTRIBUTE_NODE
The node is an [1144]Attr.
CDATA_SECTION_NODE
The node is a [1145]CDATASection.
COMMENT_NODE
The node is a [1146]Comment.
DOCUMENT_FRAGMENT_NODE
The node is a [1147]DocumentFragment.
DOCUMENT_NODE
The node is a [1148]Document.
DOCUMENT_TYPE_NODE
The node is a [1149]DocumentType.
ELEMENT_NODE
The node is an [1150]Element.
ENTITY_NODE
The node is an [1151]Entity.
ENTITY_REFERENCE_NODE
The node is an [1152]EntityReference.
NOTATION_NODE
The node is a [1153]Notation.
PROCESSING_INSTRUCTION_NODE
The node is a [1154]ProcessingInstruction.
TEXT_NODE
The node is a [1155]Text node.
The values of nodeName, nodeValue, and attributes vary
according to the node type as follows:
Interface nodeName nodeValue attributes
[1156]Attr same as [1157]Attr.name same as [1158]Attr.value null
[1159]CDATASection "#cdata-section" same as [1160]CharacterData.data,
the content of the CDATA Section null
[1161]Comment "#comment" same as [1162]CharacterData.data, the content
of the comment null
[1163]Document "#document" null null
[1164]DocumentFragment "#document-fragment" null null
[1165]DocumentType same as [1166]DocumentType.name null null
[1167]Element same as [1168]Element.tagName null [1169]NamedNodeMap
[1170]Entity entity name null null
[1171]EntityReference name of entity referenced null null
[1172]Notation notation name null null
[1173]ProcessingInstruction same as [1174]ProcessingInstruction.target
same as [1175]ProcessingInstruction.data null
[1176]Text "#text" same as [1177]CharacterData.data, the content of
the text node null
Definition group DocumentPosition
A bitmask indicating the relative document position of a
node with respect to another node.
If the two nodes being compared are the same node, then
no flags are set on the return.
Otherwise, the order of two nodes is determined by
looking for common containers -- containers which contain
both. A node directly contains any child nodes. A node
also directly contains any other nodes attached to it
such as attributes contained in an element or entities
and notations contained in a document type. Nodes
contained in contained nodes are also contained, but
less-directly as the number of intervening containers
increases.
If there is no common container node, then the order is
based upon order between the root container of each node
that is in no container. In this case, the result is
disconnected and implementation-specific. This result is
stable as long as these outer-most containing nodes
remain in memory and are not inserted into some other
containing node. This would be the case when the nodes
belong to different documents or fragments, and cloning
the document or inserting a fragment might change the
order.
If one of the nodes being compared contains the other
node, then the container precedes the contained node, and
reversely the contained node follows the container. For
example, when comparing an element against its own
attribute or child, the element node precedes its
attribute node and its child node, which both follow it.
If neither of the previous cases apply, then there exists
a most-direct container common to both nodes being
compared. In this case, the order is determined based
upon the two determining nodes directly contained in this
most-direct common container that either are or contain
the corresponding nodes being compared.
If these two determining nodes are both child nodes, then
the natural DOM order of these determining nodes within
the containing node is returned as the order of the
corresponding nodes. This would be the case, for example,
when comparing two child elements of the same element.
If one of the two determining nodes is a child node and
the other is not, then the corresponding node of the
child node follows the corresponding node of the
non-child node. This would be the case, for example, when
comparing an attribute of an element with a child element
of the same element.
If neither of the two determining node is a child node
and one determining node has a greater value of nodeType
than the other, then the corresponding node precedes the
other. This would be the case, for example, when
comparing an entity of a document type against a notation
of the same document type.
If neither of the two determining node is a child node
and nodeType is the same for both determining nodes, then
an implementation-dependent order between the determining
nodes is returned. This order is stable as long as no
nodes of the same nodeType are inserted into or removed
from the direct container. This would be the case, for
example, when comparing two attributes of the same
element, and inserting or removing additional attributes
might change the order between existing attributes.
Defined Constants
DOCUMENT_POSITION_CONTAINED_BY
The node is contained by the reference node.
A node which is contained is always
following, too.
DOCUMENT_POSITION_CONTAINS
The node contains the reference node. A node
which contains is always preceding, too.
DOCUMENT_POSITION_DISCONNECTED
The two nodes are disconnected. Order between
disconnected nodes is always
implementation-specific.
DOCUMENT_POSITION_FOLLOWING
The node follows the reference node.
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
The determination of preceding versus
following is implementation-specific.
DOCUMENT_POSITION_PRECEDING
The node precedes the reference node.
Attributes
attributes of type [1178]NamedNodeMap, readonly
A [1179]NamedNodeMap containing the attributes of
this node (if it is an [1180]Element) or null
otherwise.
baseURI of type [1181]DOMString, readonly, introduced in
DOM Level 3
The absolute base URI of this node or null if the
implementation wasn't able to obtain an absolute
URI. This value is computed according to [1182]XML
[ Base]. However, when the [1183]Document supports
the feature "HTML" [1184]DOM Level 2 HTML], the
base URI is computed using first the value of the
href attribute of the HTML BASE element if any, and
the value of the documentURI attribute from the
[1185]Document interface otherwise.
childNodes of type [1186]NodeList, readonly
A [1187]NodeList that contains all children of this
node. If there are no children, this is a
[1188]NodeList containing no nodes.
firstChild of type [1189]Node, readonly
The first child of this node. If there is no such
node, this returns null.
lastChild of type [1190]Node, readonly
The last child of this node. If there is no such
node, this returns null.
localName of type [1191]DOMString, readonly, introduced in
DOM Level 2
Returns the local part of the [1192]qualified name
of this node.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as [1193]Document.createElement(),
this is always null.
namespaceURI of type [1194]DOMString, readonly, introduced
in DOM Level 2
The [1195]namespace URI of this node, or null if it
is unspecified (see [1196]XML Namespaces).
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.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as [1197]Document.createElement(),
this is always null.
Note: Per the Namespaces in XML Specification
[1198]XML 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.
nextSibling of type [1199]Node, readonly
The node immediately following this node. If there
is no such node, this returns null.
nodeName of type [1200]DOMString, readonly
The name of this node, depending on its type; see
the table above.
nodeType of type unsigned short, readonly
A code representing the type of the underlying
object, as defined above.
nodeValue of type [1201]DOMString
The value of this node, depending on its type; see
the table above. When it is defined to be null,
setting it has no effect, including if the node is
[1202]read-only.
Exceptions on setting
[1203]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if
it is not defined to be null.
Exceptions on retrieval
[1204]DOMException
DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a [1205]DOMString variable on the implementation platform.
ownerDocument of type [1206]Document, readonly, modified in
DOM Level 2
The [1207]Document object associated with this
node. This is also the [1208]Document object used
to create new nodes. When this node is a
[1209]Document or a [1210]DocumentType which is not
used with any [1211]Document yet, this is null.
parentNode of type [1212]Node, readonly
The [1213]parent of this node. All nodes, except
[1214]Attr, [1215]Document, [1216]DocumentFragment,
[1217]Entity, and [1218]Notation 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 null.
prefix of type [1219]DOMString, introduced in DOM Level 2
The [1220]namespace prefix of this node, or null if
it is unspecified. When it is defined to be null,
setting it has no effect, including if the node is
[1221]read-only.
Note that setting this attribute, when permitted,
changes the nodeName attribute, which holds the
[1222]qualified name, as well as the tagName and
name attributes of the [1223]Element and [1224]Attr
interfaces, when applicable.
Setting the prefix to null makes it unspecified,
setting it to an empty string is implementation
dependent.
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 namespaceURI and
localName do not change.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as createElement from the
[1225]Document interface, this is always null.
Exceptions on setting
[1226]DOMException
INVALID_CHARACTER_ERR: Raised if the specified prefix contains an
illegal character according to the XML version in use specified in the
[1227]Document.xmlVersion attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed per the
Namespaces in XML specification, if the namespaceURI of this node is
null, if the specified prefix is "xml" and the namespaceURI of this
node is different from "[1228]http://www.w3.org/XML/1998/namespace",
if this node is an attribute and the specified prefix is "xmlns" and
the namespaceURI of this node is different from
"[1229]http://www.w3.org/2000/xmlns/", or if this node is an attribute
and the qualifiedName of this node is "xmlns" [1230]XML Namespaces].
[1228] http://www.w3.org/XML/1998/namespace
[1229] http://www.w3.org/2000/xmlns/
previousSibling of type [1231]Node, readonly
The node immediately preceding this node. If there
is no such node, this returns null.
textContent of type [1232]DOMString, introduced in DOM
Level 3
This attribute returns the text content of this
node and its descendants. When it is defined to be
null, setting it has no effect. On setting, any
possible children this node may have are removed
and, if it the new string is not empty or null,
replaced by a single [1233]Text node containing the
string this attribute is set to.
On getting, no serialization is performed, the
returned string does not contain any markup. No
whitespace normalization is performed and the
returned string does not contain the white spaces
in element content (see the attribute
[1234]Text.isElementContentWhitespace). Similarly,
on setting, no parsing is performed either, the
input string is taken as pure textual content.
The string returned is made of the text content of
this node depending on its type, as defined below:
Node type Content
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE,
DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute
value of every child node, excluding COMMENT_NODE and
PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the
node has no children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE,
PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
Exceptions on setting
[1235]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Exceptions on retrieval
[1236]DOMException
DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a [1237]DOMString variable on the implementation platform.
Methods
appendChild
Adds the node newChild to the end of the list of
children of this node. If the newChild is already
in the tree, it is first removed.
Parameters
newChild of type [1238]Node
The node to add.
If it is a [1239]DocumentFragment object, the
entire contents of the document fragment are
moved into the child list of this node
Return Value
[1240]Node
The node added.
Exceptions
[1241]DOMException
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild node, or if the node to
append is one of this node's [1242]ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different
document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the
previous parent of the node being inserted is readonly.
cloneNode
Returns a duplicate of this node, i.e., serves as a
generic copy constructor for nodes. The duplicate
node has no parent; (parentNode is null.) and no
user data. User data associated to the imported
node is not carried over. However, if any
[1243]UserDataHandlers has been specified along
with the associated data these handlers will be
called with the appropriate parameters before this
method returns.
Cloning an [1244]Element copies all attributes and
their values, including those generated by the XML
processor to represent defaulted attributes, but
this method does not copy any children it contains
unless it is a deep clone. This includes text
contained in an the [1245]Element since the text is
contained in a child [1246]Text node. Cloning an
[1247]Attr directly, as opposed to be cloned as
part of an [1248]Element cloning operation, returns
a specified attribute (specified is true). Cloning
an [1249]Attr always clones its children, since
they represent its value, no matter whether this is
a deep clone or not. Cloning an
[1250]EntityReference automatically constructs its
subtree if a corresponding [1251]Entity is
available, no matter whether this is a deep clone
or not. Cloning any other type of node simply
returns a copy of this node.
Note that cloning an immutable subtree results in a
mutable copy, but the children of an
[1252]EntityReference clone are [1253]readonly. In
addition, clones of unspecified [1254]Attr nodes
are specified. And, cloning [1255]Document,
[1256]DocumentType, [1257]Entity, and
[1258]Notation nodes is implementation dependent.
Parameters
deep of type boolean
If true, recursively clone the subtree under
the specified node; if false, clone only the
node itself (and its attributes, if it is an
[1259]Element).
Return Value
[1260]Node
The duplicate node.
No Exceptions
compareDocumentPosition introduced in DOM Level 3
Compares a node with this node with regard to their
position in the document and according to the
[1261]document order.
Parameters
other of type [1262]Node
The node to compare against this node.
Return Value
unsigned short
Returns how the given node is positioned relatively to this node
(i.e., "the reference node").
Exceptions
[1263]DOMException
NOT_SUPPORTED_ERR: when the compared nodes are from different DOM
implementations that do not coordinate to return consistent
implementation-specific results.
getFeature introduced in DOM Level 3
This method returns a specialized object which
implements the specialized APIs of the specified
feature and version, as specified in [1264]DOM
Features. The specialized object may also be
obtained by using binding-specific casting methods
but is not necessarily expected to, as discussed in
[1265]Mixed DOM implementations. This method also
allow the implementation to provide specialized
objects which do not support the Node interface.
Parameters
feature of type [1266]DOMString
The name of the feature requested. Note that
any plus sign "+" prepended to the name of
the feature will be ignored since it is not
significant in the context of this method.
version of type [1267]DOMString
This is the version number of the feature to
test.
Return Value
[1268]DOMObject
Returns an object which implements the specialized APIs of the
specified feature and version, if any, or null if there is no object
which implements interfaces associated with that feature. If the
[1269]DOMObject returned by this method implements the Node interface,
it must delegate to the primary core Node and not return results
inconsistent with the primary core Node such as attributes,
childNodes, etc.
No Exceptions
getUserData introduced in DOM Level 3
Retrieves the object associated to a key on a this
node. The object must first have been set to this
node by calling setUserData with the same key.
Parameters
key of type [1270]DOMString
The key the object is associated to.
Return Value
[1271]DOMUserData
Returns the [1272]DOMUserData associated to the given key on this
node, or null if there was none.
No Exceptions
hasAttributes introduced in DOM Level 2
Returns whether this node (if it is an element) has
any attributes.
Return Value
boolean
Returns true if this node has any attributes, false otherwise.
No Parameters
No Exceptions
hasChildNodes
Returns whether this node has any children.
Return Value
boolean
Returns true if this node has any children, false otherwise.
No Parameters
No Exceptions
insertBefore modified in DOM Level 3
Inserts the node newChild before the existing child
node refChild. If refChild is null, insert newChild
at the end of the list of children.
If newChild is a [1273]DocumentFragment object, all
of its children are inserted, in the same order,
before refChild. If the newChild is already in the
tree, it is first removed.
Parameters
newChild of type [1274]Node
The node to insert.
refChild of type [1275]Node
The reference node, i.e., the node before
which the new node must be inserted.
Return Value
[1276]Node
The node being inserted.
Exceptions
[1277]DOMException
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild node, or if the node to
insert is one of this node's [1278]ancestors or this node itself, or
if this node if of type [1279]Document and the DOM application
attempts to insert a second [1280]DocumentType or [1281]Element node.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different
document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the
parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node if of type [1282]Document, this
exception might be raised if the DOM implementation doesn't support
the insertion of a [1283]DocumentType or [1284]Element node.
isDefaultNamespace introduced in DOM Level 3
This method checks if the specified namespaceURI is
the default namespace or not.
Parameters
namespaceURI of type [1285]DOMString
The namespace URI to look for.
Return Value
boolean
Returns true if the specified namespaceURI is the default namespace,
false otherwise.
No Exceptions
isEqualNode introduced in DOM Level 3
Tests whether two nodes are equal.
This method tests for equality of nodes, not
sameness (i.e., whether the two nodes are
references to the same object) which can be tested
with [1286]Node.isSameNode(). All nodes that are
the same will also be equal, though the reverse may
not be true.
Two nodes are equal if and only if the following
conditions are satisfied:
# The two nodes are of the same type.
# The following string attributes are equal:
nodeName, localName, namespaceURI, prefix,
nodeValue. This is: they are both null, or they
have the same length and are character for
character identical.
# The attributes [1287]NamedNodeMaps are equal. This
is: they are both null, or they have the same
length and for each node that exists in one map
there is a node that exists in the other map and is
equal, although not necessarily at the same index.
# The childNodes [1288]NodeLists are equal. This is:
they are both null, or they have the same length
and contain equal nodes at the same index. Note
that normalization can affect equality; to avoid
this, nodes should be normalized before being
compared.
For two [1289]DocumentType nodes to be equal, the
following conditions must also be satisfied:
# The following string attributes are equal:
publicId, systemId, internalSubset.
# The entities [1290]NamedNodeMaps are equal.
# The notations [1291]NamedNodeMaps are equal.
On the other hand, the following do not affect
equality: the ownerDocument, baseURI, and
parentNode attributes, the specified attribute for
[1292]Attr nodes, the schemaTypeInfo attribute for
[1293]Attr and [1294]Element nodes, the
[1295]Text.isElementContentWhitespace attribute for
[1296]Text nodes, as well as any user data or event
listeners registered on the nodes.
Note: As a general rule, anything not mentioned in
the description above is not significant in
consideration of equality checking. Note that
future versions of this specification may take into
account more attributes and implementations conform
to this specification are expected to be updated
accordingly.
Parameters
arg of type [1297]Node
The node to compare equality with.
Return Value
boolean
Returns true if the nodes are equal, false otherwise.
No Exceptions
isSameNode introduced in DOM Level 3
Returns whether this node is the same node as the
given one.
This method provides a way to determine whether two
Node references returned by the implementation
reference the same object. When two Node references
are references to the same object, even if through
a proxy, the references may be used completely
interchangeably, such that all attributes have the
same values and calling the same DOM method on
either reference always has exactly the same
effect.
Parameters
other of type [1298]Node
The node to test against.
Return Value
boolean
Returns true if the nodes are the same, false otherwise.
No Exceptions
isSupported introduced in DOM Level 2
Tests whether the DOM implementation implements a
specific feature and that feature is supported by
this node, as specified in [1299]DOM Features.
Parameters
feature of type [1300]DOMString
The name of the feature to test.
version of type [1301]DOMString
This is the version number of the feature to
test.
Return Value
boolean
Returns true if the specified feature is supported on this node, false
otherwise.
No Exceptions
lookupNamespaceURI introduced in DOM Level 3
Look up the namespace URI associated to the given
prefix, starting from this node.
See [1302]Namespace URI Lookup for details on the
algorithm used by this method.
Parameters
prefix of type [1303]DOMString
The prefix to look for. If this parameter is
null, the method will return the default
namespace URI if any.
Return Value
[1304]DOMString
Returns the associated namespace URI or null if none is found.
No Exceptions
lookupPrefix introduced in DOM Level 3
Look up the prefix associated to the given
namespace URI, starting from this node. The default
namespace declarations are ignored by this method.
See [1305]Namespace Prefix Lookup for details on
the algorithm used by this method.
Parameters
namespaceURI of type [1306]DOMString
The namespace URI to look for.
Return Value
[1307]DOMString
Returns an associated namespace prefix if found or null if none is
found. If more than one prefix are associated to the namespace prefix,
the returned namespace prefix is implementation dependent.
No Exceptions
normalize modified in DOM Level 3
Puts all [1308]Text nodes in the full depth of the
sub-tree underneath this Node, including attribute
nodes, into a "normal" form where only structure
(e.g., elements, comments, processing instructions,
CDATA sections, and entity references) separates
[1309]Text nodes, i.e., there are neither adjacent
[1310]Text nodes nor empty [1311]Text 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 [1312]XPointer] lookups) that depend on a
particular document tree structure are to be used.
If the parameter "[1313]normalize-characters" of
the [1314]DOMConfiguration object attached to the
[1315]Node.ownerDocument is true, this method will
also fully normalize the characters of the
[1316]Text nodes.
Note: In cases where the document contains
[1317]CDATASections, the normalize operation alone
may not be sufficient, since XPointers do not
differentiate between [1318]Text nodes and
[1319]CDATASection nodes.
No Parameters
No Return Value
No Exceptions
removeChild modified in DOM Level 3
Removes the child node indicated by oldChild from
the list of children, and returns it.
Parameters
oldChild of type [1320]Node
The node being removed.
Return Value
[1321]Node
The node removed.
Exceptions
[1322]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of type [1323]Document, this
exception might be raised if the DOM implementation doesn't support
the removal of the [1324]DocumentType child or the [1325]Element
child.
replaceChild modified in DOM Level 3
Replaces the child node oldChild with newChild in
the list of children, and returns the oldChild
node.
If newChild is a [1326]DocumentFragment object,
oldChild is replaced by all of the
[1327]DocumentFragment children, which are inserted
in the same order. If the newChild is already in
the tree, it is first removed.
Parameters
newChild of type [1328]Node
The new node to put in the child list.
oldChild of type [1329]Node
The node being replaced in the list.
Return Value
[1330]Node
The node replaced.
Exceptions
[1331]DOMException
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild node, or if the node to put
in is one of this node's [1332]ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different
document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the
new node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of type [1333]Document, this
exception might be raised if the DOM implementation doesn't support
the replacement of the [1334]DocumentType child or [1335]Element
child.
setUserData introduced in DOM Level 3
Associate an object to a key on this node. The
object can later be retrieved from this node by
calling getUserData with the same key.
Parameters
key of type [1336]DOMString
The key to associate the object to.
data of type [1337]DOMUserData
The object to associate to the given key, or
null to remove any existing association to
that key.
handler of type [1338]UserDataHandler
The handler to associate to that key, or
null.
Return Value
[1339]DOMUserData
Returns the [1340]DOMUserData previously associated to the given key
on this node, or null if there was none.
No Exceptions
Interface NodeList
The NodeList interface provides the abstraction of an ordered
collection of nodes, without defining or constraining how this
collection is implemented. NodeList objects in the DOM are
[1341]live.
The items in the NodeList are accessible via an integral index,
starting from 0.
IDL Definition
interface [1342]NodeList {
[1343]Node [1344]item(in unsigned long index);
readonly attribute unsigned long [1345]length;
};
Attributes
length of type unsigned long, readonly
The number of nodes in the list. The range of valid
child node indices is 0 to length-1 inclusive.
Methods
item
Returns the indexth item in the collection. If
index is greater than or equal to the number of
nodes in the list, this returns null.
Parameters
index of type unsigned long
Index into the collection.
Return Value
[1346]Node
The node at the indexth position in the NodeList, or null if that is
not a valid index.
No Exceptions
Interface NamedNodeMap
Objects implementing the NamedNodeMap interface are used to
represent collections of nodes that can be accessed by name.
Note that NamedNodeMap does not inherit from [1347]NodeList;
NamedNodeMaps are not maintained in any particular order.
Objects contained in an object implementing NamedNodeMap may
also be accessed by an ordinal index, but this is simply to
allow convenient enumeration of the contents of a NamedNodeMap,
and does not imply that the DOM specifies an order to these
Nodes.
NamedNodeMap objects in the DOM are [1348]live.
IDL Definition
interface [1349]NamedNodeMap {
[1350]Node [1351]getNamedItem(in [1352]DOMString name);
[1353]Node [1354]setNamedItem(in [1355]Node arg)
raises([1356]DOMException);
[1357]Node [1358]removeNamedItem(in [1359]DOMString name)
raises([1360]DOMException);
[1361]Node [1362]item(in unsigned long index);
readonly attribute unsigned long [1363]length;
// Introduced in DOM Level 2:
[1364]Node [1365]getNamedItemNS(in [1366]DOMString namespaceURI
,
in [1367]DOMString localName)
raises([1368]DOMException);
// Introduced in DOM Level 2:
[1369]Node [1370]setNamedItemNS(in [1371]Node arg)
raises([1372]DOMException);
// Introduced in DOM Level 2:
[1373]Node [1374]removeNamedItemNS(in [1375]DOMString namespace
URI,
in [1376]DOMString localName)
raises([1377]DOMException);
};
Attributes
length of type unsigned long, readonly
The number of nodes in this map. The range of valid
child node indices is 0 to length-1 inclusive.
Methods
getNamedItem
Retrieves a node specified by name.
Parameters
name of type [1378]DOMString
The nodeName of a node to retrieve.
Return Value
[1379]Node
A [1380]Node (of any type) with the specified nodeName, or null if it
does not identify any node in this map.
No Exceptions
getNamedItemNS introduced in DOM Level 2
Retrieves a node specified by local name and
namespace URI.
Per [1381]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
namespaceURI of type [1382]DOMString
The [1383]namespace URI of the node to
retrieve.
localName of type [1384]DOMString
The [1385]local name of the node to retrieve.
Return Value
[1386]Node
A [1387]Node (of any type) with the specified local name and namespace
URI, or null if they do not identify any node in this map.
Exceptions
[1388]DOMException
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1389]HTML 4.01]).
item
Returns the indexth item in the map. If index is
greater than or equal to the number of nodes in
this map, this returns null.
Parameters
index of type unsigned long
Index into this map.
Return Value
[1390]Node
The node at the indexth position in the map, or null if that is not a
valid index.
No Exceptions
removeNamedItem
Removes a node specified by name. When this map
contains the attributes attached to an element, if
the removed attribute is known to have a default
value, an attribute immediately appears containing
the default value as well as the corresponding
namespace URI, local name, and prefix when
applicable.
Parameters
name of type [1391]DOMString
The nodeName of the node to remove.
Return Value
[1392]Node
The node removed from this map if a node with such a name exists.
Exceptions
[1393]DOMException
NOT_FOUND_ERR: Raised if there is no node named name in this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
removeNamedItemNS introduced in DOM Level 2
Removes a node specified by local name and
namespace URI. A removed attribute may be known to
have a default value when this map contains the
attributes attached to an element, as returned by
the attributes attribute of the [1394]Node
interface. If so, an attribute immediately appears
containing the default value as well as the
corresponding namespace URI, local name, and prefix
when applicable.
Per [1395]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
namespaceURI of type [1396]DOMString
The [1397]namespace URI of the node to
remove.
localName of type [1398]DOMString
The [1399]local name of the node to remove.
Return Value
[1400]Node
The node removed from this map if a node with such a local name and
namespace URI exists.
Exceptions
[1401]DOMException
NOT_FOUND_ERR: Raised if there is no node with the specified
namespaceURI and localName in this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1402]HTML 4.01]).
setNamedItem
Adds a node using its nodeName attribute. If a node
with that name is already present in this map, it
is replaced by the new one. Replacing a node by
itself has no effect.
As the nodeName attribute is used to derive the
name which the node must be stored under, multiple
nodes of certain types (those that have a "special"
string value) cannot be stored as the names would
clash. This is seen as preferable to allowing nodes
to be aliased.
Parameters
arg of type [1403]Node
A node to store in this map. The node will
later be accessible using the value of its
nodeName attribute.
Return Value
[1404]Node
If the new [1405]Node replaces an existing node the replaced
[1406]Node is returned, otherwise null is returned.
Exceptions
[1407]DOMException
WRONG_DOCUMENT_ERR: Raised if arg was created from a different
document than the one that created this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
INUSE_ATTRIBUTE_ERR: Raised if arg is an [1408]Attr that is already an
attribute of another [1409]Element object. The DOM user must
explicitly clone [1410]Attr nodes to re-use them in other elements.
HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node
doesn't belong in this NamedNodeMap. Examples would include trying to
insert something other than an Attr node into an Element's map of
attributes, or a non-Entity node into the DocumentType's map of
Entities.
setNamedItemNS introduced in DOM Level 2
Adds a node using its namespaceURI and localName.
If a node with that namespace URI and that local
name is already present in this map, it is replaced
by the new one. Replacing a node by itself has no
effect.
Per [1411]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
arg of type [1412]Node
A node to store in this map. The node will
later be accessible using the value of its
namespaceURI and localName attributes.
Return Value
[1413]Node
If the new [1414]Node replaces an existing node the replaced
[1415]Node is returned, otherwise null is returned.
Exceptions
[1416]DOMException
WRONG_DOCUMENT_ERR: Raised if arg was created from a different
document than the one that created this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
INUSE_ATTRIBUTE_ERR: Raised if arg is an [1417]Attr that is already an
attribute of another [1418]Element object. The DOM user must
explicitly clone [1419]Attr nodes to re-use them in other elements.
HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node
doesn't belong in this NamedNodeMap. Examples would include trying to
insert something other than an Attr node into an Element's map of
attributes, or a non-Entity node into the DocumentType's map of
Entities.
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1420]HTML 4.01]).
Interface CharacterData
The CharacterData interface extends Node with a set of
attributes and methods for accessing character data in the DOM.
For clarity this set is defined here rather than on each object
that uses these attributes and methods. No DOM objects
correspond directly to CharacterData, though [1421]Text and
others do inherit the interface from it. All offsets in this
interface start from 0.
As explained in the [1422]DOMString interface, text strings in
the DOM are represented in UTF-16, i.e. as a sequence of 16-bit
units. In the following, the term [1423]16-bit units is used
whenever necessary to indicate that indexing on CharacterData
is done in 16-bit units.
IDL Definition
interface [1424]CharacterData : [1425]Node {
attribute [1426]DOMString [1427]data;
// raises([1428]DOMException) on settin
g
// raises([1429]DOMException) on retrie
val
readonly attribute unsigned long [1430]length;
[1431]DOMString [1432]substringData(in unsigned long offset,
in unsigned long count)
raises([1433]DOMException);
void [1434]appendData(in [1435]DOMString arg)
raises([1436]DOMException);
void [1437]insertData(in unsigned long offset,
in [1438]DOMString arg)
raises([1439]DOMException);
void [1440]deleteData(in unsigned long offset,
in unsigned long count)
raises([1441]DOMException);
void [1442]replaceData(in unsigned long offset,
in unsigned long count,
in [1443]DOMString arg)
raises([1444]DOMException);
};
Attributes
data of type [1445]DOMString
The character data of the node that implements this
interface. The DOM implementation may not put
arbitrary limits on the amount of data that may be
stored in a CharacterData node. However,
implementation limits may mean that the entirety of
a node's data may not fit into a single
[1446]DOMString. In such cases, the user may call
substringData to retrieve the data in appropriately
sized pieces.
Exceptions on setting
[1447]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Exceptions on retrieval
[1448]DOMException
DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a [1449]DOMString variable on the implementation platform.
length of type unsigned long, readonly
The number of [1450]16-bit units that are available
through data and the substringData method below.
This may have the value zero, i.e., CharacterData
nodes may be empty.
Methods
appendData
Append the string to the end of the character data
of the node. Upon success, data provides access to
the concatenation of data and the [1451]DOMString
specified.
Parameters
arg of type [1452]DOMString
The [1453]DOMString to append.
Exceptions
[1454]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
No Return Value
deleteData
Remove a range of [1455]16-bit units from the node.
Upon success, data and length reflect the change.
Parameters
offset of type unsigned long
The offset from which to start removing.
count of type unsigned long
The number of 16-bit units to delete. If the
sum of offset and count exceeds length then
all 16-bit units from offset to the end of
the data are deleted.
Exceptions
[1456]DOMException
INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
than the number of 16-bit units in data, or if the specified count is
negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
No Return Value
insertData
Insert a string at the specified [1457]16-bit unit
offset.
Parameters
offset of type unsigned long
The character offset at which to insert.
arg of type [1458]DOMString
The [1459]DOMString to insert.
Exceptions
[1460]DOMException
INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
than the number of 16-bit units in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
No Return Value
replaceData
Replace the characters starting at the specified
[1461]16-bit unit offset with the specified string.
Parameters
offset of type unsigned long
The offset from which to start replacing.
count of type unsigned long
The number of 16-bit units to replace. If the
sum of offset and count exceeds length, then
all 16-bit units to the end of the data are
replaced; (i.e., the effect is the same as a
remove method call with the same range,
followed by an append method invocation).
arg of type [1462]DOMString
The [1463]DOMString with which the range must
be replaced.
Exceptions
[1464]DOMException
INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
than the number of 16-bit units in data, or if the specified count is
negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
No Return Value
substringData
Extracts a range of data from the node.
Parameters
offset of type unsigned long
Start offset of substring to extract.
count of type unsigned long
The number of 16-bit units to extract.
Return Value
[1465]DOMString
The specified substring. If the sum of offset and count exceeds the
length, then all 16-bit units to the end of the data are returned.
Exceptions
[1466]DOMException
INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
than the number of 16-bit units in data, or if the specified count is
negative.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit
into a [1467]DOMString.
Interface Attr
The Attr interface represents an attribute in an [1468]Element
object. Typically the allowable values for the attribute are
defined in a schema associated with the document.
Attr objects inherit the [1469]Node interface, but since they
are not actually child nodes of the element they describe, the
DOM does not consider them part of the document tree. Thus, the
[1470]Node attributes parentNode, previousSibling, and
nextSibling have a null value for Attr objects. The DOM takes
the view that attributes are properties of elements rather than
having a separate identity from the elements they are
associated with; this should make it more efficient to
implement such features as default attributes associated with
all elements of a given type. Furthermore, Attr nodes may not
be immediate children of a [1471]DocumentFragment. However,
they can be associated with [1472]Element nodes contained
within a [1473]DocumentFragment. In short, users and
implementors of the DOM need to be aware that Attr nodes have
some things in common with other objects inheriting the
[1474]Node interface, but they also are quite distinct.
The attribute's effective value is determined as follows: if
this attribute has been explicitly assigned any value, that
value is the attribute's effective value; otherwise, if there
is a declaration for this attribute, and that declaration
includes a default value, then that default value is the
attribute's effective value; otherwise, the attribute does not
exist on this element in the structure model until it has been
explicitly added. Note that the [1475]Node.nodeValue attribute
on the Attr instance can also be used to retrieve the string
version of the attribute's value(s).
If the attribute was not explicitly given a value in the
instance document but has a default value provided by the
schema associated with the document, an attribute node will be
created with specified set to false. Removing attribute nodes
for which a default value is defined in the schema generates a
new attribute node with the default value and specified set to
false. If validation occurred while invoking
[1476]Document.normalizeDocument(), attribute nodes with
specified equals to false are recomputed according to the
default attribute values provided by the schema. If no default
value is associate with this attribute in the schema, the
attribute node is discarded.
In XML, where the value of an attribute can contain entity
references, the child nodes of the Attr node may be either
[1477]Text or [1478]EntityReference nodes (when these are in
use; see the description of [1479]EntityReference for
discussion).
The DOM Core represents all attribute values as simple strings,
even if the DTD or schema associated with the document declares
them of some specific type such as [1480]tokenized.
The way attribute value normalization is performed by the DOM
implementation depends on how much the implementation knows
about the schema in use. Typically, the value and nodeValue
attributes of an Attr node initially returns the normalized
value given by the parser. It is also the case after
[1481]Document.normalizeDocument() is called (assuming the
right options have been set). But this may not be the case
after mutation, independently of whether the mutation is
performed by setting the string value directly or by changing
the Attr child nodes. In particular, this is true when
[1482]character references are involved, given that they are
not represented in the DOM and they impact attribute value
normalization. On the other hand, if the implementation knows
about the schema in use when the attribute value is changed,
and it is of a different type than CDATA, it may normalize it
again at that time. This is especially true of specialized DOM
implementations, such as SVG DOM implementations, which store
attribute values in an internal form different from a string.
[1482] http://www.w3.org/TR/2000/REC-xml-20001006#dt-charref
The following table gives some examples of the relations
between the attribute value in the original document (parsed
attribute), the value as exposed in the DOM, and the
serialization of the value:
Examples Parsed attribute value Initial [1483]Attr.value Serialized
attribute value
Character reference
"x²=5"
"x²=5"
"x²=5"
Built-in character entity
"y<6"
"y<6"
"y<6"
Literal newline between
"x=5
y=6"
"x=5
y=6"
"x=5
y=6"
Normalized newline between
"x=5
y=6"
"x=5 y=6"
"x=5 y=6"
Entity e with literal newline
[...]>
"x=5&e;y=6"
Dependent on Implementation and Load Options Dependent on
Implementation and Load/Save Options
IDL Definition
interface [1484]Attr : [1485]Node {
readonly attribute [1486]DOMString [1487]name;
readonly attribute boolean [1488]specified;
attribute [1489]DOMString [1490]value;
// raises([1491]DOMException) on settin
g
// Introduced in DOM Level 2:
readonly attribute [1492]Element [1493]ownerElement;
// Introduced in DOM Level 3:
readonly attribute [1494]TypeInfo [1495]schemaTypeInfo;
// Introduced in DOM Level 3:
readonly attribute boolean [1496]isId;
};
Attributes
isId of type boolean, readonly, introduced in DOM Level 3
Returns whether this attribute is known to be of
type ID (i.e. to contain an identifier for its
owner element) or not. When it is and its value is
unique, the ownerElement of this attribute can be
retrieved using the method
[1497]Document.getElementById. The implementation
could use several ways to determine if an attribute
node is known to contain an identifier:
# If validation occurred using an XML Schema
[1498]XML Schema Part 1] while loading the
document or while invoking
[1499]Document.normalizeDocument(), the
post-schema-validation infoset contributions (PSVI
contributions) values are used to determine if this
attribute is a schema-determined ID attribute using
the [1500]schema-determined ID definition in
[1501]XPointer].
# If validation occurred using a DTD while loading
the document or while invoking
[1502]Document.normalizeDocument(), the infoset
[type definition] value is used to determine if
this attribute is a DTD-determined ID attribute
using the [1503]DTD-determined ID definition in
[1504]XPointer].
# from the use of the methods
[1505]Element.setIdAttribute(),
[1506]Element.setIdAttributeNS(), or
[1507]Element.setIdAttributeNode(), i.e. it is an
user-determined ID attribute;
Note: XPointer framework (see section 3.2 in
[1508]XPointer]) consider the DOM user-determined
ID attribute as being part of the XPointer
externally-determined ID definition.
# using mechanisms that are outside the scope of this
specification, it is then an externally-determined
ID attribute. This includes using schema languages
different from XML schema and DTD.
[1500] http://www.w3.org/TR/2003/REC-xptr-framework-20030325/#term-sdi
[1503] http://www.w3.org/TR/2003/REC-xptr-framework-20030325/#term-ddi
If validation occurred while invoking
[1509]Document.normalizeDocument(), all
user-determined ID attributes are reset and all
attribute nodes ID information are then reevaluated
in accordance to the schema used. As a consequence,
if the [1510]Attr.schemaTypeInfo attribute contains
an ID type, isId will always return true.
name of type [1511]DOMString, readonly
Returns the name of this attribute. If
[1512]Node.localName is different from null, this
attribute is a [1513]qualified name.
ownerElement of type [1514]Element, readonly, introduced in
DOM Level 2
The [1515]Element node this attribute is attached
to or null if this attribute is not in use.
schemaTypeInfo of type [1516]TypeInfo, readonly, introduced
in DOM Level 3
The type information associated with this
attribute. While the type information contained in
this attribute is guarantee to be correct after
loading the document or invoking
[1517]Document.normalizeDocument(), schemaTypeInfo
may not be reliable if the node was moved.
specified of type boolean, readonly
True if this attribute was explicitly given a value
in the instance document, false otherwise. If the
application changed the value of this attribute
node (even if it ends up having the same value as
the default value) then it is set to true. The
implementation may handle attributes with default
values from other schemas similarly but
applications should use
[1518]Document.normalizeDocument() to guarantee
this information is up-to-date.
value of type [1519]DOMString
On retrieval, the value of the attribute is
returned as a string. Character and general entity
references are replaced with their values. See also
the method getAttribute on the [1520]Element
interface.
On setting, this creates a [1521]Text node with the
unparsed contents of the string, i.e. any
characters that an XML processor would recognize as
markup are instead treated as literal text. See
also the method [1522]Element.setAttribute().
Some specialized implementations, such as some
[1523]SVG 1.0] implementations, may do
normalization automatically, even after mutation;
in such case, the value on retrieval may differ
from the value on setting.
Exceptions on setting
[1524]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Interface Element
The Element interface represents an [1525]element in an HTML or
XML document. Elements may have attributes associated with
them; since the Element interface inherits from [1526]Node, the
generic [1527]Node interface attribute attributes may be used
to retrieve the set of all attributes for an element. There are
methods on the Element interface to retrieve either an
[1528]Attr object by name or an attribute value by name. In
XML, where an attribute value may contain entity references, an
[1529]Attr object should be retrieved to examine the possibly
fairly complex sub-tree representing the attribute value. On
the other hand, in HTML, where all attributes have simple
string values, methods to directly access an attribute value
can safely be used as a [1530]convenience.
Note: In DOM Level 2, the method normalize is inherited from
the [1531]Node interface where it was moved.
IDL Definition
interface [1532]Element : [1533]Node {
readonly attribute [1534]DOMString [1535]tagName;
[1536]DOMString [1537]getAttribute(in [1538]DOMString name);
void [1539]setAttribute(in [1540]DOMString name,
in [1541]DOMString value)
raises([1542]DOMException);
void [1543]removeAttribute(in [1544]DOMString name)
raises([1545]DOMException);
[1546]Attr [1547]getAttributeNode(in [1548]DOMString name);
[1549]Attr [1550]setAttributeNode(in [1551]Attr newAttr)
raises([1552]DOMException);
[1553]Attr [1554]removeAttributeNode(in [1555]Attr oldAttr)
raises([1556]DOMException);
[1557]NodeList [1558]getElementsByTagName(in [1559]DOMString name);
// Introduced in DOM Level 2:
[1560]DOMString [1561]getAttributeNS(in [1562]DOMString namespaceURI
,
in [1563]DOMString localName)
raises([1564]DOMException);
// Introduced in DOM Level 2:
void [1565]setAttributeNS(in [1566]DOMString namespaceURI,
in [1567]DOMString qualifiedName,
in [1568]DOMString value)
raises([1569]DOMException);
// Introduced in DOM Level 2:
void [1570]removeAttributeNS(in [1571]DOMString namespaceURI,
in [1572]DOMString localName)
raises([1573]DOMException);
// Introduced in DOM Level 2:
[1574]Attr [1575]getAttributeNodeNS(in [1576]DOMString namespac
eURI,
in [1577]DOMString localName)
raises([1578]DOMException);
// Introduced in DOM Level 2:
[1579]Attr [1580]setAttributeNodeNS(in [1581]Attr newAttr)
raises([1582]DOMException);
// Introduced in DOM Level 2:
[1583]NodeList [1584]getElementsByTagNameNS(in [1585]DOMString name
spaceURI,
in [1586]DOMString localName)
raises([1587]DOMException);
// Introduced in DOM Level 2:
boolean [1588]hasAttribute(in [1589]DOMString name);
// Introduced in DOM Level 2:
boolean [1590]hasAttributeNS(in [1591]DOMString namespaceURI,
in [1592]DOMString localName)
raises([1593]DOMException);
// Introduced in DOM Level 3:
readonly attribute [1594]TypeInfo [1595]schemaTypeInfo;
// Introduced in DOM Level 3:
void [1596]setIdAttribute(in [1597]DOMString name,
in boolean isId)
raises([1598]DOMException);
// Introduced in DOM Level 3:
void [1599]setIdAttributeNS(in [1600]DOMString namespaceURI,
in [1601]DOMString localName,
in boolean isId)
raises([1602]DOMException);
// Introduced in DOM Level 3:
void [1603]setIdAttributeNode(in [1604]Attr idAttr,
in boolean isId)
raises([1605]DOMException);
};
Attributes
schemaTypeInfo of type [1606]TypeInfo, readonly, introduced
in DOM Level 3
The type information associated with this element.
tagName of type [1607]DOMString, readonly
The name of the element. If [1608]Node.localName is
different from null, this attribute is a
[1609]qualified name. For example, in:
...
,
tagName has the value "elementExample". Note that
this is case-preserving in XML, as are all of the
operations of the DOM. The HTML DOM returns the
tagName of an HTML element in the canonical
uppercase form, regardless of the case in the
source HTML document.
Methods
getAttribute
Retrieves an attribute value by name.
Parameters
name of type [1610]DOMString
The name of the attribute to retrieve.
Return Value
[1611]DOMString
The [1612]Attr value as a string, or the empty string if that
attribute does not have a specified or default value.
No Exceptions
getAttributeNS introduced in DOM Level 2
Retrieves an attribute value by local name and
namespace URI.
Per [1613]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
namespaceURI of type [1614]DOMString
The [1615]namespace URI of the attribute to
retrieve.
localName of type [1616]DOMString
The [1617]local name of the attribute to
retrieve.
Return Value
[1618]DOMString
The [1619]Attr value as a string, or the empty string if that
attribute does not have a specified or default value.
Exceptions
[1620]DOMException
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1621]HTML 4.01]).
getAttributeNode
Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and
namespace URI, use the getAttributeNodeNS method.
Parameters
name of type [1622]DOMString
The name (nodeName) of the attribute to
retrieve.
Return Value
[1623]Attr
The [1624]Attr node with the specified name (nodeName) or null if
there is no such attribute.
No Exceptions
getAttributeNodeNS introduced in DOM Level 2
Retrieves an [1625]Attr node by local name and
namespace URI.
Per [1626]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
namespaceURI of type [1627]DOMString
The [1628]namespace URI of the attribute to
retrieve.
localName of type [1629]DOMString
The [1630]local name of the attribute to
retrieve.
Return Value
[1631]Attr
The [1632]Attr node with the specified attribute local name and
namespace URI or null if there is no such attribute.
Exceptions
[1633]DOMException
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1634]HTML 4.01]).
getElementsByTagName
Returns a [1635]NodeList of all [1636]descendant
Elements with a given tag name, in [1637]document
order.
Parameters
name of type [1638]DOMString
The name of the tag to match on. The special
value "*" matches all tags.
Return Value
[1639]NodeList
A list of matching Element nodes.
No Exceptions
getElementsByTagNameNS introduced in DOM Level 2
Returns a [1640]NodeList of all the
[1641]descendant Elements with a given local name
and namespace URI in [1642]document order.
Parameters
namespaceURI of type [1643]DOMString
The [1644]namespace URI of the elements to
match on. The special value "*" matches all
namespaces.
localName of type [1645]DOMString
The [1646]local name of the elements to match
on. The special value "*" matches all local
names.
Return Value
[1647]NodeList
A new [1648]NodeList object containing all the matched Elements.
Exceptions
[1649]DOMException
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1650]HTML 4.01]).
hasAttribute introduced in DOM Level 2
Returns true when an attribute with a given name is
specified on this element or has a default value,
false otherwise.
Parameters
name of type [1651]DOMString
The name of the attribute to look for.
Return Value
boolean
true if an attribute with the given name is specified on this element
or has a default value, false otherwise.
No Exceptions
hasAttributeNS introduced in DOM Level 2
Returns true when an attribute with a given local
name and namespace URI is specified on this element
or has a default value, false otherwise.
Per [1652]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
namespaceURI of type [1653]DOMString
The [1654]namespace URI of the attribute to
look for.
localName of type [1655]DOMString
The [1656]local name of the attribute to look
for.
Return Value
boolean
true if an attribute with the given local name and namespace URI is
specified or has a default value on this element, false otherwise.
Exceptions
[1657]DOMException
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1658]HTML 4.01]).
removeAttribute
Removes an attribute by name. If a default value
for the removed attribute is defined in the DTD, a
new attribute immediately appears with the default
value as well as the corresponding namespace URI,
local name, and prefix when applicable. The
implementation may handle default values from other
schemas similarly but applications should use
[1659]Document.normalizeDocument() to guarantee
this information is up-to-date.
If no attribute with this name is found, this
method has no effect.
To remove an attribute by local name and namespace
URI, use the removeAttributeNS method.
Parameters
name of type [1660]DOMString
The name of the attribute to remove.
Exceptions
[1661]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
No Return Value
removeAttributeNS introduced in DOM Level 2
Removes an attribute by local name and namespace
URI. If a default value for the removed attribute
is defined in the DTD, a new attribute immediately
appears with the default value as well as the
corresponding namespace URI, local name, and prefix
when applicable. The implementation may handle
default values from other schemas similarly but
applications should use
[1662]Document.normalizeDocument() to guarantee
this information is up-to-date.
If no attribute with this local name and namespace
URI is found, this method has no effect.
Per [1663]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
namespaceURI of type [1664]DOMString
The [1665]namespace URI of the attribute to
remove.
localName of type [1666]DOMString
The [1667]local name of the attribute to
remove.
Exceptions
[1668]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1669]HTML 4.01]).
No Return Value
removeAttributeNode
Removes the specified attribute node. If a default
value for the removed [1670]Attr node is defined in
the DTD, a new node immediately appears with the
default value as well as the corresponding
namespace URI, local name, and prefix when
applicable. The implementation may handle default
values from other schemas similarly but
applications should use
[1671]Document.normalizeDocument() to guarantee
this information is up-to-date.
Parameters
oldAttr of type [1672]Attr
The [1673]Attr node to remove from the
attribute list.
Return Value
[1674]Attr
The [1675]Attr node that was removed.
Exceptions
[1676]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.
setAttribute
Adds a new attribute. If an attribute with that
name is already present in the element, its value
is changed to be that of the value parameter. This
value is a simple string; it is not parsed as it is
being set. So any markup (such as syntax to be
recognized as an entity reference) is treated as
literal text, and needs to be appropriately escaped
by the implementation when it is written out. In
order to assign an attribute value that contains
entity references, the user must create an
[1677]Attr node plus any [1678]Text and
[1679]EntityReference nodes, build the appropriate
subtree, and use setAttributeNode to assign it as
the value of an attribute.
To set an attribute with a qualified name and
namespace URI, use the setAttributeNS method.
Parameters
name of type [1680]DOMString
The name of the attribute to create or alter.
value of type [1681]DOMString
Value to set in string form.
Exceptions
[1682]DOMException
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use specified in the
[1683]Document.xmlVersion attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
No Return Value
setAttributeNS introduced in DOM Level 2
Adds a new attribute. If an attribute with the same
local name and namespace URI is already present on
the element, its prefix is changed to be the prefix
part of the qualifiedName, and its value is changed
to be the value parameter. This value is a simple
string; it is not parsed as it is being set. So any
markup (such as syntax to be recognized as an
entity reference) is treated as literal text, and
needs to be appropriately escaped by the
implementation when it is written out. In order to
assign an attribute value that contains entity
references, the user must create an [1684]Attr node
plus any [1685]Text and [1686]EntityReference
nodes, build the appropriate subtree, and use
setAttributeNodeNS or setAttributeNode to assign it
as the value of an attribute.
Per [1687]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
namespaceURI of type [1688]DOMString
The [1689]namespace URI of the attribute to
create or alter.
qualifiedName of type [1690]DOMString
The [1691]qualified name of the attribute to
create or alter.
value of type [1692]DOMString
The value to set in string form.
Exceptions
[1693]DOMException
INVALID_CHARACTER_ERR: Raised if the specified qualified name contains
an illegal character according to the XML version in use specified in
the [1694]Document.xmlVersion attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the qualifiedName is malformed per the
Namespaces in XML specification, if the qualifiedName has a prefix and
the namespaceURI is null, if the qualifiedName has a prefix that is
"xml" and the namespaceURI is different from
"[1695]http://www.w3.org/XML/1998/namespace", if the qualifiedName or
its prefix is "xmlns" and the namespaceURI is different from
"[1696]http://www.w3.org/2000/xmlns/", or if the namespaceURI is
"[1697]http://www.w3.org/2000/xmlns/" and neither the qualifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1698]HTML 4.01]).
[1695] http://www.w3.org/XML/1998/namespace
[1696] http://www.w3.org/2000/xmlns/
[1697] http://www.w3.org/2000/xmlns/
No Return Value
setAttributeNode
Adds a new attribute node. If an attribute with
that name (nodeName) is already present in the
element, it is replaced by the new one. Replacing
an attribute node by itself has no effect.
To add a new attribute node with a qualified name
and namespace URI, use the setAttributeNodeNS
method.
Parameters
newAttr of type [1699]Attr
The [1700]Attr node to add to the attribute
list.
Return Value
[1701]Attr
If the newAttr attribute replaces an existing attribute, the replaced
[1702]Attr node is returned, otherwise null is returned.
Exceptions
[1703]DOMException
WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different
document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of
another Element object. The DOM user must explicitly clone [1704]Attr
nodes to re-use them in other elements.
setAttributeNodeNS introduced in DOM Level 2
Adds a new attribute. If an attribute with that
local name and that namespace URI is already
present in the element, it is replaced by the new
one. Replacing an attribute node by itself has no
effect.
Per [1705]XML Namespaces], applications must use
the value null as the namespaceURI parameter for
methods if they wish to have no namespace.
Parameters
newAttr of type [1706]Attr
The [1707]Attr node to add to the attribute
list.
Return Value
[1708]Attr
If the newAttr attribute replaces an existing attribute with the same
[1709]local name and [1710]namespace URI, the replaced [1711]Attr node
is returned, otherwise null is returned.
Exceptions
[1712]DOMException
WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different
document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of
another Element object. The DOM user must explicitly clone [1713]Attr
nodes to re-use them in other elements.
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML" and the language exposed through the
Document does not support XML Namespaces (such as [1714]HTML 4.01]).
setIdAttribute introduced in DOM Level 3
Declares the attribute specified by name to be of
type ID, i.e. the [1715]Attr node becomes a
user-determined ID attribute and its attribute
[1716]Attr.isId will be true. Note, however, that
this simply affects the attribute [1717]Attr.isId
of the [1718]Attr node and does not change any
schema that may be in use, in particular this does
not affect the [1719]Attr.schemaTypeInfo of the
specified [1720]Attr node.
To specify an attribute by local name and namespace
URI, use the setIdAttributeNS method.
Parameters
name of type [1721]DOMString
The name of the attribute.
isId of type boolean
Whether the attribute is a of type ID.
Exceptions
[1722]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of
this element.
No Return Value
setIdAttributeNS introduced in DOM Level 3
Declares the attribute specified by local name and
namespace URI to be of type ID, i.e. the [1723]Attr
node becomes a user-determined ID attribute and its
attribute [1724]Attr.isId will be true. Note,
however, that this simply affects the attribute
[1725]Attr.isId of the [1726]Attr node and does not
change any schema that may be in use, in particular
this does not affect the [1727]Attr.schemaTypeInfo
of the specified [1728]Attr node.
Parameters
namespaceURI of type [1729]DOMString
The [1730]namespace URI of the attribute.
localName of type [1731]DOMString
The [1732]local name of the attribute.
isId of type boolean
Whether the attribute is a of type ID.
Exceptions
[1733]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of
this element.
No Return Value
setIdAttributeNode introduced in DOM Level 3
Declares the attribute specified by node to be of
type ID, i.e. the [1734]Attr node becomes a
user-determined ID attribute and its attribute
[1735]Attr.isId will be true. Note, however, that
this simply affects the attribute [1736]Attr.isId
of the [1737]Attr node and does not change any
schema that may be in use, in particular this does
not affect the [1738]Attr.schemaTypeInfo of the
specified [1739]Attr node.
Parameters
idAttr of type [1740]Attr
The attribute node.
isId of type boolean
Whether the attribute is a of type ID.
Exceptions
[1741]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of
this element.
No Return Value
Interface Text
The Text interface inherits from [1742]CharacterData and
represents the textual content (termed [1743]character data in
XML) of an [1744]Element or [1745]Attr. If there is no markup
inside an element's content, the text is contained in a single
object implementing the Text interface that is the only child
of the element. If there is markup, it is parsed into the
[1746]information items (elements, comments, etc.) and Text
nodes that form the list of children of the element.
[1743] http://www.w3.org/TR/2000/REC-xml-20001006#syntax
When a document is first made available via the DOM, there is
only one Text node for each block of text. Users may create
adjacent Text nodes that represent the contents of a given
element without any intervening markup, but should be aware
that there is no way to represent the separations between these
nodes in XML or HTML, so they will not (in general) persist
between DOM editing sessions. The [1747]Node.normalize() method
merges any such adjacent Text objects into a single node for
each block of text.
No lexical check is done on the content of a Text node and,
depending on its position in the document, some characters must
be escaped during serialization using character references;
e.g. the characters "<&" if the textual content is part of an
element or of an attribute, the character sequence "]]>" when
part of an element, the quotation mark character " or the
apostrophe character ' when part of an attribute.
IDL Definition
interface [1748]Text : [1749]CharacterData {
[1750]Text [1751]splitText(in unsigned long offset)
raises([1752]DOMException);
// Introduced in DOM Level 3:
readonly attribute boolean [1753]isElementContentWhitespace;
// Introduced in DOM Level 3:
readonly attribute [1754]DOMString [1755]wholeText;
// Introduced in DOM Level 3:
[1756]Text [1757]replaceWholeText(in [1758]DOMString content)
raises([1759]DOMException);
};
Attributes
isElementContentWhitespace of type boolean, readonly,
introduced in DOM Level 3
Returns whether this text node contains
[1760]element content whitespace, often abusively
called "ignorable whitespace". The text node is
determined to contain whitespace in element content
during the load of the document or if validation
occurs while using
[1761]Document.normalizeDocument().
[1760] http://www.w3.org/TR/2001/REC-xml-infoset-20011024#infoitem.character
wholeText of type [1762]DOMString, readonly, introduced in
DOM Level 3
Returns all text of Text nodes
[1763]logically-adjacent text nodes to this node,
concatenated in document order.
For instance, in the example below wholeText on the
Text node that contains "bar" returns "barfoo",
while on the Text node that contains "foo" it
returns "barfoo".
barTextNode.wholeText value is "barfoo"
Figure: barTextNode.wholeText value is "barfoo"
[1764]SVG 1.0 version]
[1764] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/images/wholeTextExmpl
Methods
replaceWholeText introduced in DOM Level 3
Replaces the text of the current node and all
[1765]logically-adjacent text nodes with the
specified text. All [1766]logically-adjacent text
nodes are removed including the current node unless
it was the recipient of the replacement text.
This method returns the node which received the
replacement text. The returned node is:
# null, when the replacement text is the empty
string;
# the current node, except when the current node is
[1767]read-only;
# a new Text node of the same type (Text or
[1768]CDATASection) as the current node inserted at
the location of the replacement.
For instance, in the above example calling
replaceWholeText on the Text node that contains
"bar" with "yo" in argument results in the
following:
barTextNode.replaceWholeText("yo") modifies the
textual content of barTextNode with "yo"
Figure: barTextNode.replaceWholeText("yo") modifies
the textual content of barTextNode with "yo"
[1769]SVG 1.0 version]
[1769] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/images/wholeTextExmpl2
Where the nodes to be removed are read-only
descendants of an [1770]EntityReference, the
[1771]EntityReference must be removed instead of
the read-only nodes. If any [1772]EntityReference
to be removed has descendants that are not
[1773]EntityReference, Text, or [1774]CDATASection
nodes, the replaceWholeText method must fail before
performing any modification of the document,
raising a [1775]DOMException with the code
[1776]NO_MODIFICATION_ALLOWED_ERR.
For instance, in the example below calling
replaceWholeText on the Text node that contains
"bar" fails, because the [1777]EntityReference node
"ent" contains an [1778]Element node which cannot
be removed.
barTextNode.replaceWholeText("yo") raises a
NO_MODIFICATION_ALLOWED_ERR DOMException
Figure: barTextNode.replaceWholeText("yo") raises a
NO_MODIFICATION_ALLOWED_ERR DOMException [1779]SVG
1.0 version]
[1779] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/images/wholeTextExmpl3
Parameters
content of type [1780]DOMString
The content of the replacing Text node.
Return Value
[1781]Text
The Text node created with the specified content.
Exceptions
[1782]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text nodes being
replaced is readonly.
splitText
Breaks this node into two nodes at the specified
offset, keeping both in the tree as [1783]siblings.
After being split, this node will contain all the
content up to the offset point. A new node of the
same type, which contains all the content at and
after the offset point, is returned. If the
original node had a parent node, the new node is
inserted as the next [1784]sibling of the original
node. When the offset is equal to the length of
this node, the new node has no data.
Parameters
offset of type unsigned long
The [1785]16-bit unit offset at which to
split, starting from 0.
Return Value
[1786]Text
The new node, of the same type as this node.
Exceptions
[1787]DOMException
INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
than the number of 16-bit units in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Interface Comment
This interface inherits from [1788]CharacterData and represents
the content of a comment, i.e., all the characters between the
starting ''. Note that this is the
definition of a comment in XML, and, in practice, HTML,
although some HTML tools may implement the full SGML comment
structure.
No lexical check is done on the content of a comment and it is
therefore possible to have the character sequence "--"
(double-hyphen) in the content, which is illegal in a comment
per section 2.5 of [1789]XML 1.0]. The presence of this
character sequence must generate a fatal error during
serialization.
IDL Definition
interface [1790]Comment : [1791]CharacterData {
};
Interface TypeInfo (introduced in DOM Level 3)
The TypeInfo interface represent a type referenced from
[1792]Element or [1793]Attr nodes, specified in the
[1794]schemas associated with the document. The type is a pair
of a [1795]namespace URI and name properties, and depends on
the document's schema.
If the document's schema is an XML DTD [1796]XML 1.0], the
values are computed as follows:
+ If this type is referenced from an [1797]Attr node,
typeNamespace is null and typeName represents the [attribute
[ type] property in the [1798]XML Information Set]. If there
is no declaration for the attribute, typeName is null.
+ If this type is referenced from an [1799]Element node, the
typeNamespace and typeName are null.
If the document's schema is an XML Schema [1800]XML Schema
Part 1], the values are computed as follows using the
post-schema-validation infoset contributions (also called PSVI
contributions):
+ If the [validity] property exists AND is "invalid" or
"notKnown": the {target namespace} and {name} properties of
the declared type if available, otherwise null.
Note: At the time of writing, the XML Schema specification
does not require exposing the declared type. Thus, DOM
implementations might choose not to provide type information
if validity is not valid.
+ If the [validity] property exists and is "valid":
1. If [member type definition] exists:
1. If {name} is not absent, then expose {name} and
{target namespace} properties of the [member type
definition] property;
2. Otherwise, expose the namespace and local name of
the corresponding [1801]anonymous type name.
2. If the [type definition] property exists:
1. If {name} is not absent, then expose {name} and
{target namespace} properties of the [type
definition] property;
2. Otherwise, expose the namespace and local name of
the corresponding [1802]anonymous type name.
3. If the [member type definition anonymous] exists:
1. If it is false, then expose [member type definition
name] and [member type definition namespace]
properties;
2. Otherwise, expose the namespace and local name of
the corresponding [1803]anonymous type name.
4. If the [type definition anonymous] exists:
1. If it is false, then expose [type definition name]
and [type definition namespace] properties;
2. Otherwise, expose the namespace and local name of
the corresponding [1804]anonymous type name.
Note: Other schema languages are outside the scope of the W3C
and therefore should define how to represent their type systems
using TypeInfo.
IDL Definition
// Introduced in DOM Level 3:
interface [1805]TypeInfo {
readonly attribute [1806]DOMString [1807]typeName;
readonly attribute [1808]DOMString [1809]typeNamespace;
// DerivationMethods
const unsigned long [1810]DERIVATION_RESTRICTION = 0x00000001;
const unsigned long [1811]DERIVATION_EXTENSION = 0x00000002;
const unsigned long [1812]DERIVATION_UNION = 0x00000004;
const unsigned long [1813]DERIVATION_LIST = 0x00000008;
boolean [1814]isDerivedFrom(in [1815]DOMString typeNamespaceArg,
in [1816]DOMString typeNameArg,
in unsigned long derivationMethod);
};
Definition group DerivationMethods
The type of derivation, used by the method
[1817]TypeInfo.isDerivedFrom().
Defined Constants
DERIVATION_EXTENSION
If the document's schema is an XML Schema
[1818]XML Schema Part 1], this constant
represents the derivation by [1819]extension
if complex types are involved.
[1819] http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/#key-typeExtension
DERIVATION_LIST
If the document's schema is an XML Schema
[1820]XML Schema Part 1], this constant
represents the [1821]list if simple types are
involved.
[1821] http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/#element-list
DERIVATION_RESTRICTION
If the document's schema is an XML Schema
[1822]XML Schema Part 1], this constant
represents the derivation by
[1823]restriction if complex types are
involved, or a [1824]restriction if simple
types are involved.
[1823] http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/#key-typeRestriction
[1824] http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/#element-restriction
DERIVATION_UNION
If the document's schema is an XML Schema
[1825]XML Schema Part 1], this constant
represents the [1826]union if simple types
are involved.
[1826] http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/#element-union
Attributes
typeName of type [1827]DOMString, readonly
The name of a type declared for the associated
element or attribute, or null if unknown.
typeNamespace of type [1828]DOMString, readonly
The namespace of the type declared for the
associated element or attribute or null if the
element does not have declaration or if no
namespace information is available.
Methods
isDerivedFrom
The method checks if this TypeInfo derives from the
specified ancestor type.
Parameters
typeNamespaceArg of type [1829]DOMString
the namespace of the ancestor type.
typeNameArg of type [1830]DOMString
the name of the ancestor type.
derivationMethod of type unsigned long
the type of derivation and conditions applied
between two types, as described in the list
of constants provided in this interface. Note
that those constants:
@ are only defined if the document's schema is
an XML Schema;
@ could be combined if XML Schema types are
involved.
@ [1831]TypeInfo.DERIVATION_EXTENSION only
applies to XML Schema complex types.
The value 0x00000000 represents any kind of
derivation method.
Return Value
boolean
true if the specified type is an ancestor according to the derivation
parameter, false otherwise. If the document's schema is a DTD or no
schema is associated with the document, this method will always return
false.
No Exceptions
Interface UserDataHandler (introduced in DOM Level 3)
When associating an object to a key on a node using
[1832]Node.setUserData() the application can provide a handler
that gets called when the node the object is associated to is
being cloned, imported, or renamed. This can be used by the
application to implement various behaviors regarding the data
it associates to the DOM nodes. This interface defines that
handler.
IDL Definition
// Introduced in DOM Level 3:
interface [1833]UserDataHandler {
// OperationType
const unsigned short [1834]NODE_CLONED = 1;
const unsigned short [1835]NODE_IMPORTED = 2;
const unsigned short [1836]NODE_DELETED = 3;
const unsigned short [1837]NODE_RENAMED = 4;
const unsigned short [1838]NODE_ADOPTED = 5;
void [1839]handle(in unsigned short operation,
in [1840]DOMString key,
in [1841]DOMUserData data,
in [1842]Node src,
in [1843]Node dst);
};
Definition group OperationType
An integer indicating the type of operation being
performed on a node.
Defined Constants
NODE_ADOPTED
The node is adopted, using Node.adoptNode().
NODE_CLONED
The node is cloned, using
[1844]Node.cloneNode().
NODE_DELETED
The node is deleted.
Note: This may not be supported or may not be
reliable in certain environments, such as
Java, where the implementation has no real
control over when objects are actually
deleted.
NODE_IMPORTED
The node is imported, using
Node.importNode().
NODE_RENAMED
The node is renamed, using Node.renameNode().
Methods
handle
This method is called whenever the node for which
this handler is registered is imported or cloned.
Any exceptions thrown inside a UserDataHandler will
be ignored.
Parameters
operation of type unsigned short
Specifies the type of operation that is being
performed on the node.
key of type [1845]DOMString
Specifies the key for which this handler is
being called.
data of type [1846]DOMUserData
Specifies the data for which this handler is
being called.
src of type [1847]Node
Specifies the node being cloned, adopted,
imported, or renamed. This is null when the
node is being deleted.
dst of type [1848]Node
Specifies the node newly created if any, or
null.
No Return Value
No Exceptions
Interface DOMError (introduced in DOM Level 3)
DOMError is an interface that describes an error.
IDL Definition
// Introduced in DOM Level 3:
interface [1849]DOMError {
// ErrorSeverity
const unsigned short [1850]SEVERITY_WARNING = 1;
const unsigned short [1851]SEVERITY_ERROR = 2;
const unsigned short [1852]SEVERITY_FATAL_ERROR = 3;
readonly attribute unsigned short [1853]severity;
readonly attribute [1854]DOMString [1855]message;
readonly attribute [1856]DOMString [1857]type;
readonly attribute Object [1858]relatedException;
readonly attribute [1859]DOMObject [1860]relatedData;
readonly attribute [1861]DOMLocator [1862]location;
};
Definition group ErrorSeverity
An integer indicating the severity of the error.
Defined Constants
SEVERITY_ERROR
The severity of the error described by the
DOMError is error. A SEVERITY_ERROR may not
cause the processing to stop if the error can
be recovered, unless
[1863]DOMErrorHandler.handleError() returns
false.
SEVERITY_FATAL_ERROR
The severity of the error described by the
DOMError is fatal error. A
SEVERITY_FATAL_ERROR will cause the normal
processing to stop and the return value of
[1864]DOMErrorHandler.handleError() is
ignored. If the implementation chooses to
continue, the behavior is undefined.
SEVERITY_WARNING
The severity of the error described by the
DOMError is warning. A SEVERITY_WARNING will
not cause the processing to stop, unless
[1865]DOMErrorHandler.handleError() returns
false.
Attributes
location of type [1866]DOMLocator, readonly
The location of the error.
message of type [1867]DOMString, readonly
An implementation specific string describing the
error that occurred.
relatedData of type [1868]DOMObject, readonly
The related [1869]DOMError.type dependent data if
any.
relatedException of type Object, readonly
The related platform dependent exception if any.
severity of type unsigned short, readonly
The severity of the error, either SEVERITY_WARNING,
SEVERITY_ERROR, or SEVERITY_FATAL_ERROR.
type of type [1870]DOMString, readonly
A [1871]DOMString indicating which related data is
expected in relatedData. Users should refer to the
specification of the error in order to find its
[1872]DOMString type and relatedData definitions if
any.
Note: As an example,
[1873]Document.normalizeDocument() does generate
warnings when the "[1874]split-cdata-sections"
parameter is in use. Therefore, the method
generates a SEVERITY_WARNING with type
"cdata-section-splitted" and the first
[1875]CDATASection node in document order resulting
from the split is returned by the relatedData
attribute.
Interface DOMErrorHandler (introduced in DOM Level 3)
DOMErrorHandler is a callback interface that the DOM
implementation can call when reporting errors that happens
while processing XML data, or when doing some other processing
(e.g. validating a document). A DOMErrorHandler object can be
attached to a [1876]Document using the "[1877]error-handler" on
the [1878]DOMConfiguration interface. If more than one error
needs to be reported during an operation, the sequence and
numbers of the errors passed to the error handler are
implementation dependent.
The application that is using the DOM implementation is
expected to implement this interface.
IDL Definition
// Introduced in DOM Level 3:
interface [1879]DOMErrorHandler {
boolean [1880]handleError(in [1881]DOMError error);
};
Methods
handleError
This method is called on the error handler when an
error occurs.
If an exception is thrown from this method, it is
considered to be equivalent of returning true.
Parameters
error of type [1882]DOMError
The error object that describes the error.
This object may be reused by the DOM
implementation across multiple calls to the
handleError method.
Return Value
boolean
If the handleError method returns false, the DOM implementation should
stop the current processing when possible. If the method returns true,
the processing may continue depending on [1883]DOMError.severity.
No Exceptions
Interface DOMLocator (introduced in DOM Level 3)
DOMLocator is an interface that describes a location (e.g.
where an error occurred).
IDL Definition
// Introduced in DOM Level 3:
interface [1884]DOMLocator {
readonly attribute long [1885]lineNumber;
readonly attribute long [1886]columnNumber;
readonly attribute long [1887]byteOffset;
readonly attribute long [1888]utf16Offset;
readonly attribute [1889]Node [1890]relatedNode;
readonly attribute [1891]DOMString [1892]uri;
};
Attributes
byteOffset of type long, readonly
The byte offset into the input source this locator
is pointing to or -1 if there is no byte offset
available.
columnNumber of type long, readonly
The column number this locator is pointing to, or
-1 if there is no column number available.
lineNumber of type long, readonly
The line number this locator is pointing to, or -1
if there is no column number available.
relatedNode of type [1893]Node, readonly
The node this locator is pointing to, or null if no
node is available.
uri of type [1894]DOMString, readonly
The URI this locator is pointing to, or null if no
URI is available.
utf16Offset of type long, readonly
The UTF-16, as defined in [1895]Unicode] and
Amendment 1 of [1896]ISO/IEC 10646], offset into
the input source this locator is pointing to or -1
if there is no UTF-16 offset available.
Interface DOMConfiguration (introduced in DOM Level 3)
The DOMConfiguration interface represents the configuration of
a document and maintains a table of recognized parameters.
Using the configuration, it is possible to change
[1897]Document.normalizeDocument() behavior, such as replacing
the [1898]CDATASection nodes with [1899]Text nodes or
specifying the type of the [1900]schema that must be used when
the validation of the [1901]Document is requested.
DOMConfiguration objects are also used in [1902]DOM Level 3
Load and Save] in the DOMParser and DOMSerializer interfaces.
The parameter names used by the DOMConfiguration object are
defined throughout the DOM Level 3 specifications. Names are
case-insensitives. To avoid possible conflicts, as a
convention, names referring to parameters defined outside the
DOM specification should be made unique. Because parameters are
exposed as properties in the [1903]ECMAScript Language Binding,
names are recommended to follow the section "5.16 Identifiers"
of [1904]Unicode] with the addition of the character '-'
(HYPHEN-MINUS) but it is not enforced by the DOM
implementation. DOM Level 3 Core Implementations are required
to recognize all parameters defined in this specification. Some
parameter values may also be required to be supported by the
implementation. Refer to the definition of the parameter to
know if a value must be supported or not.
Note: Parameters are similar to features and properties used in
SAX2 [1905]SAX].
The following list of parameters defined in the DOM:
"canonical-form"
true
[optional]
Canonicalize the document according to the rules
specified in [1906]Canonical XML]. Note that this
is limited to what can be represented in the DOM.
In particular, there is no way to specify the order
of the attributes in the DOM.
This forces the following parameters to false:
"[1907]entities", "[1908]normalize-characters",
"[1909]cdata-sections".
This forces the following parameters to true:
"[1910]namespaces", "[1911]namespace-declarations",
"[1912]well-formed",
"[1913]element-content-whitespace".
Other parameters are not changed unless explicitly
specified in the description of the parameters.
In addition, the [1914]DocumentType node is removed
from the tree if any and superfluous namespace
declarations are removed from each element.
Note that querying this parameter with getParameter
cannot return true unless it has been set to true
and the parameters described above are
appropriately set.
false
[required] (default)
Do not canonicalize the document.
"cdata-sections"
true
[required] (default)
Keep [1915]CDATASection nodes in the document.
false
[required]
Transform [1916]CDATASection nodes in the document
into [1917]Text nodes. The new [1918]Text node is
then combined with any adjacent [1919]Text node.
"check-character-normalization"
true
[optional]
Check if the characters in the document are fully
normalized according to the rules defined in
[1920]CharModel] supplemented by the definitions
of relevant constructs from [1921]Section 2.13 of
[1922]XML 1.1].
[1921] http://www.w3.org/TR/2003/PR-xml11-20031105/#sec-normalization-checking
false
[required] (default)
Do not check if characters are normalized.
"comments"
true
[required] (default)
Keep [1923]Comment nodes in the document.
false
[required]
Discard [1924]Comment nodes in the document.
"datatype-normalization"
true
[optional]
Exposed schema-normalized values in the tree. Since
this parameter requires to have [1925]schema
information, the "[1926]validate" parameter will
also be set to true. Having this parameter
activated when "validate" is false has no effect
and no schema-normalization will happen.
Note: Since the document contains the result of the
XML 1.0 processing, this parameter does not apply
to attribute value normalization as defined in
section 3.3.3 of [1927]XML 1.0] and is only meant
for [1928]schema languages other than Document Type
Definition (DTD).
false
[required] (default)
Do not perform schema normalization on the tree.
"entities"
true
[required] (default)
Keep [1929]EntityReference and [1930]Entity nodes
in the document.
false
[required]
Remove all [1931]EntityReference and [1932]Entity
nodes from the document, putting the entity
expansions directly in their place. [1933]Text
nodes are normalized, as defined in
[1934]Node.normalize. Only [1935]EntityReference
nodes to non-defined entities are kept in the
document, with their associated [1936]Entity nodes
if any.
"error-handler"
[required]
Contains a [1937]DOMErrorHandler object. If an error is
encountered in the document, the implementation will call
back the [1938]DOMErrorHandler registered using this
parameter. The implementation may provide a default
[1939]DOMErrorHandler object.
When called, [1940]DOMError.relatedData will contain the
closest node to where the error occurred. If the
implementation is unable to determine the node where the
error occurs, [1941]DOMError.relatedData will contain the
[1942]Document node. Mutations to the document from
within an error handler will result in implementation
dependent behavior.
"infoset"
true
[required]
Keep in the document the information defined in the
XML Information Set [1943]XML Information Set].
This forces the following parameters to false:
"[1944]validate-if-schema", "[1945]entities",
"[1946]datatype-normalization",
"[1947]cdata-sections".
This forces the following parameters to true:
"[1948]namespace-declarations",
"[1949]well-formed",
"[1950]element-content-whitespace",
"[1951]comments", "[1952]namespaces".
Other parameters are not changed unless explicitly
specified in the description of the parameters.
Note that querying this parameter with getParameter
returns true only if the individual parameters
specified above are appropriately set.
false
Setting infoset to false has no effect.
"namespaces"
true
[required] (default)
Perform the namespace processing as defined in
[1953]Namespace normalization.
false
[optional]
Do not perform the namespace processing.
"namespace-declarations"
true
[required] (default)
Include namespace declaration attributes, specified
or defaulted from the [1954]schema, in the
document. See also the sections "Declaring
Namespaces" in [1955]XML Namespaces] and
[1956]XML Namespaces 1.1].
false
[required]
Discard all namespace declaration attributes. The
namespace prefixes ([1957]Node.prefix) are retained
even if this parameter is set to false.
"normalize-characters"
true
[optional]
Fully normalize the characters in the document
according to the rules defined in [1958]CharModel]
supplemented by the definitions of relevant
constructs from [1959]Section 2.13 of [1960]XML
1.1].
[1959] http://www.w3.org/TR/2003/PR-xml11-20031105/#sec-normalization-checking
false
[required] (default)
Do not perform character normalization.
"schema-location"
[optional]
Represent a [1961]DOMString object containing a list of
URIs, separated by whitespaces (characters matching the
[1962]nonterminal production S defined in section 2.3
[1963]XML 1.0]), that represents the [1964]schemas
against which validation should occur, i.e. the current
schema. The types of schemas referenced in this list must
match the type specified with schema-type, otherwise the
behavior of an implementation is undefined.
The schemas specified using this property take precedence
to the schema information specified in the document
itself. For namespace aware schema, if a schema specified
using this property and a schema specified in the
document instance (i.e. using the schemaLocation
attribute) in a schema document (i.e. using schema import
mechanisms) share the same targetNamespace, the schema
specified by the user using this property will be used.
If two schemas specified using this property share the
same targetNamespace or have no namespace, the behavior
is implementation dependent.
If no location has been provided, this parameter is null.
[1962] http://www.w3.org/TR/2000/REC-xml-20001006#NT-S
Note: The "schema-location" parameter is ignored unless
the "[1965]schema-type" parameter value is set. It is
strongly recommended that [1966]Document.documentURI will
be set so that an implementation can successfully resolve
any external entities referenced.
"schema-type"
[optional]
Represent a [1967]DOMString object containing an absolute
URI and representing the type of the [1968]schema
language used to validate a document against. Note that
no lexical checking is done on the absolute URI.
If this parameter is not set, a default value may be
provided by the implementation, based on the schema
languages supported and on the schema language used at
load time. If no value is provided, this parameter is
null.
Note: For XML Schema [1969]XML Schema Part 1],
applications must use the value
"http://www.w3.org/2001/XMLSchema". For XML DTD
[1970]XML 1.0], applications must use the value
"http://www.w3.org/TR/REC-xml". Other schema languages
are outside the scope of the W3C and therefore should
recommend an absolute URI in order to use this method.
"split-cdata-sections"
true
[required] (default)
Split CDATA sections containing the CDATA section
termination marker ']]>'. When a CDATA section is
split a warning is issued with a
[1971]DOMError.type equals to
"cdata-sections-splitted" and
[1972]DOMError.relatedData equals to the first
[1973]CDATASection node in document order resulting
from the split.
false
[required]
Signal an error if a [1974]CDATASection contains an
unrepresentable character.
"validate"
true
[optional]
Require the validation against a [1975]schema (i.e.
XML schema, DTD, any other type or representation
of schema) of the document as it is being
normalized as defined by [1976]XML 1.0]. If
validation errors are found, or no schema was
found, the error handler is notified.
Schema-normalized values will not be exposed
according to the schema in used unless the
parameter "[1977]datatype-normalization" is true.
This parameter will reevaluate:
# Attribute nodes with [1978]Attr.specified equals to
false, as specified in the description of the
[1979]Attr interface;
# The value of the attribute
[1980]Text.isElementContentWhitespace for all
[1981]Text nodes;
# The value of the attribute [1982]Attr.isId for all
[1983]Attr nodes;
# The attributes [1984]Element.schemaTypeInfo and
[1985]Attr.schemaTypeInfo.
Note: "[1986]validate-if-schema" and "validate" are
mutually exclusive, setting one of them to true
will set the other one to false. Applications
should also consider setting the parameter
"[1987]well-formed" to true, which is the default
for that option, when validating the document.
false
[required] (default)
Do not accomplish schema processing, including the
internal subset processing. Note that validation
might still happen if "[1988]"validate-if-schema"
is true.
"validate-if-schema"
true
[optional]
Enable validation only if a declaration for the
document element can be found in a [1989]schema
(independently of where it is found, i.e. XML
schema, DTD, or any other type or representation of
schema). If validation is enabled, this parameter
has the same behavior as the parameter
"[1990]validate" set to true.
Note: "validate-if-schema" and "[1991]validate" are
mutually exclusive, setting one of them to true
will set the other one to false.
false
[required] (default)
No schema processing should be performed if the
document has a schema, including internal subset
processing. Note that validation must still happen
if "[1992]validate" is true.
"well-formed"
true
[required] (default)
Check if all nodes are XML [1993]well formed
according to the XML version in use in
[1994]Document.xmlVersion:
# check if the attribute [1995]Node.nodeName contains
invalid characters according to its node type and
generate a [1996]DOMError of type
"wf-invalid-character-in-node-name", with a
[1997]DOMError.SEVERITY_ERROR severity, if
necessary;
# check if the text content inside [1998]Attr,
[1999]Element, [2000]Comment, [2001]Text,
[2002]CDATASection nodes for invalid characters and
generate a [2003]DOMError of type
"wf-invalid-character", with a
[2004]DOMError.SEVERITY_ERROR severity, if
necessary;
# check if the data inside
[2005]ProcessingInstruction nodes for invalid
characters and generate a [2006]DOMError of type
"wf-invalid-character", with a
[2007]DOMError.SEVERITY_ERROR severity, if
necessary;
false
[optional]
Do not check for XML well-formedness.
"element-content-whitespace"
true
[required] (default)
Keep all whitespaces in the document.
false
[optional]
Discard all [2008]Text nodes that contain
whitespaces in element content, as described in
[2009][element content whitespace]. The
implementation is expected to use the attribute
[2010]Text.isElementContentWhitespace to determine
if a [2011]Text node should be discarded or not.
[2009] http://www.w3.org/TR/2001/REC-xml-infoset-20011024#infoitem.character
The resolution of the system identifiers associated with
entities is done using [2012]Document.documentURI. However,
when the feature "LS" defined in [2013]DOM Level 3 Load and
Save] is supported by the DOM implementation, the parameter
"resource-resolver" can also be used on DOMConfiguration
objects attached to [2014]Document nodes. If this parameter is
set, [2015]Document.normalizeDocument() will invoke the
resource resolver instead of using [2016]Document.documentURI.
IDL Definition
// Introduced in DOM Level 3:
interface [2017]DOMConfiguration {
void [2018]setParameter(in [2019]DOMString name,
in [2020]DOMUserData value)
raises([2021]DOMException);
[2022]DOMUserData [2023]getParameter(in [2024]DOMString name)
raises([2025]DOMException);
boolean [2026]canSetParameter(in [2027]DOMString name,
in [2028]DOMUserData value);
readonly attribute [2029]DOMStringList [2030]parameterNames;
};
Attributes
parameterNames of type [2031]DOMStringList, readonly
The list of the parameters supported by this
DOMConfiguration object and for which at least one
value can be set by the application. Note that this
list can also contain parameter names defined
outside this specification.
Methods
canSetParameter
Check if setting a parameter to a specific value is
supported.
Parameters
name of type [2032]DOMString
The name of the parameter to check.
value of type [2033]DOMUserData
An object. if null, the returned value is
true.
Return Value
boolean
true if the parameter could be successfully set to the specified
value, or false if the parameter is not recognized or the requested
value is not supported. This does not change the current value of the
parameter itself.
No Exceptions
getParameter
Return the value of a parameter if known.
Parameters
name of type [2034]DOMString
The name of the parameter.
Return Value
[2035]DOMUserData
The current object associated with the specified parameter or null if
no object has been associated or if the parameter is not supported.
Exceptions
[2036]DOMException
NOT_FOUND_ERR: Raised when the parameter name is not recognized.
setParameter
Set the value of a parameter.
Parameters
name of type [2037]DOMString
The name of the parameter to set.
value of type [2038]DOMUserData
The new value or null if the user wishes to
unset the parameter. While the type of the
value parameter is defined as
[2039]DOMUserData, the object type must match
the type defined by the definition of the
parameter. For example, if the parameter is
[2040]"error-handler", the value must be of
type [2041]DOMErrorHandler.
Exceptions
[2042]DOMException
NOT_FOUND_ERR: Raised when the parameter name is not recognized.
NOT_SUPPORTED_ERR: Raised when the parameter name is recognized but
the requested value cannot be set.
TYPE_MISMATCH_ERR: Raised if the value type for this parameter name is
incompatible with the expected value type.
No Return Value
1.5 Extended Interfaces: XML module
The interfaces defined here form part of the DOM Core specification,
but objects that expose these interfaces will never be encountered in
a DOM implementation that deals only with HTML.
The interfaces found within this section are not mandatory. A DOM
application may use the [2043]DOMImplementation.hasFeature(feature,
version) method with parameter values "XML" and "3.0" (respectively)
to determine whether or not this module is supported by the
implementation. In order to fully support this module, an
implementation must also support the "Core" feature defined in
[2044]Fundamental Interfaces: Core module and the feature "XMLVersion"
with version "1.0" defined in [2045]Document.xmlVersion. Please refer
to additional information about [2046]Conformance in this
specification. The DOM Level 3 XML module is backward compatible with
the DOM Level 2 XML [2047]DOM Level 2 Core] and DOM Level 1 XML
[2048]DOM Level 1] modules, i.e. a DOM Level 3 XML implementation who
returns true for "XML" with the version number "3.0" must also return
true for this feature when the version number is "2.0", "1.0", "" or,
null.
Interface CDATASection
CDATA sections are used to escape blocks of text containing
characters that would otherwise be regarded as markup. The only
delimiter that is recognized in a CDATA section is the "]]>"
string that ends the CDATA section. CDATA sections cannot be
nested. Their primary purpose is for including material such as
XML fragments, without needing to escape all the delimiters.
The [2049]CharacterData.data attribute holds the text that is
contained by the CDATA section. Note that this may contain
characters that need to be escaped outside of CDATA sections
and that, depending on the character encoding ("charset")
chosen for serialization, it may be impossible to write out
some characters as part of a CDATA section.
The CDATASection interface inherits from the
[2050]CharacterData interface through the [2051]Text interface.
Adjacent CDATASection nodes are not merged by use of the
normalize method of the [2052]Node interface.
No lexical check is done on the content of a CDATA section and
it is therefore possible to have the character sequence "]]>"
in the content, which is illegal in a CDATA section per section
2.7 of [2053]XML 1.0]. The presence of this character sequence
must generate a fatal error during serialization or the cdata
section must be splitted before the serialization (see also the
parameter "split-cdata-sections" in the [2054]DOMConfiguration
interface).
Note: Because no markup is recognized within a CDATASection,
character numeric references cannot be used as an escape
mechanism when serializing. Therefore, action needs to be taken
when serializing a CDATASection with a character encoding where
some of the contained characters cannot be represented. Failure
to do so would not produce well-formed XML.
One potential solution in the serialization process is to end
the CDATA section before the character, output the character
using a character reference or entity reference, and open a new
CDATA section for any further characters in the text node.
Note, however, that some code conversion libraries at the time
of writing do not return an error or exception when a character
is missing from the encoding, making the task of ensuring that
data is not corrupted on serialization more difficult.
IDL Definition
interface [2055]CDATASection : [2056]Text {
};
Interface DocumentType
Each [2057]Document has a doctype attribute whose value is
either null or a DocumentType object. The DocumentType
interface in the DOM Core provides an interface to the list of
entities that are defined for the document, and little else
because the effect of namespaces and the various XML schema
efforts on DTD representation are not clearly understood as of
this writing.
The DOM Level 2 doesn't support editing DocumentType nodes.
DocumentType nodes are [2058]read-only.
IDL Definition
interface [2059]DocumentType : [2060]Node {
readonly attribute [2061]DOMString [2062]name;
readonly attribute [2063]NamedNodeMap [2064]entities;
readonly attribute [2065]NamedNodeMap [2066]notations;
// Introduced in DOM Level 2:
readonly attribute [2067]DOMString [2068]publicId;
// Introduced in DOM Level 2:
readonly attribute [2069]DOMString [2070]systemId;
// Introduced in DOM Level 2:
readonly attribute [2071]DOMString [2072]internalSubset;
};
Attributes
entities of type [2073]NamedNodeMap, readonly
A [2074]NamedNodeMap containing the general
entities, both external and internal, declared in
the DTD. Parameter entities are not contained.
Duplicates are discarded. For example in:
]>
the interface provides access to foo and the first
declaration of bar but not the second declaration
of bar or baz. Every node in this map also
implements the [2075]Entity interface.
The DOM Level 2 does not support editing entities,
therefore entities cannot be altered in any way.
internalSubset of type [2076]DOMString, readonly,
introduced in DOM Level 2
The internal subset as a string, or null if there
is none. This is does not contain the delimiting
square brackets.
Note: The actual content returned depends on how
much information is available to the
implementation. This may vary depending on various
parameters, including the XML processor used to
build the document.
name of type [2077]DOMString, readonly
The name of DTD; i.e., the name immediately
following the DOCTYPE keyword.
notations of type [2078]NamedNodeMap, readonly
A [2079]NamedNodeMap containing the notations
declared in the DTD. Duplicates are discarded.
Every node in this map also implements the
[2080]Notation interface.
The DOM Level 2 does not support editing notations,
therefore notations cannot be altered in any way.
publicId of type [2081]DOMString, readonly, introduced in
DOM Level 2
The public identifier of the external subset.
systemId of type [2082]DOMString, readonly, introduced in
DOM Level 2
The system identifier of the external subset. This
may be an absolute URI or not.
Interface Notation
This interface represents a notation declared in the DTD. A
notation either declares, by name, the format of an unparsed
entity (see [2083]section 4.7 of the XML 1.0 specification
[2084]XML 1.0]), or is used for formal declaration of
processing instruction targets (see [2085]section 2.6 of the
XML 1.0 specification [2086]XML 1.0]). The nodeName attribute
inherited from [2087]Node is set to the declared name of the
notation.
[2083] http://www.w3.org/TR/2000/REC-xml-20001006#Notations
[2085] http://www.w3.org/TR/2000/REC-xml-20001006#sec-pi
The DOM Core does not support editing Notation nodes; they are
therefore [2088]readonly.
A Notation node does not have any parent.
IDL Definition
interface [2089]Notation : [2090]Node {
readonly attribute [2091]DOMString [2092]publicId;
readonly attribute [2093]DOMString [2094]systemId;
};
Attributes
publicId of type [2095]DOMString, readonly
The public identifier of this notation. If the
public identifier was not specified, this is null.
systemId of type [2096]DOMString, readonly
The system identifier of this notation. If the
system identifier was not specified, this is null.
This may be an absolute URI or not.
Interface Entity
This interface represents a known entity, either parsed or
unparsed, in an XML document. Note that this models the entity
itself not the entity declaration.
The nodeName attribute that is inherited from [2097]Node
contains the name of the entity.
An XML processor may choose to completely expand entities
before the structure model is passed to the DOM; in this case
there will be no [2098]EntityReference nodes in the document
tree.
XML does not mandate that a non-validating XML processor read
and process entity declarations made in the external subset or
declared in parameter entities. This means that parsed entities
declared in the external subset need not be expanded by some
classes of applications, and that the replacement text of the
entity may not be available. When the [2099]replacement text is
available, the corresponding Entity node's child list
represents the structure of that replacement value. Otherwise,
the child list is empty.
[2099] http://www.w3.org/TR/2000/REC-xml-20001006#intern-replacement
The DOM Level 2 does not support editing Entity nodes; if a
user wants to make changes to the contents of an Entity, every
related [2100]EntityReference node has to be replaced in the
structure model by a clone of the Entity's contents, and then
the desired changes must be made to each of those clones
instead. Entity nodes and all their [2101]descendants are
[2102]readonly.
An Entity node does not have any parent.
Note: If the entity contains an unbound [2103]namespace prefix,
the namespaceURI of the corresponding node in the Entity node
subtree is null. The same is true for [2104]EntityReference
nodes that refer to this entity, when they are created using
the createEntityReference method of the [2105]Document
interface. The DOM Level 2 does not support any mechanism to
resolve namespace prefixes.
IDL Definition
interface [2106]Entity : [2107]Node {
readonly attribute [2108]DOMString [2109]publicId;
readonly attribute [2110]DOMString [2111]systemId;
readonly attribute [2112]DOMString [2113]notationName;
// Introduced in DOM Level 3:
readonly attribute [2114]DOMString [2115]inputEncoding;
// Introduced in DOM Level 3:
readonly attribute [2116]DOMString [2117]xmlEncoding;
// Introduced in DOM Level 3:
readonly attribute [2118]DOMString [2119]xmlVersion;
};
Attributes
inputEncoding of type [2120]DOMString, readonly, introduced
in DOM Level 3
An attribute specifying the encoding used for this
entity at the time of parsing, when it is an
external parsed entity. This is null if it an
entity from the internal subset or if it is not
known.
notationName of type [2121]DOMString, readonly
For unparsed entities, the name of the notation for
the entity. For parsed entities, this is null.
publicId of type [2122]DOMString, readonly
The public identifier associated with the entity if
specified, and null otherwise.
systemId of type [2123]DOMString, readonly
The system identifier associated with the entity if
specified, and null otherwise. This may be an
absolute URI or not.
xmlEncoding of type [2124]DOMString, readonly, introduced
in DOM Level 3
An attribute specifying, as part of the text
declaration, the encoding of this entity, when it
is an external parsed entity. This is null
otherwise.
xmlVersion of type [2125]DOMString, readonly, introduced in
DOM Level 3
An attribute specifying, as part of the text
declaration, the version number of this entity,
when it is an external parsed entity. This is null
otherwise.
Interface EntityReference
EntityReference nodes may be used to represent an entity
reference in the tree. Note that character references and
references to predefined entities are considered to be expanded
by the HTML or XML processor so that characters are represented
by their Unicode equivalent rather than by an entity reference.
Moreover, the XML processor may completely expand references to
entities while building the [2126]Document, instead of
providing EntityReference nodes. If it does provide such nodes,
then for an EntityReference node that represents a reference to
a known entity an [2127]Entity exists, and the subtree of the
EntityReference node is a copy of the [2128]Entity node
subtree. However, the latter may not be true when an entity
contains an unbound [2129]namespace prefix. In such a case,
because the namespace prefix resolution depends on where the
entity reference is, the [2130]descendants of the
EntityReference node may be bound to different [2131]namespace
URIs. When an EntityReference node represents a reference to an
unknown entity, the node has no children and its replacement
value, when used by [2132]Attr.value for example, is empty.
As for [2133]Entity nodes, EntityReference nodes and all their
[2134]descendants are [2135]readonly.
Note: EntityReference nodes may cause element content and
attribute value normalization problems when, such as in XML 1.0
and XML Schema, the normalization is performed after entity
reference are expanded.
IDL Definition
interface [2136]EntityReference : [2137]Node {
};
Interface ProcessingInstruction
The ProcessingInstruction interface represents a "processing
instruction", used in XML as a way to keep processor-specific
information in the text of the document.
No lexical check is done on the content of a processing
instruction and it is therefore possible to have the character
sequence "?>" in the content, which is illegal a processing
instruction per section 2.6 of [2138]XML 1.0]. The presence of
this character sequence must generate a fatal error during
serialization.
IDL Definition
interface [2139]ProcessingInstruction : [2140]Node {
readonly attribute [2141]DOMString [2142]target;
attribute [2143]DOMString [2144]data;
// raises([2145]DOMException) on settin
g
};
Attributes
data of type [2146]DOMString
The content of this processing instruction. This is
from the first non white space character after the
target to the character immediately preceding the
?>.
Exceptions on setting
[2147]DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
target of type [2148]DOMString, readonly
The target of this processing instruction. XML
defines this as being the first [2149]token
following the markup that begins the processing
instruction.
07 November 2003
Appendix A: Changes
Editor:
Philippe Le Hégaret, W3C
Table of contents
* [2150]A.1 New sections
* [2151]A.2 Changes to DOM Level 2 Core interfaces and exceptions
* [2152]A.3 New DOM features
* [2153]A.4 New types
* [2154]A.5 New interfaces
* [2155]A.6 Objects
This section summarizes the changes between [2156]DOM Level 2 Core]
and this new version of the Core specification.
A.1 New sections
The following new sections have been added:
* [2157]DOM Architecture: a global overview of the DOM Level 3
modules;
* [2158]DOM URIs: general considerations on the URI handling in DOM
Level 3;
* [2159]Base URIs: How the [base URI] property defined in [2160]XML
Information Set] has been exposed in DOM Level 3;
* [2161]Mixed DOM implementations: general considerations on DOM
implementation extensions;
* [2162]DOM Features: overview of the DOM features and how they
relate to the DOM modules;
* [2163]Bootstrapping: general introduction to the DOM Level 3
bootstrapping mechanisms;
* [2164]Namespaces Algorithms: how namespace URIs and prefixes are
resolved in DOM Level 3;
* [2165]Infoset mapping: relation between DOM Level 3 and [2166]XML
Information Set];
* [2167]Configuration Settings: relations between parameters as used
in [2168]DOMConfiguration;
A.2 Changes to DOM Level 2 Core interfaces and exceptions
Interface [2169]Attr
The [2170]Attr interface has two new attributes,
[2171]Attr.schemaTypeInfo, and [2172]Attr.isId.
Interface [2173]Document
The [2174]Document interface has seven new attributes:
[2175]Document.inputEncoding, [2176]Document.xmlEncoding,
[2177]Document.xmlStandalone, [2178]Document.xmlVersion,
[2179]Document.strictErrorChecking, [2180]Document.documentURI,
and [2181]Document.domConfig. It has three new methods:
[2182]Document.adoptNode(source),
[2183]Document.normalizeDocument(), and
[2184]Document.renameNode(n, namespaceURI, qualifiedName). The
attribute [2185]Document.doctype has been modified.
Exception [2186]DOMException
The [2187]DOMException has two new exception codes:
[2188]VALIDATION_ERR and [2189]TYPE_MISMATCH_ERR.
Interface [2190]DOMImplementation
The [2191]DOMImplementation interface has one new method,
[2192]DOMImplementation.getFeature(feature, version).
Interface [2193]Entity
The [2194]Document interface has three new attributes:
[2195]Entity.inputEncoding, [2196]Entity.xmlEncoding, and
[2197]Entity.xmlVersion.
Interface [2198]Element
The [2199]Element interface has one new attribute,
[2200]Element.schemaTypeInfo, and three new methods:
[2201]Element.setIdAttribute(name, isId),
[2202]Element.setIdAttributeNS(namespaceURI, localName, isId),
and [2203]Element.setIdAttributeNode(idAttr, isId).
Interface [2204]Node
The [2205]Node interface has two new attributes,
[2206]Node.baseURI and [2207]Node.textContent. It has nine new
methods: [2208]Node.compareDocumentPosition(other),
[2209]Node.isSameNode(other),
[2210]Node.lookupPrefix(namespaceURI),
[2211]Node.isDefaultNamespace(namespaceURI),
[2212]Node.lookupNamespaceURI(prefix),
[2213]Node.isEqualNode(arg), [2214]Node.getFeature(feature,
version), [2215]Node.setUserData(key, data, handler),
[2216]Node.getUserData(key). It introduced 6 new constants:
[2217]Node.DOCUMENT_POSITION_DISCONNECTED,
[2218]Node.DOCUMENT_POSITION_PRECEDING,
[2219]Node.DOCUMENT_POSITION_FOLLOWING,
[2220]Node.DOCUMENT_POSITION_CONTAINS,
[2221]Node.DOCUMENT_POSITION_CONTAINED_BY, and
[2222]Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC. The
methods [2223]Node.insertBefore(newChild, refChild),
[2224]Node.replaceChild(newChild, oldChild) and
[2225]Node.removeChild(oldChild) have been modified.
Interface [2226]Text
The [2227]Text interface has two new attributes,
[2228]Text.wholeText and [2229]Text.isElementContentWhitespace,
and one new method, [2230]Text.replaceWholeText(content).
A.3 New DOM features
"XMLVersion"
The "XMLVersion" DOM feature was introduced to represent if an
implementation is able to support [2231]XML 1.0] or [2232]XML
[1]. See [2233]Document.xmlVersion.
[1] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/copyright-notice.html
A.4 New types
[2234]DOMUserData
The [2235]DOMUserData type was added to the Core module.
[2236]DOMObject
The [2237]DOMObject type was added to the Core module.
A.5 New interfaces
[2238]DOMStringList
The [2239]DOMStringList interface has one attribute,
[2240]DOMStringList.length, and one method,
[2241]DOMStringList.item(index).
[2242]NameList
The [2243]NameList interface has one attribute,
[2244]NameList.length, and two methods,
[2245]NameList.getName(index) and
[2246]NameList.getNamespaceURI(index).
[2247]DOMImplementationList
The [2248]DOMImplementationList interface has one attribute,
[2249]DOMImplementationList.length, and one method,
[2250]DOMImplementationList.item(index).
[2251]DOMImplementationSource
The [2252]DOMImplementationSource interface has two methods,
[2253]DOMImplementationSource.getDOMImplementation(features),
and
[2254]DOMImplementationSource.getDOMImplementationList(features
).
[2255]TypeInfo
The [2256]TypeInfo interface has two attributes,
[2257]TypeInfo.typeName, and [2258]TypeInfo.typeNamespace.
[2259]UserDataHandler
The [2260]UserDataHandler interface has one method,
[2261]UserDataHandler.handle(operation, key, data, src, dst),
and four constants: [2262]UserDataHandler.NODE_CLONED,
[2263]UserDataHandler.NODE_IMPORTED,
[2264]UserDataHandler.NODE_DELETED, and
[2265]UserDataHandler.NODE_RENAMED.
[2266]DOMError
The [2267]DOMError interface has six attributes:
[2268]DOMError.severity, [2269]DOMError.message,
[2270]DOMError.type, [2271]DOMError.relatedException,
[2272]DOMError.relatedData, and [2273]DOMError.location. It has
four constants: [2274]DOMError.SEVERITY_WARNING,
[2275]DOMError.SEVERITY_ERROR, and
[2276]DOMError.SEVERITY_FATAL_ERROR.
[2277]DOMErrorHandler
The [2278]DOMErrorHandler interface has one method:
[2279]DOMErrorHandler.handleError(error).
[2280]DOMLocator
The [2281]DOMLocator interface has seven attributes:
[2282]DOMLocator.lineNumber, [2283]DOMLocator.columnNumber,
[2284]DOMLocator.byteOffset, [2285]DOMLocator.utf16Offset,
[2286]DOMLocator.relatedNode, [2287]DOMLocator.uri, and
[2288]DOMLocator.lineNumber.
[2289]DOMConfiguration
The [2290]DOMConfiguration interface has one attribute:
[2291]DOMConfiguration.parameterNames. It also has three
methods: [2292]DOMConfiguration.setParameter(name, value),
[2293]DOMConfiguration.getParameter(name), and
[2294]DOMConfiguration.canSetParameter(name, value).
A.6 Objects
This specification defines one object, only provided in the bindings:
DOMImplementationRegistry
The DOMImplementationRegistry object has two methods,
DOMImplementationRegistry.getDOMImplementation(features), and
DOMImplementationRegistry.getDOMImplementationList(features).
07 November 2003
Appendix B: Namespaces Algorithms
Editors:
Arnaud Le Hors, IBM
Elena Litani, IBM
Table of contents
* [2295]B.1 Namespace normalization
+ [2296]B.1.1 Scope of a binding
+ [2297]B.1.2 Conflicting namespace declaration
* [2298]B.2 Namespace Prefix Lookup
* [2299]B.3 Default Namespace Lookup
* [2300]B.4 Namespace URI Lookup
This appendix contains several namespace algorithms, such as namespace
normalization algorithm that fixes namespace information in the
Document Object Model to produce a [2301]namespace well-formed
document. If [2302]XML 1.0] is in use (see [2303]Document.xmlVersion)
the algorithms conform to [2304]XML Namespaces], otherwise if
[2305]XML 1.1] is in use, algorithms conform to [2306]XML Namespaces
1.1].
B.1 Namespace normalization
Namespace declaration attributes and prefixes are normalized as part
of the normalizeDocument method of the [2307]Document interface as if
the following method described in pseudo code was called on the
document element.
void Element.normalizeNamespaces()
{
// Pick up local namespace declarations
//
for ( all DOM Level 2 valid local namespace declaration attributes of Element
)
{
if (the namespace declaration is invalid)
{
// Note: The prefix xmlns is used only to declare namespace bindings
and
// is by definition bound to the namespace name http://www.w3.org/200
0/xmlns/.
// It must not be declared. No other prefix may be bound to this name
space name.
==> Report an error.
}
else
{
==> Record the namespace declaration
}
}
// Fixup element's namespace
//
if ( Element's namespaceURI != null )
{
if ( Element's prefix/namespace pair (or default namespace,
if no prefix) are within the scope of a binding )
{
==> do nothing, declaration in scope is inherited
See section "B.1.1: Scope of a binding" for an example
}
else
{
==> Create a local namespace declaration attr for this namespace,
with Element's current prefix (or a default namespace, if
no prefix). If there's a conflicting local declaration
already present, change its value to use this namespace.
See section "B.1.2: Conflicting namespace declaration" for an example
// NOTE that this may break other nodes within this Element's
// subtree, if they're already using this prefix.
// They will be repaired when we reach them.
}
}
else
{
// Element has no namespace URI:
if ( Element's localName is null )
{
// DOM Level 1 node
==> if in process of validation against a namespace aware schema
(i.e XML Schema) report a fatal error: the processor can not recover
in this situation.
Otherwise, report an error: no namespace fixup will be performed on
this node.
}
else
{
// Element has no pseudo-prefix
if ( there's a conflicting local default namespace declaration
already present )
{
==> change its value to use this empty namespace.
}
// NOTE that this may break other nodes within this Element's
// subtree, if they're already using the default namespaces.
// They will be repaired when we reach them.
}
}
// Examine and polish the attributes
//
for ( all non-namespace Attrs of Element )
{
if ( Attr[i] has a namespace URI )
{
if ( attribute has no prefix (default namespace decl does not apply to
attributes)
OR
attribute prefix is not declared
OR
conflict: attribute has a prefix that conflicts with a binding
already active in scope)
{
if (namespaceURI matches an in scope declaration of one or more pref
ixes)
{
// pick the most local binding available;
// if there is more than one pick one arbitrarily
==> change attribute's prefix.
}
else
{
if (the current prefix is not null and it has no in scope declar
ation)
{
==> declare this prefix
}
else
{
// find a prefix following the pattern "NS" +index (starting
at 1)
// make sure this prefix is not declared in the current scop
e.
// create a local namespace declaration attribute
==> change attribute's prefix.
}
}
}
}
else
{
// Attr[i] has no namespace URI
if ( Attr[i] has no localName )
{
// DOM Level 1 node
==> if in process of validation against a namespace aware schema
(i.e XML Schema) report a fatal error: the processor can not rec
over
in this situation.
Otherwise, report an error: no namespace fixup will be performe
d on this node.
}
else
{
// attr has no namespace URI and no prefix
// no action is required, since attrs don't use default
==> do nothing
}
}
} // end for-all-Attrs
// do this recursively
for ( all child elements of Element )
{
childElement.normalizeNamespaces()
}
} // end Element.normalizeNamespaces
B.1.1 Scope of a binding
Note: This section is informative.
An element's prefix/namespace URI pair is said to be within the scope
of a binding if its namespace prefix is bound to the same namespace
URI in the [in-scope namespaces] defined in [2308]XML Information
Set].
As an example, the following document is loaded in a DOM tree:
In the case of the child1 element, the namespace prefix and namespace
URI are within the scope of the appropriate namespace declaration
given that the namespace prefix ns of child1 is bound to
http://www.example.org/ns2.
Using the method [2309]Node.appendChild, a child2 element is added as
a sibling of child1 with the same namespace prefix and namespace URI,
i.e. "ns" and "http://www.example.org/ns2" respectively. Unlike child1
which contains the appropriate namespace declaration in its
attributes, child2's prefix/namespace URI pair is within the scope of
the namespace declaration of its parent, and the namespace prefix "ns"
is bound to "http://www.example.org/ns1". child2's prefix/namespace
URI pair is therefore not within the scope of a binding. In order to
put them within a scope of a binding, the namespace normalization
algorithm will create a namespace declaration attribute value to bind
the namespace prefix "ns" to the namespace URI
"http://www.example.org/ns2" and will attach to child2. The XML
representation of the document after the completion of the namespace
normalization algorithm will be:
To determine if an element is within the scope of a binding, one can
invoke [2310]Node.lookupNamespaceURI, using its namespace prefix as
the parameter, and compare the resulting namespace URI against the
desired URI, or one can invoke Node.isDefaultNamespaceURI using its
namespace URI if the element has no namespace prefix.
B.1.2 Conflicting namespace declaration
Note: This section is informative.
A conflicting namespace declaration could occur on an element if an
[2311]Element node and a namespace declaration attribute use the same
prefix but map them to two different namespace URIs.
As an example, the following document is loaded in a DOM tree:
Using the method Node.renameNode, the namespace URI of the element
child1 is renamed from "http://www.example.org/ns1" to
"http://www.example.org/ns2". The namespace prefix "ns" is now mapped
to two different namespace URIs at the element child1 level and thus
the namespace declaration is declared conflicting. The namespace
normalization algorithm will resolved the namespace prefix conflict by
modifying the namespace declaration attribute value from
"http://www.example.org/ns1" to "http://www.example.org/ns2". The
algorithm will then continue and consider the element child2, will no
longer find a namespace declaration mapping the namespace prefix "ns"
to "http://www.example.org/ns1" in the element's scope, and will
create a new one. The XML representation of the document after the
completion of the namespace normalization algorithm will be:
B.2 Namespace Prefix Lookup
The following describes in pseudo code the algorithm used in the
lookupPrefix method of the [2312]Node interface. Before returning
found prefix the algorithm needs to make sure that the prefix is not
redefined on an element from which the lookup started. This methods
ignores DOM Level 1 nodes.
Note: This method ignores all [2313]default namespace declarations. To
look up default namespace use isDefaultNamespace method.
DOMString lookupPrefix(in DOMString namespaceURI)
{
if (namespaceURI has no value, i.e. namespaceURI is null or empty string) {
return null;
}
short type = this.getNodeType();
switch (type) {
case Node.ELEMENT_NODE:
{
return lookupNamespacePrefix(namespaceURI, this);
}
case Node.DOCUMENT_NODE:
{
return getDocumentElement().lookupNamespacePrefix(namespaceURI);
}
case Node.ENTITY_NODE :
case Node.NOTATION_NODE:
case Node.DOCUMENT_FRAGMENT_NODE:
case Node.DOCUMENT_TYPE_NODE:
return null; // type is unknown
case Node.ATTRIBUTE_NODE:
{
if ( Attr has an owner Element )
{
return ownerElement.lookupNamespacePrefix(namespaceURI);
}
return null;
}
default:
{
if (Node has an ancestor Element )
// EntityReferences may have to be skipped to get to it
{
return ancestor.lookupNamespacePrefix(namespaceURI);
}
return null;
}
}
}
[2313] http://www.w3.org/TR/REC-xml-names/#NT-DefaultAttName
DOMString lookupNamespacePrefix(DOMString namespaceURI, Element originalElement
){
if ( Element has a namespace and Element's namespace == namespaceURI an
d
Element has a prefix and
originalElement.lookupNamespaceURI(Element's prefix) == namespaceU
RI)
{
return (Element's prefix);
}
if ( Element has attributes)
{
for ( all DOM Level 2 valid local namespace declaration attributes
of Element )
{
if (Attr's prefix == "xmlns" and
Attr's value == namespaceURI and
originalElement.lookupNamespaceURI(Attr's localname) == name
spaceURI)
{
return (Attr's localname);
}
}
}
if (Node has an ancestor Element )
// EntityReferences may have to be skipped to get to it
{
return ancestor.lookupNamespacePrefix(namespaceURI, originalElement
);
}
return null;
}
B.3 Default Namespace Lookup
The following describes in pseudo code the algorithm used in the
isDefaultNamespace method of the [2314]Node interface. This methods
ignores DOM Level 1 nodes.
boolean isDefaultNamespace(in DOMString namespaceURI)
{
switch (nodeType) {
case ELEMENT_NODE:
if ( Element has no prefix )
{
return (Element's namespace == namespaceURI);
}
if ( Element has attributes and there is a valid DOM Level 2
default namespace declaration, i.e. Attr's localName == "xmlns" )
{
return (Attr's value == namespaceURI);
}
if ( Element has an ancestor Element )
// EntityReferences may have to be skipped to get to it
{
return ancestorElement.isDefaultNamespace(namespaceURI);
}
else {
return unknown (false);
}
case DOCUMENT_NODE:
return documentElement.isDefaultNamespace(namespaceURI);
case ENTITY_NODE:
case NOTATION_NODE:
case DOCUMENT_TYPE_NODE:
case DOCUMENT_FRAGMENT_NODE:
return unknown (false);
case ATTRIBUTE_NODE:
if ( Attr has an owner Element )
{
return ownerElement.isDefaultNamespace(namespaceURI);
}
else {
return unknown (false);
}
default:
if ( Node has an ancestor Element )
// EntityReferences may have to be skipped to get to it
{
return ancestorElement.isDefaultNamespace(namespaceURI);
}
else {
return unknown (false);
}
}
}
B.4 Namespace URI Lookup
The following describes in pseudo code the algorithm used in the
lookupNamespaceURI method of the [2315]Node interface. This methods
ignores DOM Level 1 nodes.
DOMString lookupNamespaceURI(in DOMString prefix)
{
switch (nodeType) {
case ELEMENT_NODE:
{
if ( Element's namespace != null and Element's prefix == prefix )
{
// Note: prefix could be "null" in this case we are looking for
default namespace
return (Element's namespace);
}
if ( Element has attributes)
{
for ( all DOM Level 2 valid local namespace declaration attributes
of Element )
{
if (Attr's prefix == "xmlns" and Attr's localName == prefix )
// non default namespace
{
if (Attr's value is not empty)
{
return (Attr's value);
}
return unknown (null);
}
else if (Attr's localname == "xmlns" and prefix == null)
// default namespace
{
if (Attr's value is not empty)
{
return (Attr's value);
}
return unknown (null);
}
}
}
if ( Element has an ancestor Element )
// EntityReferences may have to be skipped to get to it
{
return ancestorElement.lookupNamespaceURI(prefix);
}
return null;
}
case DOCUMENT_NODE:
return documentElement.lookupNamespaceURI(prefix)
case ENTITY_NODE:
case NOTATION_NODE:
case DOCUMENT_TYPE_NODE:
case DOCUMENT_FRAGMENT_NODE:
return unknown (null);
case ATTRIBUTE_NODE:
if (Attr has an owner Element)
{
return ownerElement.lookupNamespaceURI(prefix);
}
else
{
return unknown (null);
}
default:
if (Node has an ancestor Element)
// EntityReferences may have to be skipped to get to it
{
return ancestorElement.lookupNamespaceURI(prefix);
}
else {
return unknown (null);
}
}
}
07 November 2003
Appendix E: Accessing code point boundaries
Mark Davis, IBM
Lauren Wood, SoftQuad Software Inc.
Table of contents
* [2316]E.1 Introduction
* [2317]E.2 Methods
+ [2318]StringExtend
E.1 Introduction
This appendix is an informative, not a normative, part of the Level 3
DOM specification.
Characters are represented in Unicode by numbers called code points
(also called scalar values). These numbers can range from 0 up to
1,114,111 = 10FFFF[16] (although some of these values are illegal).
Each code point can be directly encoded with a 32-bit code unit. This
encoding is termed UCS-4 (or UTF-32). The DOM specification, however,
uses UTF-16, in which the most frequent characters (which have values
less than FFFF[16]) are represented by a single 16-bit code unit,
while characters above FFFF[16] use a special pair of code units
called a surrogate pair. For more information, see [2319]Unicode] or
the Unicode Web site.
[16] http://www.w3.org/Consortium/Legal/ipr-notice#Copyright
[16] http://www.w3.org/Consortium/Legal/ipr-notice#Copyright
[16] http://www.w3.org/Consortium/Legal/ipr-notice#Copyright
While indexing by code points as opposed to code units is not common
in programs, some specifications such as [2320]XPath 1.0] (and
therefore XSLT and [2321]XPointer]) use code point indices. For
interfacing with such formats it is recommended that the programming
language provide string processing methods for converting code point
indices to code unit indices and back. Some languages do not provide
these functions natively; for these it is recommended that the native
String type that is bound to [2322]DOMString be extended to enable
this conversion. An example of how such an API might look is supplied
below.
Note: Since these methods are supplied as an illustrative example of
the type of functionality that is required, the names of the methods,
exceptions, and interface may differ from those given here.
E.2 Methods
Interface StringExtend
Extensions to a language's native String class or interface
IDL Definition
interface [2323]StringExtend {
int [2324]findOffset16(in int offset32)
raises(StringIndexOutOfBoundsException)
;
int [2325]findOffset32(in int offset16)
raises(StringIndexOutOfBoundsException)
;
};
Methods
findOffset16
Returns the UTF-16 offset that corresponds to a
UTF-32 offset. Used for random access.
Note: You can always round-trip from a UTF-32
offset to a UTF-16 offset and back. You can
round-trip from a UTF-16 offset to a UTF-32 offset
and back if and only if the offset16 is not in the
middle of a surrogate pair. Unmatched surrogates
count as a single UTF-16 value.
Parameters
offset32 of type int
UTF-32 offset.
Return Value
int
UTF-16 offset
Exceptions
StringIndexOutOfBoundsException
if offset32 is out of bounds.
findOffset32
Returns the UTF-32 offset corresponding to a UTF-16
offset. Used for random access. To find the UTF-32
length of a string, use:
len32 = findOffset32(source, source.length());
Note: If the UTF-16 offset is into the middle of a
surrogate pair, then the UTF-32 offset of the end
of the pair is returned; that is, the index of the
char after the end of the pair. You can always
round-trip from a UTF-32 offset to a UTF-16 offset
and back. You can round-trip from a UTF-16 offset
to a UTF-32 offset and back if and only if the
offset16 is not in the middle of a surrogate pair.
Unmatched surrogates count as a single UTF-16
value.
Parameters
offset16 of type int
UTF-16 offset
Return Value
int
UTF-32 offset
Exceptions
StringIndexOutOfBoundsException
if offset16 is out of bounds.
07 November 2003
Appendix F: IDL Definitions
This appendix contains the complete OMG IDL [2326]OMG IDL] for the
Level 3 Document Object Model Core definitions.
The IDL files are also available as:
[2327]http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/idl.zip
[2327] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/idl.zip
[2328]dom.idl:
[2328] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/idl/dom.idl
// File: dom.idl
#ifndef _DOM_IDL_
#define _DOM_IDL_
#pragma prefix "w3c.org"
module dom
{
valuetype [2329]DOMString sequence;
typedef unsigned long long [2330]DOMTimeStamp;
typedef any [2331]DOMUserData;
typedef Object [2332]DOMObject;
interface DOMImplementation;
interface DocumentType;
interface Document;
interface NodeList;
interface NamedNodeMap;
interface UserDataHandler;
interface Element;
interface TypeInfo;
interface DOMLocator;
exception [2333]DOMException {
unsigned short code;
};
// ExceptionCode
const unsigned short [2334]INDEX_SIZE_ERR = 1;
const unsigned short [2335]DOMSTRING_SIZE_ERR = 2;
const unsigned short [2336]HIERARCHY_REQUEST_ERR = 3;
const unsigned short [2337]WRONG_DOCUMENT_ERR = 4;
const unsigned short [2338]INVALID_CHARACTER_ERR = 5;
const unsigned short [2339]NO_DATA_ALLOWED_ERR = 6;
const unsigned short [2340]NO_MODIFICATION_ALLOWED_ERR = 7;
const unsigned short [2341]NOT_FOUND_ERR = 8;
const unsigned short [2342]NOT_SUPPORTED_ERR = 9;
const unsigned short [2343]INUSE_ATTRIBUTE_ERR = 10;
// Introduced in DOM Level 2:
const unsigned short [2344]INVALID_STATE_ERR = 11;
// Introduced in DOM Level 2:
const unsigned short [2345]SYNTAX_ERR = 12;
// Introduced in DOM Level 2:
const unsigned short [2346]INVALID_MODIFICATION_ERR = 13;
// Introduced in DOM Level 2:
const unsigned short [2347]NAMESPACE_ERR = 14;
// Introduced in DOM Level 2:
const unsigned short [2348]INVALID_ACCESS_ERR = 15;
// Introduced in DOM Level 3:
const unsigned short [2349]VALIDATION_ERR = 16;
// Introduced in DOM Level 3:
const unsigned short [2350]TYPE_MISMATCH_ERR = 17;
// Introduced in DOM Level 3:
interface [2351]DOMStringList {
[2352]DOMString [2353]item(in unsigned long index);
readonly attribute unsigned long [2354]length;
boolean [2355]contains(in [2356]DOMString str);
};
// Introduced in DOM Level 3:
interface [2357]NameList {
[2358]DOMString [2359]getName(in unsigned long index);
[2360]DOMString [2361]getNamespaceURI(in unsigned long index);
readonly attribute unsigned long [2362]length;
boolean [2363]contains(in [2364]DOMString name);
boolean [2365]containsNS(in [2366]DOMString namespaceURI,
in [2367]DOMString name);
};
// Introduced in DOM Level 3:
interface [2368]DOMImplementationList {
[2369]DOMImplementation [2370]item(in unsigned long index);
readonly attribute unsigned long [2371]length;
};
// Introduced in DOM Level 3:
interface [2372]DOMImplementationSource {
[2373]DOMImplementation [2374]getDOMImplementation(in [2375]DOMString feat
ures);
[2376]DOMImplementationList [2377]getDOMImplementationList(in [2378]DOMStri
ng features);
};
interface [2379]DOMImplementation {
boolean [2380]hasFeature(in [2381]DOMString feature,
in [2382]DOMString version);
// Introduced in DOM Level 2:
[2383]DocumentType [2384]createDocumentType(in [2385]DOMString qualif
iedName,
in [2386]DOMString publicId,
in [2387]DOMString systemId)
raises([2388]DOMException);
// Introduced in DOM Level 2:
[2389]Document [2390]createDocument(in [2391]DOMString namespaceU
RI,
in [2392]DOMString qualifiedName,
in [2393]DocumentType doctype)
raises([2394]DOMException);
// Introduced in DOM Level 3:
[2395]DOMObject [2396]getFeature(in [2397]DOMString feature,
in [2398]DOMString version);
};
interface [2399]Node {
// NodeType
const unsigned short [2400]ELEMENT_NODE = 1;
const unsigned short [2401]ATTRIBUTE_NODE = 2;
const unsigned short [2402]TEXT_NODE = 3;
const unsigned short [2403]CDATA_SECTION_NODE = 4;
const unsigned short [2404]ENTITY_REFERENCE_NODE = 5;
const unsigned short [2405]ENTITY_NODE = 6;
const unsigned short [2406]PROCESSING_INSTRUCTION_NODE = 7;
const unsigned short [2407]COMMENT_NODE = 8;
const unsigned short [2408]DOCUMENT_NODE = 9;
const unsigned short [2409]DOCUMENT_TYPE_NODE = 10;
const unsigned short [2410]DOCUMENT_FRAGMENT_NODE = 11;
const unsigned short [2411]NOTATION_NODE = 12;
readonly attribute [2412]DOMString [2413]nodeName;
attribute [2414]DOMString [2415]nodeValue;
// raises([2416]DOMException) on settin
g
// raises([2417]DOMException) on retrie
val
readonly attribute unsigned short [2418]nodeType;
readonly attribute [2419]Node [2420]parentNode;
readonly attribute [2421]NodeList [2422]childNodes;
readonly attribute [2423]Node [2424]firstChild;
readonly attribute [2425]Node [2426]lastChild;
readonly attribute [2427]Node [2428]previousSibling;
readonly attribute [2429]Node [2430]nextSibling;
readonly attribute [2431]NamedNodeMap [2432]attributes;
// Modified in DOM Level 2:
readonly attribute [2433]Document [2434]ownerDocument;
// Modified in DOM Level 3:
[2435]Node [2436]insertBefore(in [2437]Node newChild,
in [2438]Node refChild)
raises([2439]DOMException);
// Modified in DOM Level 3:
[2440]Node [2441]replaceChild(in [2442]Node newChild,
in [2443]Node oldChild)
raises([2444]DOMException);
// Modified in DOM Level 3:
[2445]Node [2446]removeChild(in [2447]Node oldChild)
raises([2448]DOMException);
[2449]Node [2450]appendChild(in [2451]Node newChild)
raises([2452]DOMException);
boolean [2453]hasChildNodes();
[2454]Node [2455]cloneNode(in boolean deep);
// Modified in DOM Level 3:
void [2456]normalize();
// Introduced in DOM Level 2:
boolean [2457]isSupported(in [2458]DOMString feature,
in [2459]DOMString version);
// Introduced in DOM Level 2:
readonly attribute [2460]DOMString [2461]namespaceURI;
// Introduced in DOM Level 2:
attribute [2462]DOMString [2463]prefix;
// raises([2464]DOMException) on settin
g
// Introduced in DOM Level 2:
readonly attribute [2465]DOMString [2466]localName;
// Introduced in DOM Level 2:
boolean [2467]hasAttributes();
// Introduced in DOM Level 3:
readonly attribute [2468]DOMString [2469]baseURI;
// DocumentPosition
const unsigned short [2470]DOCUMENT_POSITION_DISCONNECTED = 0x01;
const unsigned short [2471]DOCUMENT_POSITION_PRECEDING = 0x02;
const unsigned short [2472]DOCUMENT_POSITION_FOLLOWING = 0x04;
const unsigned short [2473]DOCUMENT_POSITION_CONTAINS = 0x08;
const unsigned short [2474]DOCUMENT_POSITION_CONTAINED_BY = 0x10;
const unsigned short [2475]DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC =
0x20;
// Introduced in DOM Level 3:
unsigned short [2476]compareDocumentPosition(in [2477]Node other)
raises([2478]DOMException);
// Introduced in DOM Level 3:
attribute [2479]DOMString [2480]textContent;
// raises([2481]DOMException) on settin
g
// raises([2482]DOMException) on retrie
val
// Introduced in DOM Level 3:
boolean [2483]isSameNode(in [2484]Node other);
// Introduced in DOM Level 3:
[2485]DOMString [2486]lookupPrefix(in [2487]DOMString namespaceURI
);
// Introduced in DOM Level 3:
boolean [2488]isDefaultNamespace(in [2489]DOMString namespaceURI
);
// Introduced in DOM Level 3:
[2490]DOMString [2491]lookupNamespaceURI(in [2492]DOMString prefix
);
// Introduced in DOM Level 3:
boolean [2493]isEqualNode(in [2494]Node arg);
// Introduced in DOM Level 3:
[2495]DOMObject [2496]getFeature(in [2497]DOMString feature,
in [2498]DOMString version);
// Introduced in DOM Level 3:
[2499]DOMUserData [2500]setUserData(in [2501]DOMString key,
in [2502]DOMUserData data,
in [2503]UserDataHandler handler);
// Introduced in DOM Level 3:
[2504]DOMUserData [2505]getUserData(in [2506]DOMString key);
};
interface [2507]NodeList {
[2508]Node [2509]item(in unsigned long index);
readonly attribute unsigned long [2510]length;
};
interface [2511]NamedNodeMap {
[2512]Node [2513]getNamedItem(in [2514]DOMString name);
[2515]Node [2516]setNamedItem(in [2517]Node arg)
raises([2518]DOMException);
[2519]Node [2520]removeNamedItem(in [2521]DOMString name)
raises([2522]DOMException);
[2523]Node [2524]item(in unsigned long index);
readonly attribute unsigned long [2525]length;
// Introduced in DOM Level 2:
[2526]Node [2527]getNamedItemNS(in [2528]DOMString namespaceU
RI,
in [2529]DOMString localName)
raises([2530]DOMException);
// Introduced in DOM Level 2:
[2531]Node [2532]setNamedItemNS(in [2533]Node arg)
raises([2534]DOMException);
// Introduced in DOM Level 2:
[2535]Node [2536]removeNamedItemNS(in [2537]DOMString namespa
ceURI,
in [2538]DOMString localName)
raises([2539]DOMException);
};
interface [2540]CharacterData : [2541]Node {
attribute [2542]DOMString [2543]data;
// raises([2544]DOMException) on settin
g
// raises([2545]DOMException) on retrie
val
readonly attribute unsigned long [2546]length;
[2547]DOMString [2548]substringData(in unsigned long offset,
in unsigned long count)
raises([2549]DOMException);
void [2550]appendData(in [2551]DOMString arg)
raises([2552]DOMException);
void [2553]insertData(in unsigned long offset,
in [2554]DOMString arg)
raises([2555]DOMException);
void [2556]deleteData(in unsigned long offset,
in unsigned long count)
raises([2557]DOMException);
void [2558]replaceData(in unsigned long offset,
in unsigned long count,
in [2559]DOMString arg)
raises([2560]DOMException);
};
interface [2561]Attr : [2562]Node {
readonly attribute [2563]DOMString [2564]name;
readonly attribute boolean [2565]specified;
attribute [2566]DOMString [2567]value;
// raises([2568]DOMException) on settin
g
// Introduced in DOM Level 2:
readonly attribute [2569]Element [2570]ownerElement;
// Introduced in DOM Level 3:
readonly attribute [2571]TypeInfo [2572]schemaTypeInfo;
// Introduced in DOM Level 3:
readonly attribute boolean [2573]isId;
};
interface [2574]Element : [2575]Node {
readonly attribute [2576]DOMString [2577]tagName;
[2578]DOMString [2579]getAttribute(in [2580]DOMString name);
void [2581]setAttribute(in [2582]DOMString name,
in [2583]DOMString value)
raises([2584]DOMException);
void [2585]removeAttribute(in [2586]DOMString name)
raises([2587]DOMException);
[2588]Attr [2589]getAttributeNode(in [2590]DOMString name);
[2591]Attr [2592]setAttributeNode(in [2593]Attr newAttr)
raises([2594]DOMException);
[2595]Attr [2596]removeAttributeNode(in [2597]Attr oldAttr)
raises([2598]DOMException);
[2599]NodeList [2600]getElementsByTagName(in [2601]DOMString name
);
// Introduced in DOM Level 2:
[2602]DOMString [2603]getAttributeNS(in [2604]DOMString namespaceU
RI,
in [2605]DOMString localName)
raises([2606]DOMException);
// Introduced in DOM Level 2:
void [2607]setAttributeNS(in [2608]DOMString namespaceURI,
in [2609]DOMString qualifiedName,
in [2610]DOMString value)
raises([2611]DOMException);
// Introduced in DOM Level 2:
void [2612]removeAttributeNS(in [2613]DOMString namespaceURI,
in [2614]DOMString localName)
raises([2615]DOMException);
// Introduced in DOM Level 2:
[2616]Attr [2617]getAttributeNodeNS(in [2618]DOMString namesp
aceURI,
in [2619]DOMString localName)
raises([2620]DOMException);
// Introduced in DOM Level 2:
[2621]Attr [2622]setAttributeNodeNS(in [2623]Attr newAttr)
raises([2624]DOMException);
// Introduced in DOM Level 2:
[2625]NodeList [2626]getElementsByTagNameNS(in [2627]DOMString na
mespaceURI,
in [2628]DOMString localName)
raises([2629]DOMException);
// Introduced in DOM Level 2:
boolean [2630]hasAttribute(in [2631]DOMString name);
// Introduced in DOM Level 2:
boolean [2632]hasAttributeNS(in [2633]DOMString namespaceURI,
in [2634]DOMString localName)
raises([2635]DOMException);
// Introduced in DOM Level 3:
readonly attribute [2636]TypeInfo [2637]schemaTypeInfo;
// Introduced in DOM Level 3:
void [2638]setIdAttribute(in [2639]DOMString name,
in boolean isId)
raises([2640]DOMException);
// Introduced in DOM Level 3:
void [2641]setIdAttributeNS(in [2642]DOMString namespaceURI,
in [2643]DOMString localName,
in boolean isId)
raises([2644]DOMException);
// Introduced in DOM Level 3:
void [2645]setIdAttributeNode(in [2646]Attr idAttr,
in boolean isId)
raises([2647]DOMException);
};
interface [2648]Text : [2649]CharacterData {
[2650]Text [2651]splitText(in unsigned long offset)
raises([2652]DOMException);
// Introduced in DOM Level 3:
readonly attribute boolean [2653]isElementContentWhitespace;
// Introduced in DOM Level 3:
readonly attribute [2654]DOMString [2655]wholeText;
// Introduced in DOM Level 3:
[2656]Text [2657]replaceWholeText(in [2658]DOMString content)
raises([2659]DOMException);
};
interface [2660]Comment : [2661]CharacterData {
};
// Introduced in DOM Level 3:
interface [2662]TypeInfo {
readonly attribute [2663]DOMString [2664]typeName;
readonly attribute [2665]DOMString [2666]typeNamespace;
// DerivationMethods
const unsigned long [2667]DERIVATION_RESTRICTION = 0x00000001
;
const unsigned long [2668]DERIVATION_EXTENSION = 0x00000002
;
const unsigned long [2669]DERIVATION_UNION = 0x00000004
;
const unsigned long [2670]DERIVATION_LIST = 0x00000008
;
boolean [2671]isDerivedFrom(in [2672]DOMString typeNamespaceArg,
in [2673]DOMString typeNameArg,
in unsigned long derivationMethod);
};
// Introduced in DOM Level 3:
interface [2674]UserDataHandler {
// OperationType
const unsigned short [2675]NODE_CLONED = 1;
const unsigned short [2676]NODE_IMPORTED = 2;
const unsigned short [2677]NODE_DELETED = 3;
const unsigned short [2678]NODE_RENAMED = 4;
const unsigned short [2679]NODE_ADOPTED = 5;
void [2680]handle(in unsigned short operation,
in [2681]DOMString key,
in [2682]DOMUserData data,
in [2683]Node src,
in [2684]Node dst);
};
// Introduced in DOM Level 3:
interface [2685]DOMError {
// ErrorSeverity
const unsigned short [2686]SEVERITY_WARNING = 1;
const unsigned short [2687]SEVERITY_ERROR = 2;
const unsigned short [2688]SEVERITY_FATAL_ERROR = 3;
readonly attribute unsigned short [2689]severity;
readonly attribute [2690]DOMString [2691]message;
readonly attribute [2692]DOMString [2693]type;
readonly attribute Object [2694]relatedException;
readonly attribute [2695]DOMObject [2696]relatedData;
readonly attribute [2697]DOMLocator [2698]location;
};
// Introduced in DOM Level 3:
interface [2699]DOMErrorHandler {
boolean [2700]handleError(in [2701]DOMError error);
};
// Introduced in DOM Level 3:
interface [2702]DOMLocator {
readonly attribute long [2703]lineNumber;
readonly attribute long [2704]columnNumber;
readonly attribute long [2705]byteOffset;
readonly attribute long [2706]utf16Offset;
readonly attribute [2707]Node [2708]relatedNode;
readonly attribute [2709]DOMString [2710]uri;
};
// Introduced in DOM Level 3:
interface [2711]DOMConfiguration {
void [2712]setParameter(in [2713]DOMString name,
in [2714]DOMUserData value)
raises([2715]DOMException);
[2716]DOMUserData [2717]getParameter(in [2718]DOMString name)
raises([2719]DOMException);
boolean [2720]canSetParameter(in [2721]DOMString name,
in [2722]DOMUserData value);
readonly attribute [2723]DOMStringList [2724]parameterNames;
};
interface [2725]CDATASection : [2726]Text {
};
interface [2727]DocumentType : [2728]Node {
readonly attribute [2729]DOMString [2730]name;
readonly attribute [2731]NamedNodeMap [2732]entities;
readonly attribute [2733]NamedNodeMap [2734]notations;
// Introduced in DOM Level 2:
readonly attribute [2735]DOMString [2736]publicId;
// Introduced in DOM Level 2:
readonly attribute [2737]DOMString [2738]systemId;
// Introduced in DOM Level 2:
readonly attribute [2739]DOMString [2740]internalSubset;
};
interface [2741]Notation : [2742]Node {
readonly attribute [2743]DOMString [2744]publicId;
readonly attribute [2745]DOMString [2746]systemId;
};
interface [2747]Entity : [2748]Node {
readonly attribute [2749]DOMString [2750]publicId;
readonly attribute [2751]DOMString [2752]systemId;
readonly attribute [2753]DOMString [2754]notationName;
// Introduced in DOM Level 3:
readonly attribute [2755]DOMString [2756]inputEncoding;
// Introduced in DOM Level 3:
readonly attribute [2757]DOMString [2758]xmlEncoding;
// Introduced in DOM Level 3:
readonly attribute [2759]DOMString [2760]xmlVersion;
};
interface [2761]EntityReference : [2762]Node {
};
interface [2763]ProcessingInstruction : [2764]Node {
readonly attribute [2765]DOMString [2766]target;
attribute [2767]DOMString [2768]data;
// raises([2769]DOMException) on settin
g
};
interface [2770]DocumentFragment : [2771]Node {
};
interface [2772]Document : [2773]Node {
// Modified in DOM Level 3:
readonly attribute [2774]DocumentType [2775]doctype;
readonly attribute [2776]DOMImplementation [2777]implementation;
readonly attribute [2778]Element [2779]documentElement;
[2780]Element [2781]createElement(in [2782]DOMString tagName)
raises([2783]DOMException);
[2784]DocumentFragment [2785]createDocumentFragment();
[2786]Text [2787]createTextNode(in [2788]DOMString data);
[2789]Comment [2790]createComment(in [2791]DOMString data);
[2792]CDATASection [2793]createCDATASection(in [2794]DOMString data)
raises([2795]DOMException);
[2796]ProcessingInstruction [2797]createProcessingInstruction(in [2798]DOMS
tring target,
in [2799]DOMString data)
raises([2800]DOMException);
[2801]Attr [2802]createAttribute(in [2803]DOMString name)
raises([2804]DOMException);
[2805]EntityReference [2806]createEntityReference(in [2807]DOMString nam
e)
raises([2808]DOMException);
[2809]NodeList [2810]getElementsByTagName(in [2811]DOMString tagn
ame);
// Introduced in DOM Level 2:
[2812]Node [2813]importNode(in [2814]Node importedNode,
in boolean deep)
raises([2815]DOMException);
// Introduced in DOM Level 2:
[2816]Element [2817]createElementNS(in [2818]DOMString namespace
URI,
in [2819]DOMString qualifiedName)
raises([2820]DOMException);
// Introduced in DOM Level 2:
[2821]Attr [2822]createAttributeNS(in [2823]DOMString namespa
ceURI,
in [2824]DOMString qualifiedName)
raises([2825]DOMException);
// Introduced in DOM Level 2:
[2826]NodeList [2827]getElementsByTagNameNS(in [2828]DOMString na
mespaceURI,
in [2829]DOMString localName);
// Introduced in DOM Level 2:
[2830]Element [2831]getElementById(in [2832]DOMString elementId)
;
// Introduced in DOM Level 3:
readonly attribute [2833]DOMString [2834]inputEncoding;
// Introduced in DOM Level 3:
readonly attribute [2835]DOMString [2836]xmlEncoding;
// Introduced in DOM Level 3:
attribute boolean [2837]xmlStandalone;
// raises([2838]DOMException) on settin
g
// Introduced in DOM Level 3:
attribute [2839]DOMString [2840]xmlVersion;
// raises([2841]DOMException) on settin
g
// Introduced in DOM Level 3:
attribute boolean [2842]strictErrorChecking;
// Introduced in DOM Level 3:
attribute [2843]DOMString [2844]documentURI;
// Introduced in DOM Level 3:
[2845]Node [2846]adoptNode(in [2847]Node source)
raises([2848]DOMException);
// Introduced in DOM Level 3:
readonly attribute [2849]DOMConfiguration [2850]domConfig;
// Introduced in DOM Level 3:
void [2851]normalizeDocument();
// Introduced in DOM Level 3:
[2852]Node [2853]renameNode(in [2854]Node n,
in [2855]DOMString namespaceURI,
in [2856]DOMString qualifiedName)
raises([2857]DOMException);
};
};
#endif // _DOM_IDL_
07 November 2003
Appendix D: Configuration Settings
Editor:
Elena Litani, IBM
D.1 Configuration Scenarios
Using the [2858]DOMConfiguration users can change behavior of the
DOMParser, DOMSerializer and [2859]Document.normalizeDocument(). If a
DOM implementation supports XML Schemas and DTD validation, the table
below defines behavior of such implementation following various
parameter settings on the [2860]DOMConfiguration. Errors are
effectively reported only if a [2861]DOMErrorHandler object is
attached to the "[2862]error-handler" parameter.
"[2863]schema-type" "[2864]validate" "[2865]validate-if-schema"
Instance schemas, i.e. the current schema Outcome Other parameters
null true false DTD and XML Schema Implementation dependent The
outcome of setting the "[2866]datatype-normalization",
"[2867]element-content-whitespace" or "[2868]namespaces" parameters to
true or false is implementation dependent.
false true
null true false none Report an error Setting the
"[2869]datatype-normalization" to true or false has no effect on the
DOM.
false true No error is reported
null true false DTD Validate against DTD Setting the
"[2870]datatype-normalization" to true or false has no effect on the
DOM.
false true
null true false XML Schema Validate against XML Schema The outcome of
setting the "[2871]namespaces" to false is implementation dependent
(likely to be an error). Setting the
"[2872]element-content-whitespace" to false does not have any effect
on the DOM.
false true
"http://www.w3.org/TR/REC-xml" true false DTD or XML Schema or both If
DTD is found, validate against DTD. Otherwise, report an error.
Setting the "[2873]datatype-normalization" to true or false has no
effect on the DOM.
false true If DTD is found, validate against DTD.
"http://www.w3.org/2001/XMLSchema" true false DTD or XML Schema or
both If XML Schema is found, validate against the schema. Otherwise,
report an error. Setting the "[2874]datatype-normalization" to true
exposes XML Schema [2875]normalized values in the DOM. The outcome of
setting the "[2876]namespaces" to false is implementation dependent
(likely to be an error).
false true If XML Schema is found, validate against the schema.
"http://www.w3.org/2001/XMLSchema" or "http://www.w3.org/TR/REC-xml"
false false DTD or XML Schema or both If XML Schema is found, it is
ignored. DOM implementations [2877]may use information available in
the DTD to perform [2878]entity resolution. Setting the
"[2879]datatype-normalization" to true of false has no effect on the
DOM.
[2875] http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/#key-nv
[2877] http://www.w3.org/TR/2000/REC-xml-20001006#proc-types
[2878] http://www.w3.org/TR/2000/REC-xml-20001006#intern-replacement
Note: If an error has to be reported, as specified in the "Outcome"
column above, the [2880]DOMError.type is "no-schema-available".
07 November 2003
Appendix C: Infoset mapping
Editor:
Philippe Le Hégaret, W3C
Table of contents
* [2881]C.1 Document node mapping
+ [2882]C.1.1 Infoset to Document node
+ [2883]C.1.2 Document node to Infoset
* [2884]C.2 Element node mapping
+ [2885]C.2.1 Infoset to Element node
+ [2886]C.2.2 Element node to Infoset
* [2887]C.3 Attr node mapping
+ [2888]C.3.1 Infoset to Attr node
+ [2889]C.3.2 Attr node to Infoset
* [2890]C.4 ProcessingInstruction node mapping
+ [2891]C.4.1 Infoset to ProcessingInstruction node
+ [2892]C.4.2 ProcessingInstruction node to Infoset
* [2893]C.5 EntityReference node mapping
+ [2894]C.5.1 Infoset to EntityReference node
+ [2895]C.5.2 EntityReference node to Infoset
* [2896]C.6 Text and CDATASection nodes mapping
+ [2897]C.6.1 Infoset to Text node
+ [2898]C.6.2 Text and CDATASection nodes to Infoset
* [2899]C.7 Comment node mapping
+ [2900]C.7.1 Infoset to Comment node
+ [2901]C.7.2 Comment node to Infoset
* [2902]C.8 DocumentType node mapping
+ [2903]C.8.1 Infoset to DocumentType node
+ [2904]C.8.2 DocumentType node to Infoset
* [2905]C.9 Entity node mapping
+ [2906]C.9.1 Infoset to Entity node
+ [2907]C.9.2 Entity node to Infoset
* [2908]C.10 Notation node mapping
+ [2909]C.10.1 Infoset to Notation node
+ [2910]C.10.2 Notation node to Infoset
This appendix contains the mappings between the XML Information Set
[2911]XML Information Set] model and the Document Object Model.
Starting from a [2912]Document node, each information item is mapped
to its respective [2913]Node, and each [2914]Node is mapped to its
respective information item. As used in the Infoset specification, the
Infoset property names are shown in square brackets, [thus].
Unless specified, the Infoset to DOM node mapping makes no distinction
between unknown and no value since both will be exposed as null (or
false if the DOM attribute is of type boolean).
C.1 Document node mapping
C.1.1 Infoset to Document node
An document information item maps to a [2915]Document node. The
attributes of the corresponding [2916]Document node are constructed as
follows:
Attribute Value
[2917]Node.nodeName "#document"
[2918]Node.nodeValue null
[2919]Node.nodeType [2920]Node.DOCUMENT_NODE
[2921]Node.parentNode null
[2922]Node.childNodes A [2923]NodeList containing the information
items in the [children] property.
[2924]Node.firstChild The first node contained in
[2925]Node.childNodes
[2926]Node.lastChild The last node contained in [2927]Node.childNodes
[2928]Node.previousSibling null
[2929]Node.nextSibling null
[2930]Node.attributes null
[2931]Node.ownerDocument null
[2932]Node.namespaceURI null
[2933]Node.prefix null
[2934]Node.localName null
[2935]Node.baseURI same as [2936]Document.documentURI
[2937]Node.textContent null
[2938]Document.doctype The document type information item
[2939]Document.implementation The [2940]DOMImplementation object used
to create this node
[2941]Document.documentElement The [document element] property
[2942]Document.inputEncoding The [character encoding scheme] property
[2943]Document.xmlEncoding null
[2944]Document.xmlStandalone The [standalone] property, or false if
the latter has no value.
[2945]Document.xmlVersion The [version] property, or "1.0" if the
latter has no value.
[2946]Document.strictErrorChecking true
[2947]Document.documentURI The [base URI] property
[2948]Document.domConfig A [2949]DOMConfiguration object whose
parameters are set to their default values
Note: The [all declarations processed] property is not exposed through
the [2950]Document node.
C.1.2 Document node to Infoset
A [2951]Document node maps to an document information item.
[2952]Document nodes with no namespace URI ([2953]Node.namespaceURI
equals to null) cannot be represented using the Infoset. The
properties of the corresponding document information item are
constructed as follows:
Property Value
[children] [2954]Node.childNodes
[document element] [2955]Document.documentElement
[notations] Document.doctype.notations
[unparsed entities] The information items from
Document.doctype.entities, whose [2956]Node.childNodes is an empty
list
[base URI] [2957]Document.documentURI
[character encoding scheme] [2958]Document.inputEncoding
[standalone] [2959]Document.xmlStandalone
[version] [2960]Document.xmlVersion
[all declarations processed] The value is implementation dependent
C.2 Element node mapping
C.2.1 Infoset to Element node
An element information item maps to a [2961]Element node. The
attributes of the corresponding [2962]Element node are constructed as
follows:
Attribute Value
[2963]Node.nodeName same as [2964]Element.tagName
[2965]Node.nodeValue null
[2966]Node.nodeType [2967]Node.ELEMENT_NODE
[2968]Node.parentNode The [parent] property
[2969]Node.childNodes A [2970]NodeList containing the information
items in the [children] property
[2971]Node.firstChild The first node contained in
[2972]Node.childNodes
[2973]Node.lastChild The last node contained in [2974]Node.childNodes
[2975]Node.previousSibling The information item preceding the current
one on the [children] property contained in the [parent] property
[2976]Node.nextSibling The information item following the current one
on the [children] property contained in the [parent] property
[2977]Node.attributes The information items contained in the
[attributes] and [namespace attributes] properties
[2978]Node.ownerDocument The document information item
[2979]Node.namespaceURI The [namespace name] property
[2980]Node.prefix The [prefix] property
[2981]Node.localName The [local name] property
[2982]Node.baseURI The [base URI] property
[2983]Node.textContent Concatenation of the [2984]Node.textContent
attribute value of every child node, excluding COMMENT_NODE and
PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the
node has no children.
[2985]Element.tagName If the [prefix] property has no value, this
contains the [local name] property. Otherwise, this contains the
concatenation of the [prefix] property, the colon ':' character, and
the [local name] property.
[2986]Element.schemaTypeInfo A [2987]TypeInfo object whose
[2988]TypeInfo.typeNamespace and [2989]TypeInfo.typeName are inferred
from the schema in use if available.
Note: The [in-scope namespaces] property is not exposed through the
[2990]Element node.
C.2.2 Element node to Infoset
An [2991]Element node maps to an element information item. Because the
Infoset only represents unexpanded entity references, non-empty
[2992]EntityReference nodes contained in [2993]Node.childNodes need to
be replaced by their content. DOM applications could use the
[2994]Document.normalizeDocument() method for that effect with the
"[2995]entities" parameter set to false. The properties of the
corresponding element information item are constructed as follows:
Property Value
[namespace name] [2996]Node.namespaceURI
[local name] [2997]Node.localName
[prefix] [2998]Node.prefix
[children] [2999]Node.childNodes, whose expanded entity references
([3000]EntityReference nodes with children) have been replaced with
their content.
[attributes] The nodes contained in [3001]Node.attributes, whose
[3002]Node.namespaceURI value is different from
"http://www.w3.org/2000/xmlns/"
[namespace attributes] The nodes contained in [3003]Node.attributes,
whose [3004]Node.namespaceURI value is "http://www.w3.org/2000/xmlns/"
[in-scope namespaces] The namespace information items computed using
the [namespace attributes] properties of this node and its ancestors.
If the [3005]DOM Level 3 XPath] module is supported, the namespace
information items can also be computed from the XPathNamespace nodes.
[base URI] [3006]Node.baseURI
[parent] [3007]Node.parentNode
C.3 Attr node mapping
C.3.1 Infoset to Attr node
An attribute information item map to a [3008]Attr node. The attributes
of the corresponding [3009]Attr node are constructed as follows:
Attribute/Method Value
[3010]Node.nodeName same as [3011]Attr.name
[3012]Node.nodeValue same as [3013]Attr.value
[3014]Node.nodeType [3015]Node.ATTRIBUTE_NODE
[3016]Node.parentNode null
[3017]Node.childNodes A [3018]NodeList containing one [3019]Text node
whose text content is the same as [3020]Attr.value.
[3021]Node.firstChild The [3022]Text node contained in
[3023]Node.childNodes
[3024]Node.lastChild The [3025]Text node contained in
[3026]Node.childNodes
[3027]Node.previousSibling null
[3028]Node.nextSibling null
[3029]Node.attributes null
[3030]Node.ownerDocument The document information item
[3031]Node.namespaceURI The [namespace name] property
[3032]Node.prefix The [prefix] property
[3033]Node.localName The [local name] property
[3034]Node.baseURI The [base URI] property of the parent element if
any
[3035]Node.textContent the value of [3036]Node.textContent of the
[3037]Text child. same as [3038]Node.nodeValue (since this attribute
node only contains one [3039]Text node)
[3040]Attr.name If the [prefix] property has no value, this contains
the [local name] property. Otherwise, this contains the concatenation
of the [prefix] property, the colon ':' character, and the [local
name] property.
[3041]Attr.specified The [specified] property
[3042]Attr.value The [normalized value] property
[3043]Attr.ownerElement The [owner element] property
[3044]Attr.schemaTypeInfo A [3045]TypeInfo object whose
[3046]TypeInfo.typeNamespace is null and [3047]TypeInfo.typeName is
the [attribute type] property
[3048]Attr.isId if the [attribute type] property is ID, this method
return true
C.3.2 Attr node to Infoset
An [3049]Attr node maps to an attribute information item. [3050]Attr
nodes with no namespace URI ([3051]Node.namespaceURI equals to null)
cannot be represented using the Infoset. The properties of the
corresponding attribute information item are constructed as follows:
Property Value
[namespace name] [3052]Node.namespaceURI
[local name] [3053]Node.localName
[prefix] [3054]Node.prefix
[normalized value] [3055]Attr.value
[specified] [3056]Attr.specified
[attribute type] Using the [3057]TypeInfo object referenced from
[3058]Attr.schemaTypeInfo, the value of [3059]TypeInfo.typeName if
[3060]TypeInfo.typeNamespace is null.
[references] if the computed [attribute type] property is IDREF,
IDREFS, ENTITY, ENTITIES, or NOTATION, the value of this property is
an ordered list of the element, unparsed entity, or notation
information items referred to in the attribute value, in the order
that they appear there. The ordered list is computed using
Node.ownerDocument.getElementById,
Node.ownerDocument.doctype.entities, and
Node.ownerDocument.doctype.notations.
[owner element] [3061]Attr.ownerElement
C.4 ProcessingInstruction node mapping
C.4.1 Infoset to ProcessingInstruction node
A processing instruction information item map to a
[3062]ProcessingInstruction node. The attributes of the corresponding
[3063]ProcessingInstruction node are constructed as follows:
Attribute Value
[3064]Node.nodeName same as [3065]ProcessingInstruction.target
[3066]Node.nodeValue same as [3067]ProcessingInstruction.data
[3068]Node.nodeType [3069]Node.PROCESSING_INSTRUCTION_NODE
[3070]Node.parentNode The [parent] property
[3071]Node.childNodes empty [3072]NodeList
[3073]Node.firstChild null
[3074]Node.lastChild null
[3075]Node.previousSibling null
[3076]Node.nextSibling null
[3077]Node.attributes null
[3078]Node.ownerDocument The document information item
[3079]Node.namespaceURI null
[3080]Node.prefix null
[3081]Node.localName null
[3082]Node.baseURI The [base URI] property of the parent element if
any. The [base URI] property of the processing instruction information
item is not exposed through the [3083]ProcessingInstruction node.
[3084]Node.textContent same as [3085]Node.nodeValue
[3086]ProcessingInstruction.target The [target] property
[3087]ProcessingInstruction.data The [content] property
C.4.2 ProcessingInstruction node to Infoset
A [3088]ProcessingInstruction node maps to an processing instruction
information item. The properties of the corresponding processing
instruction information item are constructed as follows:
Property Value
[target] [3089]ProcessingInstruction.target
[content] [3090]ProcessingInstruction.data
[base URI] [3091]Node.baseURI
[notation] The [3092]Notation node named by the target and if
available from Node.ownerDocument.doctype.notations
[parent] [3093]Node.parentNode
C.5 EntityReference node mapping
C.5.1 Infoset to EntityReference node
An unexpanded entity reference information item maps to a
[3094]EntityReference node. The attributes of the corresponding
[3095]EntityReference node are constructed as follows:
Attribute Value
[3096]Node.nodeName The [name] property
[3097]Node.nodeValue null
[3098]Node.nodeType [3099]Node.ENTITY_REFERENCE_NODE
[3100]Node.parentNode the [parent] property
[3101]Node.childNodes Empty [3102]NodeList
[3103]Node.firstChild null
[3104]Node.lastChild null
[3105]Node.previousSibling null
[3106]Node.nextSibling null
[3107]Node.attributes null
[3108]Node.ownerDocument The document information item
[3109]Node.namespaceURI null
[3110]Node.prefix null
[3111]Node.localName null
[3112]Node.baseURI The [declaration base URI] property
[3113]Node.textContent null (the node has no children)
Note: The [system identifier] and [public identifier] properties are
not exposed through the [3114]EntityReference node.
C.5.2 EntityReference node to Infoset
An [3115]EntityReference node maps to an unexpanded entity reference
information item. [3116]EntityReference nodes with children
([3117]Node.childNodes contains a non-empty list) cannot be
represented using the Infoset. The properties of the corresponding
unexpanded entity reference information item are constructed as
follows:
Property Value
[name] [3118]Node.nodeName
[system identifier] The [3119]Entity.systemId value of the
[3120]Entity node available from Node.ownerDocument.doctype.entities
if available
[public identifier] The [3121]Entity.publicId value of the
[3122]Entity node available from Node.ownerDocument.doctype.entities
if available
[declaration base URI] [3123]Node.baseURI
[parent] [3124]Node.parentNode
C.6 Text and CDATASection nodes mapping
Since the [3125]XML Information Set] doesn't represent the boundaries
of CDATA marked sections, [3126]CDATASection nodes cannot occur from
an infoset mapping.
C.6.1 Infoset to Text node
Consecutive character information items map to a [3127]Text node. The
attributes of the corresponding [3128]Text node are constructed as
follows:
Attribute/Method Value
[3129]Node.nodeName "#text"
[3130]Node.nodeValue same as [3131]CharacterData.data
[3132]Node.nodeType [3133]Node.TEXT_NODE
[3134]Node.parentNode The [parent] property
[3135]Node.childNodes empty [3136]NodeList
[3137]Node.firstChild null
[3138]Node.lastChild null
[3139]Node.previousSibling null
[3140]Node.nextSibling null
[3141]Node.attributes null
[3142]Node.ownerDocument The document information item
[3143]Node.namespaceURI null
[3144]Node.prefix null
[3145]Node.localName null
[3146]Node.baseURI The [base URI] property of the parent element if
any
[3147]Node.textContent same as [3148]Node.nodeValue
[3149]CharacterData.data A [3150]DOMString including all ISO character
code contained in the character information items
[3151]CharacterData.length The number of 16-bit units needed to encode
all ISO character code contained in the character information items
using the UTF-16 encoding.
[3152]Text.isElementContentWhitespace The [element content whitespace]
property
[3153]Text.wholeText same as [3154]CharacterData.data
Note: By construction, the values of the [parent] and [element content
whitespace] properties are necessarily the sames for all consecutive
character information items.
C.6.2 Text and CDATASection nodes to Infoset
The text content of a [3155]Text or a [3156]CDATASection node maps to
a sequence of character information items. The number of items is less
or equal to [3157]CharacterData.length. Text nodes contained in
[3158]Attr nodes are mapped to the Infoset using the [3159]Attr.value
attribute. Text nodes contained in [3160]Document nodes cannot be
represented using the Infoset. The properties of the corresponding
character information items are constructed as follows:
Property Value
[character code] The ISO character code produced using one or two
16-bit units from [3161]CharacterData.data
[element content whitespace] [3162]Text.isElementContentWhitespace
[parent] [3163]Node.parentNode
C.7 Comment node mapping
C.7.1 Infoset to Comment node
A comment information item maps to a [3164]Comment node. The
attributes of the corresponding [3165]Comment node are constructed as
follows:
Attribute Value
[3166]Node.nodeName "#comment"
[3167]Node.nodeValue same as [3168]CharacterData.data
[3169]Node.nodeType [3170]Node.COMMENT_NODE
[3171]Node.parentNode The [parent] property
[3172]Node.childNodes empty [3173]NodeList
[3174]Node.firstChild null
[3175]Node.lastChild null
[3176]Node.previousSibling null
[3177]Node.nextSibling null
[3178]Node.attributes null
[3179]Node.ownerDocument The document information item
[3180]Node.namespaceURI null
[3181]Node.prefix null
[3182]Node.localName null
[3183]Node.baseURI The [base URI] property of the parent element or
parent document if any
[3184]Node.textContent same as [3185]Node.nodeValue
[3186]CharacterData.data The [content] property encoded using the
UTF-16 encoding.
[3187]CharacterData.length The number of 16-bit units needed to encode
all ISO character code contained in the [content] property using the
UTF-16 encoding.
C.7.2 Comment node to Infoset
A [3188]Comment maps to a comment information item. The properties of
the corresponding comment information item are constructed as follows:
Property Value
[content] [3189]CharacterData.data
[parent] [3190]Node.parentNode
C.8 DocumentType node mapping
C.8.1 Infoset to DocumentType node
A document type declaration information item maps to a
[3191]DocumentType node. The attributes of the corresponding
[3192]DocumentType node are constructed as follows:
Attribute Value
[3193]Node.nodeName same as [3194]DocumentType.name
[3195]Node.nodeValue null
[3196]Node.nodeType [3197]Node.DOCUMENT_TYPE_NODE
[3198]Node.parentNode The [parent] property
[3199]Node.childNodes empty [3200]NodeList
[3201]Node.firstChild null
[3202]Node.lastChild null
[3203]Node.previousSibling null
[3204]Node.nextSibling null
[3205]Node.attributes null
[3206]Node.ownerDocument The document information item
[3207]Node.namespaceURI null
[3208]Node.prefix null
[3209]Node.localName null
[3210]Node.baseURI null
[3211]Node.textContent null
[3212]DocumentType.name The name of the document element.
[3213]DocumentType.entities The [unparsed entities] property available
from the document information item.
[3214]DocumentType.notations The [notations] property available from
the document information item.
[3215]DocumentType.publicId The [public identifier] property
[3216]DocumentType.systemId The [system identifier] property
[3217]DocumentType.internalSubset The value is implementation
dependent
Note: The [children] property is not exposed through the
[3218]DocumentType node.
C.8.2 DocumentType node to Infoset
A [3219]DocumentType maps to a document type declaration information
item. The properties of the corresponding document type declaration
information item are constructed as follows:
Property Value
[system identifier] [3220]DocumentType.systemId
[public identifier] [3221]DocumentType.publicId
[children] The value of this property is implementation dependent
[parent] [3222]Node.parentNode
C.9 Entity node mapping
C.9.1 Infoset to Entity node
An unparsed entity information item maps to a [3223]Entity node. The
attributes of the corresponding [3224]Entity node are constructed as
follows:
Attribute Value
[3225]Node.nodeName The [name] property
[3226]Node.nodeValue null
[3227]Node.nodeType [3228]Node.ENTITY_NODE
[3229]Node.parentNode null
[3230]Node.childNodes Empty [3231]NodeList
[3232]Node.firstChild null
[3233]Node.lastChild null
[3234]Node.previousSibling null
[3235]Node.nextSibling null
[3236]Node.attributes null
[3237]Node.ownerDocument The document information item
[3238]Node.namespaceURI null
[3239]Node.prefix null
[3240]Node.localName null
[3241]Node.baseURI The [declaration base URI] property
[3242]Node.textContent "" (the node has no children)
[3243]Entity.publicId The [public identifier] property
[3244]Entity.systemId The [system identifier] property
[3245]Entity.notationName The [notation name] property
[3246]Entity.inputEncoding null
[3247]Entity.xmlEncoding null
[3248]Entity.xmlVersion null
C.9.2 Entity node to Infoset
An [3249]Entity node maps to an unparsed entity information item.
[3250]Entity nodes with children ([3251]Node.childNodes contains a
non-empty list) cannot be represented using the Infoset. The
properties of the corresponding unparsed entity information item are
constructed as follows:
Property Value
[name] [3252]Node.nodeName
[system identifier] [3253]Entity.systemId
[public identifier] [3254]Entity.publicId
[declaration base URI] [3255]Node.baseURI
[notation name] [3256]Entity.notationName
[notation] The [3257]Notation node referenced from
[3258]DocumentType.notations whose name is the [notation name]
property
C.10 Notation node mapping
C.10.1 Infoset to Notation node
A notation information item maps to a [3259]Notation node. The
attributes of the corresponding [3260]Notation node are constructed as
follows:
Attribute Value
[3261]Node.nodeName The [name] property
[3262]Node.nodeValue null
[3263]Node.nodeType [3264]Node.NOTATION_NODE
[3265]Node.parentNode null
[3266]Node.childNodes Empty [3267]NodeList
[3268]Node.firstChild null
[3269]Node.lastChild null
[3270]Node.previousSibling null
[3271]Node.nextSibling null
[3272]Node.attributes null
[3273]Node.ownerDocument The document information item
[3274]Node.namespaceURI null
[3275]Node.prefix null
[3276]Node.localName null
[3277]Node.baseURI The [declaration base URI] property
[3278]Node.textContent null
[3279]Notation.publicId The [public identifier] property
[3280]Notation.systemId The [system identifier] property
C.10.2 Notation node to Infoset
A [3281]Notation maps to a notation information item. The properties
of the corresponding notation information item are constructed as
follows:
Property Value
[name] [3282]Node.nodeName
[system identifier] [3283]Notation.systemId
[public identifier] [3284]Notation.publicId
[parent] [3285]Node.parentNode
07 November 2003
Appendix G: Java Language Binding
This appendix contains the complete Java [3286]Java] bindings for the
Level 3 Document Object Model Core.
The Java files are also available as
[3287]http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/java-bind
ing.zip
[3287] http://www.w3.org/TR/2003/CR-DOM-Level-3-Core-20031107/java-binding.zip
G.1 Java Binding Extension
Note: This section is informative.
This section defines the DOMImplementationRegistry object, discussed
in [3288]Bootstrapping, for Java.
The DOMImplementationRegistry is first initialized by the application
or the implementation, depending on the context, through the Java
system property "org.w3c.dom.DOMImplementationSourceList". The value
of this property is a space separated list of names of available
classes implementing the [3289]DOMImplementationSource interface.
org/w3c/dom/bootstrap/DOMImplementationRegistry.java:
/**
* This class holds the list of registered DOMImplementations. The contents
* of the registry are drawn from the System Property
* org.w3c.dom.DOMImplementationSourceList
, which must contain a
* white-space delimited sequence of the names of classes implementing
* DOMImplementationSource
.
* Applications may also register DOMImplementationSource
* implementations by using a method on this class. They may then
* query instances of the registry for implementations supporting
* specific features.
*
* Example:
*
* // get an instance of the DOMImplementation registry
* DOMImplementationRegistry registry = DOMImplementationRegistry.newInstance()
;
* // get a DOM implementation the Level 3 XML module
* DOMImplementation domImpl = registry.getDOMImplementation("XML 3.0");
*
* This provides an application with an implementation-independent
* starting point.
*
* @see DOMImplementation
* @see DOMImplementationSource
* @since DOM Level 3
*/
package org.w3c.dom.bootstrap;
import java.lang.reflect.Method;
import java.lang.reflect.InvocationTargetException;
import java.lang.ClassLoader;
import java.lang.String;
import java.util.StringTokenizer;
import java.util.Enumeration;
import java.util.Vector;
import org.w3c.dom.DOMImplementationSource;
import org.w3c.dom.DOMImplementationList;
import org.w3c.dom.DOMImplementation;
public class DOMImplementationRegistry {
// The system property to specify the DOMImplementationSource class names.
public final static String PROPERTY =
"org.w3c.dom.DOMImplementationSourceList";
private Vector _sources;
// deny construction by other classes
private DOMImplementationRegistry() {
}
// deny construction by other classes
private DOMImplementationRegistry(Vector srcs) {
_sources = srcs;
}
/*
* This method queries the System property
* org.w3c.dom.DOMImplementationSourceList
. If it is
* able to read and parse the property, it attempts to instantiate
* classes according to each space-delimited substring. Any
* exceptions it encounters are thrown to the application. An application
* must call this method before using the class.
* @return an initialized instance of DOMImplementationRegistry
*/
public static DOMImplementationRegistry newInstance()
throws ClassNotFoundException, InstantiationException,
IllegalAccessException
{
Vector _sources = new Vector();
// fetch system property:
String p = System.getProperty(PROPERTY);
if (p != null) {
StringTokenizer st = new StringTokenizer(p);
while (st.hasMoreTokens()) {
String sourceName = st.nextToken();
// Use context class loader, falling back to Class.forName
// if and only if this fails...
Object source = getClass(sourceName).newInstance();
_sources.add(source);
}
}
return new DOMImplementationRegistry(_sources);
}
/**
* Return the first registered implementation that has the desired
* features, or null if none is found.
*
* @param features A string that specifies which features are required.
* This is a space separated list in which each feature is
* specified by its name optionally followed by a space
* and a version number.
* This is something like: "XML 1.0 Traversal +Events 2.0"
* @return An implementation that has the desired features, or
* null
if this source has none.
*/
public DOMImplementation getDOMImplementation(String features)
throws ClassNotFoundException,
InstantiationException, IllegalAccessException, ClassCastException
{
int size = _sources.size();
String name = null;
for (int i = 0; i < size; i++) {
DOMImplementationSource source =
(DOMImplementationSource) _sources.get(i);
DOMImplementation impl = source.getDOMImplementation(features);
if (impl != null) {
return impl;
}
}
return null;
}
/**
* Return the list of all registered implementation that support the desire
d
* features.
*
* @param features A string that specifies which features are required.
* This is a space separated list in which each feature is
* specified by its name optionally followed by a space
* and a version number.
* This is something like: "XML 1.0 Traversal +Events 2.0"
* @return A list of DOMImplementations that support the desired features.
*/
public DOMImplementationList getDOMImplementationList(String features)
throws ClassNotFoundException,
InstantiationException, IllegalAccessException, ClassCastException
{
int size = _sources.size();
DOMImplementationListImpl list = new DOMImplementationListImpl();
String name = null;
for (int i = 0; i < size; i++) {
DOMImplementationSource source =
(DOMImplementationSource) _sources.get(i);
DOMImplementationList impls =
source.getDOMImplementationList(features);
for (int j = 0; j < impls.getLength(); j++) {
list.add(impls.item(j));
}
}
return list;
}
/**
* Register an implementation.
*/
public void addSource(DOMImplementationSource s)
throws ClassNotFoundException,
InstantiationException, IllegalAccessException
{
_sources.add(s);
}
private static Class getClass (String className)
throws ClassNotFoundException, IllegalAccessException,
InstantiationException {
Method m = null;
ClassLoader cl = null;
try {
m = Thread.class.getMethod("getContextClassLoader", null);
} catch (NoSuchMethodException e) {
// Assume that we are running JDK 1.1, use the current ClassLoader
cl = DOMImplementationRegistry.class.getClassLoader();
}
if (cl == null ) {
try {
cl = (ClassLoader) m.invoke(Thread.currentThread(), null);
} catch (IllegalAccessException e) {
// assert(false)
throw new UnknownError(e.getMessage());
} catch (InvocationTargetException e) {
// assert(e.getTargetException() instanceof SecurityException)
throw new UnknownError(e.getMessage());
}
}
if (cl == null) {
// fall back to Class.forName
return Class.forName(className);
}
try {
return cl.loadClass(className);
} catch (ClassNotFoundException e) {
return Class.forName(className);
}
}
}
org/w3c/dom/bootstrap/DOMImplementationListImpl.java:
/**
* This class holds a list of DOMImplementations.
*
* @since DOM Level 3
*/
package org.w3c.dom.bootstrap;
import java.util.Vector;
import org.w3c.dom.DOMImplementationList;
import org.w3c.dom.DOMImplementation;
public class DOMImplementationListImpl
implements DOMImplementationList {
private Vector sources;
/*
* Construct an empty list of DOMImplementations
* @return an initialized instance of DOMImplementationRegistry
*/
public DOMImplementationListImpl()
{
sources = new Vector();
}
/**
* Returns the index
th item in the collection. If
* index
is greater than or equal to the number of
* DOMImplementation
s in the list, this returns
* null
.
* @param index Index into the collection.
* @return The DOMImplementation
at the index
* th position in the DOMImplementationList
, or
* null
if that is not a valid index.
*/
public DOMImplementation item(int index)
{
try {
return (DOMImplementation) sources.elementAt(index);
} catch (ArrayIndexOutOfBoundsException e) {
return null;
}
}
/**
* The number of DOMImplementation
s in the list. The range
* of valid child node indices is 0 to length-1
inclusive.
*/
public int getLength() {
return sources.size();
}
/**
* Add a DOMImplementation
in the list.
*/
public void add(DOMImplementation domImpl) {
sources.add(domImpl);
}
}
With this, the first line of an application typically becomes
something like (modulo exception handling):
// get a DOM Level 3 implementation that supports the XML module.
DOMImplementation impl = DOMImplementationRegistry.getDOMImplementation("XM
L 3.0");
G.2 Other Core interfaces
org/w3c/dom/DOMException.java:
package org.w3c.dom;
public class DOMException extends RuntimeException {
public DOMException(short code, String message) {
super(message);
this.code = code;
}
public short code;
// ExceptionCode
public static final short INDEX_SIZE_ERR = 1;
public static final short DOMSTRING_SIZE_ERR = 2;
public static final short HIERARCHY_REQUEST_ERR = 3;
public static final short WRONG_DOCUMENT_ERR = 4;
public static final short INVALID_CHARACTER_ERR = 5;
public static final short NO_DATA_ALLOWED_ERR = 6;
public static final short NO_MODIFICATION_ALLOWED_ERR = 7;
public static final short NOT_FOUND_ERR = 8;
public static final short NOT_SUPPORTED_ERR = 9;
public static final short INUSE_ATTRIBUTE_ERR = 10;
public static final short INVALID_STATE_ERR = 11;
public static final short SYNTAX_ERR = 12;
public static final short INVALID_MODIFICATION_ERR = 13;
public static final short NAMESPACE_ERR = 14;
public static final short INVALID_ACCESS_ERR = 15;
public static final short VALIDATION_ERR = 16;
public static final short TYPE_MISMATCH_ERR = 17;
}
org/w3c/dom/DOMStringList.java:
package org.w3c.dom;
public interface DOMStringList {
public String item(int index);
public int getLength();
public boolean contains(String str);
}
org/w3c/dom/NameList.java:
package org.w3c.dom;
public interface NameList {
public String getName(int index);
public String getNamespaceURI(int index);
public int getLength();
public boolean contains(String name);
public boolean containsNS(String namespaceURI,
String name);
}
org/w3c/dom/DOMImplementationList.java:
package org.w3c.dom;
public interface DOMImplementationList {
public DOMImplementation item(int index);
public int getLength();
}
org/w3c/dom/DOMImplementationSource.java:
package org.w3c.dom;
public interface DOMImplementationSource {
public DOMImplementation getDOMImplementation(String features);
public DOMImplementationList getDOMImplementationList(String features);
}
org/w3c/dom/DOMImplementation.java:
package org.w3c.dom;
public interface DOMImplementation {
public boolean hasFeature(String feature,
String version);
public DocumentType createDocumentType(String qualifiedName,
String publicId,
String systemId)
throws DOMException;
public Document createDocument(String namespaceURI,
String qualifiedName,
DocumentType doctype)
throws DOMException;
public Object getFeature(String feature,
String version);
}
org/w3c/dom/DocumentFragment.java:
package org.w3c.dom;
public interface DocumentFragment extends Node {
}
org/w3c/dom/Document.java:
package org.w3c.dom;
public interface Document extends Node {
public DocumentType getDoctype();
public DOMImplementation getImplementation();
public Element getDocumentElement();
public Element createElement(String tagName)
throws DOMException;
public DocumentFragment createDocumentFragment();
public Text createTextNode(String data);
public Comment createComment(String data);
public CDATASection createCDATASection(String data)
throws DOMException;
public ProcessingInstruction createProcessingInstruction(String target,
String data)
throws DOMExceptio
n;
public Attr createAttribute(String name)
throws DOMException;
public EntityReference createEntityReference(String name)
throws DOMException;
public NodeList getElementsByTagName(String tagname);
public Node importNode(Node importedNode,
boolean deep)
throws DOMException;
public Element createElementNS(String namespaceURI,
String qualifiedName)
throws DOMException;
public Attr createAttributeNS(String namespaceURI,
String qualifiedName)
throws DOMException;
public NodeList getElementsByTagNameNS(String namespaceURI,
String localName);
public Element getElementById(String elementId);
public String getInputEncoding();
public String getXmlEncoding();
public boolean getXmlStandalone();
public void setXmlStandalone(boolean xmlStandalone)
throws DOMException;
public String getXmlVersion();
public void setXmlVersion(String xmlVersion)
throws DOMException;
public boolean getStrictErrorChecking();
public void setStrictErrorChecking(boolean strictErrorChecking);
public String getDocumentURI();
public void setDocumentURI(String documentURI);
public Node adoptNode(Node source)
throws DOMException;
public DOMConfiguration getDomConfig();
public void normalizeDocument();
public Node renameNode(Node n,
String namespaceURI,
String qualifiedName)
throws DOMException;
}
org/w3c/dom/Node.java:
package org.w3c.dom;
public interface Node {
// NodeType
public static final short ELEMENT_NODE = 1;
public static final short ATTRIBUTE_NODE = 2;
public static final short TEXT_NODE = 3;
public static final short CDATA_SECTION_NODE = 4;
public static final short ENTITY_REFERENCE_NODE = 5;
public static final short ENTITY_NODE = 6;
public static final short PROCESSING_INSTRUCTION_NODE = 7;
public static final short COMMENT_NODE = 8;
public static final short DOCUMENT_NODE = 9;
public static final short DOCUMENT_TYPE_NODE = 10;
public static final short DOCUMENT_FRAGMENT_NODE = 11;
public static final short NOTATION_NODE = 12;
public String getNodeName();
public String getNodeValue()
throws DOMException;
public void setNodeValue(String nodeValue)
throws DOMException;
public short getNodeType();
public Node getParentNode();
public NodeList getChildNodes();
public Node getFirstChild();
public Node getLastChild();
public Node getPreviousSibling();
public Node getNextSibling();
public NamedNodeMap getAttributes();
public Document getOwnerDocument();
public Node insertBefore(Node newChild,
Node refChild)
throws DOMException;
public Node replaceChild(Node newChild,
Node oldChild)
throws DOMException;
public Node removeChild(Node oldChild)
throws DOMException;
public Node appendChild(Node newChild)
throws DOMException;
public boolean hasChildNodes();
public Node cloneNode(boolean deep);
public void normalize();
public boolean isSupported(String feature,
String version);
public String getNamespaceURI();
public String getPrefix();
public void setPrefix(String prefix)
throws DOMException;
public String getLocalName();
public boolean hasAttributes();
public String getBaseURI();
// DocumentPosition
public static final short DOCUMENT_POSITION_DISCONNECTED = 0x01;
public static final short DOCUMENT_POSITION_PRECEDING = 0x02;
public static final short DOCUMENT_POSITION_FOLLOWING = 0x04;
public static final short DOCUMENT_POSITION_CONTAINS = 0x08;
public static final short DOCUMENT_POSITION_CONTAINED_BY = 0x10;
public static final short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20;
public short compareDocumentPosition(Node other)
throws DOMException;
public String getTextContent()
throws DOMException;
public void setTextContent(String textContent)
throws DOMException;
public boolean isSameNode(Node other);
public String lookupPrefix(String namespaceURI);
public boolean isDefaultNamespace(String namespaceURI);
public String lookupNamespaceURI(String prefix);
public boolean isEqualNode(Node arg);
public Object getFeature(String feature,
String version);
public Object setUserData(String key,
Object data,
UserDataHandler handler);
public Object getUserData(String key);
}
org/w3c/dom/NodeList.java:
package org.w3c.dom;
public interface NodeList {
public Node item(int index);
public int getLength();
}
org/w3c/dom/NamedNodeMap.java:
package org.w3c.dom;
public interface NamedNodeMap {
public Node getNamedItem(String name);
public Node setNamedItem(Node arg)
throws DOMException;
public Node removeNamedItem(String name)
throws DOMException;
public Node item(int index);
public int getLength();
public Node getNamedItemNS(String namespaceURI,
String localName)
throws DOMException;
public Node setNamedItemNS(Node arg)
throws DOMException;
public Node removeNamedItemNS(String namespaceURI,
String localName)
throws DOMException;
}
org/w3c/dom/CharacterData.java:
package org.w3c.dom;
public interface CharacterData extends Node {
public String getData()
throws DOMException;
public void setData(String data)
throws DOMException;
public int getLength();
public String substringData(int offset,
int count)
throws DOMException;
public void appendData(String arg)
throws DOMException;
public void insertData(int offset,
String arg)
throws DOMException;
public void deleteData(int offset,
int count)
throws DOMException;
public void replaceData(int offset,
int count,
String arg)
throws DOMException;
}
org/w3c/dom/Attr.java:
package org.w3c.dom;
public interface Attr extends Node {
public String getName();
public boolean getSpecified();
public String getValue();
public void setValue(String value)
throws DOMException;
public Element getOwnerElement();
public TypeInfo getSchemaTypeInfo();
public boolean isId();
}
org/w3c/dom/Element.java:
package org.w3c.dom;
public interface Element extends Node {
public String getTagName();
public String getAttribute(String name);
public void setAttribute(String name,
String value)
throws DOMException;
public void removeAttribute(String name)
throws DOMException;
public Attr getAttributeNode(String name);
public Attr setAttributeNode(Attr newAttr)
throws DOMException;
public Attr removeAttributeNode(Attr oldAttr)
throws DOMException;
public NodeList getElementsByTagName(String name);
public String getAttributeNS(String namespaceURI,
String localName)
throws DOMException;
public void setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
throws DOMException;
public void removeAttributeNS(String namespaceURI,
String localName)
throws DOMException;
public Attr getAttributeNodeNS(String namespaceURI,
String localName)
throws DOMException;
public Attr setAttributeNodeNS(Attr newAttr)
throws DOMException;
public NodeList getElementsByTagNameNS(String namespaceURI,
String localName)
throws DOMException;
public boolean hasAttribute(String name);
public boolean hasAttributeNS(String namespaceURI,
String localName)
throws DOMException;
public TypeInfo getSchemaTypeInfo();
public void setIdAttribute(String name,
boolean isId)
throws DOMException;
public void setIdAttributeNS(String namespaceURI,
String localName,
boolean isId)
throws DOMException;
public void setIdAttributeNode(Attr idAttr,
boolean isId)
throws DOMException;
}
org/w3c/dom/Text.java:
package org.w3c.dom;
public interface Text extends CharacterData {
public Text splitText(int offset)
throws DOMException;
public boolean isElementContentWhitespace();
public String getWholeText();
public Text replaceWholeText(String content)
throws DOMException;
}
org/w3c/dom/Comment.java:
package org.w3c.dom;
public interface Comment extends CharacterData {
}
org/w3c/dom/TypeInfo.java:
package org.w3c.dom;
public interface TypeInfo {
public String getTypeName();
public String getTypeNamespace();
// DerivationMethods
public static final int DERIVATION_RESTRICTION = 0x00000001;
public static final int DERIVATION_EXTENSION = 0x00000002;
public static final int DERIVATION_UNION = 0x00000004;
public static final int DERIVATION_LIST = 0x00000008;
public boolean isDerivedFrom(String typeNamespaceArg,
String typeNameArg,
int derivationMethod);
}
org/w3c/dom/UserDataHandler.java:
package org.w3c.dom;
public interface UserDataHandler {
// OperationType
public static final short NODE_CLONED = 1;
public static final short NODE_IMPORTED = 2;
public static final short NODE_DELETED = 3;
public static final short NODE_RENAMED = 4;
public static final short NODE_ADOPTED = 5;
public void handle(short operation,
String key,
Object data,
Node src,
Node dst);
}
org/w3c/dom/DOMError.java:
package org.w3c.dom;
public interface DOMError {
// ErrorSeverity
public static final short SEVERITY_WARNING = 1;
public static final short SEVERITY_ERROR = 2;
public static final short SEVERITY_FATAL_ERROR = 3;
public short getSeverity();
public String getMessage();
public String getType();
public Object getRelatedException();
public Object getRelatedData();
public DOMLocator getLocation();
}
org/w3c/dom/DOMErrorHandler.java:
package org.w3c.dom;
public interface DOMErrorHandler {
public boolean handleError(DOMError error);
}
org/w3c/dom/DOMLocator.java:
package org.w3c.dom;
public interface DOMLocator {
public int getLineNumber();
public int getColumnNumber();
public int getByteOffset();
public int getUtf16Offset();
public Node getRelatedNode();
public String getUri();
}
org/w3c/dom/DOMConfiguration.java:
package org.w3c.dom;
public interface DOMConfiguration {
public void setParameter(String name,
Object value)
throws DOMException;
public Object getParameter(String name)
throws DOMException;
public boolean canSetParameter(String name,
Object value);
public DOMStringList getParameterNames();
}
org/w3c/dom/CDATASection.java:
package org.w3c.dom;
public interface CDATASection extends Text {
}
org/w3c/dom/DocumentType.java:
package org.w3c.dom;
public interface DocumentType extends Node {
public String getName();
public NamedNodeMap getEntities();
public NamedNodeMap getNotations();
public String getPublicId();
public String getSystemId();
public String getInternalSubset();
}
org/w3c/dom/Notation.java:
package org.w3c.dom;
public interface Notation extends Node {
public String getPublicId();
public String getSystemId();
}
org/w3c/dom/Entity.java:
package org.w3c.dom;
public interface Entity extends Node {
public String getPublicId();
public String getSystemId();
public String getNotationName();
public String getInputEncoding();
public String getXmlEncoding();
public String getXmlVersion();
}
org/w3c/dom/EntityReference.java:
package org.w3c.dom;
public interface EntityReference extends Node {
}
org/w3c/dom/ProcessingInstruction.java:
package org.w3c.dom;
public interface ProcessingInstruction extends Node {
public String getTarget();
public String getData();
public void setData(String data)
throws DOMException;
}
07 November 2003
Appendix H: ECMAScript Language Binding
This appendix contains the complete ECMAScript [3290]ECMAScript]
binding for the Level 3 Document Object Model Core definitions.
H.1 ECMAScript Binding Extension
This section defines the DOMImplementationRegistry object, discussed
in [3291]Bootstrapping, for ECMAScript.
Objects that implements the DOMImplementationRegistry interface
DOMImplementationRegistry is a global variable which has the
following functions:
getDOMImplementation(features)
This method returns the first registered object
that implements the DOMImplementation interface and
has the desired features, or null if none is found.
The features parameter is a String. See also
[3292]DOMImplementationSource.getDOMImplementation(
).
getDOMImplementationList(features)
This method returns a [3293]DOMImplementationList
list of registered object that implements the
DOMImplementation interface and has the desired
features.
The features parameter is a String. See also
[3294]DOMImplementationSource.getDOMImplementationL
ist().
H.2 Other Core interfaces
Properties of the DOMException Constructor function:
DOMException.INDEX_SIZE_ERR
The value of the constant DOMException.INDEX_SIZE_ERR is
1.
DOMException.DOMSTRING_SIZE_ERR
The value of the constant DOMException.DOMSTRING_SIZE_ERR
is 2.
DOMException.HIERARCHY_REQUEST_ERR
The value of the constant
DOMException.HIERARCHY_REQUEST_ERR is 3.
DOMException.WRONG_DOCUMENT_ERR
The value of the constant DOMException.WRONG_DOCUMENT_ERR
is 4.
DOMException.INVALID_CHARACTER_ERR
The value of the constant
DOMException.INVALID_CHARACTER_ERR is 5.
DOMException.NO_DATA_ALLOWED_ERR
The value of the constant
DOMException.NO_DATA_ALLOWED_ERR is 6.
DOMException.NO_MODIFICATION_ALLOWED_ERR
The value of the constant
DOMException.NO_MODIFICATION_ALLOWED_ERR is 7.
DOMException.NOT_FOUND_ERR
The value of the constant DOMException.NOT_FOUND_ERR is
8.
DOMException.NOT_SUPPORTED_ERR
The value of the constant DOMException.NOT_SUPPORTED_ERR
is 9.
DOMException.INUSE_ATTRIBUTE_ERR
The value of the constant
DOMException.INUSE_ATTRIBUTE_ERR is 10.
DOMException.INVALID_STATE_ERR
The value of the constant DOMException.INVALID_STATE_ERR
is 11.
DOMException.SYNTAX_ERR
The value of the constant DOMException.SYNTAX_ERR is 12.
DOMException.INVALID_MODIFICATION_ERR
The value of the constant
DOMException.INVALID_MODIFICATION_ERR is 13.
DOMException.NAMESPACE_ERR
The value of the constant DOMException.NAMESPACE_ERR is
14.
DOMException.INVALID_ACCESS_ERR
The value of the constant DOMException.INVALID_ACCESS_ERR
is 15.
DOMException.VALIDATION_ERR
The value of the constant DOMException.VALIDATION_ERR is
16.
DOMException.TYPE_MISMATCH_ERR
The value of the constant DOMException.TYPE_MISMATCH_ERR
is 17.
Objects that implement the DOMException interface:
Properties of objects that implement the DOMException interface:
code
This property is a Number.
Objects that implement the DOMStringList interface:
Properties of objects that implement the DOMStringList interface:
length
This read-only property is a Number.
Functions of objects that implement the DOMStringList interface:
item(index)
This function returns a String.
The index parameter is a Number.
Note: This object can also be dereferenced using
square bracket notation (e.g. obj[$1\47]).
Dereferencing with an integer index is equivalent
to invoking the item function with that index.
contains(str)
This function returns a Boolean.
The str parameter is a String.
Objects that implement the NameList interface:
Properties of objects that implement the NameList interface:
length
This read-only property is a Number.
Functions of objects that implement the NameList interface:
getName(index)
This function returns a String.
The index parameter is a Number.
getNamespaceURI(index)
This function returns a String.
The index parameter is a Number.
contains(name)
This function returns a Boolean.
The name parameter is a String.
containsNS(namespaceURI, name)
This function returns a Boolean.
The namespaceURI parameter is a String.
The name parameter is a String.
Objects that implement the DOMImplementationList interface:
Properties of objects that implement the DOMImplementationList
interface:
length
This read-only property is a Number.
Functions of objects that implement the DOMImplementationList
interface:
item(index)
This function returns an object that implements the
DOMImplementation interface.
The index parameter is a Number.
Note: This object can also be dereferenced using
square bracket notation (e.g. obj[$1\47]).
Dereferencing with an integer index is equivalent
to invoking the item function with that index.
Objects that implement the DOMImplementationSource interface:
Functions of objects that implement the DOMImplementationSource
interface:
getDOMImplementation(features)
This function returns an object that implements the
DOMImplementation interface.
The features parameter is a String.
getDOMImplementationList(features)
This function returns an object that implements the
DOMImplementationList interface.
The features parameter is a String.
Objects that implement the DOMImplementation interface:
Functions of objects that implement the DOMImplementation
interface:
hasFeature(feature, version)
This function returns a Boolean.
The feature parameter is a String.
The version parameter is a String.
createDocumentType(qualifiedName, publicId, systemId)
This function returns an object that implements the
DocumentType interface.
The qualifiedName parameter is a String.
The publicId parameter is a String.
The systemId parameter is a String.
This function can raise an object that implements
the DOMException interface.
createDocument(namespaceURI, qualifiedName, doctype)
This function returns an object that implements the
Document interface.
The namespaceURI parameter is a String.
The qualifiedName parameter is a String.
The doctype parameter is an object that implements
the DocumentType interface.
This function can raise an object that implements
the DOMException interface.
getFeature(feature, version)
This function returns an object that implements the
Object interface.
The feature parameter is a String.
The version parameter is a String.
Objects that implement the DocumentFragment interface:
Objects that implement the DocumentFragment interface have all
properties and functions of the Node interface.
Objects that implement the Document interface:
Objects that implement the Document interface have all properties
and functions of the Node interface as well as the
properties and functions defined below.
Properties of objects that implement the Document interface:
doctype
This read-only property is an object that
implements the DocumentType interface.
implementation
This read-only property is an object that
implements the DOMImplementation interface.
documentElement
This read-only property is an object that
implements the Element interface.
inputEncoding
This read-only property is a String.
xmlEncoding
This read-only property is a String.
xmlStandalone
This property is a Boolean and can raise an object
that implements the DOMException interface on
setting.
xmlVersion
This property is a String and can raise an object
that implements the DOMException interface on
setting.
strictErrorChecking
This property is a Boolean.
documentURI
This property is a String.
domConfig
This read-only property is an object that
implements the DOMConfiguration interface.
Functions of objects that implement the Document interface:
createElement(tagName)
This function returns an object that implements the
Element interface.
The tagName parameter is a String.
This function can raise an object that implements
the DOMException interface.
createDocumentFragment()
This function returns an object that implements the
DocumentFragment interface.
createTextNode(data)
This function returns an object that implements the
Text interface.
The data parameter is a String.
createComment(data)
This function returns an object that implements the
Comment interface.
The data parameter is a String.
createCDATASection(data)
This function returns an object that implements the
CDATASection interface.
The data parameter is a String.
This function can raise an object that implements
the DOMException interface.
createProcessingInstruction(target, data)
This function returns an object that implements the
ProcessingInstruction interface.
The target parameter is a String.
The data parameter is a String.
This function can raise an object that implements
the DOMException interface.
createAttribute(name)
This function returns an object that implements the
Attr interface.
The name parameter is a String.
This function can raise an object that implements
the DOMException interface.
createEntityReference(name)
This function returns an object that implements the
EntityReference interface.
The name parameter is a String.
This function can raise an object that implements
the DOMException interface.
getElementsByTagName(tagname)
This function returns an object that implements the
NodeList interface.
The tagname parameter is a String.
importNode(importedNode, deep)
This function returns an object that implements the
Node interface.
The importedNode parameter is an object that
implements the Node interface.
The deep parameter is a Boolean.
This function can raise an object that implements
the DOMException interface.
createElementNS(namespaceURI, qualifiedName)
This function returns an object that implements the
Element interface.
The namespaceURI parameter is a String.
The qualifiedName parameter is a String.
This function can raise an object that implements
the DOMException interface.
createAttributeNS(namespaceURI, qualifiedName)
This function returns an object that implements the
Attr interface.
The namespaceURI parameter is a String.
The qualifiedName parameter is a String.
This function can raise an object that implements
the DOMException interface.
getElementsByTagNameNS(namespaceURI, localName)
This function returns an object that implements the
NodeList interface.
The namespaceURI parameter is a String.
The localName parameter is a String.
getElementById(elementId)
This function returns an object that implements the
Element interface.
The elementId parameter is a String.
adoptNode(source)
This function returns an object that implements the
Node interface.
The source parameter is an object that implements
the Node interface.
This function can raise an object that implements
the DOMException interface.
normalizeDocument()
This function has no return value.
renameNode(n, namespaceURI, qualifiedName)
This function returns an object that implements the
Node interface.
The n parameter is an object that implements the
Node interface.
The namespaceURI parameter is a String.
The qualifiedName parameter is a String.
This function can raise an object that implements
the DOMException interface.
Properties of the Node Constructor function:
Node.ELEMENT_NODE
The value of the constant Node.ELEMENT_NODE is 1.
Node.ATTRIBUTE_NODE
The value of the constant Node.ATTRIBUTE_NODE is 2.
Node.TEXT_NODE
The value of the constant Node.TEXT_NODE is 3.
Node.CDATA_SECTION_NODE
The value of the constant Node.CDATA_SECTION_NODE is 4.
Node.ENTITY_REFERENCE_NODE
The value of the constant Node.ENTITY_REFERENCE_NODE is
5.
Node.ENTITY_NODE
The value of the constant Node.ENTITY_NODE is 6.
Node.PROCESSING_INSTRUCTION_NODE
The value of the constant
Node.PROCESSING_INSTRUCTION_NODE is 7.
Node.COMMENT_NODE
The value of the constant Node.COMMENT_NODE is 8.
Node.DOCUMENT_NODE
The value of the constant Node.DOCUMENT_NODE is 9.
Node.DOCUMENT_TYPE_NODE
The value of the constant Node.DOCUMENT_TYPE_NODE is 10.
Node.DOCUMENT_FRAGMENT_NODE
The value of the constant Node.DOCUMENT_FRAGMENT_NODE is
11.
Node.NOTATION_NODE
The value of the constant Node.NOTATION_NODE is 12.
Node.DOCUMENT_POSITION_DISCONNECTED
The value of the constant
Node.DOCUMENT_POSITION_DISCONNECTED is 0x01.
Node.DOCUMENT_POSITION_PRECEDING
The value of the constant
Node.DOCUMENT_POSITION_PRECEDING is 0x02.
Node.DOCUMENT_POSITION_FOLLOWING
The value of the constant
Node.DOCUMENT_POSITION_FOLLOWING is 0x04.
Node.DOCUMENT_POSITION_CONTAINS
The value of the constant Node.DOCUMENT_POSITION_CONTAINS
is 0x08.
Node.DOCUMENT_POSITION_CONTAINED_BY
The value of the constant
Node.DOCUMENT_POSITION_CONTAINED_BY is 0x10.
Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
The value of the constant
Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC is 0x20.
Objects that implement the Node interface:
Properties of objects that implement the Node interface:
nodeName
This read-only property is a String.
nodeValue
This property is a String, can raise an object that
implements the DOMException interface on setting
and can raise an object that implements the
DOMException interface on retrieval.
nodeType
This read-only property is a Number.
parentNode
This read-only property is an object that
implements the Node interface.
childNodes
This read-only property is an object that
implements the NodeList interface.
firstChild
This read-only property is an object that
implements the Node interface.
lastChild
This read-only property is an object that
implements the Node interface.
previousSibling
This read-only property is an object that
implements the Node interface.
nextSibling
This read-only property is an object that
implements the Node interface.
attributes
This read-only property is an object that
implements the NamedNodeMap interface.
ownerDocument
This read-only property is an object that
implements the Document interface.
namespaceURI
This read-only property is a String.
prefix
This property is a String and can raise an object
that implements the DOMException interface on
setting.
localName
This read-only property is a String.
baseURI
This read-only property is a String.
textContent
This property is a String, can raise an object that
implements the DOMException interface on setting
and can raise an object that implements the
DOMException interface on retrieval.
Functions of objects that implement the Node interface:
insertBefore(newChild, refChild)
This function returns an object that implements the
Node interface.
The newChild parameter is an object that implements
the Node interface.
The refChild parameter is an object that implements
the Node interface.
This function can raise an object that implements
the DOMException interface.
replaceChild(newChild, oldChild)
This function returns an object that implements the
Node interface.
The newChild parameter is an object that implements
the Node interface.
The oldChild parameter is an object that implements
the Node interface.
This function can raise an object that implements
the DOMException interface.
removeChild(oldChild)
This function returns an object that implements the
Node interface.
The oldChild parameter is an object that implements
the Node interface.
This function can raise an object that implements
the DOMException interface.
appendChild(newChild)
This function returns an object that implements the
Node interface.
The newChild parameter is an object that implements
the Node interface.
This function can raise an object that implements
the DOMException interface.
hasChildNodes()
This function returns a Boolean.
cloneNode(deep)
This function returns an object that implements the
Node interface.
The deep parameter is a Boolean.
normalize()
This function has no return value.
isSupported(feature, version)
This function returns a Boolean.
The feature parameter is a String.
The version parameter is a String.
hasAttributes()
This function returns a Boolean.
compareDocumentPosition(other)
This function returns a Number.
The other parameter is an object that implements
the Node interface.
This function can raise an object that implements
the DOMException interface.
isSameNode(other)
This function returns a Boolean.
The other parameter is an object that implements
the Node interface.
lookupPrefix(namespaceURI)
This function returns a String.
The namespaceURI parameter is a String.
isDefaultNamespace(namespaceURI)
This function returns a Boolean.
The namespaceURI parameter is a String.
lookupNamespaceURI(prefix)
This function returns a String.
The prefix parameter is a String.
isEqualNode(arg)
This function returns a Boolean.
The arg parameter is an object that implements the
Node interface.
getFeature(feature, version)
This function returns an object that implements the
Object interface.
The feature parameter is a String.
The version parameter is a String.
setUserData(key, data, handler)
This function returns an object that implements the
any type interface.
The key parameter is a String.
The data parameter is an object that implements the
any type interface.
The handler parameter is an object that implements
the UserDataHandler interface.
getUserData(key)
This function returns an object that implements the
any type interface.
The key parameter is a String.
Objects that implement the NodeList interface:
Properties of objects that implement the NodeList interface:
length
This read-only property is a Number.
Functions of objects that implement the NodeList interface:
item(index)
This function returns an object that implements the
Node interface.
The index parameter is a Number.
Note: This object can also be dereferenced using
square bracket notation (e.g. obj[$1\47]).
Dereferencing with an integer index is equivalent
to invoking the item function with that index.
Objects that implement the NamedNodeMap interface:
Properties of objects that implement the NamedNodeMap interface:
length
This read-only property is a Number.
Functions of objects that implement the NamedNodeMap interface:
getNamedItem(name)
This function returns an object that implements the
Node interface.
The name parameter is a String.
setNamedItem(arg)
This function returns an object that implements the
Node interface.
The arg parameter is an object that implements the
Node interface.
This function can raise an object that implements
the DOMException interface.
removeNamedItem(name)
This function returns an object that implements the
Node interface.
The name parameter is a String.
This function can raise an object that implements
the DOMException interface.
item(index)
This function returns an object that implements the
Node interface.
The index parameter is a Number.
Note: This object can also be dereferenced using
square bracket notation (e.g. obj[$1\47]).
Dereferencing with an integer index is equivalent
to invoking the item function with that index.
getNamedItemNS(namespaceURI, localName)
This function returns an object that implements the
Node interface.
The namespaceURI parameter is a String.
The localName parameter is a String.
This function can raise an object that implements
the DOMException interface.
setNamedItemNS(arg)
This function returns an object that implements the
Node interface.
The arg parameter is an object that implements the
Node interface.
This function can raise an object that implements
the DOMException interface.
removeNamedItemNS(namespaceURI, localName)
This function returns an object that implements the
Node interface.
The namespaceURI parameter is a String.
The localName parameter is a String.
This function can raise an object that implements
the DOMException interface.
Objects that implement the CharacterData interface:
Objects that implement the CharacterData interface have all
properties and functions of the Node interface as well as
the properties and functions defined below.
Properties of objects that implement the CharacterData interface:
data
This property is a String, can raise an object that
implements the DOMException interface on setting
and can raise an object that implements the
DOMException interface on retrieval.
length
This read-only property is a Number.
Functions of objects that implement the CharacterData interface:
substringData(offset, count)
This function returns a String.
The offset parameter is a Number.
The count parameter is a Number.
This function can raise an object that implements
the DOMException interface.
appendData(arg)
This function has no return value.
The arg parameter is a String.
This function can raise an object that implements
the DOMException interface.
insertData(offset, arg)
This function has no return value.
The offset parameter is a Number.
The arg parameter is a String.
This function can raise an object that implements
the DOMException interface.
deleteData(offset, count)
This function has no return value.
The offset parameter is a Number.
The count parameter is a Number.
This function can raise an object that implements
the DOMException interface.
replaceData(offset, count, arg)
This function has no return value.
The offset parameter is a Number.
The count parameter is a Number.
The arg parameter is a String.
This function can raise an object that implements
the DOMException interface.
Objects that implement the Attr interface:
Objects that implement the Attr interface have all properties and
functions of the Node interface as well as the properties
and functions defined below.
Properties of objects that implement the Attr interface:
name
This read-only property is a String.
specified
This read-only property is a Boolean.
value
This property is a String and can raise an object
that implements the DOMException interface on
setting.
ownerElement
This read-only property is an object that
implements the Element interface.
schemaTypeInfo
This read-only property is an object that
implements the TypeInfo interface.
isId
This read-only property is a Boolean.
Objects that implement the Element interface:
Objects that implement the Element interface have all properties
and functions of the Node interface as well as the
properties and functions defined below.
Properties of objects that implement the Element interface:
tagName
This read-only property is a String.
schemaTypeInfo
This read-only property is an object that
implements the TypeInfo interface.
Functions of objects that implement the Element interface:
getAttribute(name)
This function returns a String.
The name parameter is a String.
setAttribute(name, value)
This function has no return value.
The name parameter is a String.
The value parameter is a String.
This function can raise an object that implements
the DOMException interface.
removeAttribute(name)
This function has no return value.
The name parameter is a String.
This function can raise an object that implements
the DOMException interface.
getAttributeNode(name)
This function returns an object that implements the
Attr interface.
The name parameter is a String.
setAttributeNode(newAttr)
This function returns an object that implements the
Attr interface.
The newAttr parameter is an object that implements
the Attr interface.
This function can raise an object that implements
the DOMException interface.
removeAttributeNode(oldAttr)
This function returns an object that implements the
Attr interface.
The oldAttr parameter is an object that implements
the Attr interface.
This function can raise an object that implements
the DOMException interface.
getElementsByTagName(name)
This function returns an object that implements the
NodeList interface.
The name parameter is a String.
getAttributeNS(namespaceURI, localName)
This function returns a String.
The namespaceURI parameter is a String.
The localName parameter is a String.
This function can raise an object that implements
the DOMException interface.
setAttributeNS(namespaceURI, qualifiedName, value)
This function has no return value.
The namespaceURI parameter is a String.
The qualifiedName parameter is a String.
The value parameter is a String.
This function can raise an object that implements
the DOMException interface.
removeAttributeNS(namespaceURI, localName)
This function has no return value.
The namespaceURI parameter is a String.
The localName parameter is a String.
This function can raise an object that implements
the DOMException interface.
getAttributeNodeNS(namespaceURI, localName)
This function returns an object that implements the
Attr interface.
The namespaceURI parameter is a String.
The localName parameter is a String.
This function can raise an object that implements
the DOMException interface.
setAttributeNodeNS(newAttr)
This function returns an object that implements the
Attr interface.
The newAttr parameter is an object that implements
the Attr interface.
This function can raise an object that implements
the DOMException interface.
getElementsByTagNameNS(namespaceURI, localName)
This function returns an object that implements the
NodeList interface.
The namespaceURI parameter is a String.
The localName parameter is a String.
This function can raise an object that implements
the DOMException interface.
hasAttribute(name)
This function returns a Boolean.
The name parameter is a String.
hasAttributeNS(namespaceURI, localName)
This function returns a Boolean.
The namespaceURI parameter is a String.
The localName parameter is a String.
This function can raise an object that implements
the DOMException interface.
setIdAttribute(name, isId)
This function has no return value.
The name parameter is a String.
The isId parameter is a Boolean.
This function can raise an object that implements
the DOMException interface.
setIdAttributeNS(namespaceURI, localName, isId)
This function has no return value.
The namespaceURI parameter is a String.
The localName parameter is a String.
The isId parameter is a Boolean.
This function can raise an object that implements
the DOMException interface.
setIdAttributeNode(idAttr, isId)
This function has no return value.
The idAttr parameter is an object that implements
the Attr interface.
The isId parameter is a Boolean.
This function can raise an object that implements
the DOMException interface.
Objects that implement the Text interface:
Objects that implement the Text interface have all properties and
functions of the CharacterData interface as well as the
properties and functions defined below.
Properties of objects that implement the Text interface:
isElementContentWhitespace
This read-only property is a Boolean.
wholeText
This read-only property is a String.
Functions of objects that implement the Text interface:
splitText(offset)
This function returns an object that implements the
Text interface.
The offset parameter is a Number.
This function can raise an object that implements
the DOMException interface.
replaceWholeText(content)
This function returns an object that implements the
Text interface.
The content parameter is a String.
This function can raise an object that implements
the DOMException interface.
Objects that implement the Comment interface:
Objects that implement the Comment interface have all properties
and functions of the CharacterData interface.
Properties of the TypeInfo Constructor function:
TypeInfo.DERIVATION_RESTRICTION
The value of the constant TypeInfo.DERIVATION_RESTRICTION
is 0x00000001.
TypeInfo.DERIVATION_EXTENSION
The value of the constant TypeInfo.DERIVATION_EXTENSION
is 0x00000002.
TypeInfo.DERIVATION_UNION
The value of the constant TypeInfo.DERIVATION_UNION is
0x00000004.
TypeInfo.DERIVATION_LIST
The value of the constant TypeInfo.DERIVATION_LIST is
0x00000008.
Objects that implement the TypeInfo interface:
Properties of objects that implement the TypeInfo interface:
typeName
This read-only property is a String.
typeNamespace
This read-only property is a String.
Functions of objects that implement the TypeInfo interface:
isDerivedFrom(typeNamespaceArg, typeNameArg,
derivationMethod)
This function returns a Boolean.
The typeNamespaceArg parameter is a String.
The typeNameArg parameter is a String.
The derivationMethod parameter is a Number.
Properties of the UserDataHandler Constructor function:
UserDataHandler.NODE_CLONED
The value of the constant UserDataHandler.NODE_CLONED is
1.
UserDataHandler.NODE_IMPORTED
The value of the constant UserDataHandler.NODE_IMPORTED
is 2.
UserDataHandler.NODE_DELETED
The value of the constant UserDataHandler.NODE_DELETED is
3.
UserDataHandler.NODE_RENAMED
The value of the constant UserDataHandler.NODE_RENAMED is
4.
UserDataHandler.NODE_ADOPTED
The value of the constant UserDataHandler.NODE_ADOPTED is
5.
Objects that implement the UserDataHandler interface:
Functions of objects that implement the UserDataHandler
interface:
handle(operation, key, data, src, dst)
This function has no return value.
The operation parameter is a Number.
The key parameter is a String.
The data parameter is an object that implements the
any type interface.
The src parameter is an object that implements the
Node interface.
The dst parameter is an object that implements the
Node interface.
Properties of the DOMError Constructor function:
DOMError.SEVERITY_WARNING
The value of the constant DOMError.SEVERITY_WARNING is 1.
DOMError.SEVERITY_ERROR
The value of the constant DOMError.SEVERITY_ERROR is 2.
DOMError.SEVERITY_FATAL_ERROR
The value of the constant DOMError.SEVERITY_FATAL_ERROR
is 3.
Objects that implement the DOMError interface:
Properties of objects that implement the DOMError interface:
severity
This read-only property is a Number.
message
This read-only property is a String.
type
This read-only property is a String.
relatedException
This read-only property is an object that
implements the Object interface.
relatedData
This read-only property is an object that
implements the Object interface.
location
This read-only property is an object that
implements the DOMLocator interface.
Objects that implement the DOMErrorHandler interface:
Functions of objects that implement the DOMErrorHandler
interface:
handleError(error)
This function returns a Boolean.
The error parameter is an object that implements
the DOMError interface.
Objects that implement the DOMLocator interface:
Properties of objects that implement the DOMLocator interface:
lineNumber
This read-only property is a Number.
columnNumber
This read-only property is a Number.
byteOffset
This read-only property is a Number.
utf16Offset
This read-only property is a Number.
relatedNode
This read-only property is an object that
implements the Node interface.
uri
This read-only property is a String.
Objects that implement the DOMConfiguration interface:
Properties of objects that implement the DOMConfiguration
interface:
parameterNames
This read-only property is an object that
implements the DOMStringList interface.
Functions of objects that implement the DOMConfiguration
interface:
setParameter(name, value)
This function has no return value.
The name parameter is a String.
The value parameter is an object that implements
the any type interface.
This function can raise an object that implements
the DOMException interface.
getParameter(name)
This function returns an object that implements the
any type interface.
The name parameter is a String.
This function can raise an object that implements
the DOMException interface.
canSetParameter(name, value)
This function returns a Boolean.
The name parameter is a String.
The value parameter is an object that implements
the any type interface.
Objects that implement the CDATASection interface:
Objects that implement the CDATASection interface have all
properties and functions of the Text interface.
Objects that implement the DocumentType interface:
Objects that implement the DocumentType interface have all
properties and functions of the Node interface as well as
the properties and functions defined below.
Properties of objects that implement the DocumentType interface:
name
This read-only property is a String.
entities
This read-only property is an object that
implements the NamedNodeMap interface.
notations
This read-only property is an object that
implements the NamedNodeMap interface.
publicId
This read-only property is a String.
systemId
This read-only property is a String.
internalSubset
This read-only property is a String.
Objects that implement the Notation interface:
Objects that implement the Notation interface have all properties
and functions of the Node interface as well as the
properties and functions defined below.
Properties of objects that implement the Notation interface:
publicId
This read-only property is a String.
systemId
This read-only property is a String.
Objects that implement the Entity interface:
Objects that implement the Entity interface have all properties
and functions of the Node interface as well as the
properties and functions defined below.
Properties of objects that implement the Entity interface:
publicId
This read-only property is a String.
systemId
This read-only property is a String.
notationName
This read-only property is a String.
inputEncoding
This read-only property is a String.
xmlEncoding
This read-only property is a String.
xmlVersion
This read-only property is a String.
Objects that implement the EntityReference interface:
Objects that implement the EntityReference interface have all
properties and functions of the Node interface.
Objects that implement the ProcessingInstruction interface:
Objects that implement the ProcessingInstruction interface have
all properties and functions of the Node interface as
well as the properties and functions defined below.
Properties of objects that implement the ProcessingInstruction
interface:
target
This read-only property is a String.
data
This property is a String and can raise an object
that implements the DOMException interface on
setting.
Note: In addition of having [3295]DOMConfiguration parameters exposed
to the application using the setParameter and getParameter, those
parameters are also exposed as ECMAScript properties on the
[3296]DOMConfiguration object. The name of the parameter is converted
into a property name using a camel-case convention: the character '-'
(HYPHEN-MINUS) is removed and the following character is being
replaced by its uppercase equivalent.
07 November 2003
Appendix I: Acknowledgements
Many people contributed to the DOM specifications (Level 1, 2 or 3),
including participants of the DOM Working Group and the DOM Interest
Group. We especially thank the following:
Andrew Watson (Object Management Group), Andy Heninger (IBM), Angel
Diaz (IBM), Arnaud Le Hors (W3C and IBM), Ashok Malhotra (IBM and
Microsoft), Ben Chang (Oracle), Bill Smith (Sun), Bill Shea (Merrill
Lynch), Bob Sutor (IBM), Chris Lovett (Microsoft), Chris Wilson
(Microsoft), David Brownell (Sun), David Ezell (Hewlett-Packard
Company), David Singer (IBM), Dimitris Dimitriadis (Improve AB and
invited expert), Don Park (invited), Elena Litani (IBM), Eric Vasilik
(Microsoft), Gavin Nicol (INSO), Ian Jacobs (W3C), James Clark
(invited), James Davidson (Sun), Jared Sorensen (Novell), Jeroen van
Rotterdam (X-Hive Corporation), Joe Kesselman (IBM), Joe Lapp
(webMethods), Joe Marini (Macromedia), Johnny Stenback (Netscape/AOL),
Jon Ferraiolo (Adobe), Jonathan Marsh (Microsoft), Jonathan Robie
(Texcel Research and Software AG), Kim Adamson-Sharpe (SoftQuad
Software Inc.), Lauren Wood (SoftQuad Software Inc., former Chair),
Laurence Cable (Sun), Mark Davis (IBM), Mark Scardina (Oracle), Martin
Dürst (W3C), Mary Brady (NIST), Mick Goulish (Software AG), Mike
Champion (Arbortext and Software AG), Miles Sabin (Cromwell Media),
Patti Lutsky (Arbortext), Paul Grosso (Arbortext), Peter Sharpe
(SoftQuad Software Inc.), Phil Karlton (Netscape), Philippe Le Hégaret
(W3C, W3C Team Contact and former Chair), Ramesh Lekshmynarayanan
(Merrill Lynch), Ray Whitmer (iMall, Excite@Home, and Netscape/AOL,
Chair), Rezaur Rahman (Intel), Rich Rollman (Microsoft), Rick Gessner
(Netscape), Rick Jelliffe (invited), Rob Relyea (Microsoft), Scott
Isaacs (Microsoft), Sharon Adler (INSO), Steve Byrne (JavaSoft), Tim
Bray (invited), Tim Yu (Oracle), Tom Pixley (Netscape/AOL), Vidur
Apparao (Netscape), Vinod Anupam (Lucent).
Thanks to all those who have helped to improve this specification by
sending suggestions and corrections (Please, keep bugging us with your
issues!).
Many thanks to Andrew Clover, Petteri Stenius, Curt Arnold, Glenn A.
Adams, Christopher Aillon, Scott Nichol, François Yergeau, Anjana
Manian, Susan Lesch, and Jeffery B. Rancier for their review and
comments of this document.
Special thanks to the [3297]DOM Conformance Test Suites contributors:
Fred Drake, Mary Brady (NIST), Rick Rivello (NIST), Robert Clary
(Netscape), with a special mention to Curt Arnold.
[3297] http://www.w3.org/DOM/Test
I.1 Production Systems
This specification was written in XML. The HTML, OMG IDL, Java and
ECMAScript bindings were all produced automatically.
Thanks to Joe English, author of [3298]cost, which was used as the
basis for producing DOM Level 1. Thanks also to Gavin Nicol, who wrote
the scripts which run on top of cost. Arnaud Le Hors and Philippe Le
Hégaret maintained the scripts.
[3298] http://www.flightlab.com/cost
After DOM Level 1, we used [3299]Xerces as the basis DOM
implementation and wish to thank the authors. Philippe Le Hégaret and
Arnaud Le Hors wrote the [3300]Java programs which are the DOM
application.
[3299] http://xml.apache.org/xerces-j
[3300] http://dev.w3.org/cvsweb/java/classes/org/w3c/tools/specgenerator/
Thanks also to Jan Kärrman, author of [3301]html2ps, which we use in
creating the PostScript version of the specification.
[3301] http://user.it.uu.se/~jan/html2ps.html
07 November 2003
Glossary
Editors:
Arnaud Le Hors, W3C
Robert S. Sutor, IBM Research (for DOM Level 1)
Some of the following term definitions have been borrowed or modified
from similar definitions in other W3C or standards documents. See the
links within the definitions for more information.
16-bit unit
The base unit of a [3302]DOMString. This indicates that
indexing on a [3303]DOMString occurs in units of 16 bits. This
must not be misunderstood to mean that a [3304]DOMString can
store arbitrary 16-bit units. A [3305]DOMString is a character
string encoded in UTF-16; this means that the restrictions of
UTF-16 as well as the other relevant restrictions on character
strings must be maintained. A single character, for example in
the form of a numeric character reference, may correspond to
one or two 16-bit units.
ancestor
An ancestor node of any node A is any node above A in a tree
model, where "above" means "toward the root."
API
An API is an Application Programming Interface, a set of
functions or methods used to access some functionality.
anonymous type name
An anonymous type name is an implementation-defined, globally
unique qualified name provided by the processor for every
anonymous type declared in a [3306]schema.
child
A child is an immediate descendant node of a node.
client application
A [client] application is any software that uses the Document
Object Model programming interfaces provided by the hosting
implementation to accomplish useful work. Some examples of
client applications are scripts within an HTML or XML document.
COM
COM is Microsoft's Component Object Model [3307]COM], a
technology for building applications from binary software
components.
convenience
A convenience method is an operation on an object that could be
accomplished by a program consisting of more basic operations
on the object. Convenience methods are usually provided to make
the API easier and simpler to use or to allow specific programs
to create more optimized implementations for common operations.
A similar definition holds for a convenience property.
data model
A data model is a collection of descriptions of data structures
and their contained fields, together with the operations or
functions that manipulate them.
descendant
A descendant node of any node A is any node below A in a tree
model, where "below" means "away from the root."
document element
There is only one document element in a [3308]Document. This
element node is a child of the [3309]Document node. See
[3310]Well-Formed XML Documents in XML [3311]XML 1.0].
[3310] http://www.w3.org/TR/2000/REC-xml-20001006#dt-root
document order
There is an ordering, document order, defined on all the nodes
in the document corresponding to the order in which the first
character of the XML representation of each node occurs in the
XML representation of the document after expansion of general
entities. Thus, the [3312]document element node will be the
first node. Element nodes occur before their children. Thus,
document order orders element nodes in order of the occurrence
of their start-tag in the XML (after expansion of entities).
The attribute nodes of an element occur after the element and
before its children. The relative order of attribute nodes is
implementation-dependent.
ECMAScript
The programming language defined by the ECMA-262 standard
[3313]ECMAScript]. As stated in the standard, the originating
technology for ECMAScript was JavaScript [3314]JavaScript].
Note that in the ECMAScript binding, the word "property" is
used in the same sense as the IDL term "attribute."
element
Each document contains one or more elements, the boundaries of
which are either delimited by start-tags and end-tags, or, for
empty elements by an empty-element tag. Each element has a
type, identified by name, and may have a set of attributes.
Each attribute has a name and a value. See [3315]Logical
Structures in XML [3316]XML 1.0].
[3315] http://www.w3.org/TR/2000/REC-xml-20001006#sec-logical-struct
information item
An information item is an abstract representation of some
component of an XML document. See the [3317]XML Information
Set] for details.
logically-adjacent text nodes
Logically-adjacent text nodes are [3318]Text or
[3319]CDATASection nodes that can be visited sequentially in
[3320]document order or in reversed document order without
entering, exiting, or passing over [3321]Element,
[3322]Comment, or [3323]ProcessingInstruction nodes.
hosting implementation
A [hosting] implementation is a software module that provides
an implementation of the DOM interfaces so that a client
application can use them. Some examples of hosting
implementations are browsers, editors and document
repositories.
HTML
The HyperText Markup Language (HTML) is a simple markup
language used to create hypertext documents that are portable
from one platform to another. HTML documents are SGML documents
with generic semantics that are appropriate for representing
information from a wide range of applications. [3324]HTML
4.01]
inheritance
In object-oriented programming, the ability to create new
classes (or interfaces) that contain all the methods and
properties of another class (or interface), plus additional
methods and properties. If class (or interface) D inherits from
class (or interface) B, then D is said to be derived from B. B
is said to be a base class (or interface) for D. Some
programming languages allow for multiple inheritance, that is,
inheritance from more than one class or interface.
interface
An interface is a declaration of a set of methods with no
information given about their implementation. In object systems
that support interfaces and inheritance, interfaces can usually
inherit from one another.
language binding
A programming language binding for an IDL specification is an
implementation of the interfaces in the specification for the
given language. For example, a Java language binding for the
Document Object Model IDL specification would implement the
concrete Java classes that provide the functionality exposed by
the interfaces.
local name
A local name is the local part of a qualified name. This is
called the local part in Namespaces in XML [3325]XML
Namespaces].
method
A method is an operation or function that is associated with an
object and is allowed to manipulate the object's data.
model
A model is the actual data representation for the information
at hand. Examples are the structural model and the style model
representing the parse structure and the style information
associated with a document. The model might be a tree, or a
directed graph, or something else.
namespace prefix
A namespace prefix is a string that associates an element or
attribute name with a namespace URI in XML. See namespace
prefix in Namespaces in XML [3326]XML Namespaces].
namespace URI
A namespace URI is a URI that identifies an XML namespace. This
is called the namespace name in Namespaces in XML [3327]XML
[ Namespaces]. See also sections 1.3.2 "[3328] DOM URIs" and
1.3.3 "[3329] XML Namespaces" regarding URIs and namespace URIs
handling and comparison in the DOM APIs.
[3328] http://www.w3.org/TR/DOM-Level-3-Core/core.html#baseURIs-Considerations
[3329] http://www.w3.org/TR/DOM-Level-3-Core/core.html#Namespaces-Considerations
namespace well-formed
A node is a namespace well-formed XML node if it is a
[3330]well-formed node, and follows the productions and
namespace constraints. If [3331]XML 1.0] is used, the
constraints are defined in [3332]XML Namespaces]. If
[3333]XML 1.1] is used, the constraints are defined in
[3334]XML Namespaces 1.1].
object model
An object model is a collection of descriptions of classes or
interfaces, together with their member data, member functions,
and class-static operations.
parent
A parent is an immediate ancestor node of a node.
partially valid
A node in a DOM tree is partially valid if it is [3335]well
formed (this part is for comments and processing instructions)
and its immediate children are those expected by the content
model. The node may be missing trailing required children yet
still be considered partially valid.
qualified name
A qualified name is the name of an element or attribute defined
as the concatenation of a local name (as defined in this
specification), optionally preceded by a namespace prefix and
colon character. See [3336]Qualified Names in Namespaces in XML
[3337]XML Namespaces].
[3336] http://www.w3.org/TR/1999/REC-xml-names-19990114/#ns-qualnames
read only node
A read only node is a node that is immutable. This means its
list of children, its content, and its attributes, when it is
an element, cannot be changed in any way. However, a read only
node can possibly be moved, when it is not itself contained in
a read only node.
root node
The root node is a node that is not a child of any other node.
All other nodes are children or other descendants of the root
node.
schema
A schema defines a set of structural and value constraints
applicable to XML documents. Schemas can be expressed in schema
languages, such as DTD, XML Schema, etc.
sibling
Two nodes are siblings if they have the same parent node.
string comparison
When string matching is required, it is to occur as though the
comparison was between 2 sequences of code points from
[3338]Unicode].
token
An information item such as an XML Name which has been
[3339]tokenized.
tokenized
The description given to various information items (for
example, attribute values of various types, but not including
the StringType CDATA) after having been processed by the XML
processor. The process includes stripping leading and trailing
white space, and replacing multiple space characters by one.
See the definition of tokenized type.
well-formed
A node is a well-formed XML node if its serialized form,
without doing any transformation during its serialization,
matches its respective production in [3340]XML 1.0] or
[3341]XML 1.1] (depending on the XML version in use) with all
well-formedness constraints related to that production, and if
the entities which are referenced within the node are also
well-formed. If namespaces for XML are in use, the node must
also be [3342]namespace well-formed.
XML
Extensible Markup Language (XML) is an extremely simple dialect
of SGML which is completely described in this document. The
goal is to enable generic SGML to be served, received, and
processed on the Web in the way that is now possible with HTML.
XML has been designed for ease of implementation and for
interoperability with both SGML and HTML. [3343]XML 1.0]
07 November 2003