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 usingNodeList
.
Implementations should raise other exceptions under other circumstances. For example, implementations should raise an implementation-dependent exception if anull
argument is passed whennull
was not expected.
Some languages and object systems do not support the concept of exceptions. For such systems, error conditions may be indicated using native error reporting mechanisms. For some bindings, for example, methods may return error codes similar to those listed in the corresponding method descriptions.
An integer indicating the type of error generated.
Other numeric codes are reserved for W3C for possible future use.
If index or size is negative, or greater than the allowed value.
If the specified range of text does not fit into aDOMString
.
If anyNode
is inserted somewhere it doesn't belong.
If aNode
is used in a different document than the one that created it (that doesn't support it).
If an invalid or illegal character is specified, such as in an XML name.
If data is specified for aNode
which does not support data.
If an attempt is made to modify an object where modifications are not allowed.
If an attempt is made to reference aNode
in a context where it does not exist.
If the implementation does not support the requested type of object or operation.
If an attempt is made to add an attribute that is already in use elsewhere.
If an attempt is made to use an object that is not, or is no longer, usable.
If an invalid or illegal string is specified.
If an attempt is made to modify the type of the underlying object.
If an attempt is made to create or change an object in a way which is incorrect with regard to namespaces.
If a parameter or an operation is not supported by the underlying object.
If a call to a method such asinsertBefore
orremoveChild
would make theNode
invalid with respect to
If the type of an object is incompatible with the expected type of the parameter associated to the object.
TheDOMStringList
interface provides the abstraction of an ordered collection ofDOMString
values, without defining or constraining how this collection is implemented. The items in theDOMStringList
are accessible via an integral index, starting from 0.
Returns theindex
th item in the collection. Ifindex
is greater than or equal to the number ofDOMString
s in the list, this returnsnull
.
Index into the collection.
TheDOMString
at theindex
th position in theDOMStringList
, ornull
if that is not a valid index.
The number ofDOMString
s in the list. The range of valid child node indices is 0 tolength-1
inclusive.
Test if a string is part of thisDOMStringList
.
The string to look for.
true
if the string has been found,false
otherwise.
TheNameList
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 theNameList
are accessible via an integral index, starting from 0.
Returns theindex
th name item in the collection.
Index into the collection.
The name at theindex
th position in theNameList
, ornull
if there is no name for the specified index or if the index is out of range.
Returns theindex
th namespaceURI item in the collection.
Index into the collection.
The namespace URI at theindex
th position in theNameList
, ornull
if there is no name for the specified index or if the index is out of range.
The number of pairs (name and namespaceURI) in the list. The range of valid child node indices is 0 tolength-1
inclusive.
Test if a name is part of thisNameList
.
The name to look for.
true
if the name has been found,false
otherwise.
Test if the pair namespaceURI/name is part of thisNameList
.
The namespace URI to look for.
The name to look for.
true
if the pair namespaceURI/name has been found,false
otherwise.
TheDOMImplementationList
interface provides the abstraction of an ordered collection of DOM implementations, without defining or constraining how this collection is implemented. The items in theDOMImplementationList
are accessible via an integral index, starting from 0.
Returns theindex
th item in the collection. Ifindex
is greater than or equal to the number ofDOMImplementation
s in the list, this returnsnull
.
Index into the collection.
TheDOMImplementation
at theindex
th position in theDOMImplementationList
, ornull
if that is not a valid index.
The number ofDOMImplementation
s in the list. The range of valid child node indices is 0 tolength-1
inclusive.
This interface permits a DOM implementer to supply one or more implementations, based upon requested features and versions, as specified inDOMImplementationSource
object is listed in the binding-specific list of available sources so that itsDOMImplementation
objects are made available.
A method to request the first DOM implementation that supports the specified features.
A string that specifies which features and versions are required. This is a space separated list in which each feature is specified by its name optionally followed by a space and a version number.
This method returns the first item of the list returned bygetDOMImplementationList
.
As an example, the string"XML 3.0 Traversal +Events 2.0"
will request a DOM implementation that supports the module "XML" for its 3.0 version, a module that support of the "Traversal" module for any version, and the module "Events" for its 2.0 version. The module "Events" must be accessible using the methodNode.getFeature()
andDOMImplementation.getFeature()
.
The first DOM implementation that support the desired features, ornull
if this source has none.
A method to request a list of DOM implementations that support the specified features and versions, as specified in
A string that specifies which features and versions are required. This is a space separated list in which each feature is specified by its name optionally followed by a space and a version number. This is something like: "XML 3.0 Traversal +Events 2.0"
A list of DOM implementations that support the desired features.
TheDOMImplementation
interface provides a number of methods for performing operations that are independent of any particular instance of the document object model.
Test if the DOM implementation implements a specific feature and version, as specified in
The name of the feature to test.
This is the version number of the feature to test.
true
if the feature is implemented in the specified version,false
otherwise.
Creates an emptyDocumentType
node. Entity declarations and notations are not made available. Entity reference expansions and default attribute additions do not occur..
The
The external subset public identifier.
The external subset system identifier.
A newDocumentType
node withNode.ownerDocument
set tonull
.
INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to
NAMESPACE_ERR: Raised if thequalifiedName
is malformed.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as
Creates a DOM Document object of the specified type with its document element.
Note that based on theDocumentType
given to create the document, the implementation may instantiate specializedDocument
objects that support additional features than the "Core", such as "HTML"DocumentType
after the document was created makes this very unlikely to happen. Alternatively, specializedDocument
creation methods, such ascreateHTMLDocument
Document
objects.
Thenull
.
Thenull
.
The type of document to be created ornull
.
Whendoctype
is notnull
, itsNode.ownerDocument
attribute is set to the document being created.
A newDocument
object with its document element. If theNamespaceURI
,qualifiedName
, anddoctype
arenull
, the returnedDocument
is empty with no document element.
INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to
NAMESPACE_ERR: Raised if thequalifiedName
is malformed, if thequalifiedName
has a prefix and thenamespaceURI
isnull
, or if thequalifiedName
isnull
and thenamespaceURI
is different fromnull
, or if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from ""XML"
feature but a non-null namespace URI was provided, since namespaces were defined by XML.
WRONG_DOCUMENT_ERR: Raised ifdoctype
has already been used with a different document or was created from a different implementation.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified inDOMImplementation
interface.
The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method.
This is the version number of the feature to test.
Returns an object which implements the specialized APIs of the specified feature and version, if any, ornull
if there is no object which implements interfaces associated with that feature. If theDOMObject
returned by this method implements theDOMImplementation
interface, it must delegate to the primary coreDOMImplementation
and not return results inconsistent with the primary coreDOMImplementation
such ashasFeature
,getFeature
, etc.
DocumentFragment
is a "lightweight" or "minimal"Document
object. It is very common to want to be able to extract a portion of a document's tree or to create a new fragment of a document. Imagine implementing a user command like cut or rearranging a document by moving fragments around. It is desirable to have an object which can hold such fragments and it is quite natural to use a Node for this purpose. While it is true that aDocument
object could fulfill this role, aDocument
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 anotherNode
-- may takeDocumentFragment
objects as arguments; this results in all the child nodes of theDocumentFragment
being moved to the child list of this node.
The children of aDocumentFragment
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 beDocumentFragment
might have only one child and that child node could be aText
node. Such a structure model represents neither an HTML document nor a well-formed XML document.
When aDocumentFragment
is inserted into aDocument
(or indeed any otherNode
that may take children) the children of theDocumentFragment
and not theDocumentFragment
itself are inserted into theNode
. This makes theDocumentFragment
very useful when the user wishes to create nodes that areDocumentFragment
acts as the parent of these nodes so that the user can use the standard methods from theNode
interface, such asNode.insertBefore
andNode.appendChild
.
TheDocument
interface represents the entire HTML or XML document. Conceptually, it is the
Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of aDocument
, theDocument
interface also contains the factory methods needed to create these objects. TheNode
objects created have aownerDocument
attribute which associates them with theDocument
within whose context they were created.
The Document Type Declaration (seeDocumentType
) associated with this document. For XML documents without a document type declaration this returnsnull
. For HTML documents, aDocumentType
object may be returned, independently of the presence or absence of document type declaration in the HTML document.
This provides direct access to theDocumentType
node, child node of thisDocument
. This node can be set at document creation time and later changed through the use of child nodes manipulation methods, such asNode.insertBefore
, orNode.replaceChild
. Note, however, that while some implementations may instantiate different types ofDocument
objects supporting additional features than the "Core", such as "HTML"DocumentType
specified at creation time, changing it afterwards is very unlikely to result in a change of the features supported.
TheDOMImplementation
object that handles this document. A DOM application may use objects from multiple implementations.
This is a
Creates an element of the type specified. Note that the instance returned implements theElement
interface, so attributes can be specified directly on the returned object.
In addition, if there are known attributes with default values,Attr
nodes representing them are automatically created and attached to the element.
To create an element with acreateElementNS
method.
The name of the element type to instantiate. For XML, this is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use. In that case, the name is mapped to the canonical form of that markup by the DOM implementation.
A newElement
object with thenodeName
attribute set totagName
, andlocalName
,prefix
, andnamespaceURI
set tonull
.
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
Creates an emptyDocumentFragment
object.
A newDocumentFragment
.
Creates aText
node given the specified string.
The data for the node.
The newText
object.
Creates aComment
node given the specified string.
The data for the node.
The newComment
object.
Creates aCDATASection
node whose value is the specified string.
The data for theCDATASection
contents.
The newCDATASection
object.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Creates aProcessingInstruction
node given the specified name and data strings.
The target part of the processing instruction.
UnlikeDocument.createElementNS
orDocument.createAttributeNS
, no namespace well-formed checking is done on the target name. Applications should invokeDocument.normalizeDocument()
with the parameter "true
in order to ensure that the target name is namespace well-formed.
The data for the node.
The newProcessingInstruction
object.
INVALID_CHARACTER_ERR: Raised if the specified target is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Creates anAttr
of the given name. Note that theAttr
instance can then be set on anElement
using thesetAttributeNode
method.
To create an attribute with acreateAttributeNS
method.
The name of the attribute.
A newAttr
object with thenodeName
attribute set toname
, andlocalName
,prefix
, andnamespaceURI
set tonull
. The value of the attribute is the empty string.
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
Creates anEntityReference
object. In addition, if the referenced entity is known, the child list of theEntityReference
node is made the same as that of the correspondingEntity
node.
If any descendant of theEntity
node has an unboundEntityReference
node is also unbound; (itsnamespaceURI
isnull
). The DOM Level 2 and 3 do not support any mechanism to resolve namespace prefixes in this case.
The name of the entity to reference.
UnlikeDocument.createElementNS
orDocument.createAttributeNS
, no namespace well-formed checking is done on the entity name. Applications should invokeDocument.normalizeDocument()
with the parameter "true
in order to ensure that the entity name is namespace well-formed.
The newEntityReference
object.
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Returns aNodeList
of all theElements
in
The name of the tag to match on. The special value "*" matches all tags. For XML, thetagname
parameter is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use.
A newNodeList
object containing all the matchedElements
.
Imports a node from another document to this document, without altering or removing the source node from the original document; this method creates a new copy of the source node. The returned node has no parent; (parentNode
isnull
).
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node'snodeName
andnodeType
, plus the attributes related to namespaces (prefix
,localName
, andnamespaceURI
). As in thecloneNode
operation, the source node is not altered. User data associated to the imported node is not carried over. However, if anyUserDataHandlers
has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
Additional information is copied as appropriate to the The Note that the If the On import, the Only the On import, the Note that the The imported node copies its Note that the These three types of nodes inheriting from Note that thenodeType
, 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 tonull
and thespecified
flag is set totrue
on the generatedAttr
. TheAttr
are recursively imported and the resulting nodes reassembled to form the corresponding subtree.deep
parameter has no effect onAttr
nodes; they always carry their children with them when imported.deep
option was set totrue
, theDocumentFragment
are recursively imported and the resulting nodes reassembled under the importedDocumentFragment
to form the corresponding subtree. Otherwise, this simply generates an emptyDocumentFragment
.Document
nodes cannot be imported.DocumentType
nodes cannot be imported.Attr
nodes are attached to the generatedElement
. Default attributes areimportNode
deep
parameter was set totrue
, theEntity
nodes can be imported, however in the current release of the DOM theDocumentType
is readonly. Ability to add these imported nodes to aDocumentType
will be considered for addition to a future release of the DOM.publicId
,systemId
, andnotationName
attributes are copied. If adeep
import is requested, theEntity
are recursively imported and the resulting nodes reassembled to form the corresponding subtree.EntityReference
itself is copied, even if adeep
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 theDocumentType
is readonly. Ability to add these imported nodes to aDocumentType
will be considered for addition to a future release of the DOM.publicId
andsystemId
attributes are copied.deep
parameter has no effect on this type of nodes since they cannot have any children.target
anddata
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 theirdata
andlength
attributes from those of the source node.deep
parameter has no effect on these types of nodes since they cannot have any children.
The node to import.
Iftrue
, recursively import the subtree under the specified node; iffalse
, import only the node itself, as explained above. This has no effect on nodes that cannot have any children, and onAttr
, andEntityReference
nodes.
The imported node that belongs to thisDocument
.
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 theDocument.xmlVersion
attribute. This may happen when importing an XML 1.1
Creates an element of the given
Pernull
as the namespaceURI parameter for methods if they wish to have no namespace.
The
The
A newElement
object with the following attributes:
Attribute | Value |
---|---|
Node.nodeName | qualifiedName |
Node.namespaceURI | namespaceURI |
Node.prefix | prefix, extracted fromqualifiedName , ornull if there is no prefix |
Node.localName | qualifiedName |
Element.tagName | qualifiedName |
INVALID_CHARACTER_ERR: Raised if the specifiedqualifiedName
is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NAMESPACE_ERR: Raised if thequalifiedName
is a malformedqualifiedName
has a prefix and thenamespaceURI
isnull
, or if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from "qualifiedName
or its prefix is "xmlns" and thenamespaceURI
is different from "namespaceURI
is "qualifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the"XML"
feature, since namespaces were defined by XML.
Creates an attribute of the given
Pernull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
The
The
A newAttr
object with the following attributes:
Attribute | Value |
---|---|
Node.nodeName | qualifiedName |
Node.namespaceURI | namespaceURI |
Node.prefix | prefix, extracted fromqualifiedName , ornull if there is no prefix |
Node.localName | qualifiedName |
Attr.name | qualifiedName |
Node.nodeValue | the empty string |
INVALID_CHARACTER_ERR: Raised if the specifiedqualifiedName
is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NAMESPACE_ERR: Raised if thequalifiedName
is a malformedqualifiedName
has a prefix and thenamespaceURI
isnull
, if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from "qualifiedName
or its prefix is "xmlns" and thenamespaceURI
is different from "namespaceURI
is "qualifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the"XML"
feature, since namespaces were defined by XML.
Returns aNodeList
of all theElements
with a given
The"*"
matches all namespaces.
The
A newNodeList
object containing all the matchedElements
.
Returns theElement
that has an ID attribute with the given value. If no such element exists, this returnsnull
. If more than one element has an ID attribute with that value, what is returned is undefined.
The DOM implementation is expected to use the attributeAttr.isId
to determine if an attribute is of type ID.
Attributes with the name "ID" or "id" are not of type ID unless so defined.
The uniqueid
value for an element.
The matching element ornull
if there is none.
An attribute specifying the encoding used for this document at the time of the parsing. This isnull
when it is not known, such as when theDocument
was created in memory.
An attribute specifying, as part of thenull
when unspecified or when it is not known, such as when theDocument
was created in memory.
An attribute specifying, as part of thefalse
when unspecified.
No verification is done on the value when setting this attribute. Applications should useDocument.normalizeDocument()
with the "
NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature.
An attribute specifying, as part of the"1.0"
. If this document does not support the "XML" feature, the value is alwaysnull
. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invokeDocument.normalizeDocument()
in order to check for invalid characters in theNode
s that are already part of thisDocument
.
DOM applications may use theDOMImplementation.hasFeature(feature, version)
method with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supportsDocument
objects supporting a version of the "XMLVersion" feature must not raise aNOT_SUPPORTED_ERR
exception for the same version number when usingDocument.xmlVersion
.
NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by thisDocument
or if this document does not support the "XML" feature.
An attribute specifying whether error checking is enforced or not. When set tofalse
, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise anyDOMException
on DOM operations or report errors while usingDocument.normalizeDocument()
. In case of error, the behavior is undefined. This attribute istrue
by default.
The location of the document ornull
if undefined or if theDocument
was created usingDOMImplementation.createDocument
. No lexical checking is performed when setting this attribute; this could result in anull
value returned when usingNode.baseURI
.
Beware that when theDocument
supports the feature "HTML"Node.baseURI
.
Attempts to adopt a node from another document to this document. If supported, it changes the The The descendants of the source node are recursively adopted. Only the These nodes can all be adopted. No specifics.ownerDocument
of the source node, its children, as well as the attached attribute nodes if there are any. If the source node has a parent it is first removed from the child list of its parent. This effectively allows moving a subtree from one document to another (unlikeimportNode()
which create a copy of the source node instead of moving it). When it fails, applications should useDocument.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 tonull
and thespecified
flag is set totrue
on the adoptedAttr
. The descendants of the sourceAttr
are recursively adopted.Document
nodes cannot be adopted.DocumentType
nodes cannot be adopted.Entity
nodes cannot be adopted.EntityReference
node itself is adopted, the descendants are discarded, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.Notation
nodes cannot be adopted.
Since it does not create new nodes unlike theDocument.importNode()
method, this method does not raise anINVALID_CHARACTER_ERR
exception, and applications should use theDocument.normalizeDocument()
method to check if an imported name is not an XML name according to the XML version in use.
The node to move into this document.
The adopted node, ornull
if this operation fails, such as when the source node comes from a different implementation.
NOT_SUPPORTED_ERR: Raised if the source node is of typeDOCUMENT
,DOCUMENT_TYPE
.
NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly.
The configuration used whenDocument.normalizeDocument()
is invoked.
This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. As a consequence, this method updates the replacement tree ofEntityReference
nodes and normalizesText
nodes, as defined in the methodNode.normalize()
.
Otherwise, the actual result depends on the features being set on theDocument.domConfig
object and governing what operations actually take place. Noticeably this method could also make the documentCDATASection
nodes, etc. SeeDOMConfiguration
for details.
Mutation events, when supported, are generated to reflect the changes occurring on the document.
If errors occur during the invocation of this method, such as an attempt to update aNode.nodeName
contains an invalid character according to the XML version in use, errors or warnings (DOMError.SEVERITY_ERROR
orDOMError.SEVERITY_WARNING
) will be reported using theDOMErrorHandler
object associated with the "DOMError.SEVERITY_FATAL_ERROR
) if an implementation cannot recover from an error.
Rename an existing node of typeELEMENT_NODE
orATTRIBUTE_NODE
.
When possible this simply changes the name of the given node, otherwise this creates a new node with the specified name and replaces the existing node with the new node as described below.
If simply changing the name of the given node is not possible, the following operations are performed: a new node is created, any registered event listener is registered on the new node, any user data attached to the old node is removed from that node, the old node is removed from its parent if it has one, the children are moved to the new node, if the renamed node is anElement
its attributes are moved to the new node, the new node is inserted at the position the old node used to have in its parent's child nodes list if it has one, the user data that was attached to the old node is attached to the new node.
When the node being renamed is anElement
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 useDocument.normalizeDocument()
to guarantee these attributes are up-to-date.
When the node being renamed is anAttr
that is attached to anElement
, the node is first removed from theElement
attributes map. Then, once renamed, either by modifying the existing node or creating a new one as described above, it is put back.
In addition,
a user data eventNODE_RENAMED
is fired,
when the implementation supports the feature "MutationNameEvents", each mutation operation involved in this method fires the appropriate event, and in the end the event {http://www.w3.org/2001/xml-events
,DOMElementNameChanged
} or {http://www.w3.org/2001/xml-events
,DOMAttributeNameChanged
} is fired.
The node to rename.
The new
The new
The renamed node. This is either the specified node or the new node that was created to replace the specified node.
NOT_SUPPORTED_ERR: Raised when the type of the specified node is neitherELEMENT_NODE
norATTRIBUTE_NODE
, or if the implementation does not support the renaming of the
INVALID_CHARACTER_ERR: Raised if the new qualified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
WRONG_DOCUMENT_ERR: Raised when the specified node was created from a different document than this document.
NAMESPACE_ERR: Raised if thequalifiedName
is a malformedqualifiedName
has a prefix and thenamespaceURI
isnull
, or if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from "qualifiedName
, or its prefix, is "xmlns" and thenamespaceURI
is different from "
TheNode
interface is the primary datatype for the entire Document Object Model. It represents a single node in the document tree. While all objects implementing theNode
interface expose methods for dealing with children, not all objects implementing theNode
interface may have children. For example,Text
nodes may not have children, and adding children to such nodes results in aDOMException
being raised.
The attributesnodeName
,nodeValue
andattributes
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 specificnodeType
(e.g.,nodeValue
for anElement
orattributes
for aComment
), this returnsnull
. Note that the specialized interfaces may contain additional and more convenient mechanisms to get and set the relevant information.
An integer indicating which type of node this is.
Numeric codes up to 200 are reserved to W3C for possible future use.
The node is anElement
.
The node is anAttr
.
The node is aText
node.
The node is aCDATASection
.
The node is anEntityReference
.
The node is anEntity
.
The node is aProcessingInstruction
.
The node is aComment
.
The node is aDocument
.
The node is aDocumentType
.
The node is aDocumentFragment
.
The node is aNotation
.
The values ofnodeName
,nodeValue
, andattributes
vary according to the node type as follows:
Interface | nodeName | nodeValue | attributes |
---|---|---|---|
Attr | same asAttr.name | same asAttr.value | null |
CDATASection | "#cdata-section" | same asCharacterData.data , the content of the CDATA Section | null |
Comment | "#comment" | same asCharacterData.data , the content of the comment | null |
Document | "#document" | null | null |
DocumentFragment | "#document-fragment" | null | null |
DocumentType | same asDocumentType.name | null | null |
Element | same asElement.tagName | null | NamedNodeMap |
Entity | entity name | null | null |
EntityReference | name of entity referenced | null | null |
Notation | notation name | null | null |
ProcessingInstruction | same asProcessingInstruction.target | same asProcessingInstruction.data | null |
Text | "#text" | same asCharacterData.data , the content of the text node | null |
The name of this node, depending on its type; see the table above.
The value of this node, depending on its type; see the table above. When it is defined to benull
, setting it has no effect, including if the node is
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if it is not defined to benull
.
DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.
A code representing the type of the underlying object, as defined above.
TheAttr
,Document
,DocumentFragment
,Entity
, andNotation
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 isnull
.
ANodeList
that contains all children of this node. If there are no children, this is aNodeList
containing no nodes.
The first child of this node. If there is no such node, this returnsnull
.
The last child of this node. If there is no such node, this returnsnull
.
The node immediately preceding this node. If there is no such node, this returnsnull
.
The node immediately following this node. If there is no such node, this returnsnull
.
ANamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise.
TheDocument
object associated with this node. This is also theDocument
object used to create new nodes. When this node is aDocument
or aDocumentType
which is not used with anyDocument
yet, this isnull
.
Inserts the nodenewChild
before the existing child noderefChild
. IfrefChild
isnull
, insertnewChild
at the end of the list of children.
IfnewChild
is aDocumentFragment
object, all of its children are inserted, in the same order, beforerefChild
. If thenewChild
is already in the tree, it is first removed.
Inserting a node before itself is implementation dependent.
The node to insert.
The reference node, i.e., the node before which the new node must be inserted.
The node being inserted.
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to insert is one of this node'sDocument
and the DOM application attempts to insert a secondDocumentType
orElement
node.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised ifrefChild
is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of typeDocument
, this exception might be raised if the DOM implementation doesn't support the insertion of aDocumentType
orElement
node.
Replaces the child nodeoldChild
withnewChild
in the list of children, and returns theoldChild
node.
IfnewChild
is aDocumentFragment
object,oldChild
is replaced by all of theDocumentFragment
children, which are inserted in the same order. If thenewChild
is already in the tree, it is first removed.
Replacing a node with itself is implementation dependent.
The new node to put in the child list.
The node being replaced in the list.
The node replaced.
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to put in is one of this node'sDocument
and the result of the replacement operation would add a secondDocumentType
orElement
on theDocument
node.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
NOT_FOUND_ERR: Raised ifoldChild
is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of typeDocument
, this exception might be raised if the DOM implementation doesn't support the replacement of theDocumentType
child orElement
child.
Removes the child node indicated byoldChild
from the list of children, and returns it.
The node being removed.
The node removed.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifoldChild
is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of typeDocument
, this exception might be raised if the DOM implementation doesn't support the removal of theDocumentType
child or theElement
child.
Adds the nodenewChild
to the end of the list of children of this node. If thenewChild
is already in the tree, it is first removed.
The node to add.
If it is aDocumentFragment
object, the entire contents of the document fragment are moved into the child list of this node
The node added.
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to append is one of this node'sDocument
and the DOM application attempts to append a secondDocumentType
orElement
node.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly.
NOT_SUPPORTED_ERR: if thenewChild
node is a child of theDocument
node, this exception might be raised if the DOM implementation doesn't support the removal of theDocumentType
child orElement
child.
Returns whether this node has any children.
Returnstrue
if this node has any children,false
otherwise.
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode
isnull
) and no user data. User data associated to the imported node is not carried over. However, if anyUserDataHandlers
has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
Cloning anElement
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 theElement
since the text is contained in a childText
node. Cloning anAttr
directly, as opposed to be cloned as part of anElement
cloning operation, returns a specified attribute (specified
istrue
). Cloning anAttr
always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning anEntityReference
automatically constructs its subtree if a correspondingEntity
is available, no matter whether this is a deep clone or not. Cloning any other type of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy, but the children of anEntityReference
clone areAttr
nodes are specified. And, cloningDocument
,DocumentType
,Entity
, andNotation
nodes is implementation dependent.
Iftrue
, recursively clone the subtree under the specified node; iffalse
, clone only the node itself (and its attributes, if it is anElement
).
The duplicate node.
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
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 XPointerDOMConfiguration
object attached to theNode.ownerDocument
istrue
, this method will also fully normalize the characters of theText
nodes.
In cases where the document containsCDATASections
, the normalize operation alone may not be sufficient, since XPointers do not differentiate betweenText
nodes andCDATASection
nodes.
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in
The name of the feature to test.
This is the version number of the feature to test.
Returnstrue
if the specified feature is supported on this node,false
otherwise.
Thenull
if it is unspecified (see
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such asDocument.createElement()
, this is alwaysnull
.
Per the
Thenull
if it is unspecified. When it is defined to benull
, setting it has no effect, including if the node is
Note that setting this attribute, when permitted, changes thenodeName
attribute, which holds thetagName
andname
attributes of theElement
andAttr
interfaces, when applicable.
Setting the prefix tonull
makes it unspecified, setting it to an empty string is implementation dependent.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since thenamespaceURI
andlocalName
do not change.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
.
INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character according to the XML version in use specified in theDocument.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specifiedprefix
is malformed per the Namespaces in XML specification, if thenamespaceURI
of this node isnull
, if the specified prefix is "xml" and thenamespaceURI
of this node is different from "namespaceURI
of this node is different from "qualifiedName
of this node is "xmlns"
Returns the local part of the
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such asDocument.createElement()
, this is alwaysnull
.
Returns whether this node (if it is an element) has any attributes.
Returnstrue
if this node has any attributes,false
otherwise.
The absolute base URI of this node ornull
if the implementation wasn't able to obtain an absolute URI. This value is computed as described inDocument
supports the feature "HTML"documentURI
attribute from theDocument
interface otherwise.
A bitmask indicating the relative document position of a node with respect to another node.
If the two nodes being compared are the same node, then no flags are set on the return.
Otherwise, the order of two nodes is determined by looking for common containers -- containers which contain both. A node directly contains any child nodes. A node also directly contains any other nodes attached to it such as attributes contained in an element or entities and notations contained in a document type. Nodes contained in contained nodes are also contained, but less-directly as the number of intervening containers increases.
If there is no common container node, then the order is based upon order between the root container of each node that is in no container. In this case, the result is disconnected and implementation-specific. This result is stable as long as these outer-most containing nodes remain in memory and are not inserted into some other containing node. This would be the case when the nodes belong to different documents or fragments, and cloning the document or inserting a fragment might change the order.
If one of the nodes being compared contains the other node, then the container precedes the contained node, and reversely the contained node follows the container. For example, when comparing an element against its own attribute or child, the element node precedes its attribute node and its child node, which both follow it.
If neither of the previous cases apply, then there exists a most-direct container common to both nodes being compared. In this case, the order is determined based upon the two determining nodes directly contained in this most-direct common container that either are or contain the corresponding nodes being compared.
If these two determining nodes are both child nodes, then the natural DOM order of these determining nodes within the containing node is returned as the order of the corresponding nodes. This would be the case, for example, when comparing two child elements of the same element.
If one of the two determining nodes is a child node and the other is not, then the corresponding node of the child node follows the corresponding node of the non-child node. This would be the case, for example, when comparing an attribute of an element with a child element of the same element.
If neither of the two determining node is a child node and one determining node has a greater value ofnodeType
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 andnodeType
is the same for both determining nodes, then an implementation-dependent order between the determining nodes is returned. This order is stable as long as no nodes of the same nodeType are inserted into or removed from the direct container. This would be the case, for example, when comparing two attributes of the same element, and inserting or removing additional attributes might change the order between existing attributes.
The two nodes are disconnected. Order between disconnected nodes is always implementation-specific.
The second node precedes the reference node.
The node follows the reference node.
The node contains the reference node. A node which contains is always preceding, too.
The node is contained by the reference node. A node which is contained is always following, too.
The determination of preceding versus following is implementation-specific.
Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the
The node to compare against the reference node.
Returns how the node is positioned relatively to the reference node.
NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.
This attribute returns the text content of this node and its descendants. When it is defined to benull
, 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 ornull
, replaced by a singleText
node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attributeText.isElementContentWhitespace
). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
Node type | Content |
---|---|
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of thetextContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children. |
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue |
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE |
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.
Returns whether this node is the same node as the given one.
This method provides a way to determine whether twoNode
references returned by the implementation reference the same object. When twoNode
references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
The node to test against.
Returnstrue
if the nodes are the same,false
otherwise.
Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See
The namespace URI to look for.
Returns an associated namespace prefix if found ornull
if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent.
This method checks if the specifiednamespaceURI
is the default namespace or not.
The namespace URI to look for.
Returnstrue
if the specifiednamespaceURI
is the default namespace,false
otherwise.
Look up the namespace URI associated to the given prefix, starting from this node.
See
The prefix to look for. If this parameter isnull
, the method will return the default namespace URI if any.
Returns the associated namespace URI ornull
if none is found.
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested withNode.isSameNode()
. All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied: The two nodes are of the same type. The following string attributes are equal: The ThenodeName
,localName
,namespaceURI
,prefix
,nodeValue
. This is: they are bothnull
, or they have the same length and are character for character identical.attributes
NamedNodeMaps
are equal. This is: they are bothnull
, 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 bothnull
, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For two The following string attributes are equal: The TheDocumentType
nodes to be equal, the following conditions must also be satisfied:publicId
,systemId
,internalSubset
.entities
NamedNodeMaps
are equal.notations
NamedNodeMaps
are equal.
On the other hand, the following do not affect equality: theownerDocument
,baseURI
, andparentNode
attributes, thespecified
attribute forAttr
nodes, theschemaTypeInfo
attribute forAttr
andElement
nodes, theText.isElementContentWhitespace
attribute forText
nodes, as well as any user data or event listeners registered on the nodes.
As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.
The node to compare equality with.
Returnstrue
if the nodes are equal,false
otherwise.
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified inNode
interface.
The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method.
This is the version number of the feature to test.
Returns an object which implements the specialized APIs of the specified feature and version, if any, ornull
if there is no object which implements interfaces associated with that feature. If theDOMObject
returned by this method implements theNode
interface, it must delegate to the primary coreNode
and not return results inconsistent with the primary coreNode
such as attributes, childNodes, etc.
Associate an object to a key on this node. The object can later be retrieved from this node by callinggetUserData
with the same key.
The key to associate the object to.
The object to associate to the given key, ornull
to remove any existing association to that key.
The handler to associate to that key, ornull
.
Returns theDOMUserData
previously associated to the given key on this node, ornull
if there was none.
Retrieves the object associated to a key on a this node. The object must first have been set to this node by callingsetUserData
with the same key.
The key the object is associated to.
Returns theDOMUserData
associated to the given key on this node, ornull
if there was none.
TheNodeList
interface provides the abstraction of an ordered collection of nodes, without defining or constraining how this collection is implemented.NodeList
objects in the DOM are
The items in theNodeList
are accessible via an integral index, starting from 0.
Returns theindex
th item in the collection. Ifindex
is greater than or equal to the number of nodes in the list, this returnsnull
.
Index into the collection.
The node at theindex
th position in theNodeList
, ornull
if that is not a valid index.
The number of nodes in the list. The range of valid child node indices is 0 tolength-1
inclusive.
Objects implementing theNamedNodeMap
interface are used to represent collections of nodes that can be accessed by name. Note thatNamedNodeMap
does not inherit fromNodeList
;NamedNodeMaps
are not maintained in any particular order. Objects contained in an object implementingNamedNodeMap
may also be accessed by an ordinal index, but this is simply to allow convenient enumeration of the contents of aNamedNodeMap
, and does not imply that the DOM specifies an order to these Nodes.
NamedNodeMap
objects in the DOM are
Retrieves a node specified by name.
ThenodeName
of a node to retrieve.
ANode
(of any type) with the specifiednodeName
, ornull
if it does not identify any node in this map.
Adds a node using itsnodeName
attribute. If a node with that name is already present in this map, it is replaced by the new one. Replacing a node by itself has no effect.
As thenodeName
attribute is used to derive the name which the node must be stored under, multiple nodes of certain types (those that have a "special" string value) cannot be stored as the names would clash. This is seen as preferable to allowing nodes to be aliased.
A node to store in this map. The node will later be accessible using the value of itsnodeName
attribute.
If the newNode
replaces an existing node the replacedNode
is returned, otherwisenull
is returned.
WRONG_DOCUMENT_ERR: Raised ifarg
was created from a different document than the one that created this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
INUSE_ATTRIBUTE_ERR: Raised ifarg
is anAttr
that is already an attribute of anotherElement
object. The DOM user must explicitly cloneAttr
nodes to re-use them in other elements.
HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.
Removes a node specified by name. When this map contains the attributes attached to an element, if the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.
ThenodeName
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 namedname
in this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
Returns theindex
th item in the map. Ifindex
is greater than or equal to the number of nodes in this map, this returnsnull
.
Index into this map.
The node at theindex
th position in the map, ornull
if that is not a valid index.
The number of nodes in this map. The range of valid child node indices is0
tolength-1
inclusive.
Retrieves a node specified by local name and namespace URI.
Per
The
The
ANode
(of any type) with the specified local name and namespace URI, ornull
if they do not identify any node in this map.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as
Adds a node using itsnamespaceURI
andlocalName
. If a node with that namespace URI and that local name is already present in this map, it is replaced by the new one. Replacing a node by itself has no effect.
Per
A node to store in this map. The node will later be accessible using the value of itsnamespaceURI
andlocalName
attributes.
If the newNode
replaces an existing node the replacedNode
is returned, otherwisenull
is returned.
WRONG_DOCUMENT_ERR: Raised ifarg
was created from a different document than the one that created this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
INUSE_ATTRIBUTE_ERR: Raised ifarg
is anAttr
that is already an attribute of anotherElement
object. The DOM user must explicitly cloneAttr
nodes to re-use them in other elements.
HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as
Removes a node specified by local name and namespace URI. A removed attribute may be known to have a default value when this map contains the attributes attached to an element, as returned by the attributes attribute of theNode
interface. If so, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.
Per
The
The
The node removed from this map if a node with such a local name and namespace URI exists.
NOT_FOUND_ERR: Raised if there is no node with the specifiednamespaceURI
andlocalName
in this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as
TheCharacterData
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 toCharacterData
, thoughText
and others do inherit the interface from it. Alloffsets
in this interface start from0
.
As explained in theDOMString
interface, text strings in the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In the following, the term
The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in aCharacterData
node. However, implementation limits may mean that the entirety of a node's data may not fit into a singleDOMString
. In such cases, the user may callsubstringData
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 aDOMString
variable on the implementation platform.
The number ofdata
and thesubstringData
method below. This may have the value zero, i.e.,CharacterData
nodes may be empty.
Extracts a range of data from the node.
Start offset of substring to extract.
The number of 16-bit units to extract.
The specified substring. If the sum ofoffset
andcount
exceeds thelength
, then all 16-bit units to the end of the data are returned.
INDEX_SIZE_ERR: Raised if the specifiedoffset
is negative or greater than the number of 16-bit units indata
, or if the specifiedcount
is negative.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into aDOMString
.
Append the string to the end of the character data of the node. Upon success,data
provides access to the concatenation ofdata
and theDOMString
specified.
TheDOMString
to append.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Insert a string at the specified
The character offset at which to insert.
TheDOMString
to insert.
INDEX_SIZE_ERR: Raised if the specifiedoffset
is negative or greater than the number of 16-bit units indata
.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Remove a range ofdata
andlength
reflect the change.
The offset from which to start removing.
The number of 16-bit units to delete. If the sum ofoffset
andcount
exceedslength
then all 16-bit units fromoffset
to the end of the data are deleted.
INDEX_SIZE_ERR: Raised if the specifiedoffset
is negative or greater than the number of 16-bit units indata
, or if the specifiedcount
is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Replace the characters starting at the specified
The offset from which to start replacing.
The number of 16-bit units to replace. If the sum ofoffset
andcount
exceedslength
, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as aremove
method call with the same range, followed by anappend
method invocation).
TheDOMString
with which the range must be replaced.
INDEX_SIZE_ERR: Raised if the specifiedoffset
is negative or greater than the number of 16-bit units indata
, or if the specifiedcount
is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
TheAttr
interface represents an attribute in anElement
object. Typically the allowable values for the attribute are defined in a schema associated with the document.
Attr
objects inherit theNode
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, theNode
attributesparentNode
,previousSibling
, andnextSibling
have anull
value forAttr
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 aDocumentFragment
. However, they can be associated withElement
nodes contained within aDocumentFragment
. In short, users and implementors of the DOM need to be aware thatAttr
nodes have some things in common with other objects inheriting theNode
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 theNode.nodeValue
attribute on theAttr
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 withspecified
set tofalse
. Removing attribute nodes for which a default value is defined in the schema generates a new attribute node with the default value andspecified
set tofalse
. If validation occurred while invokingDocument.normalizeDocument()
, attribute nodes withspecified
equals tofalse
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 theAttr
node may be eitherText
orEntityReference
nodes (when these are in use; see the description ofEntityReference
for discussion).
The DOM Core represents all attribute values as simple strings, even if the DTD or schema associated with the document declares them of some specific type such as
The way attribute value normalization is performed by the DOM implementation depends on how much the implementation knows about the schema in use. Typically, thevalue
andnodeValue
attributes of anAttr
node initially returns the normalized value given by the parser. It is also the case afterDocument.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 theAttr
child nodes. In particular, this is true when
The following table gives some examples of the relations between the attribute value in the original document (parsed attribute), the value as exposed in the DOM, and the serialization of the value:
Examples | Parsed attribute value | InitialAttr.value | Serialized attribute value |
---|---|---|---|
Character reference | |||
Built-in character entity | |||
Literal newline between | |||
Normalized newline between | |||
Entitye with literal newline |
Returns the name of this attribute. IfNode.localName
is different fromnull
, this attribute is a
True
if this attribute was explicitly given a value in the instance document,false
otherwise. If the application changed the value of this attribute node (even if it ends up having the same value as the default value) then it is set totrue
. The implementation may handle attributes with default values from other schemas similarly but applications should useDocument.normalizeDocument()
to guarantee this information is up-to-date.
On retrieval, the value of the attribute is returned as a string. Character and general entity references are replaced with their values. See also the methodgetAttribute
on theElement
interface.
On setting, this creates aText
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 methodElement.setAttribute()
.
Some specialized implementations, such as some
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
TheElement
node this attribute is attached to ornull
if this attribute is not in use.
The type information associated with this attribute. While the type information contained in this attribute is guarantee to be correct after loading the document or invokingDocument.normalizeDocument()
,schemaTypeInfo
may not be reliable if the node was moved.
Returns whether this attribute is known to be of type ID (i.e. to contain an identifier for its owner element) or not. When it is and its value is unique, theownerElement
of this attribute can be retrieved using the methodDocument.getElementById
. The implementation could use several ways to determine if an attribute node is known to contain an identifier:
If validation occurred using an XML SchemaDocument.normalizeDocument()
, the post-schema-validation infoset contributions (PSVI contributions) values are used to determine if this attribute is a
If validation occurred using a DTD while loading the document or while invokingDocument.normalizeDocument()
, the infoset[type definition]value is used to determine if this attribute is a
from the use of the methodsElement.setIdAttribute()
,Element.setIdAttributeNS()
, orElement.setIdAttributeNode()
, i.e. it is an
XPointer framework (see section 3.2 in
using mechanisms that are outside the scope of this specification, it is then an
If validation occurred while invokingDocument.normalizeDocument()
, allAttr.schemaTypeInfo
attribute contains an ID type,isId
will always return true.
TheElement
interface represents anElement
interface inherits fromNode
, the genericNode
interface attributeattributes
may be used to retrieve the set of all attributes for an element. There are methods on theElement
interface to retrieve either anAttr
object by name or an attribute value by name. In XML, where an attribute value may contain entity references, anAttr
object should be retrieved to examine the possibly fairly complex sub-tree representing the attribute value. On the other hand, in HTML, where all attributes have simple string values, methods to directly access an attribute value can safely be used as a
In DOM Level 2, the methodnormalize
is inherited from theNode
interface where it was moved.
The name of the element. IfNode.localName
is different fromnull
, this attribute is atagName
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 thetagName
of an HTML element in the canonical uppercase form, regardless of the case in the source HTML document.
Retrieves an attribute value by name.
The name of the attribute to retrieve.
TheAttr
value as a string, or the empty string if that attribute does not have a specified or default value.
Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create anAttr
node plus anyText
andEntityReference
nodes, build the appropriate subtree, and usesetAttributeNode
to assign it as the value of an attribute.
To set an attribute with a qualified name and namespace URI, use thesetAttributeNS
method.
The name of the attribute to create or alter.
Value to set in string form.
INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Removes an attribute by name. If a default value for the removed attribute is defined in the DTD, a new attribute immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should useDocument.normalizeDocument()
to guarantee this information is up-to-date.
If no attribute with this name is found, this method has no effect.
To remove an attribute by local name and namespace URI, use theremoveAttributeNS
method.
The name of the attribute to remove.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI, use thegetAttributeNodeNS
method.
The name (nodeName
) of the attribute to retrieve.
TheAttr
node with the specified name (nodeName
) ornull
if there is no such attribute.
Adds a new attribute node. If an attribute with that name (nodeName
) is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect.
To add a new attribute node with a qualified name and namespace URI, use thesetAttributeNodeNS
method.
TheAttr
node to add to the attribute list.
If thenewAttr
attribute replaces an existing attribute, the replacedAttr
node is returned, otherwisenull
is returned.
WRONG_DOCUMENT_ERR: Raised ifnewAttr
was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised ifnewAttr
is already an attribute of anotherElement
object. The DOM user must explicitly cloneAttr
nodes to re-use them in other elements.
Removes the specified attribute node. If a default value for the removedAttr
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 useDocument.normalizeDocument()
to guarantee this information is up-to-date.
TheAttr
node to remove from the attribute list.
TheAttr
node that was removed.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifoldAttr
is not an attribute of the element.
Returns aNodeList
of allElements
with a given tag name, in
The name of the tag to match on. The special value "*" matches all tags.
A list of matchingElement
nodes.
Retrieves an attribute value by local name and namespace URI.
Pernull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
The
The
TheAttr
value as a string, or the empty string if that attribute does not have a specified or default value.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as
Adds a new attribute. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of thequalifiedName
, and its value is changed to be thevalue
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 anAttr
node plus anyText
andEntityReference
nodes, build the appropriate subtree, and usesetAttributeNodeNS
orsetAttributeNode
to assign it as the value of an attribute.
Pernull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
The
The
The value to set in string form.
INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if thequalifiedName
is malformed per the Namespaces in XML specification, if thequalifiedName
has a prefix and thenamespaceURI
isnull
, if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from "qualifiedName
or its prefix is "xmlns" and thenamespaceURI
is different from "namespaceURI
is "qualifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as
Removes an attribute by local name and namespace URI. If a default value for the removed attribute is defined in the DTD, a new attribute immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should useDocument.normalizeDocument()
to guarantee this information is up-to-date.
If no attribute with this local name and namespace URI is found, this method has no effect.
Pernull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
The
The
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as
Retrieves anAttr
node by local name and namespace URI.
Pernull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
The
The
TheAttr
node with the specified attribute local name and namespace URI ornull
if there is no such attribute.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as
Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect.
Pernull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
TheAttr
node to add to the attribute list.
If thenewAttr
attribute replaces an existing attribute with the sameAttr
node is returned, otherwisenull
is returned.
WRONG_DOCUMENT_ERR: Raised ifnewAttr
was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised ifnewAttr
is already an attribute of anotherElement
object. The DOM user must explicitly cloneAttr
nodes to re-use them in other elements.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as
Returns aNodeList
of all theElements
with a given local name and namespace URI in
The
The
A newNodeList
object containing all the matchedElements
.
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
Returnstrue
when an attribute with a given name is specified on this element or has a default value,false
otherwise.
The name of the attribute to look for.
true
if an attribute with the given name is specified on this element or has a default value,false
otherwise.
Returnstrue
when an attribute with a given local name and namespace URI is specified on this element or has a default value,false
otherwise.
Pernull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
The
The
true
if an attribute with the given local name and namespace URI is specified or has a default value on this element,false
otherwise.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as
The type information associated with this element.
If the parameterisId
istrue
, this method declares the specified attribute to be aAttr.isId
and the behavior ofDocument.getElementById
, but does not change any schema that may be in use, in particular this does not affect theAttr.schemaTypeInfo
of the specifiedAttr
node. Use the valuefalse
for the parameterisId
to undeclare an attribute for being a
To specify an attribute by local name and namespace URI, use thesetIdAttributeNS
method.
The name of the attribute.
Whether the attribute is a of type ID.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.
If the parameterisId
istrue
, this method declares the specified attribute to be aAttr.isId
and the behavior ofDocument.getElementById
, but does not change any schema that may be in use, in particular this does not affect theAttr.schemaTypeInfo
of the specifiedAttr
node. Use the valuefalse
for the parameterisId
to undeclare an attribute for being a
The
The
Whether the attribute is a of type ID.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.
If the parameterisId
istrue
, this method declares the specified attribute to be aAttr.isId
and the behavior ofDocument.getElementById
, but does not change any schema that may be in use, in particular this does not affect theAttr.schemaTypeInfo
of the specifiedAttr
node. Use the valuefalse
for the parameterisId
to undeclare an attribute for being a
The attribute node.
Whether the attribute is a of type ID.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.
TheText
interface inherits fromCharacterData
and represents the textual content (termedElement
orAttr
. If there is no markup inside an element's content, the text is contained in a single object implementing theText
interface that is the only child of the element. If there is markup, it is parsed into theText
nodes that form the list of children of the element.
When a document is first made available via the DOM, there is only oneText
node for each block of text. Users may create adjacentText
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. TheNode.normalize()
method merges any such adjacentText
objects into a single node for each block of text.
No lexical check is done on the content of aText
node and, depending on its position in the document, some characters must be escaped during serialization using character references; e.g. the characters "<&" if the textual content is part of an element or of an attribute, the character sequence "]]>" when part of an element, the quotation mark character " or the apostrophe character ' when part of an attribute.
Breaks this node into two nodes at the specifiedoffset
, keeping both in the tree asoffset
point. A new node of the same type, which contains all the content at and after theoffset
point, is returned. If the original node had a parent node, the new node is inserted as the nextoffset
is equal to the length of this node, the new node has no data.
The0
.
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 indata
.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Returns whether this text node containsDocument.normalizeDocument()
.
Returns all text ofText
nodes
For instance, in the example belowwholeText
on theText
node that contains "bar" returns "barfoo", while on theText
node that contains "foo" it returns "barfoo".
Replaces the text of the current node and all
This method returns the node which received the replacement text. The returned node is:
null
, when the replacement text is the empty string;
the current node, except when the current node is
a newText
node of the same type (Text
orCDATASection
) as the current node inserted at the location of the replacement.
For instance, in the above example callingreplaceWholeText
on theText
node that contains "bar" with "yo" in argument results in the following:
Where the nodes to be removed are read-only descendants of anEntityReference
, theEntityReference
must be removed instead of the read-only nodes. If anyEntityReference
to be removed has descendants that are notEntityReference
,Text
, orCDATASection
nodes, thereplaceWholeText
method must fail before performing any modification of the document, raising aDOMException
with the codeNO_MODIFICATION_ALLOWED_ERR
.
For instance, in the example below callingreplaceWholeText
on theText
node that contains "bar" fails, because theEntityReference
node "ent" contains anElement
node which cannot be removed.
The content of the replacingText
node.
TheText
node created with the specified content.
NO_MODIFICATION_ALLOWED_ERR: Raised if one of theText
nodes being replaced is readonly.
This interface inherits fromCharacterData
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
TheTypeInfo
interface represents a type referenced fromElement
orAttr
nodes, specified in the
If the document's schema is an XML DTD
If this type is referenced from anAttr
node,typeNamespace
is"http://www.w3.org/TR/REC-xml"
andtypeName
represents the[attribute type]property in thetypeNamespace
andtypeName
arenull
.
If this type is referenced from anElement
node,typeNamespace
andtypeName
arenull
.
If the document's schema is an XML Schema
If the[validity]property exists AND isnull
.
At the time of writing, the XML Schema specification does not require exposing the declared type. Thus, DOM implementations might choose not to provide type information if validity is not valid.
If the[validity]property exists and is
If[member type definition]exists:
If {name} is not absent, then expose {name} and {target namespace} properties of the[member type definition]property;
Otherwise, expose the namespace and local name of the corresponding
If the[type definition]property exists: If {name} is not absent, then expose {name} and {target namespace} properties of the[type definition]property; Otherwise, expose the namespace and local name of the corresponding
If the[member type definition anonymous]exists: If it is false, then expose[member type definition name]and[member type definition namespace]properties; Otherwise, expose the namespace and local name of the corresponding
If the[type definition anonymous]exists: If it is false, then expose[type definition name]and[type definition namespace]properties; Otherwise, expose the namespace and local name of the corresponding
Other schema languages are outside the scope of the W3C and therefore should define how to represent their type systems usingTypeInfo
.
The name of a type declared for the associated element or attribute, ornull
if unknown.
The namespace of the type declared for the associated element or attribute ornull
if the element does not have declaration or if no namespace information is available.
These are the available values for thederivationMethod
parameter used by the methodTypeInfo.isDerivedFrom()
. It is a set of possible types of derivation, and the values represent bit positions. If a bit in thederivationMethod
parameter is set to1
, 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 theisDerivedFrom
method, combining all of them in thederivationMethod
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:
any type derives fromxsd:anyType
.
any simple type derives fromxsd:anySimpleType
by
any complex type does not derive fromxsd:anySimpleType
by
If the document's schema is an XML Schema
If the document's schema is an XML Schema
If the document's schema is an XML Schema
DERIVATION_RESTRICTION
orDERIVATION_EXTENSION
, T2 is derived from the other type definition byDERIVATION_RESTRICTION
, T1 has {variety}
If the document's schema is an XML Schema
DERIVATION_RESTRICTION
orDERIVATION_EXTENSION
, T2 is derived from the other type definition byDERIVATION_RESTRICTION
, T1 has {variety}
This method returns if there is a derivation between the reference type definition, i.e. theTypeInfo
on which the method is being called, and the other type definition, i.e. the one passed as parameters.
the namespace of the other type definition.
the name of the other type definition.
the type of derivation and conditions applied between two types, as described in the list of constants provided in this interface.
If the document's schema is a DTD or no schema is associated with the document, this method will always returnfalse
.
If the document's schema is an XML Schema, the method willtrue
if the reference type definition is derived from the other type definition according to the derivation parameter. If the value of the parameter is0
(no bit is set to1
for thederivationMethod
parameter), the method will returntrue
if the other type definition can be reached by recursing any combination of {base type definition}, {item type definition}, or {member type definitions} from the reference type definition.
When associating an object to a key on a node usingNode.setUserData()
the application can provide a handler that gets called when the node the object is associated to is being cloned, imported, or renamed. This can be used by the application to implement various behaviors regarding the data it associates to the DOM nodes. This interface defines that handler.
An integer indicating the type of operation being performed on a node.
The node is cloned, usingNode.cloneNode()
.
The node is imported, usingDocument.importNode()
.
The node is deleted.
This may not be supported or may not be reliable in certain environments, such as Java, where the implementation has no real control over when objects are actually deleted.
The node is renamed, usingDocument.renameNode()
.
The node is adopted, usingDocument.adoptNode()
.
This method is called whenever the node for which this handler is registered is imported or cloned.
DOM applications must not raise exceptions in aUserDataHandler
. The effect of throwing exceptions from the handler is DOM implementation dependent.
Specifies the type of operation that is being performed on the node.
Specifies the key for which this handler is being called.
Specifies the data for which this handler is being called.
Specifies the node being cloned, adopted, imported, or renamed. This isnull
when the node is being deleted.
Specifies the node newly created if any, ornull
.
DOMError
is an interface that describes an error.
An integer indicating the severity of the error.
The severity of the error described by theDOMError
is warning. ASEVERITY_WARNING
will not cause the processing to stop, unlessDOMErrorHandler.handleError()
returnsfalse
.
The severity of the error described by theDOMError
is error. ASEVERITY_ERROR
may not cause the processing to stop if the error can be recovered, unlessDOMErrorHandler.handleError()
returnsfalse
.
The severity of the error described by theDOMError
is fatal error. ASEVERITY_FATAL_ERROR
will cause the normal processing to stop. The return value ofDOMErrorHandler.handleError()
is ignored unless the implementation chooses to continue, in which case the behavior becomes undefined.
The severity of the error, eitherSEVERITY_WARNING
,SEVERITY_ERROR
, orSEVERITY_FATAL_ERROR
.
An implementation specific string describing the error that occurred.
ADOMString
indicating which related data is expected inrelatedData
. Users should refer to the specification of the error in order to find itsDOMString
type andrelatedData
definitions if any.
As an example,Document.normalizeDocument()
does generate warnings when the "SEVERITY_WARNING
withtype
"cdata-sections-splitted"
and the firstCDATASection
node in document order resulting from the split is returned by therelatedData
attribute.
The related platform dependent exception if any.
The relatedDOMError.type
dependent data if any.
The location of the error.
DOMErrorHandler
is a callback interface that the DOM implementation can call when reporting errors that happens while processing XML data, or when doing some other processing (e.g. validating a document). ADOMErrorHandler
object can be attached to aDocument
using the "DOMConfiguration
interface. If more than one error needs to be reported during an operation, the sequence and numbers of the errors passed to the error handler are implementation dependent.
The application that is using the DOM implementation is expected to implement this interface.
This method is called on the error handler when an error occurs.
If an exception is thrown from this method, it is considered to be equivalent of returningtrue
.
The error object that describes the error. This object may be reused by the DOM implementation across multiple calls to thehandleError
method.
If thehandleError
method returnsfalse
, the DOM implementation should stop the current processing when possible. If the method returnstrue
, the processing may continue depending onDOMError.severity
.
DOMLocator
is an interface that describes a location (e.g. where an error occurred).
The line number this locator is pointing to, or-1
if there is no column number available.
The column number this locator is pointing to, or-1
if there is no column number available.
The byte offset into the input source this locator is pointing to or-1
if there is no byte offset available.
The UTF-16, as defined in-1
if there is no UTF-16 offset available.
The node this locator is pointing to, ornull
if no node is available.
The URI this locator is pointing to, ornull
if no URI is available.
TheDOMConfiguration
interface represents the configuration of a document and maintains a table of recognized parameters. Using the configuration, it is possible to changeDocument.normalizeDocument()
behavior, such as replacing theCDATASection
nodes withText
nodes or specifying the type of theDocument
is requested.DOMConfiguration
objects are also used inDOMParser
andDOMSerializer
interfaces.
The parameter names used by theDOMConfiguration
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 the5.16 Identifiers
of
Parameters are similar to features and properties used in SAX2
The following list of parameters defined in the DOM:
[
Canonicalize the document according to the rules specified inDocumentType
node (if any) from the tree, or removing superfluous namespace declarations from each element. Note that this is limited to what can be represented in the DOM; in particular, there is no way to specify the order of the attributes in the DOM. In addition,
Setting this parameter totrue
will also set the state of the parameters listed below. Later changes to the state of one of those parameters will revert "false
.
Parameters set tofalse
: "
Parameters set totrue
: "
Other parameters are not changed unless explicitly specified in the description of the parameters.
[
Do not canonicalize the document.
[
KeepCDATASection
nodes in the document.
[
TransformCDATASection
nodes in the document intoText
nodes. The newText
node is then combined with any adjacentText
node.
[
Check if the characters in the document areDOMError.type
equals to "check-character-normalization-failure" is issued.
[
Do not check if characters are normalized.
[
KeepComment
nodes in the document.
[
DiscardComment
nodes in the document.
[
Expose schema normalized values in the tree, such astrue
. Having this parameter activated when "validate" isfalse
has no effect and no schema-normalization will happen.
Since the document contains the result of the XML 1.0 processing, this parameter does not apply to attribute value normalization as defined in section 3.3.3 of
[
Do not perform schema normalization on the tree.
[
Keep all whitespaces in the document.
[
Discard allText
nodes that contain whitespaces in element content, as described inText.isElementContentWhitespace
to determine if aText
node should be discarded or not.
[
KeepEntityReference
nodes in the document.
[
Remove allEntityReference
nodes from the document, putting the entity expansions directly in their place.Text
nodes are normalized, as defined inNode.normalize
. Only
This parameter does not affectEntity
nodes.
[
Contains aDOMErrorHandler
object. If an error is encountered in the document, the implementation will call back theDOMErrorHandler
registered using this parameter. The implementation may provide a defaultDOMErrorHandler
object.
When called,DOMError.relatedData
will contain the closest node to where the error occurred. If the implementation is unable to determine the node where the error occurs,DOMError.relatedData
will contain theDocument
node. Mutations to the document from within an error handler will result in implementation dependent behavior.
[
Keep in the document the information defined in the XML Information Set
This forces the following parameters tofalse
: "
This forces the following parameters totrue
: "
Other parameters are not changed unless explicitly specified in the description of the parameters.
Note that querying this parameter withgetParameter
returnstrue
only if the individual parameters specified above are appropriately set.
Settinginfoset
tofalse
has no effect.
[
Perform the namespace processing as defined in
[
Do not perform the namespace processing.
This parameter has no effect if the parameter "false
.
[
Include namespace declaration attributes, specified or defaulted from the
[
Discard all namespace declaration attributes. The namespace prefixes (Node.prefix
) are retained even if this parameter is set tofalse
.
[
[
Do not perform character normalization.
[
Represent aDOMString
object containing a list of URIs, separated by whitespaces (characters matching theschema-type
, otherwise the behavior of an implementation is undefined.
The schemas specified using this property take precedence to the schema information specified in the document itself. For namespace aware schema, if a schema specified using this property and a schema specified in the document instance (i.e. using theschemaLocation
attribute) in a schema document (i.e. using schemaimport
mechanisms) share the sametargetNamespace
, the schema specified by the user using this property will be used. If two schemas specified using this property share the sametargetNamespace
or have no namespace, the behavior is implementation dependent.
If no location has been provided, this parameter isnull
.
The"schema-location"
parameter is ignored unless the "Document.documentURI
will be set so that an implementation can successfully resolve any external entities referenced.
[
Represent aDOMString
object containing an absolute URI and representing the type of the
If this parameter is not set, a default value may be provided by the implementation, based on the schema languages supported and on the schema language used at load time. If no value is provided, this parameter isnull
.
For XML Schema"http://www.w3.org/2001/XMLSchema"
. For XML DTD"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 containing the CDATA section termination marker ']]>'. When a CDATA section is split a warning is issued with aDOMError.type
equals to"cdata-sections-splitted"
andDOMError.relatedData
equals to the firstCDATASection
node in document order resulting from the split.
[
Signal an error if aCDATASection
contains an unrepresentable character.
[
Require the validation against atrue
.
This parameter will reevaluate:
Attribute nodes withAttr.specified
equals tofalse
, as specified in the description of theAttr
interface;
The value of the attributeText.isElementContentWhitespace
for allText
nodes;
The value of the attributeAttr.isId
for allAttr
nodes;
The attributesElement.schemaTypeInfo
andAttr.schemaTypeInfo
.
"true
will set the other one tofalse
. Applications should also consider setting the parameter "true
, which is the default for that option, when validating the document.
[
Do not accomplish schema processing, including the internal subset processing. Default attribute values information are kept. Note that validation might still happen if "true
.
[
Enable validation only if a declaration for the document element can be found in atrue
.
"validate-if-schema" and "true
will set the other one tofalse
.
[
No schema processing should be performed if the document has a schema, including internal subset processing. Default attribute values information are kept. Note that validation must still happen if "true
.
[
Check if all nodes are XMLDocument.xmlVersion
:
check if the attributeNode.nodeName
contains invalid characters according to its node type and generate aDOMError
of type"wf-invalid-character-in-node-name"
, with aDOMError.SEVERITY_ERROR
severity, if necessary;
check if the text content insideAttr
,Element
,Comment
,Text
,CDATASection
nodes for invalid characters and generate aDOMError
of type"wf-invalid-character"
, with aDOMError.SEVERITY_ERROR
severity, if necessary;
check if the data insideProcessingInstruction
nodes for invalid characters and generate aDOMError
of type"wf-invalid-character"
, with aDOMError.SEVERITY_ERROR
severity, if necessary;
[
Do not check for XML well-formedness.
The resolution of the system identifiers associated with entities is done usingDocument.documentURI
. However, when the feature "LS" defined inDOMConfiguration
objects attached toDocument
nodes. If this parameter is set,Document.normalizeDocument()
will invoke the resource resolver instead of usingDocument.documentURI
.
Set the value of a parameter.
The name of the parameter to set.
The new value ornull
if the user wishes to unset the parameter. While the type of the value parameter is defined asDOMUserData
, the object type must match the type defined by the definition of the parameter. For example, if the parameter isDOMErrorHandler
.
NOT_FOUND_ERR: Raised when the parameter name is not recognized.
NOT_SUPPORTED_ERR: Raised when the parameter name is recognized but the requested value cannot be set.
TYPE_MISMATCH_ERR: Raised if the value type for this parameter name is incompatible with the expected value type.
Return the value of a parameter if known.
The name of the parameter.
The current object associated with the specified parameter ornull
if no object has been associated or if the parameter is not supported.
NOT_FOUND_ERR: Raised when the parameter name is not recognized.
Check if setting a parameter to a specific value is supported.
The name of the parameter to check.
An object. ifnull
, the returned value istrue
.
true
if the parameter could be successfully set to the specified value, orfalse
if the parameter is not recognized or the requested value is not supported. This does not change the current value of the parameter itself.
The list of the parameters supported by thisDOMConfiguration
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.
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.
TheCharacterData.data
attribute holds the text that is contained by the CDATA section. Note that this
TheCDATASection
interface inherits from theCharacterData
interface through theText
interface. AdjacentCDATASection
nodes are not merged by use of thenormalize
method of theNode
interface.
No lexical check is done on the content of a CDATA section and it is therefore possible to have the character sequence"]]>"
in the content, which is illegal in a CDATA section per section 2.7 of"split-cdata-sections"
in theDOMConfiguration
interface).
Because no markup is recognized within aCDATASection
, character numeric references cannot be used as an escape mechanism when serializing. Therefore, action needs to be taken when serializing aCDATASection
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.
EachDocument
has adoctype
attribute whose value is eithernull
or aDocumentType
object. TheDocumentType
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 editingDocumentType
nodes.DocumentType
nodes are
The name of DTD; i.e., the name immediately following theDOCTYPE
keyword.
ANamedNodeMap
containing the general entities, both external and internal, declared in the DTD. Parameter entities are not contained. Duplicates are discarded. For example in:foo
and the first declaration ofbar
but not the second declaration ofbar
orbaz
. Every node in this map also implements theEntity
interface.
The DOM Level 2 does not support editing entities, thereforeentities
cannot be altered in any way.
ANamedNodeMap
containing the notations declared in the DTD. Duplicates are discarded. Every node in this map also implements theNotation
interface.
The DOM Level 2 does not support editing notations, thereforenotations
cannot be altered in any way.
The public identifier of the external subset.
The system identifier of the external subset. This may be an absolute URI or not.
The internal subset as a string, ornull
if there is none. This is does not contain the delimiting square brackets.
The actual content returned depends on how much information is available to the implementation. This may vary depending on various parameters, including the XML processor used to build the document.
This interface represents a notation declared in the DTD. A notation either declares, by name, the format of an unparsed entity (seenodeName
attribute inherited fromNode
is set to the declared name of the notation.
The DOM Core does not support editingNotation
nodes; they are therefore
ANotation
node does not have any parent.
The public identifier of this notation. If the public identifier was not specified, this isnull
.
The system identifier of this notation. If the system identifier was not specified, this isnull
. 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
ThenodeName
attribute that is inherited fromNode
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 noEntityReference
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 theEntity
node's child list represents the structure of that replacement value. Otherwise, the child list is empty.
DOM Level 3 does not support editingEntity
nodes; if a user wants to make changes to the contents of anEntity
, every relatedEntityReference
node has to be replaced in the structure model by a clone of theEntity
's contents, and then the desired changes must be made to each of those clones instead.Entity
nodes and all their
AnEntity
node does not have any parent.
If the entity contains an unboundnamespaceURI
of the corresponding node in theEntity
node subtree isnull
. The same is true forEntityReference
nodes that refer to this entity, when they are created using thecreateEntityReference
method of theDocument
interface.
The public identifier associated with the entity if specified, andnull
otherwise.
The system identifier associated with the entity if specified, andnull
otherwise. This may be an absolute URI or not.
For unparsed entities, the name of the notation for the entity. For parsed entities, this isnull
.
An attribute specifying the encoding used for this entity at the time of parsing, when it is an external parsed entity. This isnull
if it an entity from the internal subset or if it is not known.
An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. This isnull
otherwise.
An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity. This isnull
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 theDocument
, instead of providingEntityReference
nodes. If it does provide such nodes, then for anEntityReference
node that represents a reference to a known entity anEntity
exists, and the subtree of theEntityReference
node is a copy of theEntity
node subtree. However, the latter may not be true when an entity contains an unboundEntityReference
node may be bound to differentEntityReference
node represents a reference to an unknown entity, the node has no children and its replacement value, when used byAttr.value
for example, is empty.
As forEntity
nodes,EntityReference
nodes and all their
EntityReference
nodes may cause element content and attribute value normalization problems when, such as in XML 1.0 and XML Schema, the normalization is performed after entity reference are expanded.
TheProcessingInstruction
interface represents a "processing instruction", used in XML as a way to keep processor-specific information in the text of the document.
No lexical check is done on the content of a processing instruction and it is therefore possible to have the character sequence"?>"
in the content, which is illegal a processing instruction per section 2.6 of
The target of this processing instruction. XML defines this as being the first
The content of this processing instruction. This is from the first non white space character after the target to the character immediately preceding the?>
.
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Extensions to a language's native String class or interface
Returns the UTF-16 offset that corresponds to a UTF-32 offset. Used for random access.
You can always round-trip from a UTF-32 offset to a UTF-16 offset and back. You can round-trip from a UTF-16 offset to a UTF-32 offset and back if and only if the offset16 is not in the middle of a surrogate pair. Unmatched surrogates count as a single UTF-16 value.
UTF-32 offset.
UTF-16 offset
ifoffset32
is out of bounds.
Returns the UTF-32 offset corresponding to a UTF-16 offset. Used for random access. To find the UTF-32 length of a string, use:
If the UTF-16 offset is into the middle of a surrogate pair, then the UTF-32 offset of the
UTF-16 offset
UTF-32 offset
if offset16 is out of bounds.