adoptNode
public Node adoptNode(Node source)
throws DOMException
NEEDSDOC Method adoptNode
NEEDSDOC @param source
appendChild
public final Node appendChild(Node newChild)
throws DOMException
-- DTMNodeProxy is read-only
appendData
public final void appendData(String arg)
throws DOMException
org.w3c.dom.CharacterData
cloneNode
public final Node cloneNode(boolean deep)
-- DTMNodeProxy is read-only
compareDocumentPosition
public short compareDocumentPosition(Node other)
throws DOMException
Compares a node with this node with regard to their position in the
document.
other
- The node to compare against this node.
- Returns how the given node is positioned relatively to this
node.
createAttribute
public final Attr createAttribute(String name)
throws DOMException
createAttributeNS
public final Attr createAttributeNS(String namespaceURI,
String qualifiedName)
throws DOMException
namespaceURI
- qualifiedName
-
createCDATASection
public final CDATASection createCDATASection(String data)
throws DOMException
createComment
public final Comment createComment(String data)
createDocumentFragment
public final DocumentFragment createDocumentFragment()
createElement
public final Element createElement(String tagName)
throws DOMException
createElementNS
public final Element createElementNS(String namespaceURI,
String qualifiedName)
throws DOMException
namespaceURI
- qualifiedName
-
createEntityReference
public final EntityReference createEntityReference(String name)
throws DOMException
createProcessingInstruction
public final ProcessingInstruction createProcessingInstruction(String target,
String data)
throws DOMException
createTextNode
public final Text createTextNode(String data)
deleteData
public final void deleteData(int offset,
int count)
throws DOMException
org.w3c.dom.CharacterData
equals
public final boolean equals(Node node)
Test for equality based on node number.
node
- A DTM node proxy reference.
- true if the given node has the same handle as this node.
equals
public final boolean equals(Object node)
Test for equality based on node number.
node
- A DTM node proxy reference.
- true if the given node has the same handle as this node.
getActualEncoding
public String getActualEncoding()
DOM Level 3
An attribute specifying the actual encoding of this document. This is
null
otherwise.
This attribute represents the property [character encoding scheme]
defined in .
getAttribute
public final String getAttribute(String name)
getAttributeNS
public final String getAttributeNS(String namespaceURI,
String localName)
namespaceURI
- localName
-
getAttributeNode
public final Attr getAttributeNode(String name)
getAttributeNodeNS
public final Attr getAttributeNodeNS(String namespaceURI,
String localName)
namespaceURI
- localName
-
getAttributes
public final NamedNodeMap getAttributes()
getBaseURI
public String getBaseURI()
The absolute base URI of this node or 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.
When the node is an 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)
getChildNodes
public final NodeList getChildNodes()
getDTM
public final DTM getDTM()
NON-DOM: Return the DTM model
- The DTM that this proxy is a representative for.
getDTMNodeNumber
public final int getDTMNodeNumber()
NON-DOM: Return the DTM node number
getData
public final String getData()
throws DOMException
org.w3c.dom.CharacterData
getDoctype
public final DocumentType getDoctype()
getDocumentElement
public final Element getDocumentElement()
This is a bit of a problem in DTM, since a DTM may be a Document
Fragment and hence not have a clear-cut Document Element. We can
make it work in the well-formed cases but would that be confusing for others?
getDocumentURI
public String getDocumentURI()
DOM Level 3
The location of the document or null
if undefined.
Beware that when the Document
supports the feature
"HTML" , the href attribute of the HTML BASE element takes precedence
over this attribute.
getDomConfig
public DOMConfiguration getDomConfig()
The configuration used when Document.normalizeDocument
is
invoked.
getElementById
public final Element getElementById(String elementId)
getElementsByTagName
public final NodeList getElementsByTagName(String tagname)
getElementsByTagNameNS
public final NodeList getElementsByTagNameNS(String namespaceURI,
String localName)
namespaceURI
- localName
-
getFeature
public Object getFeature(String feature,
String version)
This method returns a specialized object which implements the
specialized APIs of the specified feature and version. 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.
feature
- The name of the feature requested (case-insensitive).version
- This is the version number of the feature to test. If
the version is null
or the empty string, supporting
any version of the feature will cause the method to return an
object that supports at least one version of the feature.
- 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.
getFirstChild
public final Node getFirstChild()
getImplementation
public final DOMImplementation getImplementation()
getInputEncoding
public String getInputEncoding()
getLastChild
public final Node getLastChild()
getLength
public final int getLength()
org.w3c.dom.CharacterData
getLocalName
public final String getLocalName()
getName
public final String getName()
getNamespaceURI
public final String getNamespaceURI()
getNextSibling
public final Node getNextSibling()
getNodeName
public final String getNodeName()
getNodeType
public final short getNodeType()
getNodeValue
public final String getNodeValue()
throws DOMException
getOwnerDocument
public final Document getOwnerDocument()
getOwnerElement
public final Element getOwnerElement()
Get the owner element of an attribute.
getOwnerNode
public final Node getOwnerNode()
getParentNode
public final Node getParentNode()
getPrefix
public final String getPrefix()
- The prefix for this node.
getPreviousSibling
public final Node getPreviousSibling()
getSchemaTypeInfo
public TypeInfo getSchemaTypeInfo()
getSpecified
public final boolean getSpecified()
getStrictErrorChecking
public boolean getStrictErrorChecking()
Based on the
Document
Object Model (DOM) Level 3 Core Specification of 07 April 2004..
An attribute specifying whether errors 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
. In case of error, the
behavior is undefined. This attribute is
true
by
defaults.
getStringValue
public final String getStringValue()
throws DOMException
- The string value of the node
getTagName
public final String getTagName()
getTarget
public final String getTarget()
A PI's "target" states what processor channel the PI's data
should be directed to. It is defined differently in HTML and XML.
In XML, a PI's "target" is the first (whitespace-delimited) token
following the "<?" token that begins the PI.
In HTML, target is always null.
Note that getNodeName is aliased to getTarget.
getTextContent
public String getTextContent()
throws DOMException
This attribute returns the text content of this node and its
descendants. When it is defined to be null, setting it has no effect.
When set, any possible children this node may have are removed and
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, 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.
The string returned is made of the text content of this node
depending on its type, as defined below:
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 |
getUserData
public 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 calling
setUserData
with the same key.
key
- The key the object is associated to.
- Returns the
DOMObject
associated to the given key
on this node, or null
if there was none.
getValue
public final String getValue()
getWholeText
public String getWholeText()
DOM Level 3
Returns all text of Text
nodes logically-adjacent text
nodes to this node, concatenated in document order.
getXmlEncoding
public String getXmlEncoding()
getXmlStandalone
public boolean getXmlStandalone()
getXmlVersion
public String getXmlVersion()
hasAttribute
public boolean hasAttribute(String name)
Method hasAttribute
hasAttributeNS
public boolean hasAttributeNS(String namespaceURI,
String localName)
Method hasAttributeNS
namespaceURI
- localName
-
hasAttributes
public boolean hasAttributes()
Introduced in DOM Level 2.
hasChildNodes
public final boolean hasChildNodes()
importNode
public final Node importNode(Node importedNode,
boolean deep)
throws DOMException
as of DOM Level 2 -- DTMNodeProxy is read-only
insertBefore
public final Node insertBefore(Node newChild,
Node refChild)
throws DOMException
-- DTMNodeProxy is read-only
insertData
public final void insertData(int offset,
String arg)
throws DOMException
org.w3c.dom.CharacterData
isDefaultNamespace
public boolean isDefaultNamespace(String namespaceURI)
DOM Level 3:
This method checks if the specified namespaceURI
is the
default namespace or not.
namespaceURI
- The namespace URI to look for.
true
if the specified namespaceURI
is the default namespace, false
otherwise.
isElementContentWhitespace
public boolean isElementContentWhitespace()
DOM Level 3
Returns whether this text node contains whitespace in element content,
often abusively called "ignorable whitespace".
isEqualNode
public 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 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
, 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.
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
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.
arg
- The node to compare equality with.
- If the nodes, and possibly subtrees are equal,
true
otherwise false
.
isId
public boolean isId()
isSameNode
public boolean isSameNode(Node other)
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 interchangably, such that all attributes have the
same values and calling the same DOM method on either reference
always has exactly the same effect.
other
- The node to test against.
- Returns
true
if the nodes are the same,
false
otherwise.
isSupported
public final boolean isSupported(String feature,
String version)
Ask whether we support a given DOM feature.
In fact, we do not _fully_ support any DOM feature -- we're a
read-only subset -- so arguably we should always return false.
lookupNamespaceURI
public String lookupNamespaceURI(String specifiedPrefix)
DOM Level 3:
Look up the namespace URI associated to the given prefix, starting from this node.
Use lookupNamespaceURI(null) to lookup the default namespace
lookupPrefix
public String lookupPrefix(String namespaceURI)
DOM Level 3:
Look up the prefix associated to the given namespace URI, starting from this node.
- the prefix for the namespace
normalize
public final void normalize()
normalizeDocument
public void normalizeDocument()
DOM Level 3
Normalize document.
removeAttribute
public final void removeAttribute(String name)
throws DOMException
removeAttributeNS
public final void removeAttributeNS(String namespaceURI,
String localName)
throws DOMException
namespaceURI
- localName
-
removeAttributeNode
public final Attr removeAttributeNode(Attr oldAttr)
throws DOMException
removeChild
public final Node removeChild(Node oldChild)
throws DOMException
-- DTMNodeProxy is read-only
renameNode
public Node renameNode(Node n,
String namespaceURI,
String name)
throws DOMException
DOM Level 3
Renaming node
replaceChild
public final Node replaceChild(Node newChild,
Node oldChild)
throws DOMException
-- DTMNodeProxy is read-only
replaceData
public final void replaceData(int offset,
int count,
String arg)
throws DOMException
org.w3c.dom.CharacterData
replaceWholeText
public Text replaceWholeText(String content)
throws DOMException
DOM Level 3
sameNodeAs
public final boolean sameNodeAs(Node other)
FUTURE DOM: Test node identity, in lieu of Node==Node
- true if the given node has the same handle as this node.
setActualEncoding
public void setActualEncoding(String value)
DOM Level 3
An attribute specifying the actual encoding of this document. This is
null
otherwise.
This attribute represents the property [character encoding scheme]
defined in .
setAttribute
public final void setAttribute(String name,
String value)
throws DOMException
setAttributeNS
public final void setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
throws DOMException
namespaceURI
- qualifiedName
- value
-
setAttributeNode
public final Attr setAttributeNode(Attr newAttr)
throws DOMException
setAttributeNodeNS
public final Attr setAttributeNodeNS(Attr newAttr)
throws DOMException
setData
public final void setData(String data)
throws DOMException
org.w3c.dom.CharacterData
setDocumentURI
public void setDocumentURI(String documentURI)
DOM Level 3
setIdAttribute
public void setIdAttribute(String name,
boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute
setIdAttribute
public void setIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type.
setIdAttributeNS
public void setIdAttributeNS(String namespaceURI,
String localName,
boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute
setIdAttributeNode
public void setIdAttributeNode(Attr at,
boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute
setNodeValue
public final void setNodeValue(String nodeValue)
throws DOMException
-- DTMNodeProxy is read-only
setPrefix
public final void setPrefix(String prefix)
throws DOMException
as of DOM Level 2 -- DTMNodeProxy is read-only
setStrictErrorChecking
public void setStrictErrorChecking(boolean strictErrorChecking)
Based on the
Document
Object Model (DOM) Level 3 Core Specification of 07 April 2004..
An attribute specifying whether errors 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
. In case of error, the
behavior is undefined. This attribute is
true
by
defaults.
- DOM Level 3
NEEDSDOC @param strictErrorChecking
setTextContent
public void setTextContent(String textContent)
throws DOMException
This attribute returns the text content of this node and its
descendants. When it is defined to be null, setting it has no effect.
When set, any possible children this node may have are removed and
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, 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.
The string returned is made of the text content of this node
depending on its type, as defined below:
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 |
setUserData
public Object setUserData(String key,
Object data,
UserDataHandler handler)
setValue
public final void setValue(String value)
setXmlEncoding
public void setXmlEncoding(String xmlEncoding)
setXmlStandalone
public void setXmlStandalone(boolean xmlStandalone)
throws DOMException
setXmlVersion
public void setXmlVersion(String xmlVersion)
throws DOMException
splitText
public final Text splitText(int offset)
throws DOMException
substringData
public final String substringData(int offset,
int count)
throws DOMException
org.w3c.dom.CharacterData
supports
public final boolean supports(String feature,
String version)
Ask whether we support a given DOM feature.
In fact, we do not _fully_ support any DOM feature -- we're a
read-only subset -- so arguably we should always return false.
Or we could say that we support DOM Core Level 2 but all nodes
are read-only. Unclear which answer is least misleading.
NON-DOM method. This was present in early drafts of DOM Level 2,
but was renamed isSupported. It's present here only because it's
cheap, harmless, and might help some poor fool who is still trying
to use an early Working Draft of the DOM.