- Exception DOMException
-
DOM operations only raise exceptions in "exceptional"
circumstances, i.e., when an operation is impossible to perform (either
for logical reasons, because data is lost, or because the implementation
has become unstable). In general, DOM methods return specific error
values in ordinary processing situations, such as out-of-bound errors
when using NodeList.
Implementations should raise other exceptions under other circumstances.
For example, implementations should raise an implementation-dependent
exception if a null argument is passed when
null was not expected.
Some languages and object systems do not support the concept of
exceptions. For such systems, error conditions may be indicated using
native error reporting mechanisms. For some bindings, for example,
methods may return error codes similar to those listed in the
corresponding method descriptions.
IDL Definition-
- Definition group ExceptionCode
An integer indicating the type of error generated.
Note: Other numeric codes are reserved for W3C for possible future use.
- Defined Constants
DOMSTRING_SIZE_ERR-
If the specified range of text does not fit into a DOMString
HIERARCHY_REQUEST_ERR-
If any node is inserted somewhere it doesn't belong
INDEX_SIZE_ERR-
If index or size is negative, or greater than the allowed value
INUSE_ATTRIBUTE_ERR-
If an attempt is made to add an attribute that is already in use
elsewhere
INVALID_ACCESS_ERR, introduced in DOM Level 2.-
If a parameter or an operation is not supported by the underlying
object.
INVALID_CHARACTER_ERR-
If an invalid or illegal character is specified, such as in a
name.
INVALID_MODIFICATION_ERR, introduced in DOM Level 2.-
If an attempt is made to modify the type of the underlying object.
INVALID_STATE_ERR, introduced in DOM Level 2.-
If an attempt is made to use an object that is not, or is no longer,
usable.
NAMESPACE_ERR, introduced in DOM Level 2.-
If an attempt is made to create or change an object in a way which is
incorrect with regard to namespaces.
NOT_FOUND_ERR-
If an attempt is made to reference a node in a context where it does
not exist
NOT_SUPPORTED_ERR-
If the implementation does not support the requested type of object or
operation.
NO_DATA_ALLOWED_ERR-
If data is specified for a node which does not support data
NO_MODIFICATION_ALLOWED_ERR-
If an attempt is made to modify an object where modifications are not
allowed
SYNTAX_ERR, introduced in DOM Level 2.-
If an invalid or illegal string is specified.
TYPE_MISMATCH_ERR, introduced in DOM Level 3.-
If the type of an object is incompatible with the expected type
of the parameter associated to the object.
VALIDATION_ERR, introduced in DOM Level 3.-
If a call to a method such as
insertBefore or
removeChild would make the Node invalid with
respect to "partial
validity", this exception would be raised and the operation
would not be done. This code is used in [DOM Level 3 Validation]. Refer to this specification for further information.
WRONG_DOCUMENT_ERR-
If a node is used in a different document than the one that created it
(that doesn't support it)
- Interface DOMStringList (introduced in DOM Level 3)
-
The DOMStringList interface provides the abstraction
of an ordered collection of parallel pairs of name and namespace
values, without defining or constraining how this collection is
implemented. The items in the DOMStringList are accessible
via an integral index, starting from 0.
IDL Definition-
- Attributes
length of type unsigned long, readonly- The number of
DOMStrings in the list. The range of
valid child node indices is 0 to length-1
inclusive.
- Methods
item-
Returns the
indexth item in the collection. If
index is greater than or equal to the number of
DOMStrings in the list, this returns
null.
Parameters
index of type
unsigned long-
Index into the collection.
Return Value
DOMString
|
The DOMString at the indexth
position in the DOMStringList, or
null if that is not a valid index.
|
No Exceptions
- Interface NameList (introduced in DOM Level 3)
-
The NameList interface provides the abstraction of an
ordered collection of parallel pairs of name and namespace values,
without defining or constraining how this collection is
implemented. The items in the NameList are accessible
via an integral index, starting from 0.
IDL Definition-
- Attributes
length of type unsigned long, readonly-
The number of pairs (name and namespaceURI) in the list. The
range of valid child node indices is 0 to
length-1
inclusive.
- Methods
getName-
Returns the
indexth name item in the collection.
Parameters
index of type
unsigned long-
Index into the collection.
Exceptions
DOMException
|
INDEX_SIZE_ERR: If index is
greater than or equal to the number of nodes in the list.
|
getNamespaceURI-
Returns the
indexth namespaceURI item in the
collection.
Parameters
index of type
unsigned long-
Index into the collection.
Exceptions
DOMException
|
INDEX_SIZE_ERR: If index is greater than or
equal to the number of nodes in the list.
|
- Interface DOMImplementationList (introduced in DOM Level 3)
-
The DOMImplementationList interface provides the
abstraction of an ordered collection of DOM implementations,
without defining or constraining how this collection is
implemented. The items in the DOMImplementationList
are accessible via an integral index, starting from 0.
IDL Definition-
- Attributes
length of type unsigned long, readonly-
The number of
DOMImplementations in the list. The
range of valid child node indices is 0 to length-1
inclusive.
- Methods
item-
Returns the
indexth item in the collection. If
index is greater than or equal to the number of
DOMImplementations in the list, this returns
null.
Parameters
index of type
unsigned long-
Index into the collection.
No Exceptions
- Interface DOMImplementationSource (introduced in DOM Level 3)
-
This interface permits a DOM implementer to supply one or more
implementations, based upon requested features and versions, as
specified in DOM Features. Each implemented
DOMImplementationSource object is listed in the
binding-specific list of available sources so that its
DOMImplementation objects are made available.
IDL Definition-
- Methods
getDOMImplementation-
A method to request the first DOM implementation that support the
specified features.
Parameters
features of type
DOMString-
A string that specifies which features and versions are
required. This is a space separated list in which each
feature is specified by its name optionally followed by a
space and a version number.
As an example, the string "XML 3.0 Traversal +Events
2.0" will request a DOM implementation that supports
the module "XML" for its 3.0 version, a module that support
of the "Traversal" module for any version, and the module
"Events" for its 2.0 version. The module "Events" must be
accessible using the method Node.getFeature() and
DOMImplementation.getFeature().
Return Value
DOMImplementation
|
The first DOM implementation that support the desired features, or
null if this source has none. |
No Exceptions
getDOMImplementations-
A method to request a list of DOM implementations that support
the specified features and versions, as specified in
DOM Features.
Parameters
features of type
DOMString-
A string that specifies which features and versions are
required. This is a space separated list in which each feature
is specified by its name optionally followed by a space and a
version number. This is something like: "XML 3.0 Traversal
+Events 2.0"
No Exceptions
- Interface DOMImplementation
-
The DOMImplementation interface provides a number of
methods for performing operations that are independent of any particular
instance of the document object model.
IDL Definition-
- Methods
createDocument introduced in DOM Level 2-
Creates a DOM Document object of the specified type with its document
element.
Note that based on the
DocumentType given to create the
document, the implementation may instantiate specialized
Document objects that support additional features than the
"Core", such as "HTML" [
DOM Level 2 HTML].
On the other hand, setting the
DocumentType after the
document was created makes this very unlikely to happen. Alternatively,
specialized
Document creation methods, such as
createHTMLDocument
[
DOM Level 2 HTML], can be used to obtain
specific types of
Document objects.
Return Value
Document
|
A new Document object with its document element. If the
NamespaceURI, qualifiedName, and
doctype are null, the returned
Document is empty with no document element. |
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character according to [XML 1.0]. NAMESPACE_ERR: Raised if the qualifiedName is
malformed, if the qualifiedName has a prefix and the
namespaceURI is null, or if the
qualifiedName is null and the
namespaceURI is different from null, or if the
qualifiedName has a prefix that is "xml" and the
namespaceURI is different from
"http://www.w3.org/XML/1998/namespace" [XML Namespaces],
or if the DOM implementation does not support the
"XML" feature but a non-null namespace URI was
provided, since namespaces were defined by XML. WRONG_DOCUMENT_ERR: Raised if doctype has already
been used with a different document or was created from a different
implementation. NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
createDocumentType introduced in DOM Level 2-
Creates an empty
DocumentType node. Entity declarations
and notations are not made available. Entity reference expansions and
default attribute additions do not occur..
Parameters
qualifiedName of type
DOMString-
The qualified name
of the document type to be created.
publicId of type
DOMString-
The external subset public identifier.
systemId of type
DOMString-
The external subset system identifier.
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character according to [XML 1.0]. NAMESPACE_ERR: Raised if the qualifiedName is
malformed. NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
getFeature introduced in DOM Level 3-
This method returns a specialized object which implements the
specialized APIs of the specified feature and version, as
specified in
DOM Features. The specialized
object may also be obtained by using binding-specific casting
methods but is not necessarily expected to, as discussed in
Mixed DOM implementations. This method also allow the
implementation to provide specialized objects which do not
support the
DOMImplementation interface.
Parameters
feature of type
DOMString-
The name of the feature requested. Note that any plus sign
"+" prepended to the name of the feature will be ignored
since it is not significant in the context of this method.
version of type
DOMString-
This is the version number of the feature to test.
Return Value
DOMObject
|
Returns an object which implements the specialized APIs of the
specified feature and version, if any, or null if
there is no object which implements interfaces associated with
that feature. If the DOMObject returned by this
method implements the DOMImplementation
interface, it must delegate to the primary core
DOMImplementation and not return results
inconsistent with the primary core
DOMImplementation such as
hasFeature, getFeature, etc.
|
No Exceptions
hasFeature-
Test if the DOM implementation implements a specific feature
and version, as specified in
DOM Features.
Parameters
feature of type
DOMString-
The name of the feature to test.
version of type
DOMString-
This is the version number of the feature to test.
Return Value
boolean
|
true if the feature is implemented in the specified
version, false otherwise. |
No Exceptions
- Interface DocumentFragment
-
DocumentFragment is a "lightweight" or "minimal"
Document object. It is very common to want to be able to
extract a portion of a document's tree or to create a new fragment of a
document. Imagine implementing a user command like cut or rearranging a
document by moving fragments around. It is desirable to have an object
which can hold such fragments and it is quite natural to use a Node for
this purpose. While it is true that a Document object could
fulfill this role, a Document object can potentially be a
heavyweight object, depending on the underlying implementation. What is
really needed for this is a very lightweight
object. DocumentFragment is such an object.
Furthermore, various operations -- such as inserting nodes as children
of another Node -- may take DocumentFragment
objects as arguments; this results in all the child nodes of the
DocumentFragment being moved to the child list of this
node.
The children of a DocumentFragment node are zero or more
nodes representing the tops of any sub-trees defining the structure of
the document. DocumentFragment nodes do not need to be
well-formed XML documents
(although they do need to follow the rules imposed upon well-formed XML
parsed entities, which can have multiple top nodes). For example, a
DocumentFragment might have only one child and that child
node could be a Text node. Such a structure model represents
neither an HTML document nor a well-formed XML document.
When a DocumentFragment is inserted into a
Document (or indeed any other Node that may
take children) the children of the DocumentFragment and not
the DocumentFragment itself are inserted into the
Node. This makes the DocumentFragment very
useful when the user wishes to create nodes that are
siblings; the
DocumentFragment acts as the parent of these nodes so that
the user can use the standard methods from the Node
interface, such as insertBefore and
appendChild.
IDL Definition-
- Interface Document
-
The Document interface represents the entire HTML or XML
document. Conceptually, it is the
root of the document tree, and
provides the primary access to the document's data.
Since elements, text nodes, comments, processing instructions,
etc. cannot exist outside the context of a Document, the
Document interface also contains the factory methods needed
to create these objects. The Node objects created have a
ownerDocument attribute which associates them with the
Document within whose context they were created.
IDL Definition-
- Attributes
actualEncoding of type DOMString, readonly, introduced in DOM Level 3- An attribute specifying the actual encoding of this document. This is
null when it is not known.
config of type DOMConfiguration, readonly, introduced in DOM Level 3-
The configuration used when
Document.normalizeDocument() is invoked.
doctype of type DocumentType, readonly, modified in DOM Level 3- The Document Type Declaration (see
DocumentType)
associated with this document. For HTML documents as well as XML
documents without a document type declaration this returns
null.
This provides direct access to the DocumentType node,
child node of this Document. This node can be set at
document creation time and later changed through the use of child nodes
manipulation methods, such as insertBefore, or
replaceChild. Note, however, that while some
implementations may instantiate different types of
Document objects supporting additional features than the
"Core", such as "HTML" [DOM Level 2 HTML],
based on the DocumentType specified at creation time,
changing it afterwards is very unlikely to result in a change of the
features supported.
documentElement of type Element, readonly- This is a convenience
attribute that allows direct access to the child node that is the
document element of the
document.
documentURI of type DOMString, introduced in DOM Level 3- The location of the document or
null if undefined.
Beware that when the Document supports the feature "HTML"
[DOM Level 2 HTML], the href attribute of the HTML BASE element
takes precedence over this attribute.
implementation of type DOMImplementation, readonly- The
DOMImplementation object that handles this
document. A DOM application may use objects from multiple
implementations.
strictErrorChecking of type boolean, introduced in DOM Level 3- An attribute specifying whether error checking is enforced or
not. When set to
false, the implementation is free to
not test every possible error case normally defined on DOM
operations, and not raise any DOMException on DOM
operations or report errors while using
Document.normalizeDocument(). In case of error, the
behavior is undefined. This attribute is true by
default.
xmlEncoding of type DOMString, introduced in DOM Level 3- An attribute specifying, as part of the XML declaration, the encoding
of this document. This is
null when unspecified.
xmlStandalone of type boolean, introduced in DOM Level 3- An attribute specifying, as part of the XML declaration, whether this
document is standalone.
Exceptions on setting
DOMException
|
NOT_SUPPORTED_ERR: Raised if this document does support the
"XML" feature.
|
xmlVersion of type DOMString, introduced in DOM Level 3-
An attribute specifying, as part of the XML declaration, the
version number of this document. If there is no declaration, the
value is
"1.0". Changing this attribute will affect
methods that check for illegal characters in XML names. Application
should invoke Document.normalizeDocument() in order to check
for illegal characters in the Nodes that
are already part of this Document.
Exceptions on setting
DOMException
|
NOT_SUPPORTED_ERR: Raised if the version is set to a value
that is not supported by this Document or if
this document does support the "XML" feature.
|
- Methods
adoptNode introduced in DOM Level 3-
Changes the
ownerDocument of a node, its children,
as well as the attached attribute nodes if there are any. If the node
has a parent it is first removed from its parent child list. This
effectively allows moving a subtree from one document to another. The
following list describes the specifics for each type of node.
- ATTRIBUTE_NODE
- The
ownerElement attribute is set to
null and the specified flag is set to
true on the adopted Attr. The
descendants of the source Attr are recursively
adopted. - DOCUMENT_FRAGMENT_NODE
- The descendants of the source node are recursively
adopted.
- DOCUMENT_NODE
Document nodes cannot be adopted.- DOCUMENT_TYPE_NODE
DocumentType nodes cannot be adopted.- ELEMENT_NODE
- Specified attribute nodes of the source element
are adopted, and the generated
Attr nodes. Default
attributes are discarded, though if the document being adopted
into defines default attributes for this element name, those
are assigned. The descendants of the source element are
recursively adopted. - ENTITY_NODE
Entity nodes cannot be adopted.- ENTITY_REFERENCE_NODE
- Only the
EntityReference node itself is adopted,
the descendants are discarded, since the source and destination
documents might have defined the entity differently. If the
document being imported into provides a definition for this
entity name, its value is assigned. - NOTATION_NODE
Notation nodes cannot be adopted.- PROCESSING_INSTRUCTION_NODE, TEXT_NODE, CDATA_SECTION_NODE,
COMMENT_NODE
- These nodes can all be adopted. No specifics.
Note:
Unlike the Document.importNode() method, this
method does not raise an INVALID_CHARACTER_ERR
exception and applications should use the
Document.normalizeDocument() method to check if an
imported name contain an illegal character according to the
XML version in use.
Parameters
source of type
Node-
The node to move into this document.
Return Value
Node
|
The adopted node, or null if this operation fails, such
as when the source node comes from a different implementation. |
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: Raised if the source node is of type
DOCUMENT, DOCUMENT_TYPE. NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is
readonly. |
createAttribute-
Creates an
Attr of the given name. Note that the
Attr instance can then be set on an
Element
using the
setAttributeNode method.
To create an attribute with a
qualified name and
namespace URI, use
the
createAttributeNS method.
Parameters
name of type
DOMString-
The name of the attribute.
Return Value
Attr
|
A new Attr object with the nodeName
attribute set to name, and localName,
prefix, and namespaceURI set to
null. The value of the attribute is the empty
string. |
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use
specified in the version attribute. |
createAttributeNS introduced in DOM Level 2-
Creates an attribute of the given
qualified name and
namespace
URI.
Per [
XML Namespaces], applications must use the value
null
as the
namespaceURI parameter for methods if they wish to have no
namespace.
Return Value
Attr
|
A new Attr object with the following attributes:
|
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified qualifiedName
contains an illegal character according to the XML version in use
specified in the version attribute. NAMESPACE_ERR: Raised if the qualifiedName is
a malformed qualified name, if the
qualifiedName has a prefix and the
namespaceURI is null, if the
qualifiedName has a prefix that is "xml" and the
namespaceURI is different from
"http://www.w3.org/XML/1998/namespace", if the
qualifiedName or its prefix is "xmlns" and the
namespaceURI is different from
"http://www.w3.org/2000/xmlns/", or if the
namespaceURI is
"http://www.w3.org/2000/xmlns/" and neither the
qualifiedName nor its prefix is "xmlns". NOT_SUPPORTED_ERR: Always thrown if the current document does not
support the "XML" feature, since namespaces were
defined by XML. |
createCDATASection-
Creates a
CDATASection node whose value is the specified
string.
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: Raised if this document is an HTML
document. |
createComment-
Creates a
Comment node given the specified string.
Parameters
data of type
DOMString-
The data for the node.
No Exceptions
createDocumentFragment-
createElement-
Creates an element of the type specified. Note that the instance
returned implements the
Element interface, so attributes
can be specified directly on the returned object.
In addition, if there are known attributes with default values,
Attr nodes representing them are automatically created and
attached to the element.
To create an element with a
qualified name and
namespace URI, use the
createElementNS method.
Parameters
tagName of type
DOMString-
The name of the element type to instantiate. For XML, this is
case-sensitive, otherwise it depends on the case-sensitivity of the
markup language in use. In that case, the name is mapped to the
canonical form of that markup by the DOM implementation.
Return Value
Element
|
A new Element object with the
nodeName attribute set to tagName, and
localName, prefix, and
namespaceURI set to null. |
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use
specified in the version attribute. |
createElementNS introduced in DOM Level 2-
Creates an element of the given
qualified name and
namespace URI.
Per [
XML Namespaces], applications must use the value
null
as the namespaceURI parameter for methods if they wish to have no
namespace.
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified qualifiedName
contains an illegal character according to the XML version in use
specified in the version attribute. NAMESPACE_ERR: Raised if the qualifiedName is
a malformed qualified name, if the
qualifiedName has a prefix and the
namespaceURI is null, or if the
qualifiedName has a prefix that is "xml" and the
namespaceURI is different from
"http://www.w3.org/XML/1998/namespace"
[XML Namespaces], or if the
qualifiedName or its prefix is "xmlns" and the
namespaceURI is different from
"http://www.w3.org/2000/xmlns/", or if the
namespaceURI is
"http://www.w3.org/2000/xmlns/" and neither the
qualifiedName nor its prefix is "xmlns". NOT_SUPPORTED_ERR: Always thrown if the current document does not
support the "XML" feature, since namespaces were
defined by XML. |
createEntityReference-
Creates an
EntityReference object. In addition, if the
referenced entity is known, the child list of the
EntityReference node is made the same as that of the
corresponding
Entity node.
Note: If any descendant of the Entity node has an unbound
namespace prefix, the
corresponding descendant of the created EntityReference
node is also unbound; (its namespaceURI is
null). The DOM Level 2 and 3 do not support any mechanism to
resolve namespace prefixes in this case.
Parameters
name of type
DOMString-
The name of the entity to reference.
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use
specified in the version attribute. NOT_SUPPORTED_ERR: Raised if this document is an HTML
document. |
createProcessingInstruction-
Creates a
ProcessingInstruction node given the specified
name and data strings.
Parameters
target of type
DOMString-
The target part of the processing instruction.
data of type
DOMString-
The data for the node.
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified target contains an
illegal character according to the XML version in use
specified in the version attribute. NOT_SUPPORTED_ERR: Raised if this document is an HTML
document. |
createTextNode-
Creates a
Text node given the specified string.
Parameters
data of type
DOMString-
The data for the node.
No Exceptions
getElementById introduced in DOM Level 2-
Returns the
Element that has an ID attribute with the
given value. If no such element exists, this returns
null.
If more than one element has an ID attribute with that value, what
is returned is undefined.
The DOM implementation is expected to use the method
Attr.isId() to determine if an attribute is of type
ID.
Note: Attributes with the name "ID" or "id" are not of type ID unless
so defined.
Parameters
elementId of type
DOMString-
The unique
id value for an element.
Return Value
Element
|
The matching element or null if there is none. |
No Exceptions
getElementsByTagName-
Returns a
NodeList of all the
Elements in
document
order with a given tag name and are contained in the
document.
Parameters
tagname of type
DOMString-
The name of the tag to match on. The special value "*" matches all
tags. For XML, this is case-sensitive, otherwise it depends on the
case-sensitivity of the markup language in use.
No Exceptions
getElementsByTagNameNS introduced in DOM Level 2-
importNode introduced in DOM Level 2-
Imports a node from another document to this document. The returned
node has no parent; (
parentNode is
null). The
source node is not altered or removed from the original document; this
method creates a new copy of the source node.
For all nodes, importing a node creates a node object owned by the
importing document, with attribute values identical to the source
node's
nodeName and
nodeType, plus the
attributes related to namespaces (
prefix,
localName, and
namespaceURI). As in the
cloneNode operation, the source node is not altered. User
data associated to the imported node is not carried over. However,
if any
UserDataHandlers has been specified along with the
associated data these handlers will be called with the appropriate
parameters before this method returns.
Additional information is copied as appropriate to the
nodeType, attempting to mirror the behavior expected if a
fragment of XML or HTML source was copied from one document to another,
recognizing that the two documents may have different DTDs in the XML
case. The following list describes the specifics for each type of node.
- ATTRIBUTE_NODE
- The
ownerElement attribute is set to
null and the specified flag is set to
true on the generated Attr. The
descendants of the
source Attr are recursively imported and the
resulting nodes reassembled to form the corresponding
subtree.
Note that the deep parameter has no effect on
Attr nodes; they always carry their children with
them when imported. - DOCUMENT_FRAGMENT_NODE
- If the
deep option was set to
true, the
descendants of the
source DocumentFragment are recursively imported
and the resulting nodes reassembled under the imported
DocumentFragment to form the corresponding
subtree. Otherwise, this simply generates an empty
DocumentFragment. - DOCUMENT_NODE
Document nodes cannot be imported.- DOCUMENT_TYPE_NODE
DocumentType nodes cannot be imported.- ELEMENT_NODE
- Specified attribute nodes of the source element
are imported, and the generated
Attr nodes are
attached to the generated Element. Default
attributes are not copied, though if the document
being imported into defines default attributes for this element
name, those are assigned. If the importNode
deep parameter was set to true, the
descendants of the
source element are recursively imported and the resulting nodes
reassembled to form the corresponding subtree. - ENTITY_NODE
Entity nodes can be imported, however in the
current release of the DOM the DocumentType is
readonly. Ability to add these imported nodes to a
DocumentType will be considered for addition to a
future release of the DOM.
On import, the publicId, systemId,
and notationName attributes are copied. If a
deep import is requested, the
descendants of the
the source Entity are recursively imported and the
resulting nodes reassembled to form the corresponding
subtree.- ENTITY_REFERENCE_NODE
- Only the
EntityReference itself is copied, even
if a deep import is requested, since the source
and destination documents might have defined the entity
differently. If the document being imported into provides a
definition for this entity name, its value is assigned. - NOTATION_NODE
Notation nodes can be imported, however in the
current release of the DOM the DocumentType is
readonly. Ability to add these imported nodes to a
DocumentType will be considered for addition to a
future release of the DOM.
On import, the publicId and
systemId attributes are copied.
Note that the deep parameter has no effect on
this type of nodes since they cannot have any children.- PROCESSING_INSTRUCTION_NODE
- The imported node copies its
target and
data values from those of the source node.
Note that the deep parameter has no effect on
this type of nodes since they cannot have any children. - TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
- These three types of nodes inheriting from
CharacterData copy their data and
length attributes from those of the source
node.
Note that the deep parameter has no effect on
these types of nodes since they cannot have any children.
Parameters
importedNode of type
Node-
The node to import.
deep of type
boolean-
If
true, recursively import the subtree under the
specified node; if false, import only the node itself,
as explained above. This has no effect on nodes that cannot have
any children, and on Attr, and
EntityReference nodes.
Return Value
Node
|
The imported node that belongs to this Document. |
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: Raised if the type of node being imported
is not supported. INVALID_CHARACTER_ERR: Raised if one the imported names contain an
illegal character according to the XML version in use
specified in the version attribute. This may happen when importing an XML 1.1
[XML 1.1] element into an XML 1.0 document, for
instance. |
normalizeDocument introduced in DOM Level 3-
This method acts as if the document was going through a save and
load cycle, putting the document in a "normal" form. As a
consequence, this method updates the replacement tree of
EntityReference nodes and normalizes
Text nodes, as defined in the method
Node.normalize().
Otherwise, the actual result depends on the features being set
on the
Document.config object and governing what
operations actually take place. Noticeably this method could
also make the document "namespace wellformed" according to the
algorithm described in
Namespace normalization,
check the character normalization, remove the
CDATASection nodes, etc. See
DOMConfiguration for details.
// Keep in the document the information defined
// in the XML Information Set (Java example)
DOMConfiguration docConfig = myDocument.getConfig();
docConfig.setParameter("infoset", Boolean.TRUE);
myDocument.normalizeDocument();
Mutation events, when supported, are generated to reflect the changes
occurring on the document.
If errors occur during the invocation of this method, such as an
attempt to update a
read-only
node or a
Node.nodeName contains an
invalid character according to the XML version in use, errors
will be reported using the
DOMErrorHandler object
associated with the "
error-handler"
parameter. Note that this method does not generate fatal errors.
No Parameters
No Return Value
No Exceptions
renameNode introduced in DOM Level 3-
Rename an existing node of type
ELEMENT_NODE or
ATTRIBUTE_NODE.
When possible this simply changes the name of the given node,
otherwise this creates a new node with the specified name and
replaces the existing node with the new node as described
below.
If simply changing the name of the given node is not possible,
the following operations are performed:
a new node is created, any registered event listener is registered on
the new node, any user data attached to the old node is removed from
that node, the old node is removed from its parent if it has one, the
children are moved to the new node, if the renamed node is an
Element its attributes are moved to the new node,
the new node is inserted at the position the old node used to have in
its parent's child nodes list if it has one, the user data that was
attached to the old node is attached to the new node.
When the node being renamed is an
Element only the
specified attributes are moved, default attributes originated from the
DTD are updated according to the new element name. In addition, the
implementation may update default attributes from other
schemas. Applications should use
Document.normalizeDocument() to guarantee these
attributes are up-to-date.
When the node being renamed is an
Attr that is attached
to an
Element, the node is first removed from the
Element attributes map. Then, once renamed, either by
modifying the existing node or creating a new one as described above,
it is put back.
In addition,
-
a user data event
NODE_RENAMED is fired,
-
when the implementation supports the feature
"MutationNameEvents", each mutation operation involved in
this method fires the appropriate event, and in the end the
event {
http://www.w3.org/2001/xml-events,
DOMElementNameChanged} or
{http://www.w3.org/2001/xml-events,
DOMAttributeNameChanged} is fired.
Return Value
Node
|
The renamed node. This is either the specified node or the new node
that was created to replace the specified node. |
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: Raised when the type of the specified node is
neither ELEMENT_NODE nor
ATTRIBUTE_NODE, or if the implementation does
not support the renaming of the document element. WRONG_DOCUMENT_ERR: Raised when the specified node was created
from a different document than this document. NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, if the
qualifiedName has a prefix and the
namespaceURI is null, or if the
qualifiedName has a prefix that is "xml" and the
namespaceURI is different from
"http://www.w3.org/XML/1998/namespace"
[XML Namespaces]. Also raised, when the node being
renamed is an attribute, if the qualifiedName, or
its prefix, is "xmlns" and the namespaceURI is
different from "http://www.w3.org/2000/xmlns/". |
- Interface Node
-
The Node interface is the primary datatype for the entire
Document Object Model. It represents a single node in the document
tree. While all objects implementing the Node interface
expose methods for dealing with children, not all objects implementing
the Node interface may have children. For example,
Text nodes may not have children, and adding children to
such nodes results in a DOMException being raised.
The attributes nodeName, nodeValue and
attributes are included as a mechanism to get at node
information without casting down to the specific derived interface. In
cases where there is no obvious mapping of these attributes for a
specific nodeType (e.g., nodeValue for an
Element or attributes for a
Comment), this returns null. Note that the
specialized interfaces may contain additional and more convenient
mechanisms to get and set the relevant information.
IDL Definition-
- Definition group NodeType
An integer indicating which type of node this is.
Note: Numeric codes up to 200 are reserved to W3C for possible future
use.
- Defined Constants
ATTRIBUTE_NODE-
The node is an
Attr.
CDATA_SECTION_NODE-
The node is a
CDATASection.
COMMENT_NODE-
The node is a
Comment.
DOCUMENT_FRAGMENT_NODE-
The node is a
DocumentFragment.
DOCUMENT_NODE-
The node is a
Document.
DOCUMENT_TYPE_NODE-
The node is a
DocumentType.
ELEMENT_NODE-
The node is an
Element.
ENTITY_NODE-
The node is an
Entity.
ENTITY_REFERENCE_NODE-
The node is an
EntityReference.
NOTATION_NODE-
The node is a
Notation.
PROCESSING_INSTRUCTION_NODE-
The node is a
ProcessingInstruction.
TEXT_NODE-
The node is a
Text node.
The values of nodeName, nodeValue, and
attributes vary according to the node type as follows:
- Definition group DocumentPosition
A bitmask indicating the relative document position of a node with
respect to another node.
If the two nodes being compared are the same node, then no
flags are set on the return.
Otherwise, the order of two nodes is determined by looking
for common containers -- containers which contain both. A node
directly contains any child nodes. A node also directly
contains any other nodes attached to it such as attributes
contained in an element or entities and notations contained in a
document type. Nodes contained in contained nodes are also
contained, but less-directly as the number of intervening
containers increases.
If there is no common container node,
then the order is based upon order between the root container of
each node that is in no container. In this case, the result is
disconnected and implementation-specific. This result is
stable as long as these outer-most containing nodes remain in
memory and are not inserted into some other containing node.
This would be the case when the nodes belong to different
documents or fragments, and cloning the document or inserting a
fragment might change the order.
If one of the nodes being compared contains the other node,
then the container precedes the contained node, and reversely the
contained node follows the container. For example, when comparing
an element against its own attribute or child, the element node
precedes its attribute node and its child node, which both follow
it.
If neither of the previous cases apply, then there exists a
most-direct container common to both nodes being compared. In
this case, the order is determined based upon the two
determining nodes directly contained in this most-direct common
container that either are or contain the corresponding nodes
being compared.
If these two determining nodes are both child nodes, then the
natural DOM order of these determining nodes within the
containing node is returned as the order of the corresponding
nodes. This would be the case, for example, when comparing two
child elements of the same element.
If one of the two determining nodes is a child node and the
other is not, then the corresponding node of the child node
follows the corresponding node of the non-child node. This
would be the case, for example, when comparing an attribute of
an element with a child element of the same element.
If neither of the two determining node is a child node and
one determining node has a greater value of
nodeType than the other, then the corresponding
node precedes the other. This would be the case, for example,
when comparing an entity of a document type against a notation
of the same document type.
If neither of the two determining node is a child node and
nodeType is the same for both determining nodes,
then an implementation-dependent order between the determining
nodes is returned. This order is stable as long as no nodes of
the same nodeType are inserted into or removed from the direct
container. This would be the case, for example, when comparing
two attributes of the same element, and inserting or removing
additional attributes might change the order between existing
attributes.
- Defined Constants
DOCUMENT_POSITION_CONTAINED_BY-
The node is contained by the reference node.
A node which is contained is always following, too.
DOCUMENT_POSITION_CONTAINS-
The node contains the reference node.
A node which contains is always preceding, too.
DOCUMENT_POSITION_DISCONNECTED-
The two nodes are disconnected. Order between disconnected
nodes is always implementation-specific.
DOCUMENT_POSITION_FOLLOWING-
The node follows the reference node.
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC-
The determination of preceding versus following is
implementation-specific.
DOCUMENT_POSITION_PRECEDING-
The node precedes the reference node.
- Attributes
attributes of type NamedNodeMap, readonly- A
NamedNodeMap containing the attributes of this node (if
it is an Element) or null otherwise.
baseURI of type DOMString, readonly, introduced in DOM Level 3- The absolute base URI of this node or
null if
undefined. This value is computed according to [XML Base].
However, when the Document supports the feature "HTML"
[DOM Level 2 HTML], the base URI is computed using first the
value of the href attribute of the HTML BASE element if any, and the
value of the documentURI attribute from the
Document interface otherwise.
childNodes of type NodeList, readonly- A
NodeList that contains all children of this node. If
there are no children, this is a NodeList containing no
nodes.
firstChild of type Node, readonly- The first child of this node. If there is no such node, this returns
null.
lastChild of type Node, readonly- The last child of this node. If there is no such node, this returns
null.
localName of type DOMString, readonly, introduced in DOM Level 2- Returns the local part of the
qualified name of this
node.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as Document.createElement(),
this is always null.
namespaceURI of type DOMString, readonly, introduced in DOM Level 2- The namespace URI of this
node, or
null if it is unspecified.
This is not a computed value that is the result of a namespace lookup
based on an examination of the namespace declarations in scope. It is
merely the namespace URI given at creation time.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as Document.createElement(), this is
always null.Note: Per the Namespaces in XML Specification
[XML Namespaces] an attribute does not inherit its
namespace from the element it is attached to. If an attribute is
not explicitly given a namespace, it simply has no namespace.
nextSibling of type Node, readonly- The node immediately following this node. If there is no such node,
this returns
null.
nodeName of type DOMString, readonly- The name of this node, depending on its type; see the table above.
nodeType of type unsigned short, readonly- A code representing the type of the underlying object, as defined
above.
nodeValue of type DOMString- The value of this node, depending on its type; see the table
above. When it is defined to be
null, setting it has no effect,
including if the node is read-only.
Exceptions on setting
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is
readonly and if it is not defined to be null. |
Exceptions on retrieval
DOMException
|
DOMSTRING_SIZE_ERR: Raised when it would return more characters
than fit in a DOMString variable on the implementation
platform. |
ownerDocument of type Document, readonly, modified in DOM Level 2- The
Document object associated with this node. This is
also the Document object used to create new nodes. When
this node is a Document or a DocumentType
which is not used with any Document yet, this is
null.
parentNode of type Node, readonly- The parent of this node. All nodes,
except
Attr, Document,
DocumentFragment, Entity, and
Notation may have a parent. However, if a node has just
been created and not yet added to the tree, or if it has been removed
from the tree, this is null.
prefix of type DOMString, introduced in DOM Level 2- The namespace prefix of
this node, or
null if it is unspecified.
Note that setting this attribute, when permitted, changes the
nodeName attribute, which holds the
qualified name, as well as
the tagName and name attributes of the
Element and Attr interfaces, when
applicable.
Setting the prefix to null makes it unspecified, setting
it to an empty string is implementation dependent.
Note also that changing the prefix of an attribute that is known to
have a default value, does not make a new attribute with the default
value and the original prefix appear, since the
namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as createElement from the
Document interface, this is always null.
Exceptions on setting
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified
prefix contains an illegal character according to the XML version in use
specified in the Document.xmlVersion attribute. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is
readonly. NAMESPACE_ERR: Raised if the specified
prefix is malformed per the Namespaces in XML
specification, if the namespaceURI of this node is
null, if the specified prefix is "xml" and the
namespaceURI of this node is different from
"http://www.w3.org/XML/1998/namespace", if this node is an attribute
and the specified prefix is "xmlns" and the
namespaceURI of this node is different from
"http://www.w3.org/2000/xmlns/", or if this node is an
attribute and the qualifiedName of this node is
"xmlns" [XML Namespaces]. |
previousSibling of type Node, readonly- The node immediately preceding this node. If there is no such node,
this returns
null.
textContent of type DOMString, introduced in DOM Level 3- This attribute returns the text content of this node and its
descendants. When it is defined to be
null, setting it
has no effect. On setting, any possible children this node may have are
removed and, if it the new string is not empty or null,
replaced by a single Text node containing the string
this attribute is set to.
On getting, no serialization is performed, the returned string
does not contain any markup. No whitespace normalization is
performed and the returned string does not contain the white
spaces in element content (see the method
Text.isWhitespaceInElementContent()). Similarly, on
setting, no parsing is performed either, the input string is
taken as pure textual content.
The string returned is
made of the text content of this node depending on its type, as
defined below:
| Node type | Content |
|
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE,
DOCUMENT_FRAGMENT_NODE |
concatenation of the textContent attribute value
of every child node, excluding COMMENT_NODE and
PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if
the node has no children. |
|
TEXT_NODE, CDATA_SECTION_NODE,
COMMENT_NODE, PROCESSING_INSTRUCTION_NODE |
nodeValue |
|
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE |
null |
Exceptions on setting
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. |
Exceptions on retrieval
DOMException
|
DOMSTRING_SIZE_ERR: Raised when it would return more characters
than fit in a DOMString variable on the implementation
platform. |
- Methods
appendChild-
Adds the node
newChild to the end of the list of children
of this node. If the
newChild is already in the tree, it
is first removed.
Parameters
newChild of type
Node-
The node to add.
If it is a DocumentFragment object, the entire
contents of the document fragment are moved into the child list of
this node
Exceptions
DOMException
|
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does
not allow children of the type of the newChild node,
or if the node to append is one of this node's
ancestors or this node
itself. WRONG_DOCUMENT_ERR: Raised if newChild was created
from a different document than the one that created this node. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if
the previous parent of the node being inserted is readonly. |
cloneNode-
Returns a duplicate of this node, i.e., serves as a generic copy
constructor for nodes. The duplicate node has no parent;
(
parentNode is
null.) and no user data. User
data associated to the imported node is not carried over. However,
if any
UserDataHandlers has been specified along with the
associated data these handlers will be called with the appropriate
parameters before this method returns.
Cloning an
Element copies all attributes and their
values, including those generated by the XML processor to represent
defaulted attributes, but this method does not copy any children it
contains unless it is a deep clone. This includes text contained in an
the
Element since the text is contained in a child
Text node. Cloning an
Attr directly, as
opposed to be cloned as part of an
Element cloning
operation, returns a specified attribute (
specified is
true). Cloning an
Attr always clones its
children, since they represent its value, no matter whether this is a
deep clone or not. Cloning an
EntityReference
automatically constructs its subtree if a corresponding
Entity is available, no matter whether this is a deep
clone or not. Cloning any other type of node simply returns a copy of
this node.
Note that cloning an immutable subtree results in a mutable copy, but
the children of an
EntityReference clone are
readonly. In addition, clones
of unspecified
Attr nodes are specified. And, cloning
Document,
DocumentType,
Entity,
and
Notation nodes is implementation dependent.
Parameters
deep of type
boolean-
If
true, recursively clone the subtree under the
specified node; if false, clone only the node itself
(and its attributes, if it is an Element).
No Exceptions
compareDocumentPosition introduced in DOM Level 3-
Compares a node with this node with regard to their position in the
document and according to the
document
order.
Parameters
other of type
Node-
The node to compare against this node.
Return Value
unsigned short
|
Returns how the given node is positioned relatively to this
node (i.e., "the reference node"). |
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: when the compared nodes are from different
DOM implementations that do not coordinate to return
consistent implementation-specific results. |
getFeature introduced in DOM Level 3-
This method returns a specialized object which implements the
specialized APIs of the specified feature and version, as
specified in
DOM Features. The specialized object
may also be obtained by using binding-specific casting methods
but is not necessarily expected to, as discussed in
Mixed DOM implementations. This method also allow the implementation
to provide specialized objects which do not support the
Node interface.
Parameters
feature of type
DOMString-
The name of the feature requested. Note that any plus sign
"+" prepended to the name of the feature will be ignored
since it is not significant in the context of this method.
version of type
DOMString-
This is the version number of the feature to test.
Return Value
DOMObject
|
Returns an object which implements the specialized APIs of the
specified feature and version, if any, or null if
there is no object which implements interfaces associated with
that feature. If the DOMObject returned by this
method implements the Node interface, it must
delegate to the primary core Node and not return
results inconsistent with the primary core Node
such as attributes, childNodes, etc.
|
No Exceptions
getUserData introduced in DOM Level 3-
Retrieves the object associated to a key on a this node. The object
must first have been set to this node by calling
setUserData with the same key.
Parameters
key of type
DOMString-
The key the object is associated to.
No Exceptions
hasAttributes introduced in DOM Level 2-
Returns whether this node (if it is an element) has any
attributes.
Return Value
boolean
|
Returns true if this node has any attributes,
false otherwise. |
No Parameters
No Exceptions
hasChildNodes-
Returns whether this node has any children.
Return Value
boolean
|
Returns true if this node has any children,
false otherwise. |
No Parameters
No Exceptions
insertBefore modified in DOM Level 3-
Inserts the node
newChild before the existing child node
refChild. If
refChild is
null,
insert
newChild at the end of the list of children.
If
newChild is a
DocumentFragment object,
all of its children are inserted, in the same order, before
refChild. If the
newChild is already in the
tree, it is first removed.
Parameters
newChild of type
Node-
The node to insert.
refChild of type
Node-
The reference node, i.e., the node before which the new node must
be inserted.
Return Value
Node
|
The node being inserted. |
Exceptions
DOMException
|
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does
not allow children of the type of the newChild node, or
if the node to insert is one of this node's ancestors or this node itself, or if this
node if of type Document and the DOM application
attempts to insert a second DocumentType or
Element node. WRONG_DOCUMENT_ERR: Raised if newChild was created
from a different document than the one that created this node. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if
the parent of the node being inserted is readonly. NOT_FOUND_ERR: Raised if refChild is not a child of
this node. NOT_SUPPORTED_ERR: if this node if of type Document,
this exception might be raised if the DOM implementation doesn't
support the insertion of a DocumentType or
Element node. |
isDefaultNamespace introduced in DOM Level 3-
This method checks if the specified
namespaceURI is the
default namespace or not.
Parameters
namespaceURI of type
DOMString-
The namespace URI to look for.
Return Value
boolean
|
Returns true if the specified namespaceURI
is the default namespace, false otherwise.
|
No Exceptions
isEqualNode introduced in DOM Level 3-
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether
the two nodes are references to the same object) which can be tested
with
Node.isSameNode(). All nodes that are the same will
also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are
satisfied:
-
The two nodes are of the same type.
-
The following string attributes are equal:
nodeName, localName,
namespaceURI, prefix,
nodeValue. This is: they are
both null, or they have the same length and are
character for character identical.
-
The
attributes NamedNodeMaps are
equal. This is: they are both null, or they have the
same length and for each node that exists in one map there is a
node that exists in the other map and is equal, although not
necessarily at the same index.
-
The
childNodes NodeLists are
equal. This is: they are both null, or they
have the same length and contain equal nodes at the same index.
Note that normalization can affect equality; to avoid this, nodes
should be normalized before being compared.
For two
DocumentType nodes to be equal, the following
conditions must also be satisfied:
-
The following string attributes are equal:
publicId, systemId,
internalSubset.
-
The
entities NamedNodeMaps are
equal.
-
The
notations NamedNodeMaps are
equal.
On the other hand, the following do not affect equality:
the
ownerDocument,
baseURI, and
parentNode attributes, the
specified
and attribute for
Attr nodes, the
schemaTypeInfo
attribute for
Attr and
Element nodes, the
Text.isWhitespaceInElementContent() method for
Text nodes, as well as any user data or event listeners
registered on the nodes.
Note:
As a general rule, anything not mentioned in the description
above is not significant in consideration of equality
checking. Note that future versions of this specification may
take into account more attributes and implementations conform
to this specification are expected to be updated accordingly.
Parameters
arg of type
Node-
The node to compare equality with.
Return Value
boolean
|
Returns true if the nodes are equal, false
otherwise. |
No Exceptions
isSameNode introduced in DOM Level 3-
Returns whether this node is the same node as the given one.
This method provides a way to determine whether two
Node
references returned by the implementation reference the same
object. When two
Node references are references to the
same object, even if through a proxy, the references may be used
completely interchangeably, such that all attributes have the same
values and calling the same DOM method on either reference always has
exactly the same effect.
Parameters
other of type
Node-
The node to test against.
Return Value
boolean
|
Returns true if the nodes are the same,
false otherwise. |
No Exceptions
isSupported introduced in DOM Level 2-
Tests whether the DOM implementation implements a specific feature and
that feature is supported by this node, as specified in
DOM Features.
Parameters
feature of type
DOMString-
The name of the feature to test.
version of type
DOMString-
This is the version number of the feature to test.
Return Value
boolean
|
Returns true if the specified feature is supported on
this node, false otherwise. |
No Exceptions
lookupNamespaceURI introduced in DOM Level 3-
Look up the namespace URI associated to the given prefix, starting
from this node.
See
Namespace URI Lookup for details on the
algorithm used by this method.
Parameters
prefix of type
DOMString-
The prefix to look for. If this parameter is
null,
the method will return the default namespace URI if any.
Return Value
DOMString
|
Returns the associated namespace URI or null if none is
found. |
No Exceptions
lookupPrefix introduced in DOM Level 3-
Look up the prefix associated to the given namespace URI, starting
from this node. The default namespace declarations are ignored by this method.
See
Namespace Prefix Lookup for details on the
algorithm used by this method.
Parameters
namespaceURI of type
DOMString-
The namespace URI to look for.
Return Value
DOMString
|
Returns an associated namespace prefix if found or null
if none is found. If more than one prefix are associated to the namespace
prefix, the returned namespace prefix is implementation dependent. |
No Exceptions
normalize modified in DOM Level 2-
Puts all
Text nodes in the full depth of the sub-tree
underneath this
Node, including attribute nodes, into a
"normal" form where only structure (e.g., elements, comments,
processing instructions, CDATA sections, and entity references)
separates
Text nodes, i.e., there are neither adjacent
Text nodes nor empty
Text nodes. This can be
used to ensure that the DOM view of a document is the same as if it
were saved and re-loaded, and is useful when operations (such as
XPointer [
XPointer] lookups) that
depend on a particular document tree structure are to be used.
Note: In cases where the document contains CDATASections, the
normalize operation alone may not be sufficient, since XPointers do
not differentiate between Text nodes and
CDATASection nodes.
No Parameters
No Return Value
No Exceptions
removeChild modified in DOM Level 3-
Removes the child node indicated by
oldChild from the
list of children, and returns it.
Parameters
oldChild of type
Node-
The node being removed.
Exceptions
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if oldChild is not a child of
this node. NOT_SUPPORTED_ERR: if this node is of type Document,
this exception might be raised if the DOM implementation doesn't
support the removal of the DocumentType child or the
Element child. |
replaceChild modified in DOM Level 3-
Replaces the child node
oldChild with
newChild in the list of children, and returns the
oldChild node.
If
newChild is a
DocumentFragment object,
oldChild is replaced by all of the
DocumentFragment children, which are inserted in the same
order. If the
newChild is already in the tree, it is first
removed.
Parameters
newChild of type
Node-
The new node to put in the child list.
oldChild of type
Node-
The node being replaced in the list.
Exceptions
DOMException
|
HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does
not allow children of the type of the newChild node,
or if the node to put in is one of this node's
ancestors or this node
itself. WRONG_DOCUMENT_ERR: Raised if newChild was created
from a different document than the one that created this node. NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of
the new node is readonly. NOT_FOUND_ERR: Raised if oldChild is not a child of
this node. NOT_SUPPORTED_ERR: if this node is of type Document,
this exception might be raised if the DOM implementation doesn't
support the replacement of the DocumentType child or
Element child. |
setUserData introduced in DOM Level 3-
Associate an object to a key on this node. The object can later be
retrieved from this node by calling
getUserData with the
same key.
Parameters
key of type
DOMString-
The key to associate the object to.
data of type
DOMUserData-
The object to associate to the given key, or
null to
remove any existing association to that key.
handler of type
UserDataHandler-
The handler to associate to that key, or
null.
Return Value
DOMUserData
|
Returns the DOMUserData previously associated to
the given key on this node, or null if there was none. |
No Exceptions
- Interface NodeList
-
The NodeList interface provides the abstraction of an
ordered collection of nodes, without defining or constraining how this
collection is implemented. NodeList objects in the DOM are
live.
The items in the NodeList are accessible via an
integral index, starting from 0.
IDL Definition-
- Attributes
length of type unsigned long, readonly- The number of nodes in the list. The range of valid child node indices
is 0 to
length-1 inclusive.
- Methods
item-
Returns the
indexth item in the collection. If
index is greater than or equal to the number of nodes in
the list, this returns
null.
Parameters
index of type
unsigned long-
Index into the collection.
Return Value
Node
|
The node at the indexth position in the
NodeList, or null if that is not a valid
index. |
No Exceptions
- Interface NamedNodeMap
-
Objects implementing the NamedNodeMap interface are used to
represent collections of nodes that can be accessed by name. Note that
NamedNodeMap does not inherit from NodeList;
NamedNodeMaps are not maintained in any particular
order. Objects contained in an object implementing
NamedNodeMap may also be accessed by an ordinal index, but
this is simply to allow convenient enumeration of the contents of a
NamedNodeMap, and does not imply that the DOM specifies an
order to these Nodes.
NamedNodeMap objects in the DOM are
live.
IDL Definition-
- Attributes
length of type unsigned long, readonly- The number of nodes in this map. The range of valid child node indices
is
0 to length-1 inclusive.
- Methods
getNamedItem-
Retrieves a node specified by name.
Parameters
name of type
DOMString-
The
nodeName of a node to retrieve.
Return Value
Node
|
A Node (of any type) with the specified
nodeName, or null if it does not identify
any node in this map. |
No Exceptions
getNamedItemNS introduced in DOM Level 2-
Retrieves a node specified by local name and namespace URI.
Per [
XML Namespaces], applications must use the value null
as the namespaceURI parameter for methods if they wish to have no
namespace.
Return Value
Node
|
A Node (of any type) with the specified local name and
namespace URI, or null if they do not identify any node
in this map. |
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
item-
Returns the
indexth item in the map. If
index is greater than or equal to the number of nodes in
this map, this returns
null.
Parameters
index of type
unsigned long-
Index into this map.
Return Value
Node
|
The node at the indexth position in the map, or
null if that is not a valid index. |
No Exceptions
removeNamedItem-
Removes a node specified by name. When this map contains the
attributes attached to an element, if the removed attribute is known to
have a default value, an attribute immediately appears containing the
default value as well as the corresponding namespace URI, local name,
and prefix when applicable.
Parameters
name of type
DOMString-
The
nodeName of the node to remove.
Return Value
Node
|
The node removed from this map if a node with such a name
exists. |
Exceptions
DOMException
|
NOT_FOUND_ERR: Raised if there is no node named name
in this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. |
removeNamedItemNS introduced in DOM Level 2-
Removes a node specified by local name and namespace URI. A removed
attribute may be known to have a default value when this map contains
the attributes attached to an element, as returned by the attributes
attribute of the
Node interface. If so, an attribute
immediately appears containing the default value as well as the
corresponding namespace URI, local name, and prefix when
applicable.
Per [
XML Namespaces], applications must use the value null
as the namespaceURI parameter for methods if they wish to have no
namespace.
Return Value
Node
|
The node removed from this map if a node with such a local name and
namespace URI exists. |
Exceptions
DOMException
|
NOT_FOUND_ERR: Raised if there is no node with the specified
namespaceURI and localName in this
map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
setNamedItem-
Adds a node using its
nodeName attribute. If a node with
that name is already present in this map, it is replaced by the new
one. Replacing a node by itself has no effect.
As the
nodeName attribute is used to derive the name
which the node must be stored under, multiple nodes of certain types
(those that have a "special" string value) cannot be stored as the
names would clash. This is seen as preferable to allowing nodes to be
aliased.
Parameters
arg of type
Node-
A node to store in this map. The node will later be accessible
using the value of its
nodeName attribute.
Return Value
Node
|
If the new Node replaces an existing node the replaced
Node is returned, otherwise null is
returned. |
Exceptions
DOMException
|
WRONG_DOCUMENT_ERR: Raised if arg was created from a
different document than the one that created this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. INUSE_ATTRIBUTE_ERR: Raised if arg is an
Attr that is already an attribute of another
Element object. The DOM user must explicitly clone
Attr nodes to re-use them in other elements. HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node
doesn't belong in this NamedNodeMap. Examples would include trying
to insert something other than an Attr node into an Element's map
of attributes, or a non-Entity node into the DocumentType's map of
Entities. |
setNamedItemNS introduced in DOM Level 2-
Adds a node using its
namespaceURI and
localName. If a node with that namespace URI and that
local name is already present in this map, it is replaced by the new
one. Replacing a node by itself has no effect.
Per [
XML Namespaces], applications must use the value null
as the namespaceURI parameter for methods if they wish to have no
namespace.
Parameters
arg of type
Node-
A node to store in this map. The node will later be accessible
using the value of its
namespaceURI and
localName attributes.
Return Value
Node
|
If the new Node replaces an existing node the replaced
Node is returned, otherwise null is
returned. |
Exceptions
DOMException
|
WRONG_DOCUMENT_ERR: Raised if arg was created from a
different document than the one that created this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. INUSE_ATTRIBUTE_ERR: Raised if arg is an
Attr that is already an attribute of another
Element object. The DOM user must explicitly clone
Attr nodes to re-use them in other elements. HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node
doesn't belong in this NamedNodeMap. Examples would include trying
to insert something other than an Attr node into an Element's map
of attributes, or a non-Entity node into the DocumentType's map of
Entities. NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
- Interface CharacterData
-
The CharacterData interface extends Node with a set of
attributes and methods for accessing character data in the DOM. For
clarity this set is defined here rather than on each object that uses
these attributes and methods. No DOM objects correspond directly to
CharacterData, though Text and others do
inherit the interface from it. All offsets in this
interface start from 0.
As explained in the DOMString interface, text strings
in the DOM are represented in UTF-16, i.e. as a sequence of 16-bit
units. In the following, the term 16-bit
units is used whenever necessary to indicate that indexing on
CharacterData is done in 16-bit units.
IDL Definition-
- Attributes
data of type DOMString- The character data of the node that implements this interface. The DOM
implementation may not put arbitrary limits on the amount of data that
may be stored in a
CharacterData node. However,
implementation limits may mean that the entirety of a node's data may
not fit into a single DOMString. In such cases, the user
may call substringData to retrieve the data in
appropriately sized pieces.
Exceptions on setting
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. |
Exceptions on retrieval
DOMException
|
DOMSTRING_SIZE_ERR: Raised when it would return more characters
than fit in a DOMString variable on the implementation
platform. |
length of type unsigned long, readonly- The number of 16-bit units
that are available through
data and the
substringData method below. This may have the value zero,
i.e., CharacterData nodes may be empty.
- Methods
appendData-
Append the string to the end of the character data of the node. Upon
success,
data provides access to the concatenation of
data and the
DOMString specified.
Exceptions
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
No Return Value
deleteData-
Remove a range of
16-bit units
from the node. Upon success,
data and
length
reflect the change.
Parameters
offset of type
unsigned long-
The offset from which to start removing.
count of type
unsigned long-
The number of 16-bit units to delete. If the sum of
offset and count exceeds
length then all 16-bit units from offset
to the end of the data are deleted.
Exceptions
DOMException
|
INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data, or if the specified count is
negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
No Return Value
insertData-
Insert a string at the specified
16-bit
unit offset.
Parameters
offset of type
unsigned long-
The character offset at which to insert.
arg of type
DOMString-
The
DOMString to insert.
Exceptions
DOMException
|
INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
No Return Value
replaceData-
Replace the characters starting at the specified
16-bit unit offset with the
specified string.
Parameters
offset of type
unsigned long-
The offset from which to start replacing.
count of type
unsigned long-
The number of 16-bit units to replace. If the sum of
offset and count exceeds
length, then all 16-bit units to the end of the data
are replaced; (i.e., the effect is the same as a
remove method call with the same range, followed by an
append method invocation).
arg of type
DOMString-
The
DOMString with which the range must be
replaced.
Exceptions
DOMException
|
INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data, or if the specified count is
negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
No Return Value
substringData-
Extracts a range of data from the node.
Parameters
offset of type
unsigned long-
Start offset of substring to extract.
count of type
unsigned long-
The number of 16-bit units to extract.
Return Value
DOMString
|
The specified substring. If the sum of offset and
count exceeds the length, then all 16-bit
units to the end of the data are returned. |
Exceptions
DOMException
|
INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data, or if the specified count is
negative. DOMSTRING_SIZE_ERR: Raised if the specified range of text does not
fit into a DOMString. |
- Interface Attr
-
The Attr interface represents an attribute in an
Element object. Typically the allowable values for the
attribute are defined in a schema associated with the document.
Attr objects inherit the Node interface, but
since they are not actually child nodes of the element they describe, the
DOM does not consider them part of the document tree. Thus, the
Node attributes parentNode,
previousSibling, and nextSibling have a
null value for Attr objects. The DOM takes the
view that attributes are properties of elements rather than having a
separate identity from the elements they are associated with; this should
make it more efficient to implement such features as default attributes
associated with all elements of a given type. Furthermore,
Attr nodes may not be immediate children of a
DocumentFragment. However, they can be associated with
Element nodes contained within a
DocumentFragment. In short, users and implementors of the
DOM need to be aware that Attr nodes have some things in
common with other objects inheriting the Node interface, but
they also are quite distinct.
The attribute's effective value is determined as follows: if this
attribute has been explicitly assigned any value, that value is the
attribute's effective value; otherwise, if there is a declaration for
this attribute, and that declaration includes a default value, then that
default value is the attribute's effective value; otherwise, the
attribute does not exist on this element in the structure model until it
has been explicitly added. Note that the Node.nodeValue
attribute on the Attr instance can also be used to retrieve
the string version of the attribute's value(s).
If the attribute was not explicitly given a value in the instance
document but has a default value provided by the schema associated
with the document, an attribute node will be created with
specified set to false. Removing
attribute nodes for which a default value is defined in the schema
generates a new attribute node with the default value and
specified set to false. If validation
occurred while invoking Document.normalizeDocument(),
attribute nodes with specified equals to
false are recomputed according to the default
attribute values provided by the schema. If no default value is
associate with this attribute in the schema, the attribute node is
discarded.
In XML, where the value of an attribute can contain entity references,
the child nodes of the Attr node may be either
Text or EntityReference nodes (when these are
in use; see the description of EntityReference for
discussion).
The DOM Core represents all attribute values as simple strings,
even if the DTD or schema associated with the document declares
them of some specific type such as tokenized.
The way attribute value normalization is performed by the DOM
implementation depends on how much the implementation knows about
the schema in use. Typically, the value and
nodeValue attributes of an Attr node
initially returns the normalized value given by the parser. It is
also the case after Document.normalizeDocument() is
called (assuming the right options have been set). But this may
not be the case after mutation, independently of whether the
mutation is performed by setting the string value directly or by
changing the Attr child nodes. In particular, this is
true when character entity references are involved, given that
they are not represented in the DOM and they impact attribute
value normalization. On the other hand, if the implementation
knows about the schema in use when the attribute value is changed,
and it is of a different type than CDATA, it may normalize it
again at that time. This is especially true of specialized DOM
implementations, such as SVG DOM implementations, which store
attribute values in an internal form different from a string.
The following table gives some examples of
the relations between the attribute value in the original document
(parsed attribute), the value as exposed in the DOM, and the
serialization of the value:
| Examples | Parsed attribute value | Initial Attr.value | Serialized attribute value |
|
Character reference |
|
|
|
|
Built-in character entity |
|
|
|
|
Literal newline between |
|
|
|
|
Normalized newline between |
|
|
|
Entity e with literal newline |
<!ENTITY e
'... ...'>
[...]>
"x=5&e;y=6"
|
Dependent on Implementation and Load Options |
Dependent on Implementation and Load/Save Options |
IDL Definition-
- Attributes
name of type DOMString, readonly- Returns the name of this attribute.
ownerElement of type Element, readonly, introduced in DOM Level 2- The
Element node this attribute is attached to or
null if this attribute is not in use.
schemaTypeInfo of type TypeInfo, readonly, introduced in DOM Level 3-
The type information associated with this attribute. While the
type information contained in this attribute is guarantee to be
correct after loading the document or invoking
Document.normalizeDocument(),
schemaTypeInfo may not be reliable if the node was
moved.
specified of type boolean, readonly-
True if this attribute was explicitly given a value
in the instance document, false otherwise. If the
application changed the value of this attribute node (even if it
ends up having the same value as the default value) then it is
set to true. The implementation may handle
attributes with default values from other schemas similarly but
applications should use Document.normalizeDocument()
to guarantee this information is up-to-date.
value of type DOMString- On retrieval, the value of the attribute is returned as a
string. Character and general entity references are replaced with their
values. See also the method
getAttribute on the
Element interface.
On setting, this creates a Text node with the unparsed
contents of the string, i.e. any characters that an XML processor would
recognize as markup are instead treated as literal text.
See also the method Element.setAttribute().
Some specialized implementations, such as some [SVG 1.0] implementations, may do
normalization automatically, even after mutation; in such case,
the value on retrieval may differ from the value on setting.
Exceptions on setting
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. |
- Methods
isId introduced in DOM Level 3-
Returns whether this attribute is known to be of type ID
(i.e. to contain an identifier for its owner element) or not.
When it is and its value is unique, the
ownerElement of this attribute can be retrieved
using the method
Document.getElementById. The
implementation could use several ways to determine if an
attribute node is known to contain an identifier:
If validation occurred while invoking
Document.normalizeDocument(), all
user-determined ID attributes are reset and all
attribute nodes ID information are then reevaluated in
accordance to the schema used. As a consequence, if the
Attr.schemaTypeInfo attribute contains an ID type,
isId will always return true.
Return Value
boolean
|
true if this attribute is of type ID,
false otherwise.
|
No Parameters
No Exceptions
- Interface Element
-
The Element interface represents an
element in an HTML or XML
document. Elements may have attributes associated with them; since the
Element interface inherits from Node, the
generic Node interface attribute attributes may
be used to retrieve the set of all attributes for an element. There are
methods on the Element interface to retrieve either an
Attr object by name or an attribute value by name. In XML,
where an attribute value may contain entity references, an
Attr object should be retrieved to examine the possibly
fairly complex sub-tree representing the attribute value. On the other
hand, in HTML, where all attributes have simple string values, methods to
directly access an attribute value can safely be used as a
convenience.
Note: In DOM Level 2, the method normalize is inherited from
the Node interface where it was moved.
IDL Definition-
interface Element : Node {
readonly attribute DOMString tagName;
DOMString getAttribute(in DOMString name);
void setAttribute(in DOMString name,
in DOMString value)
raises(DOMException);
void removeAttribute(in DOMString name)
raises(DOMException);
Attr getAttributeNode(in DOMString name);
Attr setAttributeNode(in Attr newAttr)
raises(DOMException);
Attr removeAttributeNode(in Attr oldAttr)
raises(DOMException);
NodeList getElementsByTagName(in DOMString name);
// Introduced in DOM Level 2:
DOMString getAttributeNS(in DOMString namespaceURI,
in DOMString localName)
raises(DOMException);
// Introduced in DOM Level 2:
void setAttributeNS(in DOMString namespaceURI,
in DOMString qualifiedName,
in DOMString value)
raises(DOMException);
// Introduced in DOM Level 2:
void removeAttributeNS(in DOMString namespaceURI,
in DOMString localName)
raises(DOMException);
// Introduced in DOM Level 2:
Attr getAttributeNodeNS(in DOMString namespaceURI,
in DOMString localName)
raises(DOMException);
// Introduced in DOM Level 2:
Attr setAttributeNodeNS(in Attr newAttr)
raises(DOMException);
// Introduced in DOM Level 2:
NodeList getElementsByTagNameNS(in DOMString namespaceURI,
in DOMString localName)
raises(DOMException);
// Introduced in DOM Level 2:
boolean hasAttribute(in DOMString name);
// Introduced in DOM Level 2:
boolean hasAttributeNS(in DOMString namespaceURI,
in DOMString localName)
raises(DOMException);
// Introduced in DOM Level 3:
readonly attribute TypeInfo schemaTypeInfo;
// Introduced in DOM Level 3:
void setIdAttribute(in DOMString name,
in boolean isId)
raises(DOMException);
// Introduced in DOM Level 3:
void setIdAttributeNS(in DOMString namespaceURI,
in DOMString localName,
in boolean isId)
raises(DOMException);
// Introduced in DOM Level 3:
void setIdAttributeNode(in Attr idAttr,
in boolean isId)
raises(DOMException);
};
- Attributes
schemaTypeInfo of type TypeInfo, readonly, introduced in DOM Level 3-
The type information associated with this element.
tagName of type DOMString, readonly- The name of the element. For example, in:
<elementExample id="demo">
...
</elementExample> ,
tagName has the value "elementExample". Note
that this is case-preserving in XML, as are all of the operations of
the DOM. The HTML DOM returns the tagName of an HTML
element in the canonical uppercase form, regardless of the case in the
source HTML document.
- Methods
getAttribute-
Retrieves an attribute value by name.
Parameters
name of type
DOMString-
The name of the attribute to retrieve.
Return Value
DOMString
|
The Attr value as a string, or the empty string if that
attribute does not have a specified or default value. |
No Exceptions
getAttributeNS introduced in DOM Level 2-
Retrieves an attribute value by local name and namespace URI.
Per [
XML Namespaces], applications must use the value
null
as the
namespaceURI parameter for methods if they wish to have no
namespace.
Return Value
DOMString
|
The Attr value as a string, or the empty string if that
attribute does not have a specified or default value. |
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
getAttributeNode-
Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI, use
the
getAttributeNodeNS method.
Parameters
name of type
DOMString-
The name (
nodeName) of the attribute to retrieve.
Return Value
Attr
|
The Attr node with the specified name
(nodeName) or null if there is no such
attribute. |
No Exceptions
getAttributeNodeNS introduced in DOM Level 2-
Retrieves an
Attr node by local name and namespace
URI.
Per [
XML Namespaces], applications must use the value
null
as the
namespaceURI parameter for methods if they wish to have no
namespace.
Return Value
Attr
|
The Attr node with the specified attribute local name
and namespace URI or null if there is no such
attribute. |
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
getElementsByTagName-
Returns a
NodeList of all
descendant Elements
with a given tag name, in
document
order.
Parameters
name of type
DOMString-
The name of the tag to match on. The special value "*" matches all
tags.
Return Value
NodeList
|
A list of matching Element nodes. |
No Exceptions
getElementsByTagNameNS introduced in DOM Level 2-
Returns a
NodeList of all the
descendant Elements
with a given local name and namespace URI in
document order.
Parameters
namespaceURI of type
DOMString-
The namespace URI of the
elements to match on. The special value "*" matches all
namespaces.
localName of type
DOMString-
The local name of the
elements to match on. The special value "*" matches all local
names.
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
hasAttribute introduced in DOM Level 2-
Returns
true when an attribute with a given name is
specified on this element or has a default value,
false
otherwise.
Parameters
name of type
DOMString-
The name of the attribute to look for.
Return Value
boolean
|
true if an attribute with the given name is specified
on this element or has a default value, false
otherwise. |
No Exceptions
hasAttributeNS introduced in DOM Level 2-
Returns
true when an attribute with a given local name
and namespace URI is specified on this element or has a default value,
false otherwise.
Per [
XML Namespaces], applications must use the value
null
as the
namespaceURI parameter for methods if they wish to have no
namespace.
Return Value
boolean
|
true if an attribute with the given local name and
namespace URI is specified or has a default value on this element,
false otherwise. |
Exceptions
DOMException
|
NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
removeAttribute-
Removes an attribute by name. If a default value for the removed
attribute is defined in the DTD, a new attribute immediately appears
with the default value as well as the corresponding namespace URI,
local name, and prefix when applicable. The implementation may handle
default values from other schemas similarly but applications should use
Document.normalizeDocument() to guarantee this information is up-to-date.
If no attribute with this name is found, this method has no
effect.
To remove an attribute by local name and namespace URI, use the
removeAttributeNS method.
Parameters
name of type
DOMString-
The name of the attribute to remove.
Exceptions
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
No Return Value
removeAttributeNS introduced in DOM Level 2-
Removes an attribute by local name and namespace URI. If a default
value for the removed attribute is defined in the DTD, a new attribute
immediately appears with the default value as well as the corresponding
namespace URI, local name, and prefix when applicable. The
implementation may handle default values from other schemas similarly
but applications should use
Document.normalizeDocument() to guarantee this
information is up-to-date.
If no attribute with this local name and namespace URI is found, this
method has no effect.
Per [
XML Namespaces], applications must use the value
null
as the
namespaceURI parameter for methods if they wish to have no
namespace.
Exceptions
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
No Return Value
removeAttributeNode-
Removes the specified attribute node. If a default value for the
removed
Attr node is defined in the DTD, a new node
immediately appears with the default value as well as the corresponding
namespace URI, local name, and prefix when applicable. The
implementation may handle default values from other schemas similarly
but applications should use
Document.normalizeDocument() to guarantee this
information is up-to-date.
Parameters
oldAttr of type
Attr-
The
Attr node to remove from the attribute list.
Exceptions
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if oldAttr is not an attribute
of the element. |
setAttribute-
Adds a new attribute. If an attribute with that name is already
present in the element, its value is changed to be that of the value
parameter. This value is a simple string; it is not parsed as it is
being set. So any markup (such as syntax to be recognized as an entity
reference) is treated as literal text, and needs to be appropriately
escaped by the implementation when it is written out. In order to
assign an attribute value that contains entity references, the user
must create an
Attr node plus any
Text and
EntityReference nodes, build the appropriate subtree, and
use
setAttributeNode to assign it as the value of an
attribute.
To set an attribute with a qualified name and namespace URI, use the
setAttributeNS method.
Parameters
name of type
DOMString-
The name of the attribute to create or alter.
value of type
DOMString-
Value to set in string form.
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character according to the XML version in use
specified in the Document.xmlVersion attribute. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
No Return Value
setAttributeNS introduced in DOM Level 2-
Adds a new attribute. If an attribute with the same local name
and namespace URI is already present on the element, its prefix is
changed to be the prefix part of the
qualifiedName, and
its value is changed to be the
value parameter. This value
is a simple string; it is not parsed as it is being set. So any markup
(such as syntax to be recognized as an entity reference) is treated as
literal text, and needs to be appropriately escaped by the
implementation when it is written out. In order to assign an attribute
value that contains entity references, the user must create an
Attr node plus any
Text and
EntityReference nodes, build the appropriate subtree, and
use
setAttributeNodeNS or
setAttributeNode to
assign it as the value of an attribute.
Per [
XML Namespaces], applications must use the value
null
as the
namespaceURI parameter for methods if they wish to have no
namespace.
Exceptions
DOMException
|
INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character according to the XML version in use
specified in the Document.xmlVersion attribute. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NAMESPACE_ERR: Raised if the qualifiedName is
malformed per the Namespaces in XML specification, if the
qualifiedName has a prefix and the
namespaceURI is null, if the
qualifiedName has a prefix that is "xml" and the
namespaceURI is different from
"http://www.w3.org/XML/1998/namespace", if the
qualifiedName or its prefix is "xmlns" and the
namespaceURI is different from
"http://www.w3.org/2000/xmlns/", or if the
namespaceURI is
"http://www.w3.org/2000/xmlns/" and neither the
qualifiedName nor its prefix is "xmlns". NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
No Return Value
setAttributeNode-
Adds a new attribute node. If an attribute with that name
(
nodeName) is already present in the element, it is
replaced by the new one. Replacing an attribute node by itself has no
effect.
To add a new attribute node with a qualified name and namespace URI,
use the
setAttributeNodeNS method.
Parameters
newAttr of type
Attr-
The
Attr node to add to the attribute list.
Return Value
Attr
|
If the newAttr attribute replaces an existing
attribute, the replaced Attr node is returned, otherwise
null is returned. |
Exceptions
DOMException
|
WRONG_DOCUMENT_ERR: Raised if newAttr was created
from a different document than the one that created the
element. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an
attribute of another Element object. The DOM user must
explicitly clone Attr nodes to re-use them in other
elements. |
setAttributeNodeNS introduced in DOM Level 2-
Adds a new attribute. If an attribute with that local name and that
namespace URI is already present in the element, it is replaced by the
new one. Replacing an attribute node by itself has no effect.
Per [
XML Namespaces], applications must use the value
null
as the
namespaceURI parameter for methods if they wish to have no
namespace.
Parameters
newAttr of type
Attr-
The
Attr node to add to the attribute list.
Return Value
Attr
|
If the newAttr attribute replaces an existing attribute
with the same local name and
namespace URI, the replaced
Attr node is returned, otherwise null is
returned. |
Exceptions
DOMException
|
WRONG_DOCUMENT_ERR: Raised if newAttr was created
from a different document than the one that created the
element. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an
attribute of another Element object. The DOM user
must explicitly clone Attr nodes to re-use them in
other elements. NOT_SUPPORTED_ERR: May be raised if the implementation does
not support the feature "XML" and the language exposed
through the Document does not support XML Namespaces (such
as [HTML 4.01]).
|
setIdAttribute introduced in DOM Level 3-
Declares the attribute specified by name to be of type ID,
i.e. the
Attr node becomes a
user-determined
ID attribute and its method
Attr.isId() will
return
true. Note, however, that this simply
affects the method
Attr.isId() of the
Attr node and does not change any schema that may
be in use, in particular this does not affect the
Attr.schemaTypeInfo of the specified
Attr node.
To specify an attribute by local name and namespace URI, use the
setIdAttributeNS method.
Parameters
name of type
DOMString-
The name of the attribute.
isId of type
boolean-
Whether the attribute is a of type ID.
Exceptions
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if the specified node is not an attribute
of this element. |
No Return Value
setIdAttributeNS introduced in DOM Level 3-
Declares the attribute specified by local name and namespace URI
to be of type ID, i.e. the
Attr node becomes a
user-determined ID attribute and its method
Attr.isId() will return
true. Note,
however, that this simply affects the method
Attr.isId() of the
Attr node and does
not change any schema that may be in use, in particular this does not
affect the
Attr.schemaTypeInfo of the specified
Attr node.
Exceptions
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if the specified node is not an attribute
of this element. |
No Return Value
setIdAttributeNode introduced in DOM Level 3-
Declares the attribute specified by node to be of type ID,
i.e. the
Attr node becomes a
user-determined
ID attribute and its method
Attr.isId() will
return
true. Note, however, that this simply
affects the method
Attr.isId() of the
Attr node and does not change any schema that may
be in use, in particular this does not affect the
Attr.schemaTypeInfo of the specified
Attr node.
Parameters
idAttr of type
Attr-
The attribute node.
isId of type
boolean-
Whether the attribute is a of type ID.
Exceptions
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if the specified node is not an attribute
of this element. |
No Return Value
- Interface Text
-
The Text interface inherits from CharacterData
and represents the textual content (termed
character data in XML) of
an Element or Attr. If there is no markup
inside an element's content, the text is contained in a single object
implementing the Text interface that is the only child of
the element. If there is markup, it is parsed into the
information items (elements,
comments, etc.) and Text nodes that form the list of
children of the element.
When a document is first made available via the DOM, there is only one
Text node for each block of text. Users may create adjacent
Text nodes that represent the contents of a given element
without any intervening markup, but should be aware that there is no way
to represent the separations between these nodes in XML or HTML, so they
will not (in general) persist between DOM editing sessions. The
Node.normalize() method merges any such
adjacent Text objects into a single node for each block of
text.
No lexical check is done on the content of a Text
node and, depending on its position in the document, some
characters must be escaped during serialization using character
references; e.g. the characters "<&" if
the textual content is part of an element or of an attribute, the
character sequence "]]>" when part of an element, the quotation
mark character " or the apostrophe character ' when part of an
attribute. If the Text node is a direct child of the
Document node, white spaces, as defined per section
2.3 of [XML 1.0], are the only characters allowed in the
content and the presence of other characters must generate a fatal
error during serialization.
IDL Definition-
- Attributes
wholeText of type DOMString, readonly, introduced in DOM Level 3- Returns all text of
Text nodes logically-adjacent text
nodes to this node, concatenated in document order.
For instance, in the example below wholeText on the
Text node that contains "bar" returns "barfoo", while on
the Text node that contains "foo" it returns "foo".
- Methods
isWhitespaceInElementContent introduced in DOM Level 3-
Returns whether this text node contains whitespace in element content,
often abusively called "ignorable whitespace". The text node is
determined to contain whitespace in element content during the
load of the document or if validation occurs while using
Document.normalizeDocument().
Return Value
boolean
|
Returns true if this text node contains whitespace in
element content, false otherwise. |
No Parameters
No Exceptions
replaceWholeText introduced in DOM Level 3-
Substitutes the specified text for the text of the current node and
all
logically-adjacent
text nodes.
This method returns the node in the hierarchy which received the
replacement text, which is null if the text was empty or is the current
node if the current node is not
read-only or otherwise is a new node of
the same type as the current node inserted at the site of the
replacement. All
logically-adjacent text
nodes are removed including the current node unless it was the
recipient of the replacement text.
For instance, in the above example calling
replaceWholeText on the
Text node that
contains "bar" with "yo" in argument results in the following:
Where the nodes to be removed are read-only descendants of an
EntityReference, the
EntityReference must be
removed instead of the read-only nodes. If any
EntityReference to be removed has descendants that are not
EntityReference,
Text, or
CDATASection nodes, the
replaceWholeText method
must fail before performing any modification of the document, raising a
DOMException with the code
NO_MODIFICATION_ALLOWED_ERR.
For instance, in the example below calling
replaceWholeText on the
Text node that
contains "bar" fails, because the
EntityReference node
"ent" contains an
Element node which cannot be removed.
Parameters
content of type
DOMString-
The content of the replacing
Text node.
Return Value
Text
|
The Text node created with the specified content. |
Exceptions
DOMException
|
NO_MODIFICATION_ALLOWED_ERR: Raised if one of the
Text nodes being replaced is readonly. |
splitText-
Breaks this node into two nodes at the specified
offset,
keeping both in the tree as
siblings. After being split, this
node will contain all the content up to the
offset
point. A new node of the same type, which contains all the content at
and after the
offset point, is returned. If the original
node had a parent node, the new node is inserted as the next
sibling of the original node. When
the
offset is equal to the length of this node, the new
node has no data.
Parameters
offset of type
unsigned long-
The 16-bit unit offset at
which to split, starting from
0.
Return Value
Text
|
The new node, of the same type as this node. |
Exceptions
DOMException
|
INDEX_SIZE_ERR: Raised if the specified offset is negative or
greater than the number of 16-bit units in data. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
- Interface Comment
-
This interface inherits from CharacterData and represents
the content of a comment, i.e., all the characters between the starting
'<!--' and ending '-->'. Note that this
is the definition of a comment in XML, and, in practice, HTML, although
some HTML tools may implement the full SGML comment structure.
No lexical check is done on the content of a comment and
it is therefore possible to have the character sequence
"--" (double-hyphen) in the content, which is illegal
in a comment per section 2.5 of [XML 1.0]. The presence
of this character sequence must generate a fatal error during
serialization.
IDL Definition-
- Interface TypeInfo (introduced in DOM Level 3)
-
The TypeInfo interface represent a type referenced
from Element or Attr nodes, specified in
the schemas associated with the
document. The type is a pair of a namespace URI and name properties,
and depends on the document's schema.
If the document's schema is an XML DTD [XML 1.0], the
values are computed as follows:
-
If this type is referenced from an
Attr node,
typeNamespace is null and
typeName represents the [attribute type]
property in the [XML Information set]. If there is
no declaration for the attribute, typeName is
null.
-
If this type is referenced from an
Element node,
the typeNamespace and typeName are
null.
If the document's schema is an XML Schema [XML Schema Part 1], the values are computed as follows using the
post-schema-validation infoset contributions (also called PSVI
contributions):
-
If the [validity] property exists AND is
"invalid" or "notKnown": the {target
namespace} and {name} properties of the declared type if
available, otherwise
null.
Note:
At the time of writing, the XML Schema specification does
not require exposing the declared type. Thus, DOM
implementations might choose not to provide type information
if validity is not valid.
-
If the [validity] property exists and is "valid":
-
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
anonymous type name.
-
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
anonymous type name.
-
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
anonymous type name.
-
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
anonymous type name.
Note:
Other schema languages are outside the scope of the W3C and
therefore should define how to represent their type systems using
TypeInfo.
IDL Definition-
- Attributes
typeName of type DOMString, readonly-
The name of a type declared for the associated element or
attribute, or
null if unknown.
typeNamespace of type DOMString, readonly-
The namespace of the type declared for the associated element or
attribute or
null if the element does not have
declaration or if no namespace information is
available.
- Interface UserDataHandler (introduced in DOM Level 3)
-
When associating an object to a key on a node using
Node.setUserData() the application can provide a handler that gets
called when the node the object is associated to is being cloned,
imported, or renamed. This can be used by the application to implement
various behaviors regarding the data it associates to the DOM nodes.
This interface defines that handler.
IDL Definition-
- Definition group OperationType
An integer indicating the type of operation being performed
on a node.
- Defined Constants
NODE_CLONED-
The node is cloned.
NODE_DELETED-
The node is deleted.
Note: This may not be supported or may not be reliable in certain
environments, such as Java, where the implementation has no real
control over when objects are actually deleted.
NODE_IMPORTED-
The node is imported.
NODE_RENAMED-
The node is renamed.
- Methods
handle-
This method is called whenever the node for which this handler is
registered is imported or cloned.
Parameters
operation of type
unsigned short-
Specifies the type of operation that is being performed on the
node.
key of type
DOMString-
Specifies the key for which this handler is being called.
data of type
DOMObject-
Specifies the data for which this handler is being called.
src of type
Node-
Specifies the node being cloned, imported, or renamed. This is
null when the node is being deleted.
dst of type
Node-
Specifies the node newly created if any, or
null.
No Return Value
No Exceptions
- Interface DOMError (introduced in DOM Level 3)
-
DOMError is an interface that describes an error.
IDL Definition-
- Definition group ErrorSeverity
An integer indicating the severity of the error.
- Defined Constants
SEVERITY_ERROR-
The severity of the error described by the
DOMError is
error
SEVERITY_FATAL_ERROR-
The severity of the error described by the
DOMError is
fatal error
SEVERITY_WARNING-
The severity of the error described by the
DOMError is
warning
- Attributes
location of type DOMLocator, readonly- The location of the error.
message of type DOMString, readonly- An implementation specific string describing the error that
occurred.
relatedData of type DOMObject, readonly-
The related
DOMError.type dependent data if any.
relatedException of type Object, readonly- The related platform dependent exception if any.
severity of type unsigned short, readonly- The severity of the error, either
SEVERITY_WARNING, SEVERITY_ERROR,
or SEVERITY_FATAL_ERROR.
type of type DOMString, readonly-
A
DOMString indicating which related data is
expected in relatedData. Users should refer to the
specification of the error in order to find its
DOMString type and relatedData
definitions if any.
Note:
As an example, Document.normalizeDocument() does
generate warnings when the "split-cdata-sections"
parameter is in use. Therefore, the method generates a
SEVERITY_WARNING with type
"cdata-section-splitted" and the first
CDATASection node in document order resulting
from the split is returned by the relatedData
attribute.
- Interface DOMErrorHandler (introduced in DOM Level 3)
-
DOMErrorHandler is a callback interface that the DOM
implementation can call when reporting errors that happens while
processing XML data, or when doing some other processing
(e.g. validating a document). A DOMErrorHandler
object can be attached to a Document using the
"error-handler"
on the DOMConfiguration interface. If more than one
error needs to be reported during an operation, the sequence and
numbers of the errors passed to the error handler are
implementation dependent.
The application that is using the DOM implementation is expected
to implement this interface.
IDL Definition-
- Methods
handleError-
This method is called on the error handler when an error occurs.
Parameters
error of type
DOMError-
The error object that describes the error. This object may
be reused by the DOM implementation across multiple calls to
the
handleError method.
Return Value
boolean
|
If the handleError method returns
true, the DOM implementation should continue as if
the error didn't happen when possible, if the method returns
false then the DOM implementation should stop the
current processing when possible.
|
No Exceptions
- Interface DOMLocator (introduced in DOM Level 3)
-
DOMLocator is an interface that describes a location
(e.g. where an error occurred).
IDL Definition-
- Attributes
columnNumber of type long, readonly- The column number this locator is pointing to, or
-1 if
there is no column number available.
lineNumber of type long, readonly- The line number this locator is pointing to, or
-1 if
there is no column number available.
offset of type long, readonly- The byte or character offset into the input source this locator is
pointing to. If the input source is a file or a byte stream then this
is the byte offset into that stream, but if the input source is a
character media then the offset is the character offset. The value is
-1 if there is no offset available.
relatedNode of type Node, readonly- The node this locator is pointing to, or
null if no node
is available.
uri of type DOMString, readonly- The URI this locator is pointing to, or
null if no URI
is available.
- Interface DOMConfiguration (introduced in DOM Level 3)
-
The DOMConfiguration interface represents the
configuration of a document and maintains a table of recognized
parameters. Using the configuration, it is possible to change
Document.normalizeDocument() behavior, such as
replacing the CDATASection nodes with
Text nodes or specifying the type of the schema that must be used when the
validation of the Document is
requested. DOMConfiguration objects are also used in
[DOM Level 3 Load and Save] in the
DOMParser and DOMSerializer interfaces.
The parameter names used by the DOMConfiguration
object are defined throughout the DOM Level 3
specifications. Names are case-insensitives. To avoid possible
conflicts, as a convention, names referring to parameters defined
outside the DOM specification should be made unique. Because
parameters are exposed as properties in the ECMAScript Language Binding, names are recommended to follow the section
"5.16 Identifiers" of [Unicode] with the addition of the character '-'
(HYPHEN-MINUS) but it is not enforced by the DOM
implementation. DOM Level 3 Core Implementations are required to
recognize all parameters defined in this specification. Some
parameter values may also be required to be supported by
the implementation. Refer to the definition of the parameter to
know if a value must be supported or not.
Note:
Parameters are similar to features and properties used in SAX2
[SAX].
The following list of parameters defined in the DOM:
"canonical-form"
true- [optional]
Canonicalize the document according to the rules specified
in [Canonical XML]. Note that this
is limited to what can be represented in the DOM. In
particular, there is no way to specify the order of the
attributes in the DOM.
This forces the following parameters to
false:
"entities",
"normalize-characters",
"cdata-sections".
This forces the following parameters to
true:
"namespaces",
"namespace-declarations",
"well-formed",
"whitespace-in-element-content".
Other parameters are not changed unless explicitly specified
in the description of the parameters.
In addition, the DocumentType node is
removed from the tree if any and superfluous namespace
declarations are removed from each element.
Note that querying this parameter with
getParameter cannot return
true unless it has been set to
true and the parameters described above are
appropriately set. false- [required] (default)
Do not canonicalize the document.
"cdata-sections"
true- [required] (default)
Keep CDATASection nodes in the document. false- [required]
Transform CDATASection nodes in the document
into Text nodes. The new Text
node is then combined with any adjacent Text
node.
"check-character-normalization"
true- [optional]
Check if the characters in the document are fully
normalized according to the rules defined in [CharModel] supplemented by the definitions of
relevant constructs from Section 2.13 of
[XML 1.1].
false- [required] (default)
Do not check if characters are normalized.
"comments"
true- [required] (default)
Keep Comment nodes in the document. false- [required]
Discard Comment nodes in the document.
"datatype-normalization"
true- [required]
Exposed schema-normalized values in the tree. Since
this parameter requires to have schema information, the
"validate"
parameter will also be set to
true. Having this parameter activated
when "validate" is false has no effect
and no schema-normalization will happen.
Note:
Since the document contains the result of the XML
1.0 processing, this parameter does not apply to
attribute value normalization as defined in section
3.3.3 of [XML 1.0] and is only meant for
schema languages
other than Document Type Definition (DTD).
false- [required] (default)
Do not perform schema normalization on the tree.
"entities"
true- [required] (default)
Keep EntityReference and Entity
nodes in the document. false- [required]
Remove all EntityReference and
Entity nodes from the document, putting
the entity expansions directly in their place.
Text nodes are normalized, as defined in
Node.normalize. Only
EntityReference nodes to non-defined
entities are kept in the document, with their
associated Entity nodes if any.
"error-handler"- [required]
Contains a DOMErrorHandler object. If an error
is encountered in the document, the implementation will call
back the DOMErrorHandler registered using this
parameter.
When called, DOMError.relatedData will contain
the closest node to where the error occurred. If the
implementation is unable to determine the node where the
error occurs, DOMError.relatedData will contain
the Document node. Mutations to the document
from within an error handler will result in implementation
dependent behavior.
"infoset"
true- [required]
Keep in the document the information defined in the
XML Information Set [XML Information set].
This forces the following parameters to
false:
"validate-if-schema",
"entities",
"datatype-normalization",
"cdata-sections".
This forces the following parameters to
true:
"namespace-declarations",
"well-formed",
"whitespace-in-element-content",
"comments", "namespaces".
Other parameters are not changed unless explicitly specified
in the description of the parameters.
Note that querying this parameter with
getParameter returns true only if
the individual parameters specified above are appropriately
set. false- Setting
infoset to false
has no effect.
"namespaces"
true- [required] (default)
Perform the namespace processing as defined in
Namespace normalization.
false- [optional]
Do not perform the namespace processing.
"namespace-declarations"
true- [required] (default)
Include namespace declaration attributes, specified or
defaulted from the schema, in the document. See
also the sections "Declaring Namespaces" in [XML Namespaces] and [XML Namespaces 1.1]. false- [required]
Discard all namespace declaration attributes. The
namespace prefixes (Node.prefix) are
retained even if this parameter is set
to false.
"normalize-characters"
true- [optional]
Fully normalize the characters in the document
according to the rules defined in [CharModel] supplemented by the definitions of
relevant constructs from Section 2.13 of
[XML 1.1].
false- [required] (default)
Do not perform character normalization.
"schema-location"- [optional]
Represent a DOMString object containing a list
of URIs, separated by whitespaces (characters matching the
nonterminal production
S defined in section 2.3 [XML 1.0]),
that represents the schemas against which validation
should occur, i.e. the current schema. The types of schemas
referenced in this list must match the type specified with
schema-type, otherwise the behavior of an
implementation is undefined.
The schemas specified using this property take precedence to
the schema information specified in the document itself. For
namespace aware schema, if a schema specified using this
property and a schema specified in the document instance
(i.e. using the schemaLocation attribute) in a
schema document (i.e. using schema import
mechanisms) share the same targetNamespace, the
schema specified by the user using this property will be
used. If two schemas specified using this property share the
same targetNamespace or have no namespace, the
behavior is implementation dependent.
If no location has been provided, this parameter is
null.
Note:
It is illegal to set the "schema-location"
parameter if the "schema-type"
parameter value is not set. It is strongly recommended
that Document.documentURI will be set so that
an implementation can successfully resolve any external
entities referenced.
"schema-type"- [optional]
Represent a DOMString object containing an
absolute URI and representing the type of the schema language used to validate a
document against. Note that no lexical checking is done on
the absolute URI.
If this parameter is not set, a default value may be
provided by the implementation, based on the schema
languages supported and on the schema language used at load
time. If no value is provided, this parameter is
null.
Note:
For XML Schema [XML Schema Part 1], applications
must use the value
"http://www.w3.org/2001/XMLSchema". For XML
DTD [XML 1.0], applications must use the value
"http://www.w3.org/TR/REC-xml". Other schema
languages are outside the scope of the W3C and therefore
should recommend an absolute URI in order to use this
method.
"split-cdata-sections"
true- [required] (default)
Split CDATA sections containing the CDATA section
termination marker ']]>'. When a CDATA section is split
a warning is issued with a
DOMError.type equals to
"cdata-sections-splitted" and
DOMError.relatedData equals to the first
CDATASection node in document order
resulting from the split. false- [required]
Signal an error if a CDATASection contains
an unrepresentable character.
"validate"
true- [optional]
Require the validation against a schema (i.e. XML schema,
DTD, any other type or representation of schema) of
the document as it is being normalized as defined by
[XML 1.0]. If validation errors are found,
or no schema was found, the error handler is
notified. Schema-normalized values will not be exposed
according to the schema in used unless the parameter
"datatype-normalization"
is true.
This parameter will reevaluate:
Note:
"validate-if-schema"
and "validate" are mutually exclusive,
setting one of them to true will set
the other one to false. Applications
should also consider setting the parameter
"well-formed" to true,
which is the default for that option, when
validating the document.
false- [required] (default)
Do not accomplish schema processing, including the
internal subset processing. Note that validation might
still happen if ""validate-if-schema"
is true.
"validate-if-schema"
true- [optional]
Enable validation only if a declaration for the
document element can be found in a schema (independently of where
it is found, i.e. XML schema, DTD, or any other type
or representation of schema). If validation is
enabled, this parameter has the same behavior as the
parameter "validate" set to
true.
Note:
"validate-if-schema" and
"validate" are mutually exclusive,
setting one of them to true will
set the other one to false.
false- [required] (default)
No schema processing should be performed if the
document has a schema, including internal subset
processing. Note that validation must still happen if
"validate"
is true.
"well-formed"
true- [required] (default)
Check if all nodes are XML well formed according
to the XML version in use in
Document.xmlVersion:
-
check if the attribute
Node.nodeName
contains invalid characters according to its node
type and generate a DOMError of type
"wf-invalid-character-in-node-name"
if necessary;
-
check if the text content inside
Attr, Element,
Comment, Text,
CDATASection nodes for invalid
characters and generate a DOMError of
type "wf-invalid-character" if
necessary;
-
check if the data inside
ProcessingInstruction nodes for
invalid characters and generate a
DOMError of type
"wf-invalid-character" if necessary;
false- [optional]
Do not check for XML well-formedness.
"whitespace-in-element-content"
true- [required] (default)
Keep all whitespaces in the document. false- [optional]
Discard all Text nodes that contain
whitespaces in element content. The implementation
is expected to use the method
Text.isWhitespaceInElementContent to
determine if a Text node should be
discarded or not.
The resolution of the system identifiers associated with entities
is done using Document.documentURI. However, when the
feature "LS" defined in [DOM Level 3 Load and Save]
is supported by the DOM implementation, the parameter
"resource-resolver" can also be used on
DOMConfiguration objects attached to
Document nodes. If this parameter is set,
Document.normalizeDocument() will invoke the entity
resolver instead of using Document.documentURI.
IDL Definition-
- Methods
canSetParameter-
Check if setting a parameter to a specific value is supported.
Parameters
name of type
DOMString-
The name of the parameter to check.
value of type
DOMUserData-
An object. if
null, the returned value is
true.
Return Value
boolean
|
true if the parameter could be successfully set
to the specified value, or false if the parameter
is not recognized or the requested value is not
supported. This does not change the current value of the
parameter itself.
|
No Exceptions
getParameter-
Return the value of a parameter if known.
Parameters
name of type
DOMString-
The name of the parameter.
Return Value
DOMUserData
|
The current object associated with the specified parameter or
null if no object has been associated or if the
parameter is not supported.
|
Exceptions
DOMException
|
NOT_FOUND_ERR: Raised when the parameter name is not
recognized.
|
setParameter-
Set the value of a parameter.
Parameters
name of type
DOMString-
The name of the parameter to set.
value of type
DOMUserData-
The new value or
null if the user wishes to
unset the parameter. While the type of the value parameter
is defined as DOMUserData, the object type must
match the type defined by the definition of the
parameter. For example, if the parameter is "error-handler", the
value must be of type DOMErrorHandler.
Exceptions
DOMException
|
NOT_FOUND_ERR: Raised when the parameter name is not
recognized.
NOT_SUPPORTED_ERR: Raised when the parameter name is
recognized but the requested value cannot be set.
TYPE_MISMATCH_ERR: Raised if the value type for this
parameter name is incompatible with the expected value type.
|
No Return Value
