-
- All Known Subinterfaces:
Attr
,CDATASection
,CharacterData
,Comment
,Document
,DocumentFragment
,DocumentType
,Element
,Entity
,EntityReference
,HTMLAnchorElement
,HTMLAppletElement
,HTMLAreaElement
,HTMLBaseElement
,HTMLBaseFontElement
,HTMLBodyElement
,HTMLBRElement
,HTMLButtonElement
,HTMLDirectoryElement
,HTMLDivElement
,HTMLDListElement
,HTMLDocument
,HTMLElement
,HTMLFieldSetElement
,HTMLFontElement
,HTMLFormElement
,HTMLFrameElement
,HTMLFrameSetElement
,HTMLHeadElement
,HTMLHeadingElement
,HTMLHRElement
,HTMLHtmlElement
,HTMLIFrameElement
,HTMLImageElement
,HTMLInputElement
,HTMLIsIndexElement
,HTMLLabelElement
,HTMLLegendElement
,HTMLLIElement
,HTMLLinkElement
,HTMLMapElement
,HTMLMenuElement
,HTMLMetaElement
,HTMLModElement
,HTMLObjectElement
,HTMLOListElement
,HTMLOptGroupElement
,HTMLOptionElement
,HTMLParagraphElement
,HTMLParamElement
,HTMLPreElement
,HTMLQuoteElement
,HTMLScriptElement
,HTMLSelectElement
,HTMLStyleElement
,HTMLTableCaptionElement
,HTMLTableCellElement
,HTMLTableColElement
,HTMLTableElement
,HTMLTableRowElement
,HTMLTableSectionElement
,HTMLTextAreaElement
,HTMLTitleElement
,HTMLUListElement
,Notation
,ProcessingInstruction
,Text
,XPathNamespace
- All Known Implementing Classes:
IIOMetadataNode
public interface Node
TheNode
interface is the primary datatype for the entire Document Object Model. It represents a single node in the document tree. While all objects implementing theNode
interface expose methods for dealing with children, not all objects implementing theNode
interface may have children. For example,Text
nodes may not have children, and adding children to such nodes results in aDOMException
being raised.The attributes
nodeName
,nodeValue
andattributes
are included as a mechanism to get at node information without casting down to the specific derived interface. In cases where there is no obvious mapping of these attributes for a specificnodeType
(e.g.,nodeValue
for anElement
orattributes
for aComment
), this returnsnull
. Note that the specialized interfaces may contain additional and more convenient mechanisms to get and set the relevant information.The values of
nodeName
,nodeValue
, andattributes
vary according to the node type as follows:Interface nodeName nodeValue attributes Attr
same as Attr.name
same as Attr.value
null
CDATASection
"#cdata-section"
same as CharacterData.data
, the content of the CDATA Sectionnull
Comment
"#comment"
same as CharacterData.data
, the content of the commentnull
Document
"#document"
null
null
DocumentFragment
"#document-fragment"
null
null
DocumentType
same as DocumentType.name
null
null
Element
same as Element.tagName
null
NamedNodeMap
Entity
entity name null
null
EntityReference
name of entity referenced null
null
Notation
notation name null
null
ProcessingInstruction
same as ProcessingInstruction.target
same as ProcessingInstruction.data
null
Text
"#text"
same as CharacterData.data
, the content of the text nodenull
See also the Document Object Model (DOM) Level 3 Core Specification.
-
-
Field Summary
Fields Modifier and Type Field Description static short
ATTRIBUTE_NODE
The node is anAttr
.static short
CDATA_SECTION_NODE
The node is aCDATASection
.static short
COMMENT_NODE
The node is aComment
.static short
DOCUMENT_FRAGMENT_NODE
The node is aDocumentFragment
.static short
DOCUMENT_NODE
The node is aDocument
.static short
DOCUMENT_POSITION_CONTAINED_BY
The node is contained by the reference node.static short
DOCUMENT_POSITION_CONTAINS
The node contains the reference node.static short
DOCUMENT_POSITION_DISCONNECTED
The two nodes are disconnected.static short
DOCUMENT_POSITION_FOLLOWING
The node follows the reference node.static short
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
The determination of preceding versus following is implementation-specific.static short
DOCUMENT_POSITION_PRECEDING
The second node precedes the reference node.static short
DOCUMENT_TYPE_NODE
The node is aDocumentType
.static short
ELEMENT_NODE
The node is anElement
.static short
ENTITY_NODE
The node is anEntity
.static short
ENTITY_REFERENCE_NODE
The node is anEntityReference
.static short
NOTATION_NODE
The node is aNotation
.static short
PROCESSING_INSTRUCTION_NODE
The node is aProcessingInstruction
.static short
TEXT_NODE
The node is aText
node.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Node
appendChild(Node newChild)
Adds the nodenewChild
to the end of the list of children of this node.Node
cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.short
compareDocumentPosition(Node other)
Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.NamedNodeMap
getAttributes()
ANamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise.String
getBaseURI()
The absolute base URI of this node ornull
if the implementation wasn't able to obtain an absolute URI.NodeList
getChildNodes()
ANodeList
that contains all children of this node.Object
getFeature(String feature, String version)
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .Node
getFirstChild()
The first child of this node.Node
getLastChild()
The last child of this node.String
getLocalName()
Returns the local part of the qualified name of this node.String
getNamespaceURI()
The namespace URI of this node, ornull
if it is unspecified (see ).Node
getNextSibling()
The node immediately following this node.String
getNodeName()
The name of this node, depending on its type; see the table above.short
getNodeType()
A code representing the type of the underlying object, as defined above.String
getNodeValue()
The value of this node, depending on its type; see the table above.Document
getOwnerDocument()
TheDocument
object associated with this node.Node
getParentNode()
The parent of this node.String
getPrefix()
The namespace prefix of this node, ornull
if it is unspecified.Node
getPreviousSibling()
The node immediately preceding this node.String
getTextContent()
This attribute returns the text content of this node and its descendants.Object
getUserData(String key)
Retrieves the object associated to a key on a this node.boolean
hasAttributes()
Returns whether this node (if it is an element) has any attributes.boolean
hasChildNodes()
Returns whether this node has any children.Node
insertBefore(Node newChild, Node refChild)
Inserts the nodenewChild
before the existing child noderefChild
.boolean
isDefaultNamespace(String namespaceURI)
This method checks if the specifiednamespaceURI
is the default namespace or not.boolean
isEqualNode(Node arg)
Tests whether two nodes are equal.boolean
isSameNode(Node other)
Returns whether this node is the same node as the given one.boolean
isSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .String
lookupNamespaceURI(String prefix)
Look up the namespace URI associated to the given prefix, starting from this node.String
lookupPrefix(String namespaceURI)
Look up the prefix associated to the given namespace URI, starting from this node.void
normalize()
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
nodes.Node
removeChild(Node oldChild)
Removes the child node indicated byoldChild
from the list of children, and returns it.Node
replaceChild(Node newChild, Node oldChild)
Replaces the child nodeoldChild
withnewChild
in the list of children, and returns theoldChild
node.void
setNodeValue(String nodeValue)
The value of this node, depending on its type; see the table above.void
setPrefix(String prefix)
The namespace prefix of this node, ornull
if it is unspecified.void
setTextContent(String textContent)
This attribute returns the text content of this node and its descendants.Object
setUserData(String key, Object data, UserDataHandler handler)
Associate an object to a key on this node.
-
-
-
Field Detail
-
ELEMENT_NODE
static final short ELEMENT_NODE
The node is anElement
.- See Also:
- Constant Field Values
-
ATTRIBUTE_NODE
static final short ATTRIBUTE_NODE
The node is anAttr
.- See Also:
- Constant Field Values
-
TEXT_NODE
static final short TEXT_NODE
The node is aText
node.- See Also:
- Constant Field Values
-
CDATA_SECTION_NODE
static final short CDATA_SECTION_NODE
The node is aCDATASection
.- See Also:
- Constant Field Values
-
ENTITY_REFERENCE_NODE
static final short ENTITY_REFERENCE_NODE
The node is anEntityReference
.- See Also:
- Constant Field Values
-
ENTITY_NODE
static final short ENTITY_NODE
The node is anEntity
.- See Also:
- Constant Field Values
-
PROCESSING_INSTRUCTION_NODE
static final short PROCESSING_INSTRUCTION_NODE
The node is aProcessingInstruction
.- See Also:
- Constant Field Values
-
COMMENT_NODE
static final short COMMENT_NODE
The node is aComment
.- See Also:
- Constant Field Values
-
DOCUMENT_NODE
static final short DOCUMENT_NODE
The node is aDocument
.- See Also:
- Constant Field Values
-
DOCUMENT_TYPE_NODE
static final short DOCUMENT_TYPE_NODE
The node is aDocumentType
.- See Also:
- Constant Field Values
-
DOCUMENT_FRAGMENT_NODE
static final short DOCUMENT_FRAGMENT_NODE
The node is aDocumentFragment
.- See Also:
- Constant Field Values
-
NOTATION_NODE
static final short NOTATION_NODE
The node is aNotation
.- See Also:
- Constant Field Values
-
DOCUMENT_POSITION_DISCONNECTED
static final short DOCUMENT_POSITION_DISCONNECTED
The two nodes are disconnected. Order between disconnected nodes is always implementation-specific.- See Also:
- Constant Field Values
-
DOCUMENT_POSITION_PRECEDING
static final short DOCUMENT_POSITION_PRECEDING
The second node precedes the reference node.- See Also:
- Constant Field Values
-
DOCUMENT_POSITION_FOLLOWING
static final short DOCUMENT_POSITION_FOLLOWING
The node follows the reference node.- See Also:
- Constant Field Values
-
DOCUMENT_POSITION_CONTAINS
static final short DOCUMENT_POSITION_CONTAINS
The node contains the reference node. A node which contains is always preceding, too.- See Also:
- Constant Field Values
-
DOCUMENT_POSITION_CONTAINED_BY
static final short DOCUMENT_POSITION_CONTAINED_BY
The node is contained by the reference node. A node which is contained is always following, too.- See Also:
- Constant Field Values
-
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
static final short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
The determination of preceding versus following is implementation-specific.- See Also:
- Constant Field Values
-
-
Method Detail
-
getNodeName
String getNodeName()
The name of this node, depending on its type; see the table above.
-
getNodeValue
String getNodeValue() throws DOMException
The value of this node, depending on its type; see the table above. When it is defined to benull
, setting it has no effect, including if the node is read-only.- Throws:
DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.
-
setNodeValue
void setNodeValue(String nodeValue) throws DOMException
The value of this node, depending on its type; see the table above. When it is defined to benull
, setting it has no effect, including if the node is read-only.- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if it is not defined to benull
.
-
getNodeType
short getNodeType()
A code representing the type of the underlying object, as defined above.
-
getParentNode
Node getParentNode()
The parent of this node. All nodes, exceptAttr
,Document
,DocumentFragment
,Entity
, andNotation
may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this isnull
.
-
getChildNodes
NodeList getChildNodes()
ANodeList
that contains all children of this node. If there are no children, this is aNodeList
containing no nodes.
-
getFirstChild
Node getFirstChild()
The first child of this node. If there is no such node, this returnsnull
.
-
getLastChild
Node getLastChild()
The last child of this node. If there is no such node, this returnsnull
.
-
getPreviousSibling
Node getPreviousSibling()
The node immediately preceding this node. If there is no such node, this returnsnull
.
-
getNextSibling
Node getNextSibling()
The node immediately following this node. If there is no such node, this returnsnull
.
-
getAttributes
NamedNodeMap getAttributes()
ANamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise.
-
getOwnerDocument
Document getOwnerDocument()
TheDocument
object associated with this node. This is also theDocument
object used to create new nodes. When this node is aDocument
or aDocumentType
which is not used with anyDocument
yet, this isnull
.- Since:
- 1.4, DOM Level 2
-
insertBefore
Node insertBefore(Node newChild, Node refChild) throws DOMException
Inserts the nodenewChild
before the existing child noderefChild
. IfrefChild
isnull
, insertnewChild
at the end of the list of children.
IfnewChild
is aDocumentFragment
object, all of its children are inserted, in the same order, beforerefChild
. If thenewChild
is already in the tree, it is first removed.Note: Inserting a node before itself is implementation dependent.
- Parameters:
newChild
- The node to insert.refChild
- The reference node, i.e., the node before which the new node must be inserted.- Returns:
- The node being inserted.
- Throws:
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to insert is one of this node's ancestors or this node itself, or if this node is of typeDocument
and the DOM application attempts to insert a secondDocumentType
orElement
node.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised ifrefChild
is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of typeDocument
, this exception might be raised if the DOM implementation doesn't support the insertion of aDocumentType
orElement
node.- Since:
- 1.4, DOM Level 3
-
replaceChild
Node replaceChild(Node newChild, Node oldChild) throws DOMException
Replaces the child nodeoldChild
withnewChild
in the list of children, and returns theoldChild
node.
IfnewChild
is aDocumentFragment
object,oldChild
is replaced by all of theDocumentFragment
children, which are inserted in the same order. If thenewChild
is already in the tree, it is first removed.Note: Replacing a node with itself is implementation dependent.
- Parameters:
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.- Returns:
- The node replaced.
- Throws:
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to put in is one of this node's ancestors or this node itself, or if this node is of typeDocument
and the result of the replacement operation would add a secondDocumentType
orElement
on theDocument
node.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
NOT_FOUND_ERR: Raised ifoldChild
is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of typeDocument
, this exception might be raised if the DOM implementation doesn't support the replacement of theDocumentType
child orElement
child.- Since:
- 1.4, DOM Level 3
-
removeChild
Node removeChild(Node oldChild) throws DOMException
Removes the child node indicated byoldChild
from the list of children, and returns it.- Parameters:
oldChild
- The node being removed.- Returns:
- The node removed.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifoldChild
is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of typeDocument
, this exception might be raised if the DOM implementation doesn't support the removal of theDocumentType
child or theElement
child.- Since:
- 1.4, DOM Level 3
-
appendChild
Node appendChild(Node newChild) throws DOMException
Adds the nodenewChild
to the end of the list of children of this node. If thenewChild
is already in the tree, it is first removed.- Parameters:
newChild
- The node to add.If it is aDocumentFragment
object, the entire contents of the document fragment are moved into the child list of this node- Returns:
- The node added.
- Throws:
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to append is one of this node's ancestors or this node itself, or if this node is of typeDocument
and the DOM application attempts to append a secondDocumentType
orElement
node.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly.
NOT_SUPPORTED_ERR: if thenewChild
node is a child of theDocument
node, this exception might be raised if the DOM implementation doesn't support the removal of theDocumentType
child orElement
child.- Since:
- 1.4, DOM Level 3
-
hasChildNodes
boolean hasChildNodes()
Returns whether this node has any children.- Returns:
- Returns
true
if this node has any children,false
otherwise.
-
cloneNode
Node cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode
isnull
) and no user data. User data associated to the imported node is not carried over. However, if anyUserDataHandlers
has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
Cloning anElement
copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any children it contains unless it is a deep clone. This includes text contained in an theElement
since the text is contained in a childText
node. Cloning anAttr
directly, as opposed to be cloned as part of anElement
cloning operation, returns a specified attribute (specified
istrue
). Cloning anAttr
always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning anEntityReference
automatically constructs its subtree if a correspondingEntity
is available, no matter whether this is a deep clone or not. Cloning any other type of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy, but the children of anEntityReference
clone are readonly . In addition, clones of unspecifiedAttr
nodes are specified. And, cloningDocument
,DocumentType
,Entity
, andNotation
nodes is implementation dependent.- Parameters:
deep
- Iftrue
, recursively clone the subtree under the specified node; iffalse
, clone only the node itself (and its attributes, if it is anElement
).- Returns:
- The duplicate node.
-
normalize
void normalize()
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of theDOMConfiguration
object attached to theNode.ownerDocument
istrue
, this method will also fully normalize the characters of theText
nodes.Note: In cases where the document contains
CDATASections
, the normalize operation alone may not be sufficient, since XPointers do not differentiate betweenText
nodes andCDATASection
nodes.- Since:
- 1.4, DOM Level 3
-
isSupported
boolean isSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .- Parameters:
feature
- The name of the feature to test.version
- This is the version number of the feature to test.- Returns:
- Returns
true
if the specified feature is supported on this node,false
otherwise. - Since:
- 1.4, DOM Level 2
-
getNamespaceURI
String getNamespaceURI()
The namespace URI of this node, ornull
if it is unspecified (see ).
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such asDocument.createElement()
, this is alwaysnull
.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.
- Since:
- 1.4, DOM Level 2
-
getPrefix
String getPrefix()
The namespace prefix of this node, ornull
if it is unspecified. When it is defined to benull
, setting it has no effect, including if the node is read-only.
Note that setting this attribute, when permitted, changes thenodeName
attribute, which holds the qualified name, as well as thetagName
andname
attributes of theElement
andAttr
interfaces, when applicable.
Setting the prefix tonull
makes it unspecified, setting it to an empty string is implementation dependent.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since thenamespaceURI
andlocalName
do not change.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
.- Since:
- 1.4, DOM Level 2
-
setPrefix
void setPrefix(String prefix) throws DOMException
The namespace prefix of this node, ornull
if it is unspecified. When it is defined to benull
, setting it has no effect, including if the node is read-only.
Note that setting this attribute, when permitted, changes thenodeName
attribute, which holds the qualified name, as well as thetagName
andname
attributes of theElement
andAttr
interfaces, when applicable.
Setting the prefix tonull
makes it unspecified, setting it to an empty string is implementation dependent.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since thenamespaceURI
andlocalName
do not change.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
.- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character according to the XML version in use specified in theDocument.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specifiedprefix
is malformed per the Namespaces in XML specification, if thenamespaceURI
of this node isnull
, if the specified prefix is "xml" and thenamespaceURI
of this node is different from " http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and thenamespaceURI
of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute and thequalifiedName
of this node is "xmlns" [XML Namespaces] .- Since:
- 1.4, DOM Level 2
-
getLocalName
String getLocalName()
Returns the local part of the qualified name of this node.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such asDocument.createElement()
, this is alwaysnull
.- Since:
- 1.4, DOM Level 2
-
hasAttributes
boolean hasAttributes()
Returns whether this node (if it is an element) has any attributes.- Returns:
- Returns
true
if this node has any attributes,false
otherwise. - Since:
- 1.4, DOM Level 2
-
getBaseURI
String getBaseURI()
The absolute base URI of this node ornull
if the implementation wasn't able to obtain an absolute URI. This value is computed as described in . However, when theDocument
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 thedocumentURI
attribute from theDocument
interface otherwise.- Since:
- 1.5, DOM Level 3
-
compareDocumentPosition
short compareDocumentPosition(Node other) throws DOMException
Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.- Parameters:
other
- The node to compare against the reference node.- Returns:
- Returns how the node is positioned relatively to the reference node.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.- Since:
- 1.5, DOM Level 3
-
getTextContent
String getTextContent() throws DOMException
This attribute returns the text content of this node and its descendants. When it is defined to benull
, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty ornull
, replaced by a singleText
node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attributeText.isElementContentWhitespace
). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:Node type Content ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of 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 - Throws:
DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.- Since:
- 1.5, DOM Level 3
-
setTextContent
void setTextContent(String textContent) throws DOMException
This attribute returns the text content of this node and its descendants. When it is defined to benull
, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty ornull
, replaced by a singleText
node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attributeText.isElementContentWhitespace
). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:Node type Content ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of 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 - Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.- Since:
- 1.5, DOM Level 3
-
isSameNode
boolean isSameNode(Node other)
Returns whether this node is the same node as the given one.
This method provides a way to determine whether twoNode
references returned by the implementation reference the same object. When twoNode
references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.- Parameters:
other
- The node to test against.- Returns:
- Returns
true
if the nodes are the same,false
otherwise. - Since:
- 1.5, DOM Level 3
-
lookupPrefix
String lookupPrefix(String namespaceURI)
Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See for details on the algorithm used by this method.- Parameters:
namespaceURI
- The namespace URI to look for.- Returns:
- 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. - Since:
- 1.5, DOM Level 3
-
isDefaultNamespace
boolean isDefaultNamespace(String namespaceURI)
This method checks if the specifiednamespaceURI
is the default namespace or not.- Parameters:
namespaceURI
- The namespace URI to look for.- Returns:
- Returns
true
if the specifiednamespaceURI
is the default namespace,false
otherwise. - Since:
- 1.5, DOM Level 3
-
lookupNamespaceURI
String lookupNamespaceURI(String prefix)
Look up the namespace URI associated to the given prefix, starting from this node.
See for details on the algorithm used by this method.- Parameters:
prefix
- The prefix to look for. If this parameter isnull
, the method will return the default namespace URI if any.- Returns:
- Returns the associated namespace URI or
null
if none is found. - Since:
- 1.5, DOM Level 3
-
isEqualNode
boolean isEqualNode(Node arg)
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested withNode.isSameNode()
. All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied:- The two nodes are of the same type.
- The following string
attributes are equal:
nodeName
,localName
,namespaceURI
,prefix
,nodeValue
. This is: they are bothnull
, or they have the same length and are character for character identical. - The
attributes
NamedNodeMaps
are equal. This is: they are bothnull
, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index. - The
childNodes
NodeLists
are equal. This is: they are bothnull
, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For twoDocumentType
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: theownerDocument
,baseURI
, andparentNode
attributes, thespecified
attribute forAttr
nodes, theschemaTypeInfo
attribute forAttr
andElement
nodes, theText.isElementContentWhitespace
attribute forText
nodes, as well as any user data or event listeners registered on the nodes.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
- The node to compare equality with.- Returns:
- Returns
true
if the nodes are equal,false
otherwise. - Since:
- 1.5, DOM Level 3
-
getFeature
Object getFeature(String feature, String version)
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support theNode
interface.- Parameters:
feature
- 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
- This is the version number of the feature to test.- Returns:
- 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 theDOMObject
returned by this method implements theNode
interface, it must delegate to the primary coreNode
and not return results inconsistent with the primary coreNode
such as attributes, childNodes, etc. - Since:
- 1.5, DOM Level 3
-
setUserData
Object setUserData(String key, Object data, UserDataHandler handler)
Associate an object to a key on this node. The object can later be retrieved from this node by callinggetUserData
with the same key.- Parameters:
key
- The key to associate the object to.data
- The object to associate to the given key, ornull
to remove any existing association to that key.handler
- The handler to associate to that key, ornull
.- Returns:
- Returns the
DOMUserData
previously associated to the given key on this node, ornull
if there was none. - Since:
- 1.5, DOM Level 3
-
getUserData
Object getUserData(String key)
Retrieves the object associated to a key on a this node. The object must first have been set to this node by callingsetUserData
with the same key.- Parameters:
key
- The key the object is associated to.- Returns:
- Returns the
DOMUserData
associated to the given key on this node, ornull
if there was none. - Since:
- 1.5, DOM Level 3
-
-