com.icl.saxon.om
public abstract class AbstractNode extends Object implements Node, NodeInfo, SourceLocator, DOMLocator
Field Summary | |
---|---|
static char[] | NODE_LETTER
Chararacteristic letters to identify each type of node, indexed using the node type
values. |
Method Summary | |
---|---|
Node | appendChild(Node newChild)
Adds the node newChild to the end of the list of children
of this node. |
void | appendData(String arg)
Append the string to the end of the character data of the 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.
|
abstract int | compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
|
void | copyStringValue(Outputter out)
Copy the string-value of this node to a given outputter.
|
Attr | createAttribute(String name)
Create an Attr of the given name.
|
Attr | createAttributeNS(String namespaceURI, String qualifiedName)
Create an attribute of the given qualified name and namespace URI.
|
CDATASection | createCDATASection(String data)
Create a CDATASection node whose value is the specified
string.
|
Comment | createComment(String data)
Create a Comment node given the specified string.
|
DocumentFragment | createDocumentFragment()
Creates an empty DocumentFragment object. |
Element | createElement(String tagName)
Creates an element of the type specified. |
Element | createElementNS(String namespaceURI, String qualifiedName)
Create an element of the given qualified name and namespace URI.
|
EntityReference | createEntityReference(String name)
Create an EntityReference object.
|
ProcessingInstruction | createProcessingInstruction(String target, String data)
Create a ProcessingInstruction node given the specified
name and data strings.
|
Text | createTextNode(String data)
Create a Text node given the specified string.
|
void | deleteData(int offset, int count)
Remove a range of 16-bit units from the node.
|
protected void | disallowUpdate()
Internal method used to indicate that update operations are not allowed |
abstract String | generateId()
Get a character string that uniquely identifies this node |
String | getAttribute(String name)
Retrieves an attribute value by name. |
Attr | getAttributeNode(String name)
Retrieves an attribute node by name.
|
Attr | getAttributeNodeNS(String namespaceURI, String localName)
Retrieves an Attr node by local name and namespace URI.
|
String | getAttributeNS(String namespaceURI, String localName)
Retrieves an attribute value by local name and namespace URI.
|
NamedNodeMap | getAttributes()
Return a NamedNodeMap containing the attributes of this node (if
it is an Element ) or null otherwise. |
abstract String | getAttributeValue(String uri, String localName)
Find the value of a given attribute of this node. |
abstract String | getAttributeValue(int fingerprint)
Get the value of a given attribute of this node |
abstract String | getBaseURI()
Get the base URI for the node. |
NodeList | getChildNodes()
Return a NodeList that contains all children of this node. |
int | getColumnNumber()
Get the column number of the node.
|
String | getData()
Get the character data of a Text or Comment node.
|
String | getDisplayName()
Get the display name of this node. |
DocumentType | getDoctype()
Get the Document Type Declaration (see DocumentType )
associated with this document. |
Element | getDocumentElement()
Get the outermost element. |
DocumentInfo | getDocumentRoot()
Get the root (document) node |
Element | getElementById(String elementId)
Return the Element whose ID is given by
elementId . |
NodeList | getElementsByTagName(String tagname)
Return a NodeList of all the Elements with
a given tag name in the order in which they are encountered in a
preorder traversal of the Document tree. |
NodeList | getElementsByTagNameNS(String namespaceURI, String localName)
Return a NodeList of all the Elements with
a given local name and namespace URI in the order in which they are
encountered in a preorder traversal of the Document tree.
|
abstract AxisEnumeration | getEnumeration(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from 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 . |
abstract int | getFingerprint()
Get the fingerprint of the node, used for matching names |
Node | getFirstChild()
Get first child (DOM method) |
DOMImplementation | getImplementation()
Get a DOMImplementation object that handles this document.
|
Node | getLastChild()
Get last child (DOM method) |
int | getLength()
Get the length of a Text or Comment node.
|
int | getLineNumber()
Get the line number of the node within its source document entity.
|
abstract String | getLocalName()
Get the local name of this node. |
String | getName()
Get the name of an attribute node (the QName) (DOM method) |
abstract int | getNameCode()
Get the name code of the node, used for displaying names |
String | getNamespaceURI()
The namespace URI of this node, or null if it is
unspecified. |
Node | getNextSibling()
Get next sibling node (DOM method) |
String | getNodeName()
Get the name of this node, following the DOM rules |
String | getNodeValue()
Get the node value as defined in the DOM.
|
Node | getOriginatingNode()
Get the node corresponding to this javax.xml.transform.dom.DOMLocator |
Document | getOwnerDocument()
Return the Document object associated with this node. |
Element | getOwnerElement()
The Element node this attribute is attached to or
null if this attribute is not in use. |
abstract NodeInfo | getParent()
Find the parent node of this node. |
Node | getParentNode()
Find the parent node of this node (DOM method). |
abstract String | getPrefix()
Get the prefix part of the name of this node. |
Node | getPreviousSibling()
Get the previous sibling of the node (DOM method) |
String | getPublicId()
Get the public identifier of the document entity containing this node.
|
TypeInfo | getSchemaTypeInfo()
The type information associated with this attribute. |
boolean | getSpecified()
If this attribute was explicitly given a value in the original
document, this is true ; otherwise, it is
false . |
abstract String | getSystemId()
Get the system ID for the entity containing the node. |
String | getTagName()
The name of the element (DOM interface). |
String | getTextContent()
This attribute returns the text content of this node and its
descendants. |
abstract String | getURI()
Get the URI part of the name of this node. |
Object | getUserData(String key)
Retrieves the object associated to a key on a this node. |
String | getValue()
Return the character value of an attribute node (DOM method) |
String | getWholeText()
Returns all text of Text nodes logically-adjacent text
nodes to this node, concatenated in document order.
|
boolean | hasAttribute(String name)
Returns true when an attribute with a given name is
specified on this element or has a default value, false
otherwise.
|
boolean | hasAttributeNS(String namespaceURI, String localName)
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.
|
abstract boolean | hasAttributes()
Returns whether this node has any attributes. |
abstract boolean | hasChildNodes()
Determine whether the node has any children. |
Node | importNode(Node importedNode, boolean deep)
Import a node from another document to this document.
|
Node | insertBefore(Node newChild, Node refChild)
Insert the node newChild before the existing child node
refChild . |
void | insertData(int offset, String arg)
Insert a string at the specified character offset.
|
boolean | isDefaultNamespace(String namespaceURI)
This method checks if the specified namespaceURI is the
default namespace or not.
|
boolean | isElementContentWhitespace()
Returns whether this text node contains
element content whitespace, often abusively called "ignorable whitespace". |
boolean | isEqualNode(Node arg)
Tests whether two nodes are equal.
|
boolean | isId()
Returns whether this attribute is known to be of type ID (i.e. to
contain an identifier for its owner element) or not.
|
boolean | isSameNode(Node other)
Returns whether this node is the same node as the given one.
|
abstract boolean | isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node |
boolean | isSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and
that feature is supported by this node. |
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 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. |
void | outputNamespaceNodes(Outputter out, boolean includeAncestors)
Output all namespace nodes associated with this element. |
void | removeAttribute(String oldAttr)
Removes the specified attribute. |
Attr | removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. |
void | removeAttributeNS(String namespaceURI, String localName)
Removes an attribute by local name and namespace URI. |
Node | removeChild(Node oldChild)
Remove the child node indicated by oldChild from the
list of children, and returns it. |
Node | replaceChild(Node newChild, Node oldChild)
Replace the child node oldChild with
newChild in the list of children, and returns the
oldChild node. |
void | replaceData(int offset, int count, String arg)
Replace the characters starting at the specified 16-bit unit offset
with the specified string. |
Text | replaceWholeText(String content)
Replaces the text of the current node and all logically-adjacent text
nodes with the specified text. |
Attr | setAttributeNode(Attr newAttr)
Adds a new attribute node. |
Attr | setAttributeNodeNS(Attr newAttr)
Add a new attribute. |
void | setAttributeNS(String namespaceURI, String qualifiedName, String value)
Adds a new attribute. |
void | setData(String data)
Set the character data of a Text or Comment node.
|
void | setIdAttribute(String name, boolean isId)
If the parameter isId is true , this method
declares the specified attribute to be a user-determined ID attribute
. |
void | setIdAttributeNode(Attr idAttr, boolean isId)
If the parameter isId is true , this method
declares the specified attribute to be a user-determined ID attribute
. |
void | setIdAttributeNS(String namespaceURI, String localName, boolean isId)
If the parameter isId is true , this method
declares the specified attribute to be a user-determined ID attribute
. |
void | setNodeValue(String nodeValue)
Set the node value. |
void | setPrefix(String prefix)
Set the namespace prefix of this node. |
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. |
void | setValue(String value)
Set the value of an attribute node. |
Text | splitText(int offset)
Break this node into two nodes at the specified offset,
keeping both in the tree as siblings. |
String | substringData(int offset, int count)
Extract a range of data from a Text or Comment node. |
boolean | supports(String feature, String version)
Alternative to isSupported(), defined in a draft DOM spec |
newChild
to the end of the list of children
of this node. DOM method: always fails.Parameters: newChild The node to add.
Returns: The node added.
Throws: DOMException
NO_MODIFICATION_ALLOWED_ERR: Always raised.
Parameters: arg The DOMString
to append.
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Parameters: 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
).
Returns: The duplicate node.
Parameters: other The node to compare against the reference node.
Returns: Returns how the node is positioned relatively to the reference node.
Throws: org.w3c.dom.DOMException NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.
Since: DOM Level 3
Parameters: other The other node, whose position is to be compared with this node
Returns: -1 if this node precedes the other node, +1 if it follows the other node, or 0 if they are the same node. (In this case, isSameNode() will always return true, and the two nodes will produce the same result for generateId())
Attr
of the given name.
DOM method: always fails, because the Saxon tree is not updateable.Parameters: name The name of the attribute.
Returns: A new Attr
object with the nodeName
attribute set to name
, and localName
,
prefix
, and namespaceURI
set to
null
.
Throws: DOMException INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
Parameters: namespaceURI The namespace URI of the attribute to create. qualifiedName The qualified name of the attribute to instantiate.
Returns: A new Attr
object.
Throws: DOMException
CDATASection
node whose value is the specified
string.
DOM method: always fails, because the Saxon tree is not updateable.Parameters: data The data for the CDATASection
contents.
Returns: The new CDATASection
object.
Throws: DOMException NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Comment
node given the specified string.
DOM method: returns null, because the Saxon tree is not updateable.Parameters: data The data for the node.
Returns: The new Comment
object.
DocumentFragment
object.Returns: A new DocumentFragment
.
DOM method: returns null, because the Saxon tree is not updateable.
Parameters: namespaceURI The namespace URI of the element to create. qualifiedName The qualified name of the element type to instantiate.
Returns: A new Element
object
Throws: DOMException
EntityReference
object.
DOM method: returns null, because the Saxon tree is not updateable.Parameters: name The name of the entity to reference.
Returns: The new EntityReference
object.
Throws: DOMException
INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
ProcessingInstruction
node given the specified
name and data strings.
DOM method: returns null, because the Saxon tree is not updateable.Parameters: target The target part of the processing instruction. data The data for the node.
Returns: The new ProcessingInstruction
object.
Throws: DOMException
INVALID_CHARACTER_ERR: Raised if the specified target contains an
illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Text
node given the specified string.
DOM method: returns null, because the Saxon tree is not updateable.Parameters: data The data for the node.
Returns: The new Text
object.
Parameters: offset The offset from which to start removing. count The number of 16-bit units to delete.
Throws: DOMException
Returns: a string.
Parameters: name The QName of the attribute to retrieve.
Returns: The Attr
value as a string, or the empty string if
that attribute does not have a specified or default value.
getAttributeNodeNS
method.Parameters: name The name (nodeName
) of the attribute to
retrieve.
Returns: The Attr
node with the specified name (
nodeName
) or null
if there is no such
attribute.
Attr
node by local name and namespace URI.
DOM method, so namespace declarations count as attributes.Parameters: namespaceURI The namespace URI of the attribute to retrieve. localName The local name of the attribute to retrieve.
Returns: The Attr
node with the specified attribute local
name and namespace URI or null
if there is no such
attribute.
Since: DOM Level 2
Parameters: namespaceURI The namespace URI of the attribute to retrieve. localName The local name of the attribute to retrieve.
Returns: The Attr
value as a string, or the empty string if
that attribute does not have a specified or default value.
Since: DOM Level 2
NamedNodeMap
containing the attributes of this node (if
it is an Element
) or null
otherwise. (DOM method)Parameters: uri the namespace uri of an attribute localName the local name of an attribute
Returns: the value of the attribute, if it exists, otherwise null
Parameters: fingerprint The fingerprint of the attribute name
Returns: the attribute value if it exists or null if not
NodeList
that contains all children of this node. If
there are no children, this is a NodeList
containing no
nodes. DOM Method.Returns: The display name of this node. For a node with no name, return an empty string.
DocumentType
)
associated with this document. For HTML documents as well as XML
documents without a document type declaration this returns
null
. DOM method.Returns: null: The Saxon tree model does not include the document type information.
Returns: the Element for the outermost element of the document. If the document is not well-formed, this returns the last element child of the root if there is one, otherwise null.
Returns: the DocumentInfo representing the containing document
Element
whose ID
is given by
elementId
. If no such element exists, returns
null
. Behavior is not defined if more than one element
has this ID
. The DOM implementation must have
information that says which attributes are of type ID. Attributes with
the name "ID" are not of type ID unless so defined. Implementations
that do not know whether attributes are of type ID or not are expected
to return null
.Parameters: elementId The unique id
value for an element.
Returns: The matching element, or null if there is none.
Since: DOM Level 2
NodeList
of all the Elements
with
a given tag name in the order in which they are encountered in a
preorder traversal of the Document
tree.Parameters: tagname The name of the tag to match on. The special value "*" matches all tags.
Returns: A new NodeList
object containing all the matched
Elements
.
NodeList
of all the Elements
with
a given local name and namespace URI in the order in which they are
encountered in a preorder traversal of the Document
tree.
DOM method.Parameters: namespaceURI The namespace URI of the elements to match on. The special value "*" matches all namespaces. localName The local name of the elements to match on. The special value "*" matches all local names.
Returns: A new NodeList
object containing all the matched
Elements
.
Since: DOM Level 2
Parameters: axisNumber The axis to be used (a constant in class Axis) nodeTest A pattern to be matched by the returned nodes
Returns: a AxisEnumeration that scans the nodes reached by the axis in turn.
Node
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
The Saxon implementation of this method always returns nullnull
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.
Since: DOM Level 3
Returns: the first child node of this node, or null if it has no children
DOMImplementation
object that handles this document.
A DOM application may use objects from multiple implementations.
DOM method.Returns: last child of this node, or null if it has no children
Returns: The local name of this node. For a node with no name, return an empty string.
null
if it is
unspecified. DOM method.
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
.
Per the Namespaces in XML Specification 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: DOM Level 2
Returns: The next sibling node. Returns null if the current node is the last child of its parent.
Returns: The name of the node. For an element this is the element name, for an attribute it is the attribute name, as a QName. Other node types return conventional names such as "#text" or "#comment"
Document
object associated with this node. (DOM method)Element
node this attribute is attached to or
null
if this attribute is not in use.Since: DOM Level 2
Returns: The Node object describing the containing element or root node.
Returns: The Node object describing the containing element or root node.
Returns: the prefix part of the name. For an unnamed node, return "".
Returns: The previous sibling node. Returns null if the current node is the first child of its parent.
Document.normalizeDocument()
, schemaTypeInfo
may not be reliable if the node was moved.
This implementation always returns null;
Since: DOM Level 3
true
; otherwise, it is
false
. (DOM method)Returns: Always true in this implementation.
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.
Text.isElementContentWhitespace
). Similarly, on setting,
no parsing is performed either, the input string is taken as pure
textual content.
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 |
The Saxon implementation returns the same result as getStringValue()
Throws: org.w3c.dom.DOMException DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString
variable on the implementation
platform.
Since: DOM Level 3
Returns: The URI of the namespace of this node. For an unnamed node, or for an element or attribute in the default namespace, return an empty string.
setUserData
with the same key.
The Saxon implementation always returns null.
Parameters: key The key the object is associated to.
Returns: Returns the DOMUserData
associated to the given
key on this node, or null
if there was none.
Since: DOM Level 3
Returns: the attribute value
Text
nodes logically-adjacent text
nodes to this node, concatenated in document order.
wholeText
on the
Text
node that contains "bar" returns "barfoo", while on
the Text
node that contains "foo" it returns "barfoo".
Since: DOM Level 3
true
when an attribute with a given name is
specified on this element or has a default value, false
otherwise.
Namespace declarations will not be retrieved.Parameters: name The name of the attribute to look for.
Returns: true
if an attribute with the given name is
specified on this element or has a default value, false
otherwise.
Since: DOM Level 2
true
when an attribute with a given local name
and namespace URI is specified on this element or has a default value,
false
otherwise.
Namespace declarations will not be retrieved.Parameters: namespaceURI The namespace URI of the attribute to look for. localName The local name of the attribute to look for.
Returns: true
if an attribute with the given local name and
namespace URI is specified or has a default value on this element,
false
otherwise.
Since: DOM Level 2
Returns: true
if this node has any attributes,
false
otherwise.
Since: DOM Level 2
Returns: true
if this node has any attributes,
false
otherwise.
Throws: DOMException
Since: DOM Level 2
newChild
before the existing child node
refChild
. DOM method: always fails.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 NO_MODIFICATION_ALLOWED_ERR: Always raised.
Parameters: offset The character offset at which to insert. arg The DOMString
to insert.
Throws: DOMException
namespaceURI
is the
default namespace or not.
Parameters: namespaceURI The namespace URI to look for.
Returns: Returns true
if the specified
namespaceURI
is the default namespace,
false
otherwise.
Since: DOM Level 3
Document.normalizeDocument()
.
The Saxon implementation always returns false.
Since: DOM Level 3
Node.isSameNode()
. All nodes that are the
same will also be equal, though the reverse may not be true.
nodeName
, localName
,
namespaceURI
, prefix
, nodeValue
. This is: they are both null
, or they have the same
length and are character for character identical.
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.
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.
DocumentType
nodes to be equal, the following
conditions must also be satisfied:
publicId
, systemId
,
internalSubset
.
entities
NamedNodeMaps
are equal.
notations
NamedNodeMaps
are equal.
ownerDocument
, baseURI
, and
parentNode
attributes, the specified
attribute for Attr
nodes, the schemaTypeInfo
attribute for Attr
and Element
nodes, the
Text.isElementContentWhitespace
attribute 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 The node to compare equality with.
Returns: Returns true
if the nodes are equal,
false
otherwise.
Since: DOM Level 3
This implementation always returns false.
Since: DOM Level 3
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 The node to test against.
Returns: Returns true
if the nodes are the same,
false
otherwise.
Since: DOM Level 3
Returns: true if this Node object and the supplied Node object represent the same node in the tree.
Parameters: feature The name of the feature to test. This is the same name
which can be passed to the method hasFeature
on
DOMImplementation
. version This is the version number of the feature to test. In
Level 2, version 1, this is the string "2.0". If the version is not
specified, supporting any version of the feature will cause the
method to return true
.
Returns: Returns true
if the specified feature is supported
on this node, false
otherwise.
Since: DOM Level 2
Parameters: prefix The prefix to look for. If this parameter is
null
, the method will return the default namespace URI
if any.
Returns: Returns the associated namespace URI or null
if
none is found.
Since: DOM Level 3
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: DOM Level 3
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.Since: DOM Level 2
Parameters: out The relevant outputter includeAncestors True if namespaces declared on ancestor elements must be output; false if it is known that these are already on the result tree
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Since: DOM Level 2
oldChild
from the
list of children, and returns it. DOM method: always fails.Parameters: oldChild The node being removed.
Returns: The node removed.
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Always raised.
oldChild
with
newChild
in the list of children, and returns the
oldChild
node. Always fails.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 NO_MODIFICATION_ALLOWED_ERR: Always raised.
Parameters: offset The offset from which to start replacing. count The number of 16-bit units to replace. arg The DOMString
with which the range must be
replaced.
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
null
, when the replacement text is
the empty string;
Text
node of the same type (
Text
or CDATASection
) as the current node
inserted at the location of the replacement.
replaceWholeText
on the Text
node that
contains "bar" with "yo" in argument results in the following:
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
.
replaceWholeText
on the Text
node that
contains "bar" fails, because the EntityReference
node
"ent" contains an Element
node which cannot be removed.
Parameters: content The content of the replacing Text
node.
Returns: The Text
node created with the specified content.
Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text
nodes being replaced is readonly.
Since: DOM Level 3
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Parameters: newAttr The Attr
node to add to the attribute list.
Returns: 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.
Throws: DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Since: DOM Level 2
Parameters: namespaceURI The namespace URI of the attribute to create or alter. qualifiedName The qualified name of the attribute to create or alter. value The value to set in string form.
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
isId
is true
, this method
declares the specified attribute to be a user-determined ID attribute
. This affects the value of Attr.isId
and the behavior
of Document.getElementById
, but does not change any
schema that may be in use, in particular this does not affect the
Attr.schemaTypeInfo
of the specified Attr
node. Use the value false
for the parameter
isId
to undeclare an attribute for being a
user-determined ID attribute.
setIdAttributeNS
method.
Parameters: name The name of the attribute. isId Whether the attribute is a of type ID.
Throws: org.w3c.dom.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.
Since: DOM Level 3
isId
is true
, this method
declares the specified attribute to be a user-determined ID attribute
. This affects the value of Attr.isId
and the behavior
of Document.getElementById
, but does not change any
schema that may be in use, in particular this does not affect the
Attr.schemaTypeInfo
of the specified Attr
node. Use the value false
for the parameter
isId
to undeclare an attribute for being a
user-determined ID attribute.
Parameters: idAttr The attribute node. isId Whether the attribute is a of type ID.
Throws: org.w3c.dom.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.
Since: DOM Level 3
isId
is true
, this method
declares the specified attribute to be a user-determined ID attribute
. This affects the value of Attr.isId
and the behavior
of Document.getElementById
, but does not change any
schema that may be in use, in particular this does not affect the
Attr.schemaTypeInfo
of the specified Attr
node. Use the value false
for the parameter
isId
to undeclare an attribute for being a
user-determined ID attribute.
Parameters: namespaceURI The namespace URI of the attribute. localName The local name of the attribute. isId Whether the attribute is a of type ID.
Throws: org.w3c.dom.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.
Since: DOM Level 3
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.
Text.isElementContentWhitespace
). Similarly, on setting,
no parsing is performed either, the input string is taken as pure
textual content.
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: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Since: DOM Level 3
getUserData
with the
same key.
Parameters: 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
.
Returns: Returns the DOMUserData
previously associated to
the given key on this node, or null
if there was none.
Since: DOM Level 3
Parameters: offset The 16-bit unit offset at which to split, starting from 0.
Returns: The new node, of the same type as this node.
Throws: DOMException
Parameters: offset Start offset of substring to extract. count The number of 16-bit units to extract.
Returns: 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.
Throws: 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.