|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
The values of
nodeName
,
nodeValue
, and
attributes
vary according to the node type as follows:
Node Type | nodeName | nodeValue | attributes |
Element | tagName | null | NamedNodeMap |
Attr | name of attribute | value of attribute | null |
Text | #text | content of the text node | null |
CDATASection | #cdata-section | content of the CDATA Section | null |
EntityReference | name of entity referenced | null | null |
Entity | entity name | null | null |
ProcessingInstruction | target | entire content excluding the target | null |
Comment | #comment | content of the comment | null |
Document | #document | null | null |
DocumentType | document type name | null | null |
DocumentFragment | #document-fragment | null | null |
Notation | notation name | null | null |
Property Summary | ||
nodeName |
getNodeName | The name of this node, depending on its type; see the table above. |
nodeValue |
getNodeValue setNodeValue | The value of this node, depending on its type; see the table above. |
nodeType |
getNodeType | A code representing the type of the underlying object, as defined above. |
parentNode |
getParentNode | The parent of this node. All nodes, except
|
childNodes |
getChildNodes | A
|
firstChild |
getFirstChild | The first child of this node. If there is no such node, this returns
|
lastChild |
getLastChild | The last child of this node. If there is no such node, this returns
|
previousSibling |
getPreviousSibling | The node immediately preceding this node. If there is no such node, this returns
|
nextSibling |
getNextSibling | The node immediately following this node. If there is no such node, this returns
|
attributes |
getAttributes | A
|
ownerDocument |
getOwnerDocument | The
|
Field Summary | |
static short |
ATTRIBUTE_NODE
The node is an Attr . |
static short |
CDATA_SECTION_NODE
The node is a CDATASection . |
static short |
COMMENT_NODE
The node is a Comment . |
static short |
DOCUMENT_FRAGMENT_NODE
The node is a DocumentFragment . |
static short |
DOCUMENT_NODE
The node is a Document . |
static short |
DOCUMENT_TYPE_NODE
The node is a DocumentType . |
static short |
ELEMENT_NODE
The node is a Element . |
static short |
ENTITY_NODE
The node is an Entity . |
static short |
ENTITY_REFERENCE_NODE
The node is an EntityReference . |
static short |
NOTATION_NODE
The node is a Notation . |
static short |
PROCESSING_INSTRUCTION_NODE
The node is a ProcessingInstruction . |
static short |
TEXT_NODE
The node is a Text node. |
Method Summary | |
Node |
appendChild(Node newChild)
Adds the node newChild 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. |
NamedNodeMap |
getAttributes()
Returns the value of the attributes property. |
NodeList |
getChildNodes()
Returns the value of the childNodes property. |
Node |
getFirstChild()
Returns the value of the firstChild property. |
Node |
getLastChild()
Returns the value of the lastChild property. |
Node |
getNextSibling()
Returns the value of the nextSibling property. |
java.lang.String |
getNodeName()
Returns the value of the nodeName property. |
short |
getNodeType()
Returns the value of the nodeType property. |
java.lang.String |
getNodeValue()
Returns the value of the nodeValue property. |
Document |
getOwnerDocument()
Returns the value of the ownerDocument property. |
Node |
getParentNode()
Returns the value of the parentNode property. |
Node |
getPreviousSibling()
Returns the value of the previousSibling property. |
boolean |
hasChildNodes()
This is a convenience method to allow easy determination of whether a node has any children. |
Node |
insertBefore(Node newChild,
Node refChild)
Inserts the node newChild before the existing child node
refChild . |
Node |
removeChild(Node oldChild)
Removes the child node indicated by oldChild from the list of children, and returns it. |
Node |
replaceChild(Node newChild,
Node oldChild)
Replaces the child node oldChild with
newChild in the list of children, and returns the
oldChild node. |
void |
setNodeValue(java.lang.String nodeValue)
Assigns the value of the nodeValue property. |
Field Detail |
public static final short ELEMENT_NODE
Element
.public static final short ATTRIBUTE_NODE
Attr
.public static final short TEXT_NODE
Text
node.public static final short CDATA_SECTION_NODE
CDATASection
.public static final short ENTITY_REFERENCE_NODE
EntityReference
.public static final short ENTITY_NODE
Entity
.public static final short PROCESSING_INSTRUCTION_NODE
ProcessingInstruction
.public static final short COMMENT_NODE
Comment
.public static final short DOCUMENT_NODE
Document
.public static final short DOCUMENT_TYPE_NODE
DocumentType
.public static final short DOCUMENT_FRAGMENT_NODE
DocumentFragment
.public static final short NOTATION_NODE
Notation
.Method Detail |
public java.lang.String getNodeName()
nodeName
property.public void setNodeValue(java.lang.String nodeValue) throws DOMException
nodeValue
property.NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
public java.lang.String getNodeValue() throws DOMException
nodeValue
property.DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a
DOMString
variable on the implementation platform.
public short getNodeType()
nodeType
property.public Node getParentNode()
parentNode
property.public NodeList getChildNodes()
childNodes
property.public Node getFirstChild()
firstChild
property.public Node getLastChild()
lastChild
property.public Node getPreviousSibling()
previousSibling
property.public Node getNextSibling()
nextSibling
property.public NamedNodeMap getAttributes()
attributes
property.public Document getOwnerDocument()
ownerDocument
property.public Node insertBefore(Node newChild, Node refChild) throws DOMException
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.
newChild
- The node to insert.refChild
- The reference node, i.e., the node before which the new node must be inserted.newChild
node, or if the node to insert is one of this node's ancestors.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.
NOT_FOUND_ERR: Raised if
refChild
is not a child of this node.
public Node replaceChild(Node newChild, Node oldChild) throws DOMException
Replaces the child node
oldChild
with
newChild
in the list of children, and returns the
oldChild
node. If the
newChild
is already in the tree, it is first removed.
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.newChild
node, or it the node to put in is one of this node's ancestors.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.
NOT_FOUND_ERR: Raised if
oldChild
is not a child of this node.
public Node removeChild(Node oldChild) throws DOMException
Removes the child node indicated by
oldChild
from the list of children, and returns it.
oldChild
- The node being removed.NOT_FOUND_ERR: Raised if
oldChild
is not a child of this node.
public Node appendChild(Node newChild) throws DOMException
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.
newChild
- 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
newChild
node, or if the node to append is one of this node's ancestors.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.
public boolean hasChildNodes()
This is a convenience method to allow easy determination of whether a node has any children.
true
if the node has any children, false
if the node has no children.public 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
returns
null
.).
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 text it contains unless it is a deep clone, since the text is contained in a child
Text
node. Cloning any other type of node simply returns a copy of this node.
deep
- 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
).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |