This specification defines a set of objects and interfaces for accessing and manipulating document objects. The functionality specified (the Core functionality) is sufficient to allow software developers and Web script authors to access and manipulate parsed HTML [HTML 4.01] and XML [XML 1.0] content inside conforming products. The DOM Core API also allows creation and population of a Document
object using only DOM API calls. A solution for loading a Document
and saving it persistently is proposed in [DOM Level 3 Load and Save].
The DOM presents documents as a hierarchy of Node
objects that also implement other, more specialized interfaces. Some types of nodes may have child nodes of various types, and others are leaf nodes that cannot have anything below them in the document structure. For XML and HTML, the node types, and which node types they may have as children, are as follows:
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 childrenThe DOM also specifies a NodeList
interface to handle ordered lists of Nodes
, such as the children of a Node
, or the elements returned by 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 live; that is, changes to the underlying document structure are reflected in all relevant 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 element (or removes children, or modifies them), those changes are automatically reflected in the 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 interfaces rather than classes. That means that an implementation need only expose methods with the defined names and specified operation, not implement classes that correspond directly to the interfaces. This allows the DOM APIs to be implemented as a thin veneer on top of legacy applications with their own data structures, or on top of newer applications with different class hierarchies. This also means that ordinary constructors (in the Java or C++ sense) cannot be used to create DOM objects, since the underlying objects to be constructed may have little relationship to the DOM interfaces. The conventional solution to this in object-oriented design is to define factory methods that create instances of objects that implement the various interfaces. Objects implementing some interface "X" are created by a "createX()" method on the 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 ECMAScript and Java) require any memory management methods, but DOM bindings for other languages (especially C or C++) may require such support. These extensions will be the responsibility of those adapting the DOM API to a specific language, not the DOM Working Group.
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 [OMG IDL] and ECMAScript [ECMAScript] have significant limitations in their ability to disambiguate names from different namespaces that make it difficult to avoid naming conflicts with short, familiar names. So, DOM names tend to be long and descriptive in order to be unique across all environments.
The Working Group has also attempted to be internally consistent in its use of various terms, even though these may not be common distinctions in other APIs. For example, the DOM API uses the method name "remove" when the method changes the structural model, and the method name "delete" when the method gets rid of something inside the structure model. The thing that is deleted is not returned. The thing that is removed may be returned, when it makes sense to return it.
The DOM Core APIs present two somewhat different sets of interfaces to an XML/HTML document: one presenting an "object oriented" approach with a hierarchy of inheritance, and a "simplified" view that allows all manipulation to be done via the Node
interface without requiring casts (in Java and other C-like languages) or query interface calls in COM environments. These operations are fairly expensive in Java and COM, and the DOM may be used in performance-critical environments, so we allow significant functionality using just the Node
interface. Because many other users will find the inheritance hierarchy easier to understand than the "everything is a Node
" approach to the DOM, we also support the full higher-level interfaces for those who prefer a more object-oriented API.
In practice, this means that there is a certain amount of redundancy in the API. The Working Group considers the "inheritance" approach the primary view of the API, and the full set of functionality on 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 API must satisfy.
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
TypeThe DOMString
type is used to store [Unicode] characters as a sequence of 16-bit units using UTF-16 as defined in [Unicode] and Amendment 1 of [ISO/IEC 10646].
Characters are fully normalized as defined in appendix B of [XML 1.1] if:
true
while loading the document or the document was certified as defined in [XML 1.1];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 fully-normalized text.
A DOMString
is a sequence of 16-bit units.
valuetype DOMString sequence<unsigned short>;
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 [ISO/IEC 10646]. A single numeric character reference in a source document may therefore in some cases correspond to two 16-bit units in a DOMString
(a high surrogate and a low surrogate). For issues related to string comparisons, refer to String Comparisons in the DOM.
For Java and ECMAScript, DOMString
is bound to the String
type because both languages also use UTF-16 as their encoding.
Note: As of August 2000, the OMG IDL specification ([OMG IDL]) included a wstring
type. However, that definition did not meet the interoperability criteria of the DOM API since it relied on negotiation to decide the width and encoding of a character.
DOMTimeStamp
TypeThe DOMTimeStamp
type is used to store an absolute or relative time.
A DOMTimeStamp
represents a number of milliseconds.
typedef unsigned long long DOMTimeStamp;
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
TypeThe DOMUserData
type is used to store application data.
A DOMUserData
represents a reference to application data.
typedef any DOMUserData;
For Java, DOMUserData
is bound to the Object
type. For ECMAScript, DOMUserData
is bound to any type
.
The DOM has many interfaces that imply string matching. For XML, string comparisons are case-sensitive and performed with a binary comparison of the 16-bit units of the 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 element names and lowercase for attribute names. For this reason, applications should also compare element and attribute names returned by the DOM implementation in a case-insensitive manner.
The character normalization, i.e. transforming into their fully normalized form as as defined in [XML 1.1], is assumed to happen at serialization time. The DOM Level 3 Load and Save module [DOM Level 3 Load and Save] provides a serialization mechanism (see the DOMSerializer
interface, section 2.3.1) and uses the DOMConfiguration
parameters "normalize-characters" and "check-character-normalization" to assure that text is fully normalized [XML 1.1]. Other serialization mechanisms built on top of the DOM Level 3 Core also have to assure that text is fully normalized.
The DOM specification relies on DOMString
values as resource identifiers, such that the following conditions are met:
The term "absolute URI" refers to a complete resource identifier and the term "relative URI" refers to an incomplete resource identifier.
Within the DOM specifications, these identifiers are called URIs, "Uniform Resource Identifiers", but this is meant abstractly. The DOM implementation does not necessarily process its URIs according to the URI specification [IETF RFC 2396]. Generally the particular form of these identifiers must be ignored.
When is not possible to completely ignore the type of a DOM URI, either because a relative identifier must be made absolute or because content must be retrieved, the DOM implementation must at least support identifier types appropriate to the content being processed. [HTML 4.01], [XML 1.0], and associated namespace specification [XML Namespaces] rely on [IETF RFC 2396] to determine permissible characters and resolving relative URIs. Other specifications such as namespaces in XML 1.1 [XML Namespaces 1.1] may rely on alternative resource identifier types that may, for example, include non-ASCII characters, necessitating support for alternative resource identifier types where required by applicable specifications.
DOM Level 2 and 3 support XML namespaces [XML Namespaces] by augmenting several interfaces of the DOM Level 1 Core to allow creating and manipulating elements and attributes associated to a namespace. When [XML 1.1] is in use (see Document.xmlVersion
), DOM Level 3 also supports [XML Namespaces 1.1].
As far as the DOM is concerned, special attributes used for declaring XML namespaces are still exposed and can be manipulated just like any other attribute. However, nodes are permanently bound to namespace URIs as they get created. Consequently, moving a node within a document, using the DOM, in no case results in a change of its namespace prefix or namespace URI. Similarly, creating a node with a namespace prefix and namespace URI, or changing the namespace prefix of a node, does not result in any addition, removal, or modification of any special attributes for declaring the appropriate XML namespaces. Namespace validation is not enforced; the DOM application is responsible. In particular, since the mapping between prefixes and namespace URIs is not enforced, in general, the resulting document cannot be serialized naively. For example, applications may have to declare every namespace in use when serializing a document.
In general, the DOM implementation (and higher) doesn't perform any URI normalization or canonicalization. The URIs given to the DOM are assumed to be valid (e.g., characters such as white spaces are properly escaped), and no lexical checking is performed. Absolute URI references are treated as strings and compared literally. How relative namespace URI references are treated is undefined. To ensure interoperability only absolute namespace URI references (i.e., URI references beginning with a scheme name and a colon) should be used. Applications should use the value null
as the namespaceURI
parameter for methods if they wish to have no namespace. In programming languages where empty strings can be differentiated from null, empty strings, when given as a namespace URI, are converted to null
. This is true even though the DOM does no lexical checking of URIs.
Note: Element.setAttributeNS(null, ...)
puts the attribute in the per-element-type partitions as defined in XML Namespace Partitions in [XML Namespaces].
Note: In the DOM, all namespace declaration attributes are by definition bound to the namespace URI: "http://www.w3.org/2000/xmlns/". These are the attributes whose namespace prefix or qualified name is "xmlns" as introduced in [XML Namespaces 1.1].
In a document with no namespaces, the child list of an EntityReference
node is always the same as that of the corresponding Entity
. This is not true in a document where an entity contains unbound namespace prefixes. In such a case, the descendants of the corresponding EntityReference
nodes may be bound to different namespace URIs, depending on where the entity references are. Also, because, in the DOM, nodes always remain bound to the same namespace URI, moving such 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 descendants of the returned 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.
Note: DOM Level 1 methods are namespace ignorant. Therefore, while it is safe to use these methods when not dealing with namespaces, using them and the new ones at the same time should be avoided. DOM Level 1 methods solely identify attribute nodes by their 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 element may have two attributes (or more) that have the same 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 [XML Information Set] by providing a new attribute on the 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]. This means its value depends on the location of the node in the tree and moving the node from one place to another in the tree may affect its value. Other changes, such as adding or changing an xml:base
attribute on the node being queried or one of its ancestors may also affect its value.
One consequence of this it that when external entity references are expanded while building a 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. [DOM Level 3 Load and Save] handles elements as described here and generates a warning in the latter case.
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 [MathML 2.0] and SVG [SVG 1.1] specifications have developed DOM extensions to allow users to manipulate instances of these vocabularies using semantics appropriate to images and mathematics, respectively, as well as the generic DOM XML semantics. Instances of SVG or MathML are often embedded in XML documents conforming to a different schema such as XHTML.
While the Namespaces in XML specification [XML Namespaces] provides a mechanism for integrating these documents at the syntax level, it has become clear that the DOM Level 2 Recommendation [DOM Level 2 Core] is not rich enough to cover all the issues that have been encountered in having these different DOM implementations be used together in a single application. DOM Level 3 deals with the requirements brought about by embedding fragments written according to a specific markup language (the embedded component) in a document where the rest of the markup is not written according to that specific markup language (the host document). It does not deal with fragments embedded by reference or linking.
A DOM implementation supporting DOM Level 3 Core should be able to collaborate with subcomponents implementing specific DOMs to assemble a compound document that can be traversed and manipulated via DOM interfaces as if it were a seamless whole.
The normal typecast operation on an object should support the interfaces expected by legacy code for a given document type. Typecasting techniques may not be adequate for selecting between multiple DOM specializations of an object which were combined at run time, because they may not all be part of the same object as defined by the binding's object model. Conflicts are most obvious with the 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 (Conformance). Features are case-insensitive and are also defined for a specific set of versions. For example, this specification defines the features "Core"
and "XML"
, for the version "3.0"
. Versions "1.0"
and "2.0"
can also be used for features defined in the corresponding DOM Levels. To avoid possible conflicts, as a convention, names referring to features defined outside the DOM specification should be made unique. Applications could then request for features to be supported by a DOM implementation using the methods 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 Mixed DOM Implementations, DOM Level 3 Core should be able to collaborate with subcomponents implementing specific DOMs. For that effect, the methods 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.
// example 1, without prepending the "+" if (myNode.isSupported("Events", "3.0")) { EventTarget evt = (EventTarget) myNode; // ... } // example 2, with the "+" if (myNode.isSupported("+Events", "3.0")) { // (the plus sign "+" is irrelevant for the getFeature method itself // and is ignored by this method anyway) EventTarget evt = (EventTarget) myNode.getFeature("Events", "3.0"); // ... }
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 Java Language Binding and ECMAScript Language Binding for specifics.
In all cases, though, the DOMImplementationRegistry
provides a getDOMImplementation
method accepting a features string, which is passed to every known 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 fundamental, and must be fully implemented by all conforming implementations of the DOM, including all HTML DOM implementations [DOM Level 2 HTML], unless otherwise specified.
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 conformance in this specification. The DOM Level 3 Core module is backward compatible with the DOM Level 2 Core [DOM Level 2 Core] module, i.e. a DOM Level 3 Core implementation who returns true
for "Core" with the version
number "3.0"
must also return true
for this feature
when the version
number is "2.0"
, ""
or, null
.
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.
exception DOMException { unsigned short code; }; // ExceptionCode const unsigned short INDEX_SIZE_ERR = 1; const unsigned short DOMSTRING_SIZE_ERR = 2; const unsigned short HIERARCHY_REQUEST_ERR = 3; const unsigned short WRONG_DOCUMENT_ERR = 4; const unsigned short INVALID_CHARACTER_ERR = 5; const unsigned short NO_DATA_ALLOWED_ERR = 6; const unsigned short NO_MODIFICATION_ALLOWED_ERR = 7; const unsigned short NOT_FOUND_ERR = 8; const unsigned short NOT_SUPPORTED_ERR = 9; const unsigned short INUSE_ATTRIBUTE_ERR = 10; // Introduced in DOM Level 2: const unsigned short INVALID_STATE_ERR = 11; // Introduced in DOM Level 2: const unsigned short SYNTAX_ERR = 12; // Introduced in DOM Level 2: const unsigned short INVALID_MODIFICATION_ERR = 13; // Introduced in DOM Level 2: const unsigned short NAMESPACE_ERR = 14; // Introduced in DOM Level 2: const unsigned short INVALID_ACCESS_ERR = 15; // Introduced in DOM Level 3: const unsigned short VALIDATION_ERR = 16; // Introduced in DOM Level 3: const unsigned short TYPE_MISMATCH_ERR = 17;
An integer indicating the type of error generated.
Note: Other numeric codes are reserved for W3C for possible future use.
DOMSTRING_SIZE_ERR
DOMString
.
HIERARCHY_REQUEST_ERR
Node
is inserted somewhere it doesn't belong.
INDEX_SIZE_ERR
INUSE_ATTRIBUTE_ERR
INVALID_ACCESS_ERR
, introduced in DOM Level 2.
INVALID_CHARACTER_ERR
INVALID_MODIFICATION_ERR
, introduced in DOM Level 2.
INVALID_STATE_ERR
, introduced in DOM Level 2.
NAMESPACE_ERR
, introduced in DOM Level 2.
NOT_FOUND_ERR
Node
in a context where it does not exist.
NOT_SUPPORTED_ERR
NO_DATA_ALLOWED_ERR
Node
which does not support data.
NO_MODIFICATION_ALLOWED_ERR
SYNTAX_ERR
, introduced in DOM Level 2.
TYPE_MISMATCH_ERR
, introduced in DOM Level 3.
VALIDATION_ERR
, introduced in DOM Level 3.
insertBefore
or removeChild
would make the Node
invalid with respect to "partial validity", this exception would be raised and the operation would not be done. This code is used in [DOM Level 3 Validation]. Refer to this specification for further information.
WRONG_DOCUMENT_ERR
Node
is used in a different document than the one that created it (that doesn't support it).
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.
// Introduced in DOM Level 3: interface DOMStringList { DOMString item(in unsigned long index); readonly attribute unsigned long length; boolean contains(in DOMString str); };
contains
DOMStringList
.
str
of type DOMString
|
|
item
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
of type unsigned long
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.
// Introduced in DOM Level 3: interface NameList { DOMString getName(in unsigned long index); DOMString getNamespaceURI(in unsigned long index); readonly attribute unsigned long length; boolean contains(in DOMString str); boolean containsNS(in DOMString namespaceURI, in DOMString name); };
length
of type unsigned long
, readonly
length-1
inclusive. contains
NameList
.
str
of type DOMString
|
|
containsNS
getName
index
th name item in the collection.
index
of type unsigned long
The name at the |
getNamespaceURI
index
th namespaceURI item in the collection.
index
of type unsigned long
The namespace URI at the |
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.
// Introduced in DOM Level 3: interface DOMImplementationList { DOMImplementation item(in unsigned long index); readonly attribute unsigned long length; };
length
of type unsigned long
, readonly
DOMImplementation
s in the list. The range of valid child node indices is 0 to length-1
inclusive. item
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
of type unsigned long
The |
This interface permits a DOM implementer to supply one or more implementations, based upon requested features and versions, as specified in DOM Features. Each implemented DOMImplementationSource
object is listed in the binding-specific list of available sources so that its DOMImplementation
objects are made available.
// Introduced in DOM Level 3: interface DOMImplementationSource { DOMImplementation getDOMImplementation(in DOMString features); DOMImplementationList getDOMImplementationList(in DOMString features); };
getDOMImplementation
features
of type DOMString
getDOMImplementationList
. "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 |
getDOMImplementationList
features
of type DOMString
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.
interface DOMImplementation { boolean hasFeature(in DOMString feature, in DOMString version); // Introduced in DOM Level 2: DocumentType createDocumentType(in DOMString qualifiedName, in DOMString publicId, in DOMString systemId) raises(DOMException); // Introduced in DOM Level 2: Document createDocument(in DOMString namespaceURI, in DOMString qualifiedName, in DocumentType doctype) raises(DOMException); // Introduced in DOM Level 3: DOMObject getFeature(in DOMString feature, in DOMString version); };
createDocument
introduced in DOM Level 2
DocumentType
given to create the document, the implementation may instantiate specialized Document
objects that support additional features than the "Core", such as "HTML" [DOM Level 2 HTML]. On the other hand, setting the DocumentType
after the document was created makes this very unlikely to happen. Alternatively, specialized Document
creation methods, such as createHTMLDocument
[DOM Level 2 HTML], can be used to obtain specific types of Document
objects.
namespaceURI
of type DOMString
null
.qualifiedName
of type DOMString
null
.doctype
of type DocumentType
null
.doctype
is not null
, its Node.ownerDocument
attribute is set to the document being created.INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to [XML 1.0]. NAMESPACE_ERR: Raised if the WRONG_DOCUMENT_ERR: Raised if 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 [HTML 4.01]). |
createDocumentType
introduced in DOM Level 2
DocumentType
node. Entity declarations and notations are not made available. Entity reference expansions and default attribute additions do not occur..
qualifiedName
of type DOMString
publicId
of type DOMString
systemId
of type DOMString
A new |
INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to [XML 1.0]. NAMESPACE_ERR: Raised if the 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 [HTML 4.01]). |
getFeature
introduced in DOM Level 3
DOMImplementation
interface.
Returns an object which implements the specialized APIs of the specified feature and version, if any, or |
hasFeature
|
|
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 well-formed XML documents (although they do need to follow the rules imposed upon well-formed XML parsed entities, which can have multiple top nodes). For example, a DocumentFragment
might have only one child and that child node could be a 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 siblings; the 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
.
interface DocumentFragment : Node { };
The Document
interface represents the entire HTML or XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.
Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document
, the Document
interface also contains the factory methods needed to create these objects. The Node
objects created have a ownerDocument
attribute which associates them with the Document
within whose context they were created.
interface Document : Node { // Modified in DOM Level 3: readonly attribute DocumentType doctype; readonly attribute DOMImplementation implementation; readonly attribute Element documentElement; Element createElement(in DOMString tagName) raises(DOMException); DocumentFragment createDocumentFragment(); Text createTextNode(in DOMString data); Comment createComment(in DOMString data); CDATASection createCDATASection(in DOMString data) raises(DOMException); ProcessingInstruction createProcessingInstruction(in DOMString target, in DOMString data) raises(DOMException); Attr createAttribute(in DOMString name) raises(DOMException); EntityReference createEntityReference(in DOMString name) raises(DOMException); NodeList getElementsByTagName(in DOMString tagname); // Introduced in DOM Level 2: Node importNode(in Node importedNode, in boolean deep) raises(DOMException); // Introduced in DOM Level 2: Element createElementNS(in DOMString namespaceURI, in DOMString qualifiedName) raises(DOMException); // Introduced in DOM Level 2: Attr createAttributeNS(in DOMString namespaceURI, in DOMString qualifiedName) raises(DOMException); // Introduced in DOM Level 2: NodeList getElementsByTagNameNS(in DOMString namespaceURI, in DOMString localName); // Introduced in DOM Level 2: Element getElementById(in DOMString elementId); // Introduced in DOM Level 3: readonly attribute DOMString inputEncoding; // Introduced in DOM Level 3: readonly attribute DOMString xmlEncoding; // Introduced in DOM Level 3: attribute boolean xmlStandalone; // raises(DOMException) on setting // Introduced in DOM Level 3: attribute DOMString xmlVersion; // raises(DOMException) on setting // Introduced in DOM Level 3: attribute boolean strictErrorChecking; // Introduced in DOM Level 3: attribute DOMString documentURI; // Introduced in DOM Level 3: Node adoptNode(in Node source) raises(DOMException); // Introduced in DOM Level 3: readonly attribute DOMConfiguration domConfig; // Introduced in DOM Level 3: void normalizeDocument(); // Introduced in DOM Level 3: Node renameNode(in Node n, in DOMString namespaceURI, in DOMString qualifiedName) raises(DOMException); };
doctype
of type DocumentType
, readonly, modified in DOM Level 3
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.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" [DOM Level 2 HTML], based on the DocumentType
specified at creation time, changing it afterwards is very unlikely to result in a change of the features supported.documentElement
of type Element
, readonly
documentURI
of type DOMString
, introduced in DOM Level 3
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
. Document
supports the feature "HTML" [DOM Level 2 HTML], the href attribute of the HTML BASE element takes precedence over this attribute when computing Node.baseURI
. domConfig
of type DOMConfiguration
, readonly, introduced in DOM Level 3
Document.normalizeDocument()
is invoked. implementation
of type DOMImplementation
, readonly
DOMImplementation
object that handles this document. A DOM application may use objects from multiple implementations.inputEncoding
of type DOMString
, readonly, introduced in DOM Level 3
null
when it is not known, such as when the Document
was created in memory.strictErrorChecking
of type boolean
, introduced in DOM Level 3
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.xmlEncoding
of type DOMString
, readonly, introduced in DOM Level 3
null
when unspecified or when it is not known, such as when the Document
was created in memory.xmlStandalone
of type boolean
, introduced in DOM Level 3
false
when unspecified.
Note: No verification is done on the value when setting this attribute. Applications should use Document.normalizeDocument()
with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].
NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature. |
xmlVersion
of type DOMString
, introduced in DOM Level 3
"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 invalid characters in XML names. Application should invoke Document.normalizeDocument()
in order to check for invalid characters in the Node
s that are already part of this Document
. DOMImplementation.hasFeature(feature, version)
method with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. Document
objects supporting a version of the "XMLVersion" feature must not raise a 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 |
adoptNode
introduced in DOM Level 3
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.
Note: 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 is not an XML name according to the XML version in use.
source
of type Node
The adopted node, or |
NOT_SUPPORTED_ERR: Raised if the source node is of type NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly. |
createAttribute
Attr
of the given name. Note that the Attr
instance can then be set on an Element
using the setAttributeNode
method. createAttributeNS
method.
name
of type DOMString
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the |
createAttributeNS
introduced in DOM Level 2
null
as the namespaceURI
parameter for methods if they wish to have no namespace.
namespaceURI
of type DOMString
qualifiedName
of type DOMString
A new
|
INVALID_CHARACTER_ERR: Raised if the specified NAMESPACE_ERR: Raised if the NOT_SUPPORTED_ERR: Always thrown if the current document does not support the |
createCDATASection
CDATASection
node whose value is the specified string.
data
of type DOMString
CDATASection
contents.The new |
NOT_SUPPORTED_ERR: Raised if this document is an HTML document. |
createComment
createDocumentFragment
DocumentFragment
object.
A new |
createElement
Element
interface, so attributes can be specified directly on the returned object.Attr
nodes representing them are automatically created and attached to the element.createElementNS
method.
tagName
of type DOMString
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the |
createElementNS
introduced in DOM Level 2
null
as the namespaceURI parameter for methods if they wish to have no namespace.
namespaceURI
of type DOMString
qualifiedName
of type DOMString
A new
|
INVALID_CHARACTER_ERR: Raised if the specified NAMESPACE_ERR: Raised if the NOT_SUPPORTED_ERR: Always thrown if the current document does not support the |
createEntityReference
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.
Note: If any descendant of the Entity
node has an unbound namespace prefix, the corresponding descendant of the created 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.
name
of type DOMString
Document.createElementNS
or Document.createAttributeNS
, no namespace well-formed checking is done on the entity name. Applications should invoke Document.normalizeDocument()
with the parameter "namespaces" set to true
in order to ensure that the entity name is namespace well-formed. The new |
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the NOT_SUPPORTED_ERR: Raised if this document is an HTML document. |
createProcessingInstruction
ProcessingInstruction
node given the specified name and data strings.
target
of type DOMString
Document.createElementNS
or Document.createAttributeNS
, no namespace well-formed checking is done on the target name. Applications should invoke Document.normalizeDocument()
with the parameter "namespaces" set to true
in order to ensure that the target name is namespace well-formed. data
of type DOMString
The new |
INVALID_CHARACTER_ERR: Raised if the specified target is not an XML name according to the XML version in use specified in the NOT_SUPPORTED_ERR: Raised if this document is an HTML document. |
createTextNode
getElementById
introduced in DOM Level 2
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. Attr.isId
to determine if an attribute is of type ID.
Note: Attributes with the name "ID" or "id" are not of type ID unless so defined.
elementId
of type DOMString
id
value for an element.The matching element or |
getElementsByTagName
NodeList
of all the Elements
in document order with a given tag name and are contained in the document.
tagname
of type DOMString
tagname
parameter is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use. getElementsByTagNameNS
introduced in DOM Level 2
NodeList
of all the Elements
with a given local name and namespace URI in document order.
namespaceURI
of type DOMString
"*"
matches all namespaces.localName
of type DOMString
importNode
introduced in DOM Level 2
parentNode
is null
).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.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 descendants of the source 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 descendants of the source 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 not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If the importNode
deep
parameter was set to true
, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
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 descendants of the the source 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.
importedNode
of type Node
deep
of type boolean
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 |
NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported. INVALID_CHARACTER_ERR: Raised if one of the imported names is not an XML name according to the XML version in use specified in the |
normalizeDocument
introduced in DOM Level 3
EntityReference
nodes and normalizes Text
nodes, as defined in the method Node.normalize()
. Document.domConfig
object and governing what operations actually take place. Noticeably this method could also make the document namespace well-formed according to the algorithm described in Namespace Normalization, check the character normalization, remove the CDATASection
nodes, etc. See DOMConfiguration
for details.
// Keep in the document the information defined // in the XML Information Set (Java example) DOMConfiguration docConfig = myDocument.getDomConfig(); docConfig.setParameter("infoset", Boolean.TRUE); myDocument.normalizeDocument();
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 "error-handler" parameter. Note this method might also report fatal errors (DOMError.SEVERITY_FATAL_ERROR
) if an implementation cannot recover from an error.
renameNode
introduced in DOM Level 3
ELEMENT_NODE
or ATTRIBUTE_NODE
.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.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.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.NODE_RENAMED
is fired,http://www.w3.org/2001/xml-events
, DOMElementNameChanged
} or {http://www.w3.org/2001/xml-events
, DOMAttributeNameChanged
} is fired.n
of type Node
namespaceURI
of type DOMString
qualifiedName
of type DOMString
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 INVALID_CHARACTER_ERR: Raised if the new qualified name is not an XML name according to the XML version in use specified in the WRONG_DOCUMENT_ERR: Raised when the specified node was created from a different document than this document. NAMESPACE_ERR: Raised if the |
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.
interface Node { // NodeType const unsigned short ELEMENT_NODE = 1; const unsigned short ATTRIBUTE_NODE = 2; const unsigned short TEXT_NODE = 3; const unsigned short CDATA_SECTION_NODE = 4; const unsigned short ENTITY_REFERENCE_NODE = 5; const unsigned short ENTITY_NODE = 6; const unsigned short PROCESSING_INSTRUCTION_NODE = 7; const unsigned short COMMENT_NODE = 8; const unsigned short DOCUMENT_NODE = 9; const unsigned short DOCUMENT_TYPE_NODE = 10; const unsigned short DOCUMENT_FRAGMENT_NODE = 11; const unsigned short NOTATION_NODE = 12; readonly attribute DOMString nodeName; attribute DOMString nodeValue; // raises(DOMException) on setting // raises(DOMException) on retrieval readonly attribute unsigned short nodeType; readonly attribute Node parentNode; readonly attribute NodeList childNodes; readonly attribute Node firstChild; readonly attribute Node lastChild; readonly attribute Node previousSibling; readonly attribute Node nextSibling; readonly attribute NamedNodeMap attributes; // Modified in DOM Level 2: readonly attribute Document ownerDocument; // Modified in DOM Level 3: Node insertBefore(in Node newChild, in Node refChild) raises(DOMException); // Modified in DOM Level 3: Node replaceChild(in Node newChild, in Node oldChild) raises(DOMException); // Modified in DOM Level 3: Node removeChild(in Node oldChild) raises(DOMException); // Modified in DOM Level 3: Node appendChild(in Node newChild) raises(DOMException); boolean hasChildNodes(); Node cloneNode(in boolean deep); // Modified in DOM Level 3: void normalize(); // Introduced in DOM Level 2: boolean isSupported(in DOMString feature, in DOMString version); // Introduced in DOM Level 2: readonly attribute DOMString namespaceURI; // Introduced in DOM Level 2: attribute DOMString prefix; // raises(DOMException) on setting // Introduced in DOM Level 2: readonly attribute DOMString localName; // Introduced in DOM Level 2: boolean hasAttributes(); // Introduced in DOM Level 3: readonly attribute DOMString baseURI; // DocumentPosition const unsigned short DOCUMENT_POSITION_DISCONNECTED = 0x01; const unsigned short DOCUMENT_POSITION_PRECEDING = 0x02; const unsigned short DOCUMENT_POSITION_FOLLOWING = 0x04; const unsigned short DOCUMENT_POSITION_CONTAINS = 0x08; const unsigned short DOCUMENT_POSITION_CONTAINED_BY = 0x10; const unsigned short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20; // Introduced in DOM Level 3: unsigned short compareDocumentPosition(in Node other) raises(DOMException); // Introduced in DOM Level 3: attribute DOMString textContent; // raises(DOMException) on setting // raises(DOMException) on retrieval // Introduced in DOM Level 3: boolean isSameNode(in Node other); // Introduced in DOM Level 3: DOMString lookupPrefix(in DOMString namespaceURI); // Introduced in DOM Level 3: boolean isDefaultNamespace(in DOMString namespaceURI); // Introduced in DOM Level 3: DOMString lookupNamespaceURI(in DOMString prefix); // Introduced in DOM Level 3: boolean isEqualNode(in Node arg); // Introduced in DOM Level 3: DOMObject getFeature(in DOMString feature, in DOMString version); // Introduced in DOM Level 3: DOMUserData setUserData(in DOMString key, in DOMUserData data, in UserDataHandler handler); // Introduced in DOM Level 3: DOMUserData getUserData(in DOMString key); };
An integer indicating which type of node this is.
Note: Numeric codes up to 200 are reserved to W3C for possible future use.
ATTRIBUTE_NODE
Attr
.
CDATA_SECTION_NODE
CDATASection
.
COMMENT_NODE
Comment
.
DOCUMENT_FRAGMENT_NODE
DocumentFragment
.
DOCUMENT_NODE
Document
.
DOCUMENT_TYPE_NODE
DocumentType
.
ELEMENT_NODE
Element
.
ENTITY_NODE
Entity
.
ENTITY_REFERENCE_NODE
EntityReference
.
NOTATION_NODE
Notation
.
PROCESSING_INSTRUCTION_NODE
ProcessingInstruction
.
TEXT_NODE
Text
node.
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 |
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.
DOCUMENT_POSITION_CONTAINED_BY
DOCUMENT_POSITION_CONTAINS
DOCUMENT_POSITION_DISCONNECTED
DOCUMENT_POSITION_FOLLOWING
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
DOCUMENT_POSITION_PRECEDING
attributes
of type NamedNodeMap
, readonly
NamedNodeMap
containing the attributes of this node (if it is an Element
) or null
otherwise.baseURI
of type DOMString
, readonly, introduced in DOM Level 3
null
if the implementation wasn't able to obtain an absolute URI. This value is computed as described in Base URIs. However, when the Document
supports the feature "HTML" [DOM Level 2 HTML], the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI
attribute from the Document
interface otherwise.childNodes
of type NodeList
, readonly
NodeList
that contains all children of this node. If there are no children, this is a NodeList
containing no nodes.firstChild
of type Node
, readonly
null
.lastChild
of type Node
, readonly
null
.localName
of type DOMString
, readonly, introduced in DOM Level 2
ELEMENT_NODE
and ATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such as Document.createElement()
, this is always null
.namespaceURI
of type DOMString
, readonly, introduced in DOM Level 2
null
if it is unspecified (see XML Namespaces).ELEMENT_NODE
and ATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such as Document.createElement()
, this is always null
.
Note: Per the Namespaces in XML Specification [XML Namespaces] an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.
nextSibling
of type Node
, readonly
null
.nodeName
of type DOMString
, readonly
nodeType
of type unsigned short
, readonly
nodeValue
of type DOMString
null
, setting it has no effect, including if the node is read-only.NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if it is not defined to be |
DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a |
ownerDocument
of type Document
, readonly, modified in DOM Level 2
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
.parentNode
of type Node
, readonly
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
. prefix
of type DOMString
, introduced in DOM Level 2
null
if it is unspecified. When it is defined to be null
, setting it has no effect, including if the node is read-only.nodeName
attribute, which holds the qualified name, as well as the tagName
and name
attributes of the Element
and Attr
interfaces, when applicable.null
makes it unspecified, setting it to an empty string is implementation dependent.namespaceURI
and localName
do not change.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 NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NAMESPACE_ERR: Raised if the specified |
previousSibling
of type Node
, readonly
null
.textContent
of type DOMString
, introduced in DOM Level 3
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. Text.isElementContentWhitespace
). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content. Node type | Content |
---|---|
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children. |
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue |
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. |
DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a |
appendChild
modified in DOM Level 3
newChild
to the end of the list of children of this node. If the newChild
is already in the tree, it is first removed.
newChild
of type Node
DocumentFragment
object, the entire contents of the document fragment are moved into the child list of this nodeThe node added. |
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the WRONG_DOCUMENT_ERR: Raised if 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 |
cloneNode
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.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.EntityReference
clone are readonly. In addition, clones of unspecified Attr
nodes are specified. And, cloning Document
, DocumentType
, Entity
, and Notation
nodes is implementation dependent.
deep
of type boolean
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. |
compareDocumentPosition
introduced in DOM Level 3
other
of type 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. |
getFeature
introduced in DOM Level 3
Node
interface.
Returns an object which implements the specialized APIs of the specified feature and version, if any, or |
getUserData
introduced in DOM Level 3
setUserData
with the same key.
key
of type DOMString
Returns the |
hasAttributes
introduced in DOM Level 2
|
Returns |
hasChildNodes
|
Returns |
insertBefore
modified in DOM Level 3
newChild
before the existing child node refChild
. If refChild
is null
, insert newChild
at the end of the list of children.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.
Note: Inserting a node before itself is implementation dependent.
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 WRONG_DOCUMENT_ERR: Raised if 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 NOT_SUPPORTED_ERR: if this node is of type |
isDefaultNamespace
introduced in DOM Level 3
namespaceURI
is the default namespace or not.
namespaceURI
of type DOMString
|
Returns |
isEqualNode
introduced in DOM Level 3
Node.isSameNode()
. All nodes that are the same will also be equal, though the reverse may not be true.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.DocumentType
nodes to be equal, the following conditions must also be satisfied:
publicId
, systemId
, internalSubset
.entities
NamedNodeMaps
are equal.notations
NamedNodeMaps
are equal.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.
Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.
arg
of type Node
|
Returns |
isSameNode
introduced in DOM Level 3
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.
other
of type Node
|
Returns |
isSupported
introduced in DOM Level 2
|
Returns |
lookupNamespaceURI
introduced in DOM Level 3
prefix
of type DOMString
null
, the method will return the default namespace URI if any.Returns the associated namespace URI or |
lookupPrefix
introduced in DOM Level 3
namespaceURI
of type DOMString
Returns an associated namespace prefix if found or |
normalize
modified in DOM Level 3
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 [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of the DOMConfiguration
object attached to the Node.ownerDocument
is true
, this method will also fully normalize the characters of the Text
nodes.
Note: 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.
removeChild
modified in DOM Level 3
oldChild
from the list of children, and returns it.
oldChild
of type Node
The node removed. |
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if NOT_SUPPORTED_ERR: if this node is of type |
replaceChild
modified in DOM Level 3
oldChild
with newChild
in the list of children, and returns the oldChild
node.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.
Note: Replacing a node with itself is implementation dependent.
The node replaced. |
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the WRONG_DOCUMENT_ERR: Raised if NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly. NOT_FOUND_ERR: Raised if NOT_SUPPORTED_ERR: if this node is of type |
setUserData
introduced in DOM Level 3
getUserData
with the same key.
key
of type DOMString
data
of type DOMUserData
null
to remove any existing association to that key.handler
of type UserDataHandler
null
.Returns the |
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 live.
The items in the NodeList
are accessible via an integral index, starting from 0.
length
of type unsigned long
, readonly
length-1
inclusive.item
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
of type unsigned long
The node at the |
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 live.
interface NamedNodeMap { Node getNamedItem(in DOMString name); Node setNamedItem(in Node arg) raises(DOMException); Node removeNamedItem(in DOMString name) raises(DOMException); Node item(in unsigned long index); readonly attribute unsigned long length; // Introduced in DOM Level 2: Node getNamedItemNS(in DOMString namespaceURI, in DOMString localName) raises(DOMException); // Introduced in DOM Level 2: Node setNamedItemNS(in Node arg) raises(DOMException); // Introduced in DOM Level 2: Node removeNamedItemNS(in DOMString namespaceURI, in DOMString localName) raises(DOMException); };
length
of type unsigned long
, readonly
0
to length-1
inclusive.getNamedItem
getNamedItemNS
introduced in DOM Level 2
namespaceURI
of type DOMString
localName
of type DOMString
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 [HTML 4.01]). |
item
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
of type unsigned long
The node at the |
removeNamedItem
name
of type DOMString
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 NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. |
removeNamedItemNS
introduced in DOM Level 2
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.namespaceURI
of type DOMString
localName
of type DOMString
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 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 [HTML 4.01]). |
setNamedItem
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.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.
arg
of type Node
nodeName
attribute.WRONG_DOCUMENT_ERR: Raised if NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. INUSE_ATTRIBUTE_ERR: Raised if HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities. |
setNamedItemNS
introduced in DOM Level 2
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.arg
of type Node
namespaceURI
and localName
attributes.WRONG_DOCUMENT_ERR: Raised if NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. INUSE_ATTRIBUTE_ERR: Raised if 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 [HTML 4.01]). |
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 16-bit units is used whenever necessary to indicate that indexing on CharacterData is done in 16-bit units.
interface CharacterData : Node { attribute DOMString data; // raises(DOMException) on setting // raises(DOMException) on retrieval readonly attribute unsigned long length; DOMString substringData(in unsigned long offset, in unsigned long count) raises(DOMException); void appendData(in DOMString arg) raises(DOMException); void insertData(in unsigned long offset, in DOMString arg) raises(DOMException); void deleteData(in unsigned long offset, in unsigned long count) raises(DOMException); void replaceData(in unsigned long offset, in unsigned long count, in DOMString arg) raises(DOMException); };
data
of type DOMString
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 |
length
of type unsigned long
, readonly
data
and the substringData
method below. This may have the value zero, i.e., CharacterData
nodes may be empty.appendData
data
provides access to the concatenation of data
and the DOMString
specified.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
deleteData
data
and length
reflect the change.
offset
of type unsigned long
count
of type unsigned long
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 NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
insertData
INDEX_SIZE_ERR: Raised if the specified NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
replaceData
offset
of type unsigned long
count
of type unsigned long
offset
and count
exceeds length
, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as a remove
method call with the same range, followed by an append
method invocation).arg
of type DOMString
DOMString
with which the range must be replaced.INDEX_SIZE_ERR: Raised if the specified NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
substringData
offset
of type unsigned long
count
of type unsigned long
The specified substring. If the sum of |
INDEX_SIZE_ERR: Raised if the specified DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a |
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 tokenized.
The way attribute value normalization is performed by the DOM implementation depends on how much the implementation knows about the schema in use. Typically, the value
and nodeValue
attributes of an Attr
node initially returns the normalized value given by the parser. It is also the case after 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 character references are involved, given that they are not represented in the DOM and they impact attribute value normalization. On the other hand, if the implementation knows about the schema in use when the attribute value is changed, and it is of a different type than CDATA, it may normalize it again at that time. This is especially true of specialized DOM implementations, such as SVG DOM implementations, which store attribute values in an internal form different from a string.
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 |
"x²=5" |
"x²=5" |
"x²=5" |
Built-in character entity |
"y<6" |
"y<6" |
"y<6" |
Literal newline between |
"x=5 y=6" |
"x=5 y=6" |
"x=5 y=6" |
Normalized newline between |
"x=5 y=6" |
"x=5 y=6" |
"x=5 y=6" |
Entity e with literal newline |
<!ENTITY e '... ...'> [...]> "x=5&e;y=6" |
Dependent on Implementation and Load Options | Dependent on Implementation and Load/Save Options |
interface Attr : Node { readonly attribute DOMString name; readonly attribute boolean specified; attribute DOMString value; // raises(DOMException) on setting // Introduced in DOM Level 2: readonly attribute Element ownerElement; // Introduced in DOM Level 3: readonly attribute TypeInfo schemaTypeInfo; // Introduced in DOM Level 3: readonly attribute boolean isId; };
isId
of type boolean
, readonly, introduced in DOM Level 3
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:
Document.normalizeDocument()
, the post-schema-validation infoset contributions (PSVI contributions) values are used to determine if this attribute is a schema-determined ID attribute using the schema-determined ID definition in [XPointer].Document.normalizeDocument()
, the infoset [type definition] value is used to determine if this attribute is a DTD-determined ID attribute using the DTD-determined ID definition in [XPointer].Element.setIdAttribute()
, Element.setIdAttributeNS()
, or Element.setIdAttributeNode()
, i.e. it is an user-determined ID attribute; Note: XPointer framework (see section 3.2 in [XPointer]) consider the DOM user-determined ID attribute as being part of the XPointer externally-determined ID definition.
Document.normalizeDocument()
, all user-determined ID attributes are reset and all attribute nodes ID information are then reevaluated in accordance to the schema used. As a consequence, if the Attr.schemaTypeInfo
attribute contains an ID type, isId
will always return true. name
of type DOMString
, readonly
Node.localName
is different from null
, this attribute is a qualified name.ownerElement
of type Element
, readonly, introduced in DOM Level 2
Element
node this attribute is attached to or null
if this attribute is not in use.schemaTypeInfo
of type TypeInfo
, readonly, introduced in DOM Level 3
Document.normalizeDocument()
, schemaTypeInfo
may not be reliable if the node was moved. specified
of type boolean
, readonly
True
if this attribute was explicitly given a value in the instance document, false
otherwise. If the application changed the value of this attribute node (even if it ends up having the same value as the default value) then it is set to true
. The implementation may handle attributes with default values from other schemas similarly but applications should use Document.normalizeDocument()
to guarantee this information is up-to-date. value
of type DOMString
getAttribute
on the Element
interface.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()
.NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. |
The Element
interface represents an element in an HTML or XML document. Elements may have attributes associated with them; since the 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 convenience.
Note: In DOM Level 2, the method normalize
is inherited from the Node
interface where it was moved.
interface Element : Node { readonly attribute DOMString tagName; DOMString getAttribute(in DOMString name); void setAttribute(in DOMString name, in DOMString value) raises(DOMException); void removeAttribute(in DOMString name) raises(DOMException); Attr getAttributeNode(in DOMString name); Attr setAttributeNode(in Attr newAttr) raises(DOMException); Attr removeAttributeNode(in Attr oldAttr) raises(DOMException); NodeList getElementsByTagName(in DOMString name); // Introduced in DOM Level 2: DOMString getAttributeNS(in DOMString namespaceURI, in DOMString localName) raises(DOMException); // Introduced in DOM Level 2: void setAttributeNS(in DOMString namespaceURI, in DOMString qualifiedName, in DOMString value) raises(DOMException); // Introduced in DOM Level 2: void removeAttributeNS(in DOMString namespaceURI, in DOMString localName) raises(DOMException); // Introduced in DOM Level 2: Attr getAttributeNodeNS(in DOMString namespaceURI, in DOMString localName) raises(DOMException); // Introduced in DOM Level 2: Attr setAttributeNodeNS(in Attr newAttr) raises(DOMException); // Introduced in DOM Level 2: NodeList getElementsByTagNameNS(in DOMString namespaceURI, in DOMString localName) raises(DOMException); // Introduced in DOM Level 2: boolean hasAttribute(in DOMString name); // Introduced in DOM Level 2: boolean hasAttributeNS(in DOMString namespaceURI, in DOMString localName) raises(DOMException); // Introduced in DOM Level 3: readonly attribute TypeInfo schemaTypeInfo; // Introduced in DOM Level 3: void setIdAttribute(in DOMString name, in boolean isId) raises(DOMException); // Introduced in DOM Level 3: void setIdAttributeNS(in DOMString namespaceURI, in DOMString localName, in boolean isId) raises(DOMException); // Introduced in DOM Level 3: void setIdAttributeNode(in Attr idAttr, in boolean isId) raises(DOMException); };
schemaTypeInfo
of type TypeInfo
, readonly, introduced in DOM Level 3
tagName
of type DOMString
, readonly
Node.localName
is different from null
, this attribute is a qualified name. For example, in:
<elementExample id="demo"> ... </elementExample> ,
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.getAttribute
getAttributeNS
introduced in DOM Level 2
null
as the namespaceURI
parameter for methods if they wish to have no namespace.
namespaceURI
of type DOMString
localName
of type DOMString
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature |
getAttributeNode
getAttributeNodeNS
method.
name
of type DOMString
nodeName
) of the attribute to retrieve.getAttributeNodeNS
introduced in DOM Level 2
Attr
node by local name and namespace URI.null
as the namespaceURI
parameter for methods if they wish to have no namespace.
namespaceURI
of type DOMString
localName
of type DOMString
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature |
getElementsByTagName
NodeList
of all descendant Elements
with a given tag name, in document order.
name
of type DOMString
A list of matching |
getElementsByTagNameNS
introduced in DOM Level 2
NodeList
of all the descendant Elements
with a given local name and namespace URI in document order.
namespaceURI
of type DOMString
localName
of type DOMString
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature |
hasAttribute
introduced in DOM Level 2
true
when an attribute with a given name is specified on this element or has a default value, false
otherwise.
name
of type DOMString
|
|
hasAttributeNS
introduced in DOM Level 2
true
when an attribute with a given local name and namespace URI is specified on this element or has a default value, false
otherwise.null
as the namespaceURI
parameter for methods if they wish to have no namespace.
namespaceURI
of type DOMString
localName
of type DOMString
|
|
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature |
removeAttribute
Document.normalizeDocument()
to guarantee this information is up-to-date.removeAttributeNS
method.
name
of type DOMString
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
removeAttributeNS
introduced in DOM Level 2
Document.normalizeDocument()
to guarantee this information is up-to-date.null
as the namespaceURI
parameter for methods if they wish to have no namespace.
namespaceURI
of type DOMString
localName
of type DOMString
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature |
removeAttributeNode
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.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if |
setAttribute
Attr
node plus any Text
and EntityReference
nodes, build the appropriate subtree, and use setAttributeNode
to assign it as the value of an attribute.setAttributeNS
method.
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
setAttributeNS
introduced in DOM Level 2
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.null
as the namespaceURI
parameter for methods if they wish to have no namespace.
namespaceURI
of type DOMString
qualifiedName
of type DOMString
value
of type DOMString
INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to the XML version in use specified in the NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NAMESPACE_ERR: Raised if the NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature |
setAttributeNode
nodeName
) is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect.setAttributeNodeNS
method.
WRONG_DOCUMENT_ERR: Raised if NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if |
setAttributeNodeNS
introduced in DOM Level 2
null
as the namespaceURI
parameter for methods if they wish to have no namespace.
If the |
WRONG_DOCUMENT_ERR: Raised if NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature |
setIdAttribute
introduced in DOM Level 3
isId
is true
, this method declares the specified attribute to be a user-determined ID attribute. This affects the value of 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 user-determined ID attribute. setIdAttributeNS
method.
name
of type DOMString
isId
of type boolean
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. |
setIdAttributeNS
introduced in DOM Level 3
isId
is true
, this method declares the specified attribute to be a user-determined ID attribute. This affects the value of 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 user-determined ID attribute.
namespaceURI
of type DOMString
localName
of type DOMString
isId
of type boolean
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. |
setIdAttributeNode
introduced in DOM Level 3
isId
is true
, this method declares the specified attribute to be a user-determined ID attribute. This affects the value of 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 user-determined ID attribute.
idAttr
of type Attr
isId
of type boolean
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 character data in XML) of an 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 information items (elements, comments, etc.) and 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.
interface Text : CharacterData { Text splitText(in unsigned long offset) raises(DOMException); // Introduced in DOM Level 3: readonly attribute boolean isElementContentWhitespace; // Introduced in DOM Level 3: readonly attribute DOMString wholeText; // Introduced in DOM Level 3: Text replaceWholeText(in DOMString content) raises(DOMException); };
isElementContentWhitespace
of type boolean
, readonly, introduced in DOM Level 3
Document.normalizeDocument()
.wholeText
of type DOMString
, readonly, introduced in DOM Level 3
Text
nodes logically-adjacent text nodes to this node, concatenated in document order.wholeText
on the Text
node that contains "bar" returns "barfoo", while on the Text
node that contains "foo" it returns "barfoo".
Figure: barTextNode.wholeText value is "barfoo" [SVG 1.0 version]
replaceWholeText
introduced in DOM Level 3
null
, when the replacement text is the empty string;Text
node of the same type (Text
or CDATASection
) as the current node inserted at the location of the replacement.replaceWholeText
on the Text
node that contains "bar" with "yo" in argument results in the following:
Figure: barTextNode.replaceWholeText("yo") modifies the textual content of barTextNode with "yo" [SVG 1.0 version]
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
.replaceWholeText
on the Text
node that contains "bar" fails, because the EntityReference
node "ent" contains an Element
node which cannot be removed.
Figure: barTextNode.replaceWholeText("yo") raises a NO_MODIFICATION_ALLOWED_ERR DOMException [SVG 1.0 version]
content
of type DOMString
Text
node.The |
NO_MODIFICATION_ALLOWED_ERR: Raised if one of the |
splitText
offset
, keeping both in the tree as siblings. After being split, this node will contain all the content up to the offset
point. A new node of the same type, which contains all the content at and after the offset
point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the offset
is equal to the length of this node, the new node has no data.
offset
of type unsigned long
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 NO_MODIFICATION_ALLOWED_ERR: Raised if this node 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 [XML 1.0]. The presence of this character sequence must generate a fatal error during serialization.
interface Comment : CharacterData { };
The TypeInfo
interface represents a type referenced from Element
or Attr
nodes, specified in the schemas associated with the document. The type is a pair of a namespace URI and name properties, and depends on the document's schema.
If the document's schema is an XML DTD [XML 1.0], the values are computed as follows:
Attr
node, typeNamespace
is "http://www.w3.org/TR/REC-xml"
and typeName
represents the [attribute type] property in the [XML Information Set]. If there is no declaration for the attribute, typeNamespace
and typeName
are null
.Element
node, typeNamespace
and typeName
are null
.If the document's schema is an XML Schema [XML Schema Part 1], the values are computed as follows using the post-schema-validation infoset contributions (also called PSVI contributions):
null
. Note: At the time of writing, the XML Schema specification does not require exposing the declared type. Thus, DOM implementations might choose not to provide type information if validity is not valid.
Note: Other schema languages are outside the scope of the W3C and therefore should define how to represent their type systems using TypeInfo
.
// Introduced in DOM Level 3: interface TypeInfo { readonly attribute DOMString typeName; readonly attribute DOMString typeNamespace; // DerivationMethods const unsigned long DERIVATION_RESTRICTION = 0x00000001; const unsigned long DERIVATION_EXTENSION = 0x00000002; const unsigned long DERIVATION_UNION = 0x00000004; const unsigned long DERIVATION_LIST = 0x00000008; boolean isDerivedFrom(in DOMString typeNamespaceArg, in DOMString typeNameArg, in unsigned long derivationMethod); };
These are the available values for the derivationMethod
parameter used by the method TypeInfo.isDerivedFrom()
. It is a set of possible types of derivation, and the values represent bit positions. If a bit in the derivationMethod
parameter is set to 1
, the corresponding type of derivation will be taken into account when evaluating the derivation between the reference type definition and the other type definition. When using the isDerivedFrom
method, combining all of them in the derivationMethod
parameter is equivalent to invoking the method for each of them separately and combining the results with the OR boolean function. This specification only defines the type of derivation for XML Schema.
In addition to the types of derivation listed below, please note that:
xsd:anyType
.xsd:anySimpleType
by restriction.xsd:anySimpleType
by restriction.DERIVATION_EXTENSION
DERIVATION_LIST
DERIVATION_RESTRICTION
or DERIVATION_EXTENSION
, T2 is derived from the other type definition by DERIVATION_RESTRICTION
, T1 has {variety} list, and T2 is the {item type definition}. Note that T1 could be the same as the reference type definition, and T2 could be the same as the other type definition.
DERIVATION_RESTRICTION
DERIVATION_UNION
DERIVATION_RESTRICTION
or DERIVATION_EXTENSION
, T2 is derived from the other type definition by DERIVATION_RESTRICTION
, T1 has {variety} union, and one of the {member type definitions} is T2. Note that T1 could be the same as the reference type definition, and T2 could be the same as the other type definition.
typeName
of type DOMString
, readonly
null
if unknown. typeNamespace
of type DOMString
, readonly
null
if the element does not have declaration or if no namespace information is available. isDerivedFrom
TypeInfo
on which the method is being called, and the other type definition, i.e. the one passed as parameters.
typeNamespaceArg
of type DOMString
typeNameArg
of type DOMString
derivationMethod
of type unsigned long
|
If the document's schema is a DTD or no schema is associated with the document, this method will always return |
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.
// Introduced in DOM Level 3: interface UserDataHandler { // OperationType const unsigned short NODE_CLONED = 1; const unsigned short NODE_IMPORTED = 2; const unsigned short NODE_DELETED = 3; const unsigned short NODE_RENAMED = 4; const unsigned short NODE_ADOPTED = 5; void handle(in unsigned short operation, in DOMString key, in DOMUserData data, in Node src, in Node dst); };
An integer indicating the type of operation being performed on a node.
NODE_ADOPTED
Document.adoptNode()
.
NODE_CLONED
Node.cloneNode()
.
NODE_DELETED
Note: This may not be supported or may not be reliable in certain environments, such as Java, where the implementation has no real control over when objects are actually deleted.
NODE_IMPORTED
Document.importNode()
.
NODE_RENAMED
Document.renameNode()
.
handle
UserDataHandler
. The effect of throwing exceptions from the handler is DOM implementation dependent.
operation
of type unsigned short
key
of type DOMString
data
of type DOMUserData
src
of type Node
null
when the node is being deleted.dst
of type Node
null
.DOMError
is an interface that describes an error.
// Introduced in DOM Level 3: interface DOMError { // ErrorSeverity const unsigned short SEVERITY_WARNING = 1; const unsigned short SEVERITY_ERROR = 2; const unsigned short SEVERITY_FATAL_ERROR = 3; readonly attribute unsigned short severity; readonly attribute DOMString message; readonly attribute DOMString type; readonly attribute DOMObject relatedException; readonly attribute DOMObject relatedData; readonly attribute DOMLocator location; };
An integer indicating the severity of the error.
SEVERITY_ERROR
DOMError
is error. A SEVERITY_ERROR
may not cause the processing to stop if the error can be recovered, unless DOMErrorHandler.handleError()
returns false
.
SEVERITY_FATAL_ERROR
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.
SEVERITY_WARNING
DOMError
is warning. A SEVERITY_WARNING
will not cause the processing to stop, unless DOMErrorHandler.handleError()
returns false
.
location
of type DOMLocator
, readonly
message
of type DOMString
, readonly
relatedData
of type DOMObject
, readonly
DOMError.type
dependent data if any. relatedException
of type DOMObject
, readonly
severity
of type unsigned short
, readonly
SEVERITY_WARNING
, SEVERITY_ERROR
, or SEVERITY_FATAL_ERROR
.type
of type DOMString
, readonly
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.
Note: As an example, Document.normalizeDocument()
does generate warnings when the "split-cdata-sections" parameter is in use. Therefore, the method generates a SEVERITY_WARNING
with type
"cdata-sections-splitted"
and the first CDATASection
node in document order resulting from the split is returned by the relatedData
attribute.
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 "error-handler" on 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.
// Introduced in DOM Level 3: interface DOMErrorHandler { boolean handleError(in DOMError error); };
handleError
true
.
error
of type DOMError
handleError
method.
|
If the |
DOMLocator
is an interface that describes a location (e.g. where an error occurred).
// Introduced in DOM Level 3: interface DOMLocator { readonly attribute long lineNumber; readonly attribute long columnNumber; readonly attribute long byteOffset; readonly attribute long utf16Offset; readonly attribute Node relatedNode; readonly attribute DOMString uri; };
byteOffset
of type long
, readonly
-1
if there is no byte offset available.columnNumber
of type long
, readonly
-1
if there is no column number available.lineNumber
of type long
, readonly
-1
if there is no column number available.relatedNode
of type Node
, readonly
null
if no node is available.uri
of type DOMString
, readonly
null
if no URI is available.utf16Offset
of type long
, readonly
-1
if there is no UTF-16 offset 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 schema that must be used when the validation of the Document
is requested. DOMConfiguration
objects are also used in [DOM Level 3 Load and Save] in the DOMParser
and DOMSerializer
interfaces.
The parameter names used by the DOMConfiguration
object are defined throughout the DOM Level 3 specifications. Names are case-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 ECMAScript Language Binding, names are recommended to follow the section "5.16 Identifiers" of [Unicode] with the addition of the character '-' (HYPHEN-MINUS) but it is not enforced by the DOM implementation. DOM Level 3 Core Implementations are required to recognize all parameters defined in this specification. Some parameter values may also be required to be supported by the implementation. Refer to the definition of the parameter to know if a value must be supported or not.
Note: Parameters are similar to features and properties used in SAX2 [SAX].
The following list of parameters defined in the DOM:
"canonical-form"
true
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, true
will also set the state of the parameters listed below. Later changes to the state of one of those parameters will revert "canonical-form" back to false
. false
: "entities", "normalize-characters", "cdata-sections". true
: "namespaces", "namespace-declarations", "well-formed", "element-content-whitespace". false
"cdata-sections"
true
CDATASection
nodes in the document.
false
CDATASection
nodes in the document into Text
nodes. The new Text
node is then combined with any adjacent Text
node.
"check-character-normalization"
true
DOMError.type
equals to "check-character-normalization-failure" is issued.
false
"comments"
"datatype-normalization"
true
true
. Having this parameter activated when "validate" is false
has no effect and no schema-normalization will happen.
Note: Since the document contains the result of the XML 1.0 processing, this parameter does not apply to attribute value normalization as defined in section 3.3.3 of [XML 1.0] and is only meant for schema languages other than Document Type Definition (DTD).
false
"element-content-whitespace"
true
false
Text
nodes that contain whitespaces in element content, as described in [element content whitespace]. The implementation is expected to use the attribute Text.isElementContentWhitespace
to determine if a Text
node should be discarded or not.
"entities"
true
EntityReference
nodes in the document.
false
EntityReference
nodes from the document, putting the entity expansions directly in their place. Text
nodes are normalized, as defined in Node.normalize
. Only unexpanded entity references are kept in the document.
Note: This parameter does not affect Entity
nodes.
"error-handler"
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. 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.
"infoset"
true
false
: "validate-if-schema", "entities", "datatype-normalization", "cdata-sections".true
: "namespace-declarations", "well-formed", "element-content-whitespace", "comments", "namespaces".getParameter
returns true
only if the individual parameters specified above are appropriately set.
false
infoset
to false
has no effect.
"namespaces"
true
false
"namespace-declarations"
false
.
true
false
Node.prefix
) are retained even if this parameter is set to false
.
"normalize-characters"
true
false
"schema-location"
DOMString
object containing a list of URIs, separated by whitespaces (characters matching the nonterminal production S defined in section 2.3 [XML 1.0]), that represents the schemas against which validation should occur, i.e. the current schema. The types of schemas referenced in this list must match the type specified with schema-type
, otherwise the behavior of an implementation is undefined. 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. null
.
Note: The "schema-location"
parameter is ignored unless the "schema-type" parameter value is set. It is strongly recommended that Document.documentURI
will be set so that an implementation can successfully resolve any external entities referenced.
"schema-type"
DOMString
object containing an absolute URI and representing the type of the schema language used to validate a document against. Note that no lexical checking is done on the absolute URI. null
.
Note: For XML Schema [XML Schema Part 1], applications must use the value "http://www.w3.org/2001/XMLSchema"
. For XML DTD [XML 1.0], applications must use the value "http://www.w3.org/TR/REC-xml"
. Other schema languages are outside the scope of the W3C and therefore should recommend an absolute URI in order to use this method.
"split-cdata-sections"
true
DOMError.type
equals to "cdata-sections-splitted"
and DOMError.relatedData
equals to the first CDATASection
node in document order resulting from the split.
false
CDATASection
contains an unrepresentable character.
"validate"
true
true
. Attr.specified
equals to false
, as specified in the description of the Attr
interface;Text.isElementContentWhitespace
for all Text
nodes;Attr.isId
for all Attr
nodes;Element.schemaTypeInfo
and Attr.schemaTypeInfo
.Note: "validate-if-schema" and "validate" are mutually exclusive, setting one of them to true
will set the other one to false
. Applications should also consider setting the parameter "well-formed" to true
, which is the default for that option, when validating the document.
false
true
.
"validate-if-schema"
true
true
.
Note: "validate-if-schema" and "validate" are mutually exclusive, setting one of them to true
will set the other one to false
.
false
true
.
"well-formed"
true
Document.xmlVersion
:
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;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;ProcessingInstruction
nodes for invalid characters and generate a DOMError
of type "wf-invalid-character"
, with a DOMError.SEVERITY_ERROR
severity, if necessary;false
The resolution of the system identifiers associated with entities is done using Document.documentURI
. However, when the feature "LS" defined in [DOM Level 3 Load and Save] is supported by the DOM implementation, the parameter "resource-resolver" can also be used on DOMConfiguration
objects attached to Document
nodes. If this parameter is set, Document.normalizeDocument()
will invoke the resource resolver instead of using Document.documentURI
.
// Introduced in DOM Level 3: interface DOMConfiguration { void setParameter(in DOMString name, in DOMUserData value) raises(DOMException); DOMUserData getParameter(in DOMString name) raises(DOMException); boolean canSetParameter(in DOMString name, in DOMUserData value); readonly attribute DOMStringList parameterNames; };
parameterNames
of type DOMStringList
, readonly
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. canSetParameter
name
of type DOMString
value
of type DOMUserData
null
, the returned value is true
.
|
|
getParameter
name
of type DOMString
The current object associated with the specified parameter or |
NOT_FOUND_ERR: Raised when the parameter name is not recognized. |
setParameter
name
of type DOMString
value
of type DOMUserData
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 "error-handler", the value must be of type 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. |
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 Fundamental Interfaces: Core Module and the feature "XMLVersion" with version "1.0" defined in Document.xmlVersion
. Please refer to additional information about Conformance in this specification. The DOM Level 3 XML module is backward compatible with the DOM Level 2 XML [DOM Level 2 Core] and DOM Level 1 XML [DOM Level 1] modules, i.e. a DOM Level 3 XML implementation who returns true
for "XML" with the version
number "3.0"
must also return true
for this feature
when the version
number is "2.0"
, "1.0"
, ""
or, null
.
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 may contain characters that need to be escaped outside of CDATA sections and that, depending on the character encoding ("charset") chosen for serialization, it may be impossible to write out some characters as part of a CDATA section.
The CDATASection
interface inherits from the 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 [XML 1.0]. The presence of this character sequence must generate a fatal error during serialization or the cdata section must be splitted before the serialization (see also the parameter "split-cdata-sections"
in the DOMConfiguration
interface).
Note: Because no markup is recognized within a CDATASection
, character numeric references cannot be used as an escape mechanism when serializing. Therefore, action needs to be taken when serializing a CDATASection
with a character encoding where some of the contained characters cannot be represented. Failure to do so would not produce well-formed XML.
One potential solution in the serialization process is to end the CDATA section before the character, output the character using a character reference or entity reference, and open a new CDATA section for any further characters in the text node. Note, however, that some code conversion libraries at the time of writing do not return an error or exception when a character is missing from the encoding, making the task of ensuring that data is not corrupted on serialization more difficult.
interface CDATASection : Text { };
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 read-only.
interface DocumentType : Node { readonly attribute DOMString name; readonly attribute NamedNodeMap entities; readonly attribute NamedNodeMap notations; // Introduced in DOM Level 2: readonly attribute DOMString publicId; // Introduced in DOM Level 2: readonly attribute DOMString systemId; // Introduced in DOM Level 2: readonly attribute DOMString internalSubset; };
entities
of type NamedNodeMap
, readonly
NamedNodeMap
containing the general entities, both external and internal, declared in the DTD. Parameter entities are not contained. Duplicates are discarded. For example in:
<!DOCTYPE ex SYSTEM "ex.dtd" [ <!ENTITY foo "foo"> <!ENTITY bar "bar"> <!ENTITY bar "bar2"> <!ENTITY % baz "baz"> ]> <ex/>
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.entities
cannot be altered in any way.internalSubset
of type DOMString
, readonly, introduced in DOM Level 2
null
if there is none. This is does not contain the delimiting square brackets.
Note: The actual content returned depends on how much information is available to the implementation. This may vary depending on various parameters, including the XML processor used to build the document.
name
of type DOMString
, readonly
DOCTYPE
keyword.notations
of type NamedNodeMap
, readonly
NamedNodeMap
containing the notations declared in the DTD. Duplicates are discarded. Every node in this map also implements the Notation
interface.notations
cannot be altered in any way.publicId
of type DOMString
, readonly, introduced in DOM Level 2
systemId
of type DOMString
, readonly, introduced in DOM Level 2
This interface represents a notation declared in the DTD. A notation either declares, by name, the format of an unparsed entity (see section 4.7 of the XML 1.0 specification [XML 1.0]), or is used for formal declaration of processing instruction targets (see section 2.6 of the XML 1.0 specification [XML 1.0]). The 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 readonly.
A Notation
node does not have any parent.
interface Notation : Node { readonly attribute DOMString publicId; readonly attribute DOMString systemId; };
publicId
of type DOMString
, readonly
null
.systemId
of type DOMString
, readonly
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 not the entity declaration.
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 replacement text is available, the corresponding 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 descendants are readonly.
An Entity
node does not have any parent.
Note: If the entity contains an unbound namespace prefix, the 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.
interface Entity : Node { readonly attribute DOMString publicId; readonly attribute DOMString systemId; readonly attribute DOMString notationName; // Introduced in DOM Level 3: readonly attribute DOMString inputEncoding; // Introduced in DOM Level 3: readonly attribute DOMString xmlEncoding; // Introduced in DOM Level 3: readonly attribute DOMString xmlVersion; };
inputEncoding
of type DOMString
, readonly, introduced in DOM Level 3
null
if it an entity from the internal subset or if it is not known.notationName
of type DOMString
, readonly
null
.publicId
of type DOMString
, readonly
null
otherwise.systemId
of type DOMString
, readonly
null
otherwise. This may be an absolute URI or not.xmlEncoding
of type DOMString
, readonly, introduced in DOM Level 3
null
otherwise.xmlVersion
of type DOMString
, readonly, introduced in DOM Level 3
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 namespace prefix. In such a case, because the namespace prefix resolution depends on where the entity reference is, the descendants of the EntityReference
node may be bound to different namespace URIs. When an EntityReference
node represents a reference to an unknown entity, the node has no children and its replacement value, when used by Attr.value
for example, is empty.
As for Entity
nodes, EntityReference
nodes and all their descendants are readonly.
Note: EntityReference
nodes may cause element content and attribute value normalization problems when, such as in XML 1.0 and XML Schema, the normalization is performed after entity reference are expanded.
interface EntityReference : Node { };
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 [XML 1.0]. The presence of this character sequence must generate a fatal error during serialization.
interface ProcessingInstruction : Node { readonly attribute DOMString target; attribute DOMString data; // raises(DOMException) on setting };
data
of type DOMString
?>
.NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. |
target
of type DOMString
, readonly