CARVIEW |
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
This version enhances DOM Level 2 Core by completing the mapping
between DOM and the XML Information Set
This document contains the Document Object Model Level 3 Core
specification and is a
It is based on the feedback received during the
W3C Advisory Committee Representatives are now invited to submit
their formal review via Web form, as described in the Call for
Review. Additional comments may be sent to a Team-only list,
Publication as a Proposed 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.
Patent disclosures relevant to this specification may be found
on the Working Group's
Created in electronic form.
$Revision: 1.5 $
Copyright © 2004
This document is published under the
This section is a copy of the W3C® Document
Notice and License and could be found at
Copyright © 2004
https://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
A link or URL to the original W3C document.
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]
When space permits, inclusion of the full text of this
No right to create modifications or derivatives of W3C documents is
granted pursuant to this license. However, if additional requirements
(documented in the
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.
This section is a copy of the W3C® Software
Copyright Notice and License and could be found at
Copyright © 2004
https://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:
The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
Any pre-existing intellectual property disclaimers, notices,
or terms and conditions. If none exist, the
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.
This section is a copy of the W3C® Short Software
Notice and could be found at
Copyright © 2004
Copyright © [$date-of-software]
[1] https://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
The Document Object Model (DOM) is an application programming interface
(
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
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
OMG IDL is used only as a language-independent and
implementation-neutral way to specify
The DOM is a programming
A graphical representation of the DOM of the example table, with whitespaces in element content (often abusively called "ignorable whitespace") removed, is:
An example of DOM manipulation using ECMAScript would be:
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
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 "
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
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
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
The Document Object Model, despite its name, is not a
competitor to the Component Object Model
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.
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:
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 <p> be recognized as a start tag. The representation of general
entities, both internal and external, are defined within the
extended (XML) interfaces of
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,
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
The following representation contains all DOM modules, represented using their feature names, defined along the DOM specifications:
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.
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
Here is the complete list of DOM Level 3.0 modules and the features used by them. Feature names are case-insensitive.
defines the feature
Defines the feature
defines the feature
defines the feature
defines the feature
defines the feature
defines the feature
defines the feature
defines the feature
defines the feature
defines the feature
defines the feature
defines the feature
defines the feature
A DOM implementation must not return true
to the
DOMImplementation.hasFeature(feature, version)
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"
.
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,
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.
DOM applications may provide additional interfaces and objects not found in this specification and still be considered DOM conformant.
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.
This specification defines a set of objects and interfaces for
accessing and manipulating document objects. The functionality
specified (the Document
object
using only DOM API calls. A solution for loading a
Document
and saving it persistently is proposed in
The DOM presents documents as a hierarchy of Node
objects
that also implement other, more specialized interfaces. Some types of
nodes may have Document
-- Element
(maximum of one),
ProcessingInstruction
, Comment
,
DocumentType
(maximum of one) DocumentFragment
-- Element
,
ProcessingInstruction
, Comment
,
Text
, CDATASection
,
EntityReference
DocumentType
-- no childrenEntityReference
-- Element
,
ProcessingInstruction
, Comment
,
Text
, CDATASection
,
EntityReference
Element
-- Element
, Text
,
Comment
, ProcessingInstruction
,
CDATASection
, EntityReference
Attr
-- Text
,
EntityReference
ProcessingInstruction
-- no childrenComment
-- no childrenText
-- no childrenCDATASection
-- no childrenEntity
-- Element
,
ProcessingInstruction
, Comment
,
Text
, CDATASection
,
EntityReference
Notation
-- no children
The DOM also specifies a NodeList
interface to handle
ordered lists of Nodes
, such as the children of a
Node
, or the Element.getElementsByTagNameNS(namespaceURI, localName)
method, and also a NamedNodeMap
interface to handle unordered sets of nodes referenced by their name
attribute, such as the attributes of an Element
.
NodeList
and
NamedNodeMap
objects in the DOM are NodeList
and NamedNodeMap
objects. For example, if a DOM user gets a NodeList
object containing the children of an Element
, then
subsequently adds more children to that
NodeList
, without further action on the user's
part. Likewise, changes to a Node
in the tree are
reflected in all references to that Node
in
NodeList
and NamedNodeMap
objects.
Finally, the interfaces Text
,
Comment
, and CDATASection
all inherit from
the CharacterData
interface.
Most of the APIs defined by this specification are
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
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
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.
The DOM Core Node
interface without requiring casts (in Java and other C-like languages)
or query interface calls in Node
interface. Because many other users will find the
Node
" approach to the
DOM, we also support the full higher-level interfaces for those who
prefer a more object-oriented
In practice, this means that there is a certain amount of redundancy
in the 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 Node
interface, we don't specify a completely
redundant one.) Thus, even though there is a generic
Node.nodeName
attribute on the Node
interface,
there is still a Element.tagName
attribute on the
Element
interface; these two attributes must contain the
same value, but the it is worthwhile to support both, given the
different constituencies the DOM
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.
DOMString
type
The DOMString
type is used to store
Characters are
the parameter "true
while loading the document or
the document was certified as defined in
the parameter "true
while using the method
Document.normalizeDocument()
, or while using
the method Node.normalize()
;
Note that, with the exceptions of
Document.normalizeDocument()
and
Node.normalize()
, manipulating characters using DOM
methods does not guarantee to preserve a
A DOMString
is a sequence of
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 DOMString
(a high surrogate and a low
surrogate). For issues related to string comparisons, refer to
For Java and ECMAScript, DOMString
is bound to the
String
type because both languages also use UTF-16
as their encoding.
As of August 2000, the OMG IDL specification
(wstring
type. However, that definition did not meet the interoperability
criteria of the DOM
DOMTimeStamp
type
The DOMTimeStamp
type is used to store an absolute
or relative time.
A DOMTimeStamp
represents a number of
milliseconds.
For Java, DOMTimeStamp
is bound to the
long
type. For ECMAScript, DOMTimeStamp
is bound to the Date
type because the range of the
integer
type is too small.
DOMUserData
type
The DOMUserData
type is used to store
application data.
A DOMUserData
represents a reference to
application data.
For Java, DOMUserData
is bound to the
Object
type. For ECMAScript,
DOMUserData
is bound to any type
.
DOMObject
type
The DOMObject
type is used to represent an
object.
A DOMObject
represents an object reference.
For Java and ECMAScript, DOMObject
is bound to the
Object
type.
The DOM has many interfaces that imply string matching. For
XML, string comparisons are case-sensitive and performed with a
binary 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
The character normalization, i.e. transforming into their DOMSerializer
interface, section
2.3.1) and uses the DOMConfiguration
parameters
"
The DOM specification relies on DOMString
values as
resource identifiers, such that the following conditions are
met:
An absolute identifier absolutely identifies a resource on the Web;
Simple string equality establishes equality of absolute resource identifiers, and no other equivalence of resource identifiers is considered significant to the DOM specification;
A relative identifier is easily detected and made absolute relative to an absolute identifier;
Retrieval of content of a resource may be accomplished where required.
The term "
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
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.
DOM Level 2 and 3 support XML namespaces Document.xmlVersion
), DOM Level 3 also supports
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
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 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.
Element.setAttributeNS(null, ...)
puts the attribute in
the
In the DOM, all namespace declaration attributes are
In a document with no namespaces, the
EntityReference
node is always the same as that of the
corresponding Entity
. This is not true in a document where
an entity contains unbound EntityReference
nodes may be bound to different
EntityReference
nodes can lead to documents that cannot be
serialized. This is also true when the DOM Level 1 method
Document.createEntityReference(name)
is used to create
entity references that correspond to such
entities, since the EntityReference
are unbound. While DOM Level
3 does have support for the resolution of namespace prefixes,
use of such entities and entity references should be
avoided or used with extreme care.
The "NS" methods, such as
Document.createElementNS(namespaceURI, qualifiedName)
and
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 Document.createElement(tagName)
and
Document.createAttribute(name)
. Elements and attributes created in this
way do not have any namespace prefix, namespace URI, or local name.
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
Node.nodeName
. On the contrary, the DOM Level 2 methods
related to namespaces, identify attribute nodes by their
Node.namespaceURI
and Node.localName
. Because of this
fundamental difference, mixing both sets of methods can lead to
unpredictable results. In particular, using
Element.setAttributeNS(namespaceURI, qualifiedName, value)
, an
Node.nodeName
, but different
Node.namespaceURI
s. Calling Element.getAttribute(name)
with
that nodeName
could then return any of those
attributes. The result depends on the implementation. Similarly,
using Element.setAttributeNode(newAttr)
, one can set two attributes (or
more) that have different Node.nodeName
s but the same
Node.prefix
and Node.namespaceURI
. In this case
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, Element.setAttribute(name, value)
and
Element.setAttributeNS(namespaceURI, qualifiedName, value)
affect the node that
Element.getAttribute(name)
and
Element.getAttributeNS(namespaceURI, localName)
,
respectively, return.
The DOM Level 3 adds support for the [base URI] property
defined in
Node
interface that exposes this information. However,
unlike the Node.namespaceURI
attribute, the
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 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 Document
one may need to add, or
change, an xml:base attribute to the
Element
nodes originally contained in the entity being
expanded so that the Node.baseURI
returns the correct value. In
the case of ProcessingInstruction
nodes originally
contained in the entity being expanded the information is lost.
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 by their users. For example, the MathML
While the Namespaces in XML specification
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
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 Document
object, since there can only be one owner and root of the document
hierarchy.
Each DOM module defines one or more features, as listed in the
conformance section ("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
DOMImplementationSource.getDOMImplementation(features)
or
DOMImplementationSource.getDOMImplementationList(features)
,
check the features supported by a DOM implementation using the
method DOMImplementation.hasFeature(feature, version)
, or by a specific node using
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 Node
interface if the feature
"Events" was supported by the node.
As discussed DOMImplementation.getFeature(feature, version)
and
Node.getFeature(feature, version)
were
introduced. In the case of
DOMImplementation.hasFeature(feature, version)
and
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
DOMImplementation.getFeature(feature, version)
and
Node.getFeature(feature, version)
. Without a plus,
only features whose interfaces are directly castable are
considered.
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
In all cases, though, the DOMImplementationRegistry
provides a getDOMImplementation
method accepting a
features string, which is passed to every known
DOMImplementationSource
until a suitable
DOMImplementation
is found and returned.
The DOMImplementationRegistry
also provides a getDOMImplementationList
method accepting a
features string, which is passed to every known
DOMImplementationSource
, and returns a list of suitable
DOMImplementations
. Those two methods are
the same as the ones found on the DOMImplementationSource
interface.
Any number of DOMImplementationSource
objects can be
registered. A source may return one or more
DOMImplementation
singletons or construct new
DOMImplementation
objects, depending upon whether the
requested features require specialized state in the
DOMImplementation
object.
The interfaces within this section are considered
A DOM application may use the
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 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
.
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 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.
An integer indicating the type of error generated.
Other numeric codes are reserved for W3C for possible future use.
If index or size is negative, or greater than the allowed value.
If the specified range of text does not fit into a DOMString
.
If any Node
is inserted somewhere it doesn't belong.
If a Node
is used in a different document than the one that created it
(that doesn't support it).
If an invalid or illegal character is specified, such as in a name.
If data is specified for a Node
which does not support data.
If an attempt is made to modify an object where modifications are not allowed.
If an attempt is made to reference a Node
in a context where it does
not exist.
If the implementation does not support the requested type of object or operation.
If an attempt is made to add an attribute that is already in use elsewhere.
If an attempt is made to use an object that is not, or is no longer, usable.
If an invalid or illegal string is specified.
If an attempt is made to modify the type of the underlying object.
If an attempt is made to create or change an object in a way which is incorrect with regard to namespaces.
If a parameter or an operation is not supported by the underlying object.
If a call to a method such as insertBefore
or
removeChild
would make the Node
invalid with
respect to
If the type of an object is incompatible with the expected type of the parameter associated to the object.
The DOMStringList
interface provides the abstraction
of an ordered collection of 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.
Returns the index
th item in the collection. If
index
is greater than or equal to the number of
DOMString
s in the list, this returns
null
.
Index into the collection.
The DOMString
at the index
th
position in the DOMStringList
, or
null
if that is not a valid index.
The number of DOMString
s in the list. The range of
valid child node indices is 0 to length-1
inclusive.
Test if a string is part of this DOMStringList
.
The string to look for.
true
if the string has been found,
false
otherwise.
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.
Returns the index
th name item in the collection.
Index into the collection.
The name at the index
th
position in the NameList
, or null
if
there is no name for the specified index or if the index is
out of range.
Returns the index
th namespaceURI item in the
collection.
Index into the collection.
The namespace URI at the index
th
position in the NameList
, or null
if
there is no name for the specified index or if the index is
out of range.
The number of pairs (name and namespaceURI) in the list. The
range of valid child node indices is 0 to length-1
inclusive.
Test if a name is part of this NameList
.
The name to look for.
true
if the name has been found,
false
otherwise.
Test if the pair namespaceURI/name is part of this
NameList
.
The namespace URI to look for.
The name to look for.
true
if the pair namespaceURI/name has been
found, false
otherwise.
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.
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
.
Index into the collection.
The DOMImplementation
at the index
th
position in the DOMImplementationList
, or
null
if that is not a valid index.
The number of DOMImplementation
s in the list. The
range of valid child node indices is 0 to length-1
inclusive.
This interface permits a DOM implementer to supply one or more
implementations, based upon requested features and versions, as
specified in DOMImplementationSource
object is listed in the
binding-specific list of available sources so that its
DOMImplementation
objects are made available.
A method to request the first DOM implementation that supports the specified features.
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 Node.getFeature()
and
DOMImplementation.getFeature()
.
The first DOM implementation that support the desired features, or
null
if this source has none.
A method to request a list of DOM implementations that support
the specified features and versions, as specified in
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"
A list of DOM implementations that support the desired features.
The DOMImplementation
interface provides a number of
methods for performing operations that are independent of any particular
instance of the document object model.
Test if the DOM implementation implements a specific feature
and version, as specified in
The name of the feature to test.
This is the version number of the feature to test.
true
if the feature is implemented in the specified
version, false
otherwise.
Creates an empty DocumentType
node. Entity declarations
and notations are not made available. Entity reference expansions and
default attribute additions do not occur..
The
The external subset public identifier.
The external subset system identifier.
A new DocumentType
node with
Node.ownerDocument
set to null
.
INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character according to
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
Creates a DOM Document object of the specified type with its document element.
Note that based on the DocumentType
given to create the
document, the implementation may instantiate specialized
Document
objects that support additional features than the
"Core", such as "HTML" DocumentType
after the
document was created makes this very unlikely to happen. Alternatively,
specialized Document
creation methods, such as
createHTMLDocument
Document
objects.
The null
.
The null
.
The type of document to be created or null
.
When doctype
is not null
, its
Node.ownerDocument
attribute is set to the document
being created.
A new Document
object with its document element. If the
NamespaceURI
, qualifiedName
, and
doctype
are null
, the returned
Document
is empty with no document element.
INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character according to
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
""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
This method returns a specialized object which implements the
specialized APIs of the specified feature and version, as
specified in DOMImplementation
interface.
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.
This is the version number of the feature to test.
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 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.
DocumentFragment
is a "lightweight" or "minimal"
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 Document
object could
fulfill this role, a 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 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
DocumentFragment
might have only one child and that child
node could be a Text
node. Such a structure model represents
neither an HTML document nor a well-formed XML document.
When a DocumentFragment
is inserted into a
Document
(or indeed any other Node
that may
take children) the children of the DocumentFragment
and not
the DocumentFragment
itself are inserted into the
Node
. This makes the DocumentFragment
very
useful when the user wishes to create nodes that are
DocumentFragment
acts as the parent of these nodes so that
the user can use the standard methods from the Node
interface, such as Node.insertBefore
and
Node.appendChild
.
The Document
interface represents the entire HTML or XML
document. Conceptually, it is the
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 Node
objects created have a
ownerDocument
attribute which associates them with the
Document
within whose context they were created.
The Document Type Declaration (see DocumentType
)
associated with this document. For XML
documents without a document type declaration this returns
null
. For HTML documents, a
DocumentType
object may be returned, independently
of the presence or absence of document type declaration in the
HTML document.
This provides direct access to the 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 Node.insertBefore
, or
Node.replaceChild
. Note, however, that while some
implementations may instantiate different types of
Document
objects supporting additional features than the
"Core", such as "HTML" DocumentType
specified at creation time,
changing it afterwards is very unlikely to result in a change of the
features supported.
The DOMImplementation
object that handles this
document. A DOM application may use objects from multiple
implementations.
This is a
Creates an element of the type specified. Note that the instance
returned implements the Element
interface, so attributes
can be specified directly on the returned object.
In addition, if there are known attributes with default values,
Attr
nodes representing them are automatically created and
attached to the element.
To create an element with a createElementNS
method.
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.
A new Element
object with the
nodeName
attribute set to tagName
, and
localName
, prefix
, and
namespaceURI
set to null
.
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use
specified in the Document.xmlVersion
attribute.
Creates an empty DocumentFragment
object.
A new DocumentFragment
.
Creates a Text
node given the specified string.
The data for the node.
The new Text
object.
Creates a Comment
node given the specified string.
The data for the node.
The new Comment
object.
Creates a CDATASection
node whose value is the specified
string.
The data for the CDATASection
contents.
The new CDATASection
object.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Creates a ProcessingInstruction
node given the specified
name and data strings.
The target part of the processing instruction.
Unlike Document.createElementNS
or
Document.createAttributeNS
, no namespace
well-formed checking is done on the target name. Applications
should invoke Document.normalizeDocument()
with
the parameter "true
in order to ensure that the target name is
namespace well-formed.
The data for the node.
The new ProcessingInstruction
object.
INVALID_CHARACTER_ERR: Raised if the specified target contains an
illegal character according to the XML version in use
specified in the Document.xmlVersion
attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Creates an Attr
of the given name. Note that the
Attr
instance can then be set on an Element
using the setAttributeNode
method.
To create an attribute with a createAttributeNS
method.
The name of the attribute.
A new 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.
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use
specified in the Document.xmlVersion
attribute.
Creates an EntityReference
object. In addition, if the
referenced entity is known, the child list of the
EntityReference
node is made the same as that of the
corresponding Entity
node.
If any descendant of the Entity
node has an unbound
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.
The name of the entity to reference.
Unlike Document.createElementNS
or
Document.createAttributeNS
, no namespace
well-formed checking is done on the entity name. Applications
should invoke Document.normalizeDocument()
with
the parameter "true
in order to ensure that the entity name is
namespace well-formed.
The new EntityReference
object.
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use
specified in the Document.xmlVersion
attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Returns a NodeList
of all the
Elements
in
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.
A new NodeList
object containing all the matched
Elements
.
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 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
The Note that the If the On import, the Only the On import, the Note that the The imported node copies its Note that the These three types of nodes inheriting from
Note that 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.
ownerElement
attribute is set to
null
and the specified
flag is set to
true
on the generated Attr
. The
Attr
are recursively imported and the
resulting nodes reassembled to form the corresponding
subtree.deep
parameter has no effect on
Attr
nodes; they always carry their children with
them when imported.deep
option was set to
true
, the
DocumentFragment
are recursively imported
and the resulting nodes reassembled under the imported
DocumentFragment
to form the corresponding
subtree. Otherwise, this simply generates an empty
DocumentFragment
.Document
nodes cannot be imported.DocumentType
nodes cannot be imported.Attr
nodes are
attached to the generated Element
. Default
attributes are importNode
deep
parameter was set to true
, the
Entity
nodes can be imported, however in the
current release of the DOM the DocumentType
is
readonly. Ability to add these imported nodes to a
DocumentType
will be considered for addition to a
future release of the DOM.publicId
, systemId
,
and notationName
attributes are copied. If a
deep
import is requested, the
Entity
are recursively imported and the
resulting nodes reassembled to form the corresponding
subtree.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
nodes can be imported, however in the
current release of the DOM the DocumentType
is
readonly. Ability to add these imported nodes to a
DocumentType
will be considered for addition to a
future release of the DOM.publicId
and
systemId
attributes are copied.deep
parameter has no effect on
this type of nodes since they cannot have any children.target
and
data
values from those of the source node.deep
parameter has no effect on
this type of nodes since they cannot have any children.CharacterData
copy their data
and
length
attributes from those of the source
node.deep
parameter has no effect on
these types of nodes since they cannot have any children.
The node to import.
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 Attr
, and
EntityReference
nodes.
The imported node that belongs to this Document
.
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 Document.xmlVersion
attribute. This may happen when importing an XML 1.1
Creates an element of the given
Per null
as the namespaceURI parameter for methods if they wish to have no
namespace.
The
The
A new Element
object with the following attributes:
Attribute | Value |
---|---|
Node.nodeName |
qualifiedName |
Node.namespaceURI |
namespaceURI |
Node.prefix | prefix, extracted from
qualifiedName , or null if there is no
prefix |
Node.localName |
qualifiedName |
Element.tagName |
qualifiedName |
INVALID_CHARACTER_ERR: Raised if the specified qualifiedName
contains an illegal character according to the XML version in use
specified in the Document.xmlVersion
attribute.
NAMESPACE_ERR: Raised if the qualifiedName
is
a malformed 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
"qualifiedName
or its prefix is "xmlns" and the
namespaceURI
is different from
"namespaceURI
is
"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.
Creates an attribute of the given
Per null
as the namespaceURI
parameter for methods if they wish to have no
namespace.
The
The
A new Attr
object with the following attributes:
Attribute | Value |
---|---|
Node.nodeName | qualifiedName |
Node.namespaceURI |
namespaceURI |
Node.prefix | prefix, extracted from
qualifiedName , or null if there is no
prefix |
Node.localName |
qualifiedName |
Attr.name |
qualifiedName |
Node.nodeValue |
the empty string |
INVALID_CHARACTER_ERR: Raised if the specified qualifiedName
contains an illegal character according to the XML version in use
specified in the Document.xmlVersion
attribute.
NAMESPACE_ERR: Raised if the qualifiedName
is
a malformed qualifiedName
has a prefix and the
namespaceURI
is null
, if the
qualifiedName
has a prefix that is "xml" and the
namespaceURI
is different from
"qualifiedName
or its prefix is "xmlns" and the
namespaceURI
is different from
"namespaceURI
is
"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.
Returns a NodeList
of all the Elements
with
a given
The "*"
matches all
namespaces.
The
A new NodeList
object containing all the matched
Elements
.
Returns the 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
Attr.isId
to determine if an attribute is of type
ID.
Attributes with the name "ID" or "id" are not of type ID unless so defined.
The unique id
value for an element.
The matching element or null
if there is none.
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.
An attribute specifying, as part of the null
when
unspecified.
An attribute specifying, as part of the false
when
unspecified.
No verification is done on the value when setting this
attribute. Applications should use
Document.normalizeDocument()
with the "
NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature.
An attribute specifying, as part of the "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
Document.normalizeDocument()
in order to check for
illegal characters in the Node
s that are already
part of this Document
.
DOM applications may use the
DOMImplementation.hasFeature(feature, version)
method with parameter values "XMLVersion" and "1.0"
(respectively) to determine if an implementation supports
Document
objects supporting a
version of the "XMLVersion" feature must not raise a
NOT_SUPPORTED_ERR
exception for the same version
number when using Document.xmlVersion
.
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.
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 DOMException
on DOM
operations or report errors while using
Document.normalizeDocument()
. In case of error, the
behavior is undefined. This attribute is true
by
default.
The location of the document or null
if undefined
or if the Document
was created using
DOMImplementation.createDocument
. No lexical
checking is performed when setting this attribute; this could
result in a null
value returned when using
Node.baseURI
.
Beware that when the Document
supports the feature
"HTML" Node.baseURI
.
Attempts to adopt a node from another document to this
document. If supported, it changes the
The The descendants of the source node are recursively
adopted. Only the These nodes can all be adopted. No specifics.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
Document.importNode()
instead. Note that if the
adopted node is already part of this document (i.e. the source
and target document are the same), this method still has the
effect of removing the source node from the child list of its
parent, if any. The following list describes the specifics for
each type of node.
ownerElement
attribute is set to
null
and the specified
flag is set to
true
on the adopted Attr
. The
descendants of the source Attr
are recursively
adopted.Document
nodes cannot be adopted.DocumentType
nodes cannot be adopted.Entity
nodes cannot be adopted.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
nodes cannot be adopted.
Since it does not create new nodes unlike the
Document.importNode()
method, this method does
not raise an INVALID_CHARACTER_ERR
exception, and
applications should use the
Document.normalizeDocument()
method to check if
an imported name contain an illegal character according to the
XML version in use.
The node to move into this document.
The adopted node, or null
if this operation fails, such
as when the source node comes from a different implementation.
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.
The configuration used when
Document.normalizeDocument()
is invoked.
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
EntityReference
nodes and normalizes
Text
nodes, as defined in the method
Node.normalize()
.
Otherwise, the actual result depends on the features being set
on the Document.domConfig
object and governing what
operations actually take place. Noticeably this method could
also make the document CDATASection
nodes,
etc. See DOMConfiguration
for details.
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 Node.nodeName
contains an
invalid character according to the XML version in use, errors or
warnings (DOMError.SEVERITY_ERROR
or
DOMError.SEVERITY_WARNING
) will be reported using
the DOMErrorHandler
object associated with the
"DOMError.SEVERITY_FATAL_ERROR
) if an
implementation cannot recover from an error.
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
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 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
Document.normalizeDocument()
to guarantee these
attributes are up-to-date.
When the node being renamed is an Attr
that is attached
to an Element
, the node is first removed from the
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 {https://www.w3.org/2001/xml-events
,
DOMElementNameChanged
} or
{https://www.w3.org/2001/xml-events
,
DOMAttributeNameChanged
} is fired.
The node to rename.
The new
The new
The renamed node. This is either the specified node or the new node that was created to replace the specified node.
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
INVALID_CHARACTER_ERR: Raised if the new qualified name contains an
illegal character according to the XML version in use
specified in the 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 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
"qualifiedName
, or
its prefix, is "xmlns" and the namespaceURI
is
different from "
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use
specified in the Document.xmlVersion
attribute.
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,
Text
nodes may not have children, and adding children to
such nodes results in a 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
Element
or attributes
for a
Comment
), this returns null
. Note that the
specialized interfaces may contain additional and more convenient
mechanisms to get and set the relevant information.
An integer indicating which type of node this is.
Numeric codes up to 200 are reserved to W3C for possible future use.
The node is an Element
.
The node is an Attr
.
The node is a Text
node.
The node is a CDATASection
.
The node is an EntityReference
.
The node is an Entity
.
The node is a ProcessingInstruction
.
The node is a Comment
.
The node is a Document
.
The node is a DocumentType
.
The node is a DocumentFragment
.
The node is a Notation
.
The values of nodeName
, nodeValue
, and
attributes
vary according to the node type as follows:
Interface | nodeName | nodeValue | attributes |
---|---|---|---|
Attr |
same as Attr.name |
same as Attr.value |
null |
CDATASection |
"#cdata-section" |
same as CharacterData.data , the content of
the CDATA Section |
null |
Comment |
"#comment" |
same as CharacterData.data , the content of the comment |
null |
Document |
"#document" |
null |
null |
DocumentFragment |
"#document-fragment" |
null |
null |
DocumentType |
same as DocumentType.name |
null |
null |
Element |
same as Element.tagName |
null |
NamedNodeMap |
Entity |
entity name | null |
null |
EntityReference |
name of entity referenced | null |
null |
Notation |
notation name | null |
null |
ProcessingInstruction |
same as ProcessingInstruction.target |
same as ProcessingInstruction.data |
null |
Text |
"#text" |
same as CharacterData.data , the content of the text node |
null |
The name of this node, depending on its type; see the table above.
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
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is
readonly and if it is not defined to be null
.
DOMSTRING_SIZE_ERR: Raised when it would return more characters
than fit in a DOMString
variable on the implementation
platform.
A code representing the type of the underlying object, as defined above.
The Attr
, Document
,
DocumentFragment
, Entity
, and
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
.
A NodeList
that contains all children of this node. If
there are no children, this is a NodeList
containing no
nodes.
The first child of this node. If there is no such node, this returns
null
.
The last child of this node. If there is no such node, this returns
null
.
The node immediately preceding this node. If there is no such node,
this returns null
.
The node immediately following this node. If there is no such node,
this returns null
.
A NamedNodeMap
containing the attributes of this node (if
it is an Element
) or null
otherwise.
The Document
object associated with this node. This is
also the Document
object used to create new nodes. When
this node is a Document
or a DocumentType
which is not used with any Document
yet, this is
null
.
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 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.
Inserting a node before itself is implementation dependent.
The node to insert.
The reference node, i.e., the node before which the new node must be inserted.
The node being inserted.
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 Document
and the DOM application
attempts to insert a second DocumentType
or
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 is of type Document
,
this exception might be raised if the DOM implementation doesn't
support the insertion of a DocumentType
or
Element
node.
Replaces the child node oldChild
with
newChild
in the list of children, and returns the
oldChild
node.
If newChild
is a DocumentFragment
object,
oldChild
is replaced by all of the
DocumentFragment
children, which are inserted in the same
order. If the newChild
is already in the tree, it is first
removed.
Replacing a node with itself is implementation dependent.
The new node to put in the child list.
The node being replaced in the list.
The node replaced.
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
Document
and the result of the
replacement operation would add a second DocumentType
or
Element
on the Document
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 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 Document
,
this exception might be raised if the DOM implementation doesn't
support the replacement of the DocumentType
child or
Element
child.
Removes the child node indicated by oldChild
from the
list of children, and returns it.
The node being removed.
The node removed.
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 Document
,
this exception might be raised if the DOM implementation doesn't
support the removal of the DocumentType
child or the
Element
child.
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.
The node to add.
If it is a DocumentFragment
object, the entire
contents of the document fragment are moved into the child list of
this node
The node added.
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
Document
and the DOM application
attempts to append a second DocumentType
or
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 previous parent of the node being inserted is readonly.
NOT_SUPPORTED_ERR: if the newChild
node is a
child of the Document
node, this exception might
be raised if the DOM implementation doesn't support the
removal of the DocumentType
child or
Element
child.
Returns whether this node has any children.
Returns true
if this node has any children,
false
otherwise.
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 UserDataHandlers
has been specified along with the
associated data these handlers will be called with the appropriate
parameters before this method returns.
Cloning an 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 Element
since the text is contained in a child
Text
node. Cloning an Attr
directly, as
opposed to be cloned as part of an Element
cloning
operation, returns a specified attribute (specified
is
true
). Cloning an Attr
always clones its
children, since they represent its value, no matter whether this is a
deep clone or not. Cloning an EntityReference
automatically constructs its subtree if a corresponding
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 EntityReference
clone are
Attr
nodes are specified. And, cloning
Document
, DocumentType
, Entity
,
and Notation
nodes is implementation dependent.
If true
, recursively clone the subtree under the
specified node; if false
, clone only the node itself
(and its attributes, if it is an Element
).
The duplicate node.
Puts all 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 Text
nodes, i.e.,
there are neither adjacent Text
nodes nor empty
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
DOMConfiguration
object attached to the
Node.ownerDocument
is true
, this
method will also fully normalize the characters of the
Text
nodes.
In cases where the document contains CDATASections
, the
normalize operation alone may not be sufficient, since XPointers do
not differentiate between Text
nodes and
CDATASection
nodes.
Tests whether the DOM implementation implements a specific feature and
that feature is supported by this node, as specified in
The name of the feature to test.
This is the version number of the feature to test.
Returns true
if the specified feature is supported on
this node, false
otherwise.
The null
if it is unspecified (see
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 Document.createElement()
, this is
always null
.
Per the
The null
if it is
unspecified. When it is defined to be null
, setting
it has no effect, including if the node is
Note that setting this attribute, when permitted, changes the
nodeName
attribute, which holds the
tagName
and name
attributes of the
Element
and 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
Document
interface, this is always null
.
INVALID_CHARACTER_ERR: Raised if the specified
prefix contains an illegal character according to the XML version in use
specified in the 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
"namespaceURI
of this node is different from
"qualifiedName
of this node is
"xmlns"
Returns the local part of the
For nodes of any type other than ELEMENT_NODE
and
ATTRIBUTE_NODE
and nodes created with a DOM Level 1
method, such as Document.createElement()
,
this is always null
.
Returns whether this node (if it is an element) has any attributes.
Returns true
if this node has any attributes,
false
otherwise.
The absolute base URI of this node or null
if the
implementation wasn't able to obtain an absolute URI. This value
is computed as described in Document
supports the feature "HTML" documentURI
attribute from the Document
interface otherwise.
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.
The two nodes are disconnected. Order between disconnected nodes is always implementation-specific.
The second node precedes the reference node.
The node follows the reference node.
The node contains the reference node. A node which contains is always preceding, too.
The node is contained by the reference node. A node which is contained is always following, too.
The determination of preceding versus following is implementation-specific.
Compares the reference node, i.e. the node on which this method
is being called, with a node, i.e. the one passed as a parameter, with
regard to their position in the document and according to the
The node to compare against the reference node.
Returns how the node is positioned relatively to the reference node.
NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.
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 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
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 |
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMSTRING_SIZE_ERR: Raised when it would return more characters
than fit in a DOMString
variable on the implementation
platform.
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.
The node to test against.
Returns true
if the nodes are the same,
false
otherwise.
Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See
The namespace URI to look for.
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.
This method checks if the specified namespaceURI
is the
default namespace or not.
The namespace URI to look for.
Returns true
if the specified namespaceURI
is the default namespace, false
otherwise.
Look up the namespace URI associated to the given prefix, starting from this node.
See
The prefix to look for. If this parameter is null
,
the method will return the default namespace URI if any.
Returns the associated namespace URI or null
if none is
found.
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 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:
The The nodeName
, localName
,
namespaceURI
, prefix
,
nodeValue
. This is: they are
both null
, or they have the same length and are
character for character identical.attributes
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.childNodes
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 The following string attributes are equal:
The The DocumentType
nodes to be equal, the following
conditions must also be satisfied:
publicId
, systemId
,
internalSubset
.entities
NamedNodeMaps
are
equal.notations
NamedNodeMaps
are
equal.
On the other hand, the following do not affect equality:
the ownerDocument
, baseURI
, and
parentNode
attributes, the specified
attribute for Attr
nodes, the schemaTypeInfo
attribute for Attr
and Element
nodes, the
Text.isElementContentWhitespace
attribute for
Text
nodes, as well as any user data or event listeners
registered on the nodes.
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.
The node to compare equality with.
Returns true
if the nodes are equal, false
otherwise.
This method returns a specialized object which implements the
specialized APIs of the specified feature and version, as
specified in Node
interface.
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.
This is the version number of the feature to test.
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 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.
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.
The key to associate the object to.
The object to associate to the given key, or null
to
remove any existing association to that key.
The handler to associate to that key, or null
.
Returns the DOMUserData
previously associated to
the given key on this node, or null
if there was none.
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.
The key the object is associated to.
Returns the DOMUserData
associated to the given
key on this node, or null
if there was none.
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
The items in the NodeList
are accessible via an
integral index, starting from 0.
Returns the index
th item in the collection. If
index
is greater than or equal to the number of nodes in
the list, this returns null
.
Index into the collection.
The node at the index
th position in the
NodeList
, or null
if that is not a valid
index.
The number of nodes in the list. The range of valid child node indices
is 0 to length-1
inclusive.
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 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
Retrieves a node specified by name.
The nodeName
of a node to retrieve.
A Node
(of any type) with the specified
nodeName
, or null
if it does not identify
any node in this map.
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.
A node to store in this map. The node will later be accessible
using the value of its nodeName
attribute.
If the new Node
replaces an existing node the replaced
Node
is returned, otherwise null
is
returned.
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
Attr
that is already an attribute of another
Element
object. The DOM user must explicitly clone
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.
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.
The nodeName
of the node to remove.
The node removed from this map if a node with such a name exists.
NOT_FOUND_ERR: Raised if there is no node named name
in this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
Returns the index
th item in the map. If
index
is greater than or equal to the number of nodes in
this map, this returns null
.
Index into this map.
The node at the index
th position in the map, or
null
if that is not a valid index.
The number of nodes in this map. The range of valid child node indices
is 0
to length-1
inclusive.
Retrieves a node specified by local name and namespace URI.
Per
The
The
A Node
(of any type) with the specified local name and
namespace URI, or null
if they do not identify any node
in this map.
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
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
A node to store in this map. The node will later be accessible
using the value of its namespaceURI
and
localName
attributes.
If the new Node
replaces an existing node the replaced
Node
is returned, otherwise null
is
returned.
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
Attr
that is already an attribute of another
Element
object. The DOM user must explicitly clone
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
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 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
The
The
The node removed from this map if a node with such a local name and namespace URI exists.
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
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 Text
and others do
inherit the interface from it. All offsets
in this
interface start from 0
.
As explained in the 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
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 DOMString
. In such cases, the user
may call substringData
to retrieve the data in
appropriately sized pieces.
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMSTRING_SIZE_ERR: Raised when it would return more characters
than fit in a DOMString
variable on the implementation
platform.
The number of data
and the
substringData
method below. This may have the value zero,
i.e., CharacterData
nodes may be empty.
Extracts a range of data from the node.
Start offset of substring to extract.
The number of 16-bit units to extract.
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.
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 DOMString
.
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 DOMString
specified.
The DOMString
to append.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Insert a string at the specified
The character offset at which to insert.
The DOMString
to insert.
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.
Remove a range of data
and length
reflect the change.
The offset from which to start removing.
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.
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.
Replace the characters starting at the specified
The offset from which to start replacing.
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).
The DOMString
with which the range must be
replaced.
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.
The Attr
interface represents an attribute in an
Element
object. Typically the allowable values for the
attribute are defined in a schema associated with the document.
Attr
objects inherit the 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
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
DocumentFragment
. However, they can be associated with
Element
nodes contained within a
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 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 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 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
Text
or EntityReference
nodes (when these are
in use; see the description of 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
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 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
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 Attr.value |
Serialized attribute value |
---|---|---|---|
Character reference | |||
Built-in character entity | |||
Literal newline between | |||
Normalized newline between | |||
Entity e with literal newline |
Returns the name of this attribute. If
Node.localName
is different from null
, this
attribute is a
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 Document.normalizeDocument()
to guarantee this information is up-to-date.
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
Element
interface.
On setting, this creates a 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 Element.setAttribute()
.
Some specialized implementations, such as some
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
The Element
node this attribute is attached to or
null
if this attribute is not in use.
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
Document.normalizeDocument()
,
schemaTypeInfo
may not be reliable if the node was
moved.
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 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 Document.normalizeDocument()
, the
post-schema-validation infoset contributions (PSVI
contributions) values are used to determine if this
attribute is a
If validation occurred using a DTD while loading the document
or while invoking Document.normalizeDocument()
,
the infoset [type definition] value is used to determine if this
attribute is a
from the use of the methods
Element.setIdAttribute()
,
Element.setIdAttributeNS()
, or
Element.setIdAttributeNode()
, i.e. it is an
XPointer framework (see section 3.2 in
using mechanisms that are outside the scope of this
specification, it is then an
If validation occurred while invoking
Document.normalizeDocument()
, all
Attr.schemaTypeInfo
attribute contains an ID type,
isId
will always return true.
The Element
interface represents an
Element
interface inherits from Node
, the
generic 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
Attr
object by name or an attribute value by name. In XML,
where an attribute value may contain entity references, an
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
In DOM Level 2, the method normalize
is inherited from
the Node
interface where it was moved.
The name of the element. If Node.localName
is
different from null
, this
attribute is a 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.
Retrieves an attribute value by name.
The name of the attribute to retrieve.
The Attr
value as a string, or the empty string if that
attribute does not have a specified or default value.
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 Attr
node plus any Text
and
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.
The name of the attribute to create or alter.
Value to set in string form.
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use
specified in the Document.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
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
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.
The name of the attribute to remove.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI, use
the getAttributeNodeNS
method.
The name (nodeName
) of the attribute to retrieve.
The Attr
node with the specified name
(nodeName
) or null
if there is no such
attribute.
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.
The Attr
node to add to the attribute list.
If the newAttr
attribute replaces an existing
attribute, the replaced Attr
node is returned, otherwise
null
is returned.
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 Attr
nodes to re-use them in other
elements.
Removes the specified attribute node. If a default value for the
removed 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 Document.normalizeDocument()
to guarantee this
information is up-to-date.
The Attr
node to remove from the attribute list.
The Attr
node that was removed.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldAttr
is not an attribute
of the element.
Returns a NodeList
of all
Elements
with a given tag name, in
The name of the tag to match on. The special value "*" matches all tags.
A list of matching Element
nodes.
Retrieves an attribute value by local name and namespace URI.
Per null
as the namespaceURI
parameter for methods if they wish to have no
namespace.
The
The
The Attr
value as a string, or the empty string if that
attribute does not have a specified or default value.
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
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
Attr
node plus any Text
and
EntityReference
nodes, build the appropriate subtree, and
use setAttributeNodeNS
or setAttributeNode
to
assign it as the value of an attribute.
Per null
as the namespaceURI
parameter for methods if they wish to have no
namespace.
The
The
The value to set in string form.
INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character according to the XML version in use
specified in the 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
"qualifiedName
or its prefix is "xmlns" and the
namespaceURI
is different from
"namespaceURI
is
"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
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 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 null
as the namespaceURI
parameter for methods if they wish to have no
namespace.
The
The
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
Retrieves an Attr
node by local name and namespace
URI.
Per null
as the namespaceURI
parameter for methods if they wish to have no
namespace.
The
The
The Attr
node with the specified attribute local name
and namespace URI or null
if there is no such
attribute.
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
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 null
as the namespaceURI
parameter for methods if they wish to have no
namespace.
The Attr
node to add to the attribute list.
If the newAttr
attribute replaces an existing attribute
with the same Attr
node is returned, otherwise null
is
returned.
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 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
Returns a NodeList
of all the
Elements
with a given local name and namespace URI in
The
The
A new NodeList
object containing all the matched
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
Returns true
when an attribute with a given name is
specified on this element or has a default value, false
otherwise.
The name of the attribute to look for.
true
if an attribute with the given name is specified
on this element or has a default value, false
otherwise.
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 null
as the namespaceURI
parameter for methods if they wish to have no
namespace.
The
The
true
if an attribute with the given local name and
namespace URI is specified or has a default value on this element,
false
otherwise.
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
The type information associated with this element.
If the parameter isId
is true
, this
method declares the specified attribute to be a
Attr.isId
and the behavior of
Document.getElementById
, but does not change any
schema that may be in use, in particular this does not affect
the Attr.schemaTypeInfo
of the specified
Attr
node. Use the value false
for the
parameter isId
to undeclare an attribute for being
a
To specify an attribute by local name and namespace URI, use the
setIdAttributeNS
method.
The name of the attribute.
Whether the attribute is a of type ID.
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.
If the parameter isId
is true
, this
method declares the specified attribute to be a
Attr.isId
and the behavior of
Document.getElementById
, but does not change any
schema that may be in use, in particular this does not affect
the Attr.schemaTypeInfo
of the specified
Attr
node. Use the value false
for the
parameter isId
to undeclare an attribute for being
a
The
The
Whether the attribute is a of type ID.
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.
Declares the attribute specified by node to be of type ID,
i.e. the Attr
node becomes a Attr.isId
will
be true
. Note, however, that this simply
affects the attribute Attr.isId
of the
Attr
node and does not change any schema that may
be in use, in particular this does not affect the
Attr.schemaTypeInfo
of the specified
Attr
node.
The attribute node.
Whether the attribute is a of type ID.
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.
The Text
interface inherits from CharacterData
and represents the textual content (termed
Element
or 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
Text
nodes that form the list of
children of the element.
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
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.
Breaks this node into two nodes at the specified offset
,
keeping both in the tree as
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
offset
is equal to the length of this node, the new
node has no data.
The 0
.
The new node, of the same type as this node.
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.
Returns whether this text node contains Document.normalizeDocument()
.
Returns all text of Text
nodes
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".
Replaces the text of the current node and
all
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
a new Text
node of the same type
(Text
or 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:
Where the nodes to be removed are read-only descendants of an
EntityReference
, the EntityReference
must be
removed instead of the read-only nodes. If any
EntityReference
to be removed has descendants that are not
EntityReference
, Text
, or
CDATASection
nodes, the replaceWholeText
method
must fail before performing any modification of the document, raising a
DOMException
with the code
NO_MODIFICATION_ALLOWED_ERR
.
For instance, in the example below calling
replaceWholeText
on the Text
node that
contains "bar" fails, because the EntityReference
node "ent" contains an Element
node which cannot be
removed.
The content of the replacing Text
node.
The Text
node created with the specified content.
NO_MODIFICATION_ALLOWED_ERR: Raised if one of the
Text
nodes being replaced is readonly.
This interface inherits from CharacterData
and represents
the content of a comment, i.e., all the characters between the starting
'<!--
' and ending '-->
'. 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
The TypeInfo
interface represents a type referenced
from Element
or Attr
nodes, specified in
the
If the document's schema is an XML DTD
If this type is referenced from an Attr
node,
typeNamespace
is
"https://www.w3.org/TR/REC-xml"
and
typeName
represents the [attribute type]
property in the typeNamespace
and
typeName
are null
.
If this type is referenced from an Element
node,
typeNamespace
and typeName
are
null
.
If the document's schema is an XML Schema
If the [validity] property exists AND is
null
.
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
If [member type definition] exists:
If {name} is not absent, then expose {name} and {target namespace} properties of the [member type definition] property;
Otherwise, expose the namespace and local name of the corresponding
If the [type definition] property exists:
If {name} is not absent, then expose {name} and {target namespace} properties of the
[type definition] property; Otherwise, expose the namespace and local name of the corresponding
If the [member type definition anonymous] exists:
If it is false, then expose
[member type definition name] and [member type definition namespace] properties; Otherwise, expose the namespace and local name of the corresponding
If the [type definition anonymous] exists:
If it is false, then expose
[type definition name] and [type definition namespace] properties; Otherwise, expose the namespace and local name of the corresponding
Other schema languages are outside the scope of the W3C and
therefore should define how to represent their type systems using
TypeInfo
.
The name of a type declared for the associated element or
attribute, or null
if unknown.
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.
The type of derivation, used by the method
TypeInfo.isDerivedFrom()
.
If the document's schema is an XML Schema
If the document's schema is an XML Schema
If the document's schema is an XML Schema
If the document's schema is an XML Schema
The method checks if this TypeInfo
derives from the
specified ancestor type.
the namespace of the ancestor type.
the name of the ancestor type.
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.
TypeInfo.DERIVATION_EXTENSION
only applies
to XML Schema complex types.
The value 0x00000000
represents any kind of
derivation method.
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
.
When associating an object to a key on a node using
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.
An integer indicating the type of operation being performed on a node.
The node is cloned, using Node.cloneNode()
.
The node is imported, using Node.importNode()
.
The node is deleted.
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.
The node is renamed, using Node.renameNode()
.
The node is adopted, using Node.adoptNode()
.
This method is called whenever the node for which this handler is registered is imported or cloned.
DOM applications must not raised exceptions in a
UserDataHandler
. The effect of throwing exceptions
from the handler is DOM implementation dependent.
Specifies the type of operation that is being performed on the node.
Specifies the key for which this handler is being called.
Specifies the data for which this handler is being called.
Specifies the node being cloned, adopted, imported, or
renamed. This is null
when the node is being
deleted.
Specifies the node newly created if any, or null
.
DOMError
is an interface that describes an error.
An integer indicating the severity of the error.
The severity of the error described by the
DOMError
is warning. A
SEVERITY_WARNING
will not cause the processing to
stop, unless DOMErrorHandler.handleError()
returns
false
.
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 DOMErrorHandler.handleError()
returns false
.
The severity of the error described by the
DOMError
is fatal error. A
SEVERITY_FATAL_ERROR
will cause the normal
processing to stop. The return value of
DOMErrorHandler.handleError()
is ignored unless the
implementation chooses to continue, in which case the behavior
becomes undefined.
The severity of the error, either
SEVERITY_WARNING
, SEVERITY_ERROR
,
or SEVERITY_FATAL_ERROR
.
An implementation specific string describing the error that occurred.
A DOMString
indicating which related data is
expected in relatedData
. Users should refer to the
specification of the error in order to find its
DOMString
type and relatedData
definitions if any.
As an example, Document.normalizeDocument()
does
generate warnings when the "SEVERITY_WARNING
with type
"cdata-section-splitted"
and the first
CDATASection
node in document order resulting
from the split is returned by the relatedData
attribute.
The related platform dependent exception if any.
The related DOMError.type
dependent data if any.
The location of the error.
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 Document
using the
"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.
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
.
The error object that describes the error. This object may
be reused by the DOM implementation across multiple calls to
the handleError
method.
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
DOMError.severity
.
DOMLocator
is an interface that describes a location
(e.g. where an error occurred).
The line number this locator is pointing to, or -1
if
there is no column number available.
The column number this locator is pointing to, or -1
if
there is no column number available.
The byte offset into the input source this locator is pointing
to or -1
if there is no byte offset available.
The UTF-16, as defined in -1
if there is no UTF-16
offset available.
The node this locator is pointing to, or null
if no node
is available.
The URI this locator is pointing to, or null
if no URI
is available.
The DOMConfiguration
interface represents the
configuration of a document and maintains a table of recognized
parameters. Using the configuration, it is possible to change
Document.normalizeDocument()
behavior, such as
replacing the CDATASection
nodes with
Text
nodes or specifying the type of the Document
is
requested. DOMConfiguration
objects are also used in
DOMParser
and DOMSerializer
interfaces.
The parameter names used by the DOMConfiguration
object are defined throughout the DOM Level 3
specifications. Names are case-insensitive. 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 5.16 Identifiers
of
Parameters are similar to features and properties used in SAX2
The following list of parameters defined in the DOM:
[
Canonicalize the document according to the rules
specified in DocumentType
node (if
any) from the tree, or removing superfluous namespace
declarations from each element. 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. In addition,
Setting this parameter to true
will also
set the state of the parameters listed below. Later
changes to the state of one of those parameters will
revert "false
.
Parameters set to
false
:
"
Parameters set to
true
:
"
Other parameters are not changed unless explicitly specified in the description of the parameters.
[
Do not canonicalize the document.
[
Keep CDATASection
nodes in the document.
[
Transform CDATASection
nodes in the document
into Text
nodes. The new Text
node is then combined with any adjacent Text
node.
[
Check if the characters in the document are
[
Do not check if characters are normalized.
[
Keep Comment
nodes in the document.
[
Discard Comment
nodes in the document.
[
Exposed schema-normalized values in the tree. Since
this parameter requires to have true
. Having this parameter activated
when "validate" is false
has no effect
and no schema-normalization will happen.
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
[
Do not perform schema normalization on the tree.
[
Keep all whitespaces in the document.
[
Discard all Text
nodes that contain
whitespaces in element content, as described in
Text.isElementContentWhitespace
to
determine if a Text
node should be
discarded or not.
[
Keep EntityReference
nodes in the
document.
[
Remove all EntityReference
nodes from the
document, putting the entity expansions directly in
their place. Text
nodes are normalized,
as defined in Node.normalize
. Only
EntityReference
nodes to non-defined
entities are kept in the document, with their
associated Entity
nodes if any.
[
Contains a DOMErrorHandler
object. If an error
is encountered in the document, the implementation will call
back the DOMErrorHandler
registered using this
parameter. The implementation may provide a default
DOMErrorHandler
object.
When called, 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, DOMError.relatedData
will contain
the Document
node. Mutations to the document
from within an error handler will result in implementation
dependent behavior.
[
Keep in the document the information defined in the
XML Information Set
This forces the following parameters to
false
:
"
This forces the following parameters to
true
:
"
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.
Setting infoset
to false
has no effect.
[
Perform the namespace processing as defined in
[
Do not perform the namespace processing.
This parameter has no effect if the parameter "false
.
[
Include namespace declaration attributes, specified or
defaulted from the
[
Discard all namespace declaration attributes. The
namespace prefixes (Node.prefix
) are
retained even if this parameter is set
to false
.
[
[
Do not perform character normalization.
[
Represent a DOMString
object containing a list
of URIs, separated by whitespaces (characters matching the
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
.
The "schema-location"
parameter is ignored
unless the "Document.documentURI
will be set so that an
implementation can successfully resolve any external
entities referenced.
[
Represent a DOMString
object containing an
absolute URI and representing the type of the
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
.
For XML Schema "https://www.w3.org/2001/XMLSchema"
. For XML
DTD "https://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 containing the CDATA section
termination marker ']]>'. When a CDATA section is split
a warning is issued with a
DOMError.type
equals to
"cdata-sections-splitted"
and
DOMError.relatedData
equals to the first
CDATASection
node in document order
resulting from the split.
[
Signal an error if a CDATASection
contains
an unrepresentable character.
[
Require the validation against a true
.
This parameter will reevaluate:
Attribute nodes with Attr.specified
equals to false
, as specified in the
description of the Attr
interface;
The value of the attribute
Text.isElementContentWhitespace
for
all Text
nodes;
The value of the attribute Attr.isId
for all Attr
nodes;
The attributes Element.schemaTypeInfo
and Attr.schemaTypeInfo
.
"true
will set
the other one to false
. Applications
should also consider setting the parameter
"true
,
which is the default for that option, when
validating the document.
[
Do not accomplish schema processing, including the
internal subset processing. Note that validation might
still happen if "true
.
[
Enable validation only if a declaration for the
document element can be found in a true
.
"validate-if-schema" and
"true
will
set the other one to false
.
[
No schema processing should be performed if the
document has a schema, including internal subset
processing. Note that validation must still happen if
"true
.
[
Check if all nodes are XML Document.xmlVersion
:
check if the attribute Node.nodeName
contains invalid characters according to its node
type and generate a DOMError
of type
"wf-invalid-character-in-node-name"
,
with a DOMError.SEVERITY_ERROR
severity, if necessary;
check if the text content inside
Attr
, Element
,
Comment
, Text
,
CDATASection
nodes for invalid
characters and generate a DOMError
of
type "wf-invalid-character"
, with a
DOMError.SEVERITY_ERROR
severity, if
necessary;
check if the data inside
ProcessingInstruction
nodes for
invalid characters and generate a
DOMError
of type
"wf-invalid-character"
, with a
DOMError.SEVERITY_ERROR
severity, if
necessary;
[
Do not check for XML well-formedness.
The resolution of the system identifiers associated with entities
is done using Document.documentURI
. However, when the
feature "LS" defined in DOMConfiguration
objects attached to
Document
nodes. If this parameter is set,
Document.normalizeDocument()
will invoke the resource
resolver instead of using Document.documentURI
.
Set the value of a parameter.
The name of the parameter to set.
The new value or null
if the user wishes to
unset the parameter. While the type of the value parameter
is defined as DOMUserData
, the object type must
match the type defined by the definition of the
parameter. For example, if the parameter is DOMErrorHandler
.
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.
Return the value of a parameter if known.
The name of the parameter.
The current object associated with the specified parameter or
null
if no object has been associated or if the
parameter is not supported.
NOT_FOUND_ERR: Raised when the parameter name is not recognized.
Check if setting a parameter to a specific value is supported.
The name of the parameter to check.
An object. if null
, the returned value is
true
.
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.
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.
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
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 Document.xmlVersion
. Please refer to additional
information about 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
.
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 CharacterData.data
attribute
holds the text that is contained by the CDATA
section. Note that this
The CDATASection
interface inherits from the
CharacterData
interface through the Text
interface. Adjacent CDATASection
nodes are not merged by use
of the normalize
method of the 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 "split-cdata-sections"
in the
DOMConfiguration
interface).
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.
Each 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.
DOM Level 3 doesn't support editing DocumentType
nodes. DocumentType
nodes are
The name of DTD; i.e., the name immediately following the
DOCTYPE
keyword.
A NamedNodeMap
containing the general entities, both
external and internal, declared in the DTD. Parameter entities are not
contained. Duplicates are discarded. For example in:
foo
and the first
declaration of bar
but not the second declaration of
bar
or baz
. Every node in this map also
implements the Entity
interface.
The DOM Level 2 does not support editing entities, therefore
entities
cannot be altered in any way.
A NamedNodeMap
containing the notations declared in the
DTD. Duplicates are discarded. Every node in this map also implements
the Notation
interface.
The DOM Level 2 does not support editing notations, therefore
notations
cannot be altered in any way.
The public identifier of the external subset.
The system identifier of the external subset. This may be an absolute URI or not.
The internal subset as a string, or null
if there is
none. This is does not contain the delimiting square brackets.
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.
This interface represents a notation declared in the DTD. A notation
either declares, by name, the format of an unparsed entity (see nodeName
attribute
inherited from
Node
is set to the declared name of the notation.
The DOM Core does not support editing Notation
nodes; they are therefore
A Notation
node does not have any parent.
The public identifier of this notation. If the
public identifier was not specified, this is null
.
The system identifier of this notation. If the system identifier
was not specified, this is null
. This may be an absolute
URI or not.
This interface represents a known entity, either parsed or unparsed, in an
XML document. Note that this models the entity itself
The nodeName
attribute that is inherited from
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
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
Entity
node's child list
represents the structure of that replacement value. Otherwise, the child
list is empty.
DOM Level 3 does not support editing Entity
nodes; if a
user wants to make changes to the contents of an Entity
,
every related 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
An Entity
node does not have any parent.
If the entity contains an unbound
namespaceURI
of the corresponding node in the
Entity
node subtree is null
. The same is
true for EntityReference
nodes that refer to this entity,
when they are created using the createEntityReference
method of the Document
interface.
The public identifier associated with the entity if specified, and
null
otherwise.
The system identifier associated with the entity if specified, and
null
otherwise. This may be an absolute URI or not.
For unparsed entities, the name of the notation for the entity. For
parsed entities, this is null
.
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.
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.
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.
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
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 Entity
exists, and the subtree of the
EntityReference
node is a copy of the
Entity
node subtree. However, the latter may not be true
when an entity contains an unbound EntityReference
node may be bound to different
EntityReference
node represents a reference to an unknown
entity, the node has no children and its
replacement value, when used by Attr.value
for example,
is empty.
As for Entity
nodes, EntityReference
nodes and
all their
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.
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
The target of this processing instruction. XML defines this as being
the first
The content of this processing instruction. This is from the first non
white space character after the target to the character immediately
preceding the ?>
.
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
This section summarizes the changes between
The following new sections have been added:
DOMConfiguration
;
The Attr
interface has two new attributes,
Attr.schemaTypeInfo
, and
Attr.isId
.
The Document
interface has seven new
attributes: Document.inputEncoding
,
Document.xmlEncoding
,
Document.xmlStandalone
,
Document.xmlVersion
,
Document.strictErrorChecking
,
Document.documentURI
, and
Document.domConfig
. It has three new methods:
Document.adoptNode(source)
,
Document.normalizeDocument()
, and
Document.renameNode(n, namespaceURI,
qualifiedName)
. The attribute
Document.doctype
has been modified.
The DOMException
has two new exception codes:
VALIDATION_ERR
and
TYPE_MISMATCH_ERR
.
The DOMImplementation
interface has one new
method, DOMImplementation.getFeature(feature,
version)
.
The Entity
interface has three new
attributes: Entity.inputEncoding
,
Entity.xmlEncoding
, and
Entity.xmlVersion
.
The Element
interface has one new attribute,
Element.schemaTypeInfo
, and three new methods:
Element.setIdAttribute(name, isId)
,
Element.setIdAttributeNS(namespaceURI, localName,
isId)
, and Element.setIdAttributeNode(idAttr,
isId)
.
The Node
interface has two new attributes,
Node.baseURI
and Node.textContent
.
It has nine new methods:
Node.compareDocumentPosition(other)
,
Node.isSameNode(other)
,
Node.lookupPrefix(namespaceURI)
,
Node.isDefaultNamespace(namespaceURI)
,
Node.lookupNamespaceURI(prefix)
,
Node.isEqualNode(arg)
,
Node.getFeature(feature, version)
,
Node.setUserData(key, data, handler)
,
Node.getUserData(key)
. It introduced 6 new
constants: Node.DOCUMENT_POSITION_DISCONNECTED
,
Node.DOCUMENT_POSITION_PRECEDING
,
Node.DOCUMENT_POSITION_FOLLOWING
,
Node.DOCUMENT_POSITION_CONTAINS
,
Node.DOCUMENT_POSITION_CONTAINED_BY
, and
Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
. The
methods Node.insertBefore(newChild, refChild)
,
Node.replaceChild(newChild, oldChild)
and
Node.removeChild(oldChild)
have been modified.
The Text
interface has two new attributes,
Text.wholeText
and
Text.isElementContentWhitespace
, and one new
method, Text.replaceWholeText(content)
.
The "XMLVersion" DOM feature was introduced to represent if
an implementation is able to support Document.xmlVersion
.
The DOMUserData
type was added to the Core
module.
The DOMObject
type was added to the Core
module.
The DOMStringList
interface has one
attribute, DOMStringList.length
, and one
method, DOMStringList.item(index)
.
The NameList
interface has one attribute,
NameList.length
, and two methods,
NameList.getName(index)
and
NameList.getNamespaceURI(index)
.
The DOMImplementationList
interface has one
attribute, DOMImplementationList.length
, and
one method,
DOMImplementationList.item(index)
.
The DOMImplementationSource
interface has two
methods,
DOMImplementationSource.getDOMImplementation(features)
,
and
DOMImplementationSource.getDOMImplementationList(features)
.
The TypeInfo
interface has two attributes,
TypeInfo.typeName
, and
TypeInfo.typeNamespace
.
The UserDataHandler
interface has one method,
UserDataHandler.handle(operation, key, data, src,
dst)
, and four constants:
UserDataHandler.NODE_CLONED
,
UserDataHandler.NODE_IMPORTED
,
UserDataHandler.NODE_DELETED
, and
UserDataHandler.NODE_RENAMED
.
The DOMError
interface has six attributes:
DOMError.severity
,
DOMError.message
,
DOMError.type
,
DOMError.relatedException
,
DOMError.relatedData
, and
DOMError.location
. It has four constants:
DOMError.SEVERITY_WARNING
,
DOMError.SEVERITY_ERROR
, and
DOMError.SEVERITY_FATAL_ERROR
.
The DOMErrorHandler
interface has one method:
DOMErrorHandler.handleError(error)
.
The DOMLocator
interface has seven attributes:
DOMLocator.lineNumber
,
DOMLocator.columnNumber
,
DOMLocator.byteOffset
,
DOMLocator.utf16Offset
,
DOMLocator.relatedNode
,
DOMLocator.uri
, and
DOMLocator.lineNumber
.
The DOMConfiguration
interface has one attribute:
DOMConfiguration.parameterNames
.
It also has three methods:
DOMConfiguration.setParameter(name, value)
,
DOMConfiguration.getParameter(name)
, and
DOMConfiguration.canSetParameter(name,
value)
.
This specification defines one object, only provided in the bindings:
The DOMImplementationRegistry
object has two methods,
DOMImplementationRegistry.getDOMImplementation(features)
,
and
DOMImplementationRegistry.getDOMImplementationList(features)
.
This appendix contains several namespace algorithms, such as namespace normalization algorithm
that fixes namespace information in the Document Object Model to produce a
Document.xmlVersion
) the algorithms
conform to
Namespace declaration attributes and prefixes are normalized as
part of the normalizeDocument
method of the
Document
interface as if the following method
described in pseudo code was called on the document element.
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
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
https://www.example.org/ns2
.
Using the method Node.appendChild
, a
child2
element is added as a sibling of
child1
with the same namespace prefix and namespace
URI, i.e. "ns"
and
"https://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
"https://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 "https://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 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.
This section is informative.
A conflicting namespace declaration could occur on an element if
an 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
"https://www.example.org/ns1"
to
"https://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
"https://www.example.org/ns1"
to
"https://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
"https://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:
The following describes in pseudo code the algorithm used in the
lookupPrefix
method of the 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.
This method ignores all isDefaultNamespace
method.
The following describes in pseudo code the algorithm used in the
isDefaultNamespace
method of the Node
interface. This methods ignores DOM Level 1 nodes.
The following describes in pseudo code the algorithm used in the
lookupNamespaceURI
method of the Node
interface. This methods ignores DOM Level 1 nodes.
This appendix contains the mappings between the XML Information Set
Document
node, each Node
, and each
Node
is mapped to its respective
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
).
An Document
node. The attributes of the corresponding
Document
node are constructed as follows:
Attribute | Value |
---|---|
Node.nodeName |
"#document" |
Node.nodeValue |
null |
Node.nodeType |
Node.DOCUMENT_NODE |
Node.parentNode |
null |
Node.childNodes |
A NodeList containing the information items
in the [children] property.
|
Node.firstChild |
The first node contained in Node.childNodes |
Node.lastChild |
The last node contained in Node.childNodes |
Node.previousSibling |
null |
Node.nextSibling |
null |
Node.attributes |
null |
Node.ownerDocument |
null |
Node.namespaceURI |
null |
Node.prefix |
null |
Node.localName |
null |
Node.baseURI |
same as Document.documentURI |
Node.textContent |
null |
Document.doctype |
The document type information item |
Document.implementation |
The DOMImplementation object used to create
this node |
Document.documentElement |
The [document element] property |
Document.inputEncoding |
The [character encoding scheme] property |
Document.xmlEncoding |
null |
Document.xmlStandalone |
The [standalone] property, or false
if the latter has no value. |
Document.xmlVersion |
The [version] property, or "1.0" if
the latter has no value. |
Document.strictErrorChecking |
true |
Document.documentURI |
The [base URI] property |
Document.domConfig |
A DOMConfiguration object whose parameters
are set to their default values |
The [notations], [unparsed entities] properties
are being exposed in the DocumentType
node.
The [all declarations processed] property is not
exposed through the Document
node.
A Document
node maps to an Document
nodes with no
namespace URI (Node.namespaceURI
equals to
null
) cannot be represented using the Infoset. The
properties of the corresponding
Property | Value |
---|---|
[children] | Node.childNodes |
[document element] | Document.documentElement |
[notations] | Document.doctype.notations |
[unparsed entities] | The information items from
Document.doctype.entities , whose
Node.childNodes is an empty list |
[base URI] | Document.documentURI |
[character encoding scheme] | Document.inputEncoding |
[standalone] | Document.xmlStandalone |
[version] | Document.xmlVersion |
[all declarations processed] | The value is implementation dependent |
An Element
node. The attributes of the corresponding
Element
node are constructed as follows:
Attribute | Value |
---|---|
Node.nodeName |
same as Element.tagName |
Node.nodeValue |
null |
Node.nodeType |
Node.ELEMENT_NODE |
Node.parentNode |
The [parent] property |
Node.childNodes |
A NodeList containing the information items
in the [children] property
|
Node.firstChild |
The first node contained in Node.childNodes |
Node.lastChild |
The last node contained in Node.childNodes |
Node.previousSibling |
The information item preceding the current one on the [children] property contained in the [parent] property |
Node.nextSibling |
The information item following the current one on the [children] property contained in the [parent] property |
Node.attributes |
The information items contained in the [attributes] and [namespace attributes] properties |
Node.ownerDocument |
The document information item |
Node.namespaceURI |
The [namespace name] property |
Node.prefix |
The [prefix] property |
Node.localName |
The [local name] property |
Node.baseURI |
The [base URI] property |
Node.textContent |
Concatenation of the 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. |
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. |
Element.schemaTypeInfo |
A TypeInfo object whose
TypeInfo.typeNamespace and
TypeInfo.typeName are inferred from the
schema in use if available.
|
The [in-scope namespaces] property is not exposed through the
Element
node.
An Element
node maps to an EntityReference
nodes contained in
Node.childNodes
need to be replaced by their
content. DOM applications could use the
Document.normalizeDocument()
method for that effect
with the "false
. The properties of the
corresponding
Property | Value |
---|---|
[namespace name] | Node.namespaceURI |
[local name] | Node.localName |
[prefix] | Node.prefix |
[children] | Node.childNodes , whose
expanded entity references (EntityReference
nodes with children) have been replaced with
their content. |
[attributes] | The nodes contained in Node.attributes ,
whose Node.namespaceURI value is different
from "https://www.w3.org/2000/xmlns/" |
[namespace attributes] | The nodes contained in Node.attributes ,
whose Node.namespaceURI value is
"https://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 XPathNamespace nodes.
|
[base URI] | Node.baseURI |
[parent] | Node.parentNode |
An Attr
node. The attributes of the corresponding
Attr
node are constructed as follows:
Attribute/Method | Value |
---|---|
Node.nodeName |
same as Attr.name |
Node.nodeValue |
same as Attr.value |
Node.nodeType |
Node.ATTRIBUTE_NODE |
Node.parentNode |
null |
Node.childNodes |
A NodeList containing one Text
node whose text content is the same as
Attr.value .
|
Node.firstChild |
The Text node contained in Node.childNodes |
Node.lastChild |
The Text node contained in Node.childNodes |
Node.previousSibling |
null |
Node.nextSibling |
null |
Node.attributes |
null |
Node.ownerDocument |
The document information item |
Node.namespaceURI |
The [namespace name] property |
Node.prefix |
The [prefix] property |
Node.localName |
The [local name] property |
Node.baseURI |
null |
Node.textContent |
the value of Node.textContent of the
Text child.
same as Node.nodeValue (since this
attribute node only contains one Text node) |
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. |
Attr.specified |
The [specified] property |
Attr.value |
The [normalized value] property |
Attr.ownerElement |
The [owner element] property |
Attr.schemaTypeInfo |
A TypeInfo object whose
TypeInfo.typeNamespace is
"https://www.w3.org/TR/REC-xml" and
TypeInfo.typeName is the [attribute
type] property
|
Attr.isId |
if the [attribute type] property is ID, this method return
true
|
An Attr
node maps to an Attr
nodes with no namespace URI
(Node.namespaceURI
equals to null
)
cannot be represented using the Infoset. The properties of the
corresponding
Property | Value |
---|---|
[namespace name] | Node.namespaceURI |
[local name] | Node.localName |
[prefix] | Node.prefix |
[normalized value] | Attr.value |
[specified] | Attr.specified |
[attribute type] |
Using the TypeInfo object referenced from
Attr.schemaTypeInfo , the value of
TypeInfo.typeName if
TypeInfo.typeNamespace is
"https://www.w3.org/TR/REC-xml" .
|
[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] | Attr.ownerElement |
A ProcessingInstruction
node. The attributes of the
corresponding ProcessingInstruction
node are
constructed as follows:
Attribute | Value |
---|---|
Node.nodeName |
same as ProcessingInstruction.target |
Node.nodeValue |
same as ProcessingInstruction.data |
Node.nodeType |
Node.PROCESSING_INSTRUCTION_NODE |
Node.parentNode |
The [parent] property |
Node.childNodes |
empty NodeList |
Node.firstChild |
null |
Node.lastChild |
null |
Node.previousSibling |
null |
Node.nextSibling |
null |
Node.attributes |
null |
Node.ownerDocument |
The document information item |
Node.namespaceURI |
null |
Node.prefix |
null |
Node.localName |
null |
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
ProcessingInstruction node. |
Node.textContent |
same as Node.nodeValue |
ProcessingInstruction.target |
The [target] property |
ProcessingInstruction.data |
The [content] property |
A ProcessingInstruction
node maps to an
Property | Value |
---|---|
[target] | ProcessingInstruction.target |
[content] | ProcessingInstruction.data |
[base URI] | Node.baseURI (which is equivalent to the
base URI of its parent element if any) |
[notation] |
The Notation node named by the target and if
available from Node.ownerDocument.doctype.notations
|
[parent] | Node.parentNode |
An EntityReference
node. The attributes of
the corresponding EntityReference
node are
constructed as follows:
Attribute | Value |
---|---|
Node.nodeName |
The [name] property |
Node.nodeValue |
null |
Node.nodeType |
Node.ENTITY_REFERENCE_NODE |
Node.parentNode |
the [parent] property |
Node.childNodes |
Empty NodeList |
Node.firstChild |
null |
Node.lastChild |
null |
Node.previousSibling |
null |
Node.nextSibling |
null |
Node.attributes |
null |
Node.ownerDocument |
The document information item |
Node.namespaceURI |
null |
Node.prefix |
null |
Node.localName |
null |
Node.baseURI |
The [declaration base URI] property |
Node.textContent |
null (the node has no children) |
The [system identifier] and [public identifier]
properties are not exposed through the
EntityReference
node, but throught the
Entity
node reference from this
EntityReference
node, if any.
An EntityReference
node maps to an EntityReference
nodes with children
(Node.childNodes
contains a non-empty list) cannot
be represented using the Infoset. The properties of the
corresponding
Property | Value |
---|---|
[name] | Node.nodeName |
[system identifier] | The Entity.systemId value of the
Entity node available from
Node.ownerDocument.doctype.entities if available |
[public identifier] | The Entity.publicId value of the
Entity node available from
Node.ownerDocument.doctype.entities if available |
[declaration base URI] | Node.baseURI |
[parent] | Node.parentNode |
Since the CDATASection
nodes cannot
occur from an infoset mapping.
Consecutive Text
node. The attributes of the corresponding
Text
node are constructed as follows:
Attribute/Method | Value |
---|---|
Node.nodeName |
"#text" |
Node.nodeValue |
same as CharacterData.data |
Node.nodeType |
Node.TEXT_NODE |
Node.parentNode |
The [parent] property |
Node.childNodes |
empty NodeList |
Node.firstChild |
null |
Node.lastChild |
null |
Node.previousSibling |
null |
Node.nextSibling |
null |
Node.attributes |
null |
Node.ownerDocument |
The document information item |
Node.namespaceURI |
null |
Node.prefix |
null |
Node.localName |
null |
Node.baseURI |
null |
Node.textContent |
same as Node.nodeValue |
CharacterData.data |
A DOMString including all [character
code] contained in the |
CharacterData.length |
The number of 16-bit units needed to encode all ISO 10646
character code contained in the |
Text.isElementContentWhitespace |
The [element content whitespace] property |
Text.wholeText |
same as CharacterData.data |
By construction, the values of the [parent] and [element
content whitespace] properties are necessarily the sames for
all consecutive
The text content of a Text
or a
CDATASection
node maps to a sequence of
CharacterData.length
. Text nodes
contained in Attr
nodes are mapped to the Infoset
using the Attr.value
attribute. Text nodes
contained in Document
nodes cannot be represented
using the Infoset. The properties of the corresponding
Property | Value |
---|---|
[character code] | The ISO 10646 character code produced using one or two
CharacterData.data |
[element content whitespace] | Text.isElementContentWhitespace |
[parent] | Node.parentNode |
A Comment
node. The attributes of the corresponding
Comment
node are constructed as follows:
Attribute | Value |
---|---|
Node.nodeName |
"#comment" |
Node.nodeValue |
same as CharacterData.data |
Node.nodeType |
Node.COMMENT_NODE |
Node.parentNode |
The [parent] property |
Node.childNodes |
empty NodeList |
Node.firstChild |
null |
Node.lastChild |
null |
Node.previousSibling |
null |
Node.nextSibling |
null |
Node.attributes |
null |
Node.ownerDocument |
The document information item |
Node.namespaceURI |
null |
Node.prefix |
null |
Node.localName |
null |
Node.baseURI |
null |
Node.textContent |
same as Node.nodeValue |
CharacterData.data |
The [content] property encoded using the UTF-16 encoding. |
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. |
A Comment
maps to a
Property | Value |
---|---|
[content] | CharacterData.data |
[parent] | Node.parentNode |
A DocumentType
node. The attributes of the
corresponding DocumentType
node are constructed as
follows:
Attribute | Value |
---|---|
Node.nodeName |
same as DocumentType.name |
Node.nodeValue |
null |
Node.nodeType |
Node.DOCUMENT_TYPE_NODE |
Node.parentNode |
The [parent] property |
Node.childNodes |
empty NodeList |
Node.firstChild |
null |
Node.lastChild |
null |
Node.previousSibling |
null |
Node.nextSibling |
null |
Node.attributes |
null |
Node.ownerDocument |
The document information item |
Node.namespaceURI |
null |
Node.prefix |
null |
Node.localName |
null |
Node.baseURI |
null |
Node.textContent |
null |
DocumentType.name |
The name of the document element. |
DocumentType.entities |
The [unparsed entities] property available from the document information item. |
DocumentType.notations |
The [notations] property available from the document information item. |
DocumentType.publicId |
The [public identifier] property |
DocumentType.systemId |
The [system identifier] property |
DocumentType.internalSubset |
The value is implementation dependent |
The [children] property is not exposed through the
DocumentType
node.
A DocumentType
maps to a
Property | Value |
---|---|
[system identifier] | DocumentType.systemId |
[public identifier] | DocumentType.publicId |
[children] | The value of this property is implementation dependent |
[parent] | Node.parentNode |
An Entity
node. The attributes of the corresponding
Entity
node are constructed as follows:
Attribute | Value |
---|---|
Node.nodeName |
The [name] property |
Node.nodeValue |
null |
Node.nodeType |
Node.ENTITY_NODE |
Node.parentNode |
null |
Node.childNodes |
Empty NodeList |
Node.firstChild |
null |
Node.lastChild |
null |
Node.previousSibling |
null |
Node.nextSibling |
null |
Node.attributes |
null |
Node.ownerDocument |
The document information item |
Node.namespaceURI |
null |
Node.prefix |
null |
Node.localName |
null |
Node.baseURI |
The [declaration base URI] property |
Node.textContent |
"" (the node has no children) |
Entity.publicId |
The [public identifier] property |
Entity.systemId |
The [system identifier] property |
Entity.notationName |
The [notation name] property |
Entity.inputEncoding |
null |
Entity.xmlEncoding |
null |
Entity.xmlVersion |
null |
The [notation] property is available through the
DocumentType
node.
An Entity
node maps to an Entity
nodes with children
(Node.childNodes
contains a non-empty list) cannot
be represented using the Infoset. The properties of the
corresponding
Property | Value |
---|---|
[name] | Node.nodeName |
[system identifier] | Entity.systemId |
[public identifier] | Entity.publicId |
[declaration base URI] | Node.baseURI |
[notation name] | Entity.notationName |
[notation] | The Notation node referenced from
DocumentType.notations whose name is the
[notation name] property |
A Notation
node. The attributes of the corresponding
Notation
node are constructed as follows:
Attribute | Value |
---|---|
Node.nodeName |
The [name] property |
Node.nodeValue |
null |
Node.nodeType |
Node.NOTATION_NODE |
Node.parentNode |
null |
Node.childNodes |
Empty NodeList |
Node.firstChild |
null |
Node.lastChild |
null |
Node.previousSibling |
null |
Node.nextSibling |
null |
Node.attributes |
null |
Node.ownerDocument |
The document information item |
Node.namespaceURI |
null |
Node.prefix |
null |
Node.localName |
null |
Node.baseURI |
The [declaration base URI] property |
Node.textContent |
null |
Notation.publicId |
The [public identifier] property |
Notation.systemId |
The [system identifier] property |
A Notation
maps to a
Property | Value |
---|---|
[name] | Node.nodeName |
[system identifier] | Notation.systemId |
[public identifier] | Notation.publicId |
[parent] | Node.parentNode |
Using the DOMConfiguration
users can change behavior
of the DOMParser
, DOMSerializer
and
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 DOMConfiguration
. Errors
are effectively reported only if a DOMErrorHandler
object is attached to the "
" |
" |
" |
Instance schemas, i.e. the current schema | Outcome | Other parameters |
---|---|---|---|---|---|
null |
true |
false |
DTD and XML Schema | Implementation dependent |
The outcome of setting the "true or false is implementation
dependent.
|
false |
true |
||||
null |
true |
false |
none | Report an error |
Setting the "true or false has no effect on
the DOM.
|
false |
true |
No error is reported | |||
null |
true |
false |
DTD | Validate against DTD |
Setting the "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 "false is implementation dependent (likely to be
an error). Setting the "false does not have any effect on the DOM.
|
false |
true |
||||
"https://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 "true or false has no effect on
the DOM.
|
false |
true |
If DTD is found, validate against DTD. | |||
"https://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 "true exposes XML Schema false is implementation dependent (likely to be
an error).
|
false |
true |
If XML Schema is found, validate against the schema. | |||
"https://www.w3.org/2001/XMLSchema" or
"https://www.w3.org/TR/REC-xml"
|
false |
false |
DTD or XML Schema or both |
If XML Schema is found, it is ignored. DOM implementations
|
Setting the "true of false has no effect on
the DOM.
|
If an error has to be reported, as specified in the "Outcome"
column above, the DOMError.type
is
"no-schema-available"
.
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 = 10FFFF16 (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 FFFF16) are represented
by a single 16-bit code unit, while characters above FFFF16
use a special pair of code units called a surrogate pair. For more information,
see
While indexing by code points as opposed to code units is not
common in programs, some specifications such as String
type that is bound
to DOMString
be extended to enable this
conversion. An example of how such an API might look is supplied
below.
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.
Extensions to a language's native String class or interface
Returns the UTF-16 offset that corresponds to a UTF-32 offset. Used for random access.
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.
UTF-32 offset.
UTF-16 offset
if offset32
is out of bounds.
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:
If the UTF-16 offset is into the middle of a surrogate pair,
then the UTF-32 offset of the
UTF-16 offset
UTF-32 offset
if offset16 is out of bounds.
This appendix contains the complete OMG IDL
The IDL files are also available as:
This appendix contains the complete Java
The Java files are also available as
This section is informative.
This section defines the DOMImplementationRegistry
object,
discussed in
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 DOMImplementationSource
interface.
With this, the first line of an application typically becomes something like (modulo exception handling):
This appendix contains the complete ECMAScript
This section defines the DOMImplementationRegistry
object,
discussed in
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
DOMImplementationSource.getDOMImplementation()
.
This method returns a
DOMImplementationList
list of registered object
that implements the DOMImplementation
interface and has the desired features.
The
features parameter is a String. See
also
DOMImplementationSource.getDOMImplementationList()
.
In addition of having DOMConfiguration
parameters
exposed to the application using the setParameter
and getParameter
, those parameters are also exposed
as ECMAScript properties on the 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.
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.,
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
This specification was written in XML. The HTML, OMG IDL, Java and ECMAScript bindings were all produced automatically.
Thanks to Joe English, author of
After DOM Level 1, we used
Thanks also to Jan Kärrman, author of
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.
The base unit of a DOMString
. This indicates that
indexing on a DOMString
occurs in units of 16 bits.
This must not be misunderstood to mean that a DOMString
can store arbitrary 16-bit units. A 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.
An
An
An
The process by which an
The process by which an
A
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.
The
A
A model for a document that represents the document
after it has been manipulated in some way. For example, any
combination of any of the following transformations would
create a cooked model:
Expansion of internal text entities. Expansion of external entities. Model augmentation with style-specified generated
text. Execution of style-specified
reordering. Execution of scripts.
A
A
When new releases of specifications are released, some older
features may be marked as being
A
There is only one document element in a Document
. This
element node is a child of the Document
node. See
There is an ordering,
The term "DOM Level 0" refers to a mix (not formally specified) of HTML document functionalities offered by Netscape Navigator version 3.0 and Microsoft Internet Explorer version 3.0. In some cases, attributes or methods have been included for reasons of backward compatibility with "DOM Level 0".
The programming language defined by the ECMA-262 standard
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
An event is the representation of some asynchronous occurrence
(such as a mouse click on the presentation of the element, or
the removal of child node from an element, or any of
unthinkably many other possibilities) that gets associated
with an
The object to which an
Two nodes are
Two nodes are NodeList
objects, and the pairs of
equivalent attributes must in fact be deeply equivalent.
Two NodeList
objects are
Two NamedNodeMap
objects are
Two DocumentType
nodes are NamedNodeMap
objects.
An information item is an abstract representation of some
component of an XML document. See the
Text
or CDATASection
nodes that can be visited
sequentially in Element
,
Comment
, or ProcessingInstruction
nodes.
A
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.
The HyperText Markup Language (
An Interface Definition Language (
Companies, organizations, and individuals that claim to support the Document Object Model as an API for their products.
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
Also known as the
An
A programming
An object is
A
A
A
A
A
A node is a
An
A
A node in a DOM tree is
A
A
The
A
Two nodes are
When string matching is required, it is to occur as
though the comparison was between 2 sequences of code points
from
A document is
The target node is the node representing the
The process by which an
An information item such as an
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
A document is
See initial structure model.
A node is a
Extensible Markup Language (
See
An
For the latest version of any W3C specification please consult the list of
DOM Requirements for DOM Level 3in
OMG IDL Syntax and Semanticsdefined in