|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Node3
interface is an extension to the DOM Level 2
Node
interface containing the DOM Level 3 additions.
See also the Document Object Model (DOM) Level 3 Core Specification.
Field Summary | |
static short |
TREE_POSITION_ANCESTOR
The node is an ancestor of the reference node. |
static short |
TREE_POSITION_DESCENDANT
The node is a descendant of the reference node. |
static short |
TREE_POSITION_DISCONNECTED
The two nodes are disconnected, they do not have any common ancestor. |
static short |
TREE_POSITION_EQUIVALENT
The two nodes have an equivalent position. |
static short |
TREE_POSITION_FOLLOWING
The node follows the reference node. |
static short |
TREE_POSITION_PRECEDING
The node precedes the reference node. |
static short |
TREE_POSITION_SAME_NODE
The two nodes are the same. |
Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
Method Summary | |
short |
compareTreePosition(org.w3c.dom.Node other)
Compares a node with this node with regard to their position in the tree and according to the document order. |
java.lang.String |
getBaseURI()
The absolute base URI of this node or null if undefined. |
org.w3c.dom.Node |
getInterface(java.lang.String feature)
This method makes available a Node 's specialized interface
(see ).What are the relations between Node.isSupported and
Node3.getInterface?Should we rename this method (and also
DOMImplementation.getInterface?)?getInterface can return a node that
doesn't actually support the requested interface and will lead to a
cast exception. |
java.lang.String |
getTextContent()
This attribute returns the text content of this node and its descendants. |
java.lang.Object |
getUserData(java.lang.String key)
Retrieves the object associated to a key on a this node. |
boolean |
isEqualNode(org.w3c.dom.Node arg,
boolean deep)
Tests whether two nodes are equal. |
boolean |
isSameNode(org.w3c.dom.Node other)
Returns whether this node is the same node as the given one. |
java.lang.String |
lookupNamespacePrefix(java.lang.String namespaceURI)
Look up the prefix associated to the given namespace URI, starting from this node. |
java.lang.String |
lookupNamespaceURI(java.lang.String prefix)
Look up the namespace URI associated to the given prefix, starting from this node. |
void |
setTextContent(java.lang.String textContent)
This attribute returns the text content of this node and its descendants. |
java.lang.Object |
setUserData(java.lang.String key,
java.lang.Object data,
UserDataHandler handler)
Associate an object to a key on this node. |
Methods inherited from interface org.w3c.dom.Node |
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix |
Field Detail |
public static final short TREE_POSITION_PRECEDING
public static final short TREE_POSITION_FOLLOWING
public static final short TREE_POSITION_ANCESTOR
public static final short TREE_POSITION_DESCENDANT
public static final short TREE_POSITION_EQUIVALENT
ownerElement
, and two
nodes that are the same.public static final short TREE_POSITION_SAME_NODE
public static final short TREE_POSITION_DISCONNECTED
Method Detail |
public java.lang.String getBaseURI()
null
if undefined.
This value is computed according to . However, when the
Document
supports the feature "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.
Element
, a Document
or a a ProcessingInstruction
, this attribute represents
the properties [base URI] defined in . When the node is a
Notation
, an Entity
, or an
EntityReference
, this attribute represents the
properties [declaration base URI] in the . How will this be affected
by resolution of relative namespace URIs issue?It's not.Should this
only be on Document, Element, ProcessingInstruction, Entity, and
Notation nodes, according to the infoset? If not, what is it equal to
on other nodes? Null? An empty string? I think it should be the
parent's.No.Should this be read-only and computed or and actual
read-write attribute?Read-only and computed (F2F 19 Jun 2000 and
teleconference 30 May 2001).If the base HTML element is not yet
attached to a document, does the insert change the Document.baseURI?
Yes. (F2F 26 Sep 2001)public short compareTreePosition(org.w3c.dom.Node other)
other
- The node to compare against this node.public java.lang.String getTextContent() throws org.w3c.dom.DOMException
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, the returned string does not contain the
element content whitespaces . Similarly, on setting, no parsing is
performed either, the input string is taken as pure textual content.
Node type | Content |
---|---|
ELEMENT_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 |
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE |
nodeValue |
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
org.w3c.dom.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.org.w3c.dom.DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString
variable on the implementation
platform.public void setTextContent(java.lang.String textContent) throws org.w3c.dom.DOMException
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, the returned string does not contain the
element content whitespaces . Similarly, on setting, no parsing is
performed either, the input string is taken as pure textual content.
Node type | Content |
---|---|
ELEMENT_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 |
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE |
nodeValue |
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
org.w3c.dom.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.org.w3c.dom.DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString
variable on the implementation
platform.public boolean isSameNode(org.w3c.dom.Node other)
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.Do we really want to make this
different from equals?Yes, change name from isIdentical to
isSameNode. (Telcon 4 Jul 2000).Is this really needed if we provide a
unique key?Yes, because the key is only unique within a document.
(F2F 2 Mar 2001).Definition of 'sameness' is needed.other
- The node to test against.true
if the nodes are the same,
false
otherwise.public java.lang.String lookupNamespacePrefix(java.lang.String namespaceURI)
namespaceURI
- The namespace URI to look for.null
if none is found. If more than one prefix are associated to the
namespace prefix, the returned namespace prefix is implementation
dependent.public java.lang.String lookupNamespaceURI(java.lang.String prefix)
prefix
- The prefix to look for.null
if
none is found.public boolean isEqualNode(org.w3c.dom.Node arg, boolean deep)
Node.isSameNode
. All nodes that are the same
will also be equal, though the reverse may not be true.
nodeName
, localName
,
namespaceURI
, prefix
, nodeValue
, baseURI
. 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. This is true
for Attr
nodes as for any other type of node. Note that
normalization can affect equality; to avoid this, nodes should be
normalized before being compared.
DocumentType
nodes to be equal, the following
conditions must also be satisfied: The following string attributes
are equal: publicId
, systemId
,
internalSubset
.The entities
NamedNodeMaps
are equal.The notations
NamedNodeMaps
are equal.
ownerDocument
attribute, the specified
attribute for Attr
nodes, the
isWhitespaceInElementContent
attribute for
Text
nodes, as well as any user data or event listeners
registered on the nodes.Should this be optional?No.arg
- The node to compare equality with.deep
- If true
, recursively compare the subtrees; if
false
, compare only the nodes themselves (and its
attributes, if it is an Element
).true
otherwise false
.public org.w3c.dom.Node getInterface(java.lang.String feature)
Node
's specialized interface
(see ).What are the relations between Node.isSupported and
Node3.getInterface?Should we rename this method (and also
DOMImplementation.getInterface?)?getInterface can return a node that
doesn't actually support the requested interface and will lead to a
cast exception. Other solutions are returning null or throwing an
exception.feature
- The name of the feature requested (case-insensitive).Node
which implements the
specialized APIs of the specified feature, if any, or
null
if there is no alternate Node
which
implements interfaces associated with that feature. Any alternate
Node
returned by this method must delegate to the
primary core Node
and not return results inconsistent
with the primary core Node
such as key
,
attributes
, childNodes
, etc.public java.lang.Object setUserData(java.lang.String key, java.lang.Object data, UserDataHandler handler)
getUserData
with the
same key.key
- The key to associate the object to.data
- The object to associate to the given key, or
null
to remove any existing association to that key.handler
- The handler to associate to that key, or
null
.DOMObject
previously associated to
the given key on this node, or null
if there was none.public java.lang.Object getUserData(java.lang.String key)
setUserData
with the same key.key
- The key the object is associated to.DOMObject
associated to the given key
on this node, or null
if there was none.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |